1.7.3Please send us your comment about this page
The KDE Multimedia classes. More...
Namespaces |
|
| namespace | Experimental |
| namespace | BackendCapabilities |
|
Collection of functions describing the capabilities of the Backend. |
|
Classes |
|
| class | AbstractAudioOutput |
| Common base class for all audio outputs.
More... |
|
| class | AbstractMediaStream |
| Base class for custom media data streams.
More... |
|
| class | AbstractVideoOutput |
| Common base class for all video outputs.
More... |
|
| class | AddonInterface |
| Interface for Menu, Chapter, Angle and
Title/Track control. More... |
|
| class | AudioDataOutput |
| This class gives you the audio data (for
visualizations). More... |
|
| class | AudioDataOutputInterface |
| class | AudioOutput |
| Class for audio output to the soundcard.
More... |
|
| class | AudioOutputInterface40 |
| class | AudioOutputInterface42 |
| class | BackendInterface |
| Main Backend class interface. More... |
|
| class | Effect |
| Effects that can be inserted into a
Path.
More... |
|
| class | EffectInterface |
| Interface for Effect objects.
More... |
|
| class | EffectParameter |
| This class describes one parameter of an
effect. More... |
|
| class | EffectWidget |
| Widget to control the parameters of an
Effect. More... |
|
| class | GlobalConfig |
| class | MediaController |
| Controls optional features of a media
file/device like title, chapter, angle. More... |
|
| class | MediaNode |
| class | MediaObject |
| Interface for media playback of a given URL.
More... |
|
| class | MediaObjectInterface |
| Backend interface for media sources.
More... |
|
| class | MediaSource |
| Note that all constructors of this class are
implicit, so that you can simply write. More... |
|
| class | ObjectDescriptionData |
| Data class for objects describing devices or
features of the backend. More... |
|
| class | ObjectDescription |
| Provides a tuple of enduser visible name and
description. More... |
|
| class | ObjectDescriptionModelData |
| Data class for models for ObjectDescription
objects. More... |
|
| class | ObjectDescriptionModel |
| The
ObjectDescriptionModel class provides a model from a list of
ObjectDescription
objects. More... |
|
| class | Path |
| Connection object providing convenient
effect insertion. More... |
|
| class | PlatformPlugin |
| class | PulseSupport |
| class | SeekSlider |
| Widget providing a slider for seeking in
MediaObject
objects. More... |
|
| class | StreamInterface |
| Backend interface to handle media streams
(AbstractMediaStream).
More... |
|
| class | VideoPlayer |
| Playback class for simple tasks. More... |
|
| class | VideoWidget |
| Widget to display video. More... |
|
| class | VideoWidgetInterface44 |
| class | VolumeFaderEffect |
| Audio effect to gradually fade the audio
volume. More... |
|
| class | VolumeSlider |
| Widget providing a slider to control the
volume of an AudioOutput.
More... |
|
Typedefs |
|
| typedef AudioOutputInterface40 | AudioOutputInterface |
| typedef
ObjectDescription < AudioOutputDeviceType > |
AudioOutputDevice |
| typedef
ObjectDescription < AudioCaptureDeviceType > |
AudioCaptureDevice |
| typedef
ObjectDescription < EffectType > |
EffectDescription |
| typedef
ObjectDescription < AudioChannelType > |
AudioChannelDescription |
| typedef
ObjectDescription < SubtitleType > |
SubtitleDescription |
| typedef
ObjectDescriptionModel < AudioOutputDeviceType > |
AudioOutputDeviceModel |
| typedef
ObjectDescriptionModel < AudioCaptureDeviceType > |
AudioCaptureDeviceModel |
| typedef
ObjectDescriptionModel < EffectType > |
EffectDescriptionModel |
| typedef
ObjectDescriptionModel < AudioChannelType > |
AudioChannelDescriptionModel |
| typedef
ObjectDescriptionModel < SubtitleType > |
SubtitleDescriptionModel |
| typedef VideoWidgetInterface | VideoWidgetInterfaceLatest |
Enumerations |
|
| enum | ObjectDescriptionType
{ AudioOutputDeviceType, EffectType, AudioChannelType, SubtitleType, AudioCaptureDeviceType } |
|
Defines the type of information that is contained in a ObjectDescription object. More... |
|
| enum | DiscType { NoDisc = -1, Cd = 0, Dvd = 1, Vcd = 2 } |
|
Enum to identify the media discs supported by MediaObject. More... |
|
| enum | MetaData
{ ArtistMetaData, AlbumMetaData, TitleMetaData, DateMetaData, GenreMetaData, TracknumberMetaData, DescriptionMetaData, MusicBrainzDiscIdMetaData } |
|
Provided as keys for MediaObject::metaData for convenience, in addition to the strings defined in the Ogg Vorbis specification. More... |
|
| enum | State
{ LoadingState, StoppedState, PlayingState, BufferingState, PausedState, ErrorState } |
|
The state the media producing object is in at the moment. More... |
|
| enum | Category
{ NoCategory = -1, NotificationCategory = 0, MusicCategory = 1, VideoCategory = 2, CommunicationCategory = 3, GameCategory = 4, AccessibilityCategory = 5, LastCategory = AccessibilityCategory } |
|
Set's the category your program should be listed in in the mixer. More... |
|
| enum | ErrorType { NoError = 0, NormalError = 1, FatalError = 2 } |
|
Tells your program how to recover from an error. More... |
|
Functions |
|
| uint PHONON_EXPORT | qHash (const Phonon::EffectParameter ¶m) |
| PHONON_EXPORT MediaObject * | createPlayer (Phonon::Category category, const MediaSource &source=MediaSource()) |
| Convenience function to create a MediaObject and
AudioOutput
connected by a path. |
|
| template<ObjectDescriptionType T> | |
| QDebug | operator<< (QDebug s, const ObjectDescription< T > &o) |
| PHONON_EXPORT const char * | phononVersion () |
| PHONON_EXPORT QString | categoryToString (Category c) |
| Returns a (translated) string to show to the
user identifying the given Category. |
|
| virtual void | setAspectRatio (Phonon::VideoWidget::AspectRatio)=0 |
| virtual qreal | brightness () const =0 |
| virtual void | setBrightness (qreal)=0 |
|
virtual Phonon::VideoWidget::ScaleMode |
scaleMode () const =0 |
| virtual void | setScaleMode (Phonon::VideoWidget::ScaleMode)=0 |
| virtual qreal | contrast () const =0 |
| virtual void | setContrast (qreal)=0 |
| virtual qreal | hue () const =0 |
| virtual void | setHue (qreal)=0 |
| virtual qreal | saturation () const =0 |
| virtual void | setSaturation (qreal)=0 |
| virtual QWidget * | widget ()=0 |
| virtual void | setVolume (float) |
|
virtual Phonon::VolumeFaderEffect::FadeCurve |
fadeCurve () const |
| virtual void | setFadeCurve (Phonon::VolumeFaderEffect::FadeCurve) |
| virtual void | fadeTo (float, int) |
Variables |
|
| D | __pad0__ |
The KDE Multimedia classes.
In this Namespace you find the classes to access Multimedia functions for audio and video playback. Those classes are not dependent on any specific framework (like they were in pre KDE4 times) but rather use exchangeable backends to do the work.
If you want to write a new backend take a look at phonon_backend_development_page.
Definition at line 143 of file audiooutputinterface.h.
| typedef ObjectDescription<AudioOutputDeviceType> AudioOutputDevice |
Definition at line 272 of file objectdescription.h.
| typedef ObjectDescription<AudioCaptureDeviceType> AudioCaptureDevice |
Definition at line 277 of file objectdescription.h.
| typedef ObjectDescription<EffectType> EffectDescription |
Definition at line 291 of file objectdescription.h.
| typedef ObjectDescription<AudioChannelType> AudioChannelDescription |
Definition at line 311 of file objectdescription.h.
| typedef ObjectDescription<SubtitleType> SubtitleDescription |
Definition at line 312 of file objectdescription.h.
| typedef ObjectDescriptionModel<AudioOutputDeviceType> AudioOutputDeviceModel |
Definition at line 366 of file objectdescriptionmodel.h.
| typedef ObjectDescriptionModel<AudioCaptureDeviceType> AudioCaptureDeviceModel |
Definition at line 367 of file objectdescriptionmodel.h.
| typedef ObjectDescriptionModel<EffectType> EffectDescriptionModel |
Definition at line 368 of file objectdescriptionmodel.h.
| typedef ObjectDescriptionModel<AudioChannelType> AudioChannelDescriptionModel |
Definition at line 369 of file objectdescriptionmodel.h.
| typedef ObjectDescriptionModel<SubtitleType> SubtitleDescriptionModel |
Definition at line 370 of file objectdescriptionmodel.h.
| typedef VideoWidgetInterface VideoWidgetInterfaceLatest |
Definition at line 67 of file videowidgetinterface.h.
Defines the type of information that is contained in a ObjectDescription object.
Definition at line 48 of file objectdescription.h.
{
AudioOutputDeviceType,
EffectType,
AudioChannelType,
SubtitleType,
AudioCaptureDeviceType
//VideoOutputDeviceType,
//VideoCaptureDeviceType,
//AudioCodecType,
//VideoCodecType,
//ContainerFormatType,
//VisualizationType,
};
| enum DiscType |
Enum to identify the media discs supported by MediaObject.
Definition at line 77 of file phononnamespace.h.
| enum MetaData |
Provided as keys for MediaObject::metaData for convenience, in addition to the strings defined in the Ogg Vorbis specification.
Definition at line 101 of file phononnamespace.h.
| enum State |
The state the media producing object is in at the moment.
Definition at line 142 of file phononnamespace.h.
| enum Category |
Set's the category your program should be listed in in the mixer.
A Jukebox will set this to Music, a VoIP program to Communication, a DVD player to video, and so on.
Definition at line 188 of file phononnamespace.h.
{
NoCategory = -1,
NotificationCategory = 0,
MusicCategory = 1,
VideoCategory = 2,
CommunicationCategory = 3,
GameCategory = 4,
AccessibilityCategory = 5,
LastCategory = AccessibilityCategory
};
| enum ErrorType |
Tells your program how to recover from an error.
| NoError |
No error. MediaObject::errorType() returns this if MediaObject::state() != Phonon::ErrorState. |
| NormalError |
Playback should work, and trying with another URL should work. |
| FatalError |
Something important does not work. Your program cannot continue playback or capture or whatever it was trying to do without help from the user. |
Definition at line 233 of file phononnamespace.h.
{
NoError = 0,
NormalError = 1,
FatalError = 2
};
| uint PHONON_EXPORT Phonon::qHash | ( | const Phonon::EffectParameter & | param | ) |
| PHONON_EXPORT MediaObject* Phonon::createPlayer | ( | Phonon::Category | category, |
| const MediaSource & | source =
MediaSource() |
||
| ) |
Convenience function to create a MediaObject and AudioOutput connected by a path.
Definition at line 264 of file objectdescription.h.
{
return s << o.name();
}
| PHONON_EXPORT const char* Phonon::phononVersion | ( | ) |
| PHONON_EXPORT QString Phonon::categoryToString | ( | Category | c | ) |
Returns a (translated) string to show to the user identifying the given Category.
| virtual void Phonon::setAspectRatio | ( | Phonon::VideoWidget::AspectRatio | ) | [pure virtual] |
| virtual qreal Phonon::brightness | ( | ) | const [pure virtual] |
| virtual void Phonon::setBrightness | ( | qreal | ) | [pure virtual] |
| virtual Phonon::VideoWidget::ScaleMode Phonon::scaleMode | ( | ) | const [pure virtual] |
| virtual void Phonon::setScaleMode | ( | Phonon::VideoWidget::ScaleMode | ) | [pure virtual] |
| virtual qreal Phonon::contrast | ( | ) | const [pure virtual] |
| virtual void Phonon::setContrast | ( | qreal | ) | [pure virtual] |
| virtual qreal Phonon::hue | ( | ) | const [pure virtual] |
| virtual void Phonon::setHue | ( | qreal | ) | [pure virtual] |
| virtual qreal Phonon::saturation | ( | ) | const [pure virtual] |
| virtual void Phonon::setSaturation | ( | qreal | ) | [pure virtual] |
| virtual QWidget* Phonon::widget | ( | ) | [pure virtual] |
| virtual void Phonon::setVolume | ( | float | ) | [virtual] |
| virtual Phonon::VolumeFaderEffect::FadeCurve Phonon::fadeCurve | ( | ) | const [virtual] |
| virtual void Phonon::setFadeCurve | ( | Phonon::VolumeFaderEffect::FadeCurve | ) | [virtual] |
| virtual void Phonon::fadeTo | ( | float | , |
| int | |||
| ) | [virtual] |
Definition at line 48 of file volumefaderinterface.h.
| D __pad0__ |
Definition at line 37 of file abstractaudiooutput.h.