| 1 |
/** |
| 2 |
\page phonon_Backend The Backend Class |
| 3 |
\ingroup Backend |
| 4 |
|
| 5 |
\section phonon_Backend_requiredfunctions Required Functions |
| 6 |
\li bool \ref phonon_Backend_supportsOSD "supportsOSD()" |
| 7 |
\li bool \ref phonon_Backend_supportsFourcc "supportsFourcc( quint32 )" |
| 8 |
\li bool \ref phonon_Backend_supportsSubtitles "supportsSubtitles()" |
| 9 |
\li bool \ref phonon_Backend_supportsVideo "supportsVideo()" |
| 10 |
\li QStringList \ref phonon_Backend_availableMimeTypes "availableMimeTypes()" |
| 11 |
|
| 12 |
\section Member Function Documentation |
| 13 |
|
| 14 |
\subsection phonon_Backend_supportsFourcc bool supportsFourcc( quint32 fourcc ) |
| 15 |
Tells whether the FOURCC (four character code) is supported for |
| 16 |
the \ref phonon_VideoDataOutput "VideoDataOutput" interface. If you return \c true, you have to be |
| 17 |
able to return VideoFrame objects accordingly from |
| 18 |
\ref phonon_VideoDataOutput "VideoDataOutput". |
| 19 |
\param fourcc A four character code defining a video frame format. |
| 20 |
\returns \c true if your \ref phonon_VideoDataOutput "VideoDataOutput" can |
| 21 |
output video frames in the requested format. |
| 22 |
\returns \c false if the video frames can not be converted into the requested |
| 23 |
format. |
| 24 |
|
| 25 |
\subsection phonon_Backend_availableMimeTypes QStringList availableMimeTypes() |
| 26 |
Lists the MIME types the backend can read and decode. |
| 27 |
|
| 28 |
\subsection phonon_Backend_xIndexes QSet<int> <device/codec/effect/...>Indexes() |
| 29 |
Returns a set of indexes that identify the devices/codecs/effects/... the |
| 30 |
backend supports. This list needs to be compiled from looking at |
| 31 |
available hardware and virtual devices/plugins/... . The implementation |
| 32 |
should use cached information, but you need to invalidate the cache |
| 33 |
whenever the hardware configuration changes or new virtual devices come |
| 34 |
available/new plugins are installed/... . |
| 35 |
|
| 36 |
\return The indexes of the available devices/codecs/effects/... |
| 37 |
|
| 38 |
\see \ref phonon_Backend_xName |
| 39 |
\see \ref phonon_Backend_xDescription |
| 40 |
|
| 41 |
\subsection phonon_Backend_xName QString <device/codec/effect/...>Name( int index ) |
| 42 |
Returns the name of the given device/codec/effect/... |
| 43 |
|
| 44 |
\param index The index of one device/codec/effect/... this is one index |
| 45 |
out of \ref phonon_Backend_xIndexes |
| 46 |
|
| 47 |
\returns A translated user visible string to name the device. |
| 48 |
|
| 49 |
\see \ref phonon_Backend_xIndexes |
| 50 |
\see \ref phonon_Backend_xDescription |
| 51 |
\subsection phonon_Backend_xDescription QString <device/codec/effect/...>Description( int index ) |
| 52 |
Returns the description of the given device/codec/effect/... |
| 53 |
|
| 54 |
\param index The index of one device/codec/effect/... this is one index |
| 55 |
out of \ref phonon_Backend_xIndexes |
| 56 |
|
| 57 |
\returns A translated user visible string to describe the device. |
| 58 |
|
| 59 |
\see \ref phonon_Backend_xIndexes |
| 60 |
\see \ref phonon_Backend_xName |
| 61 |
|
| 62 |
\subsection phonon_Backend_audioCaptureDeviceVideoIndex qint32 audioCaptureDeviceVideoIndex( int index ) |
| 63 |
\param index The index of the device. This is one of the indexes the backend |
| 64 |
returned via \ref phonon_Backend_xIndexes |
| 65 |
\returns An index of a video capture device that is associated with the given |
| 66 |
audio capture device. For example a webcam might have both a video and an audio |
| 67 |
capture device, and in order give the user a hint that the audio and video |
| 68 |
capture devices belong together this index is used. |
| 69 |
\returns If there is no associated video capture device return -1. |
| 70 |
|
| 71 |
\subsection phonon_Backend_videoCaptureDeviceAudioIndex qint32 videoCaptureDeviceAudioIndex( int index ) |
| 72 |
\param index The index of the device. This is one of the indexes the backend |
| 73 |
returned via \ref phonon_Backend_xIndexes |
| 74 |
\returns An index of a audio capture device that is associated with the given |
| 75 |
video capture device. For example a webcam might have both a audio and an video |
| 76 |
capture device, and in order give the user a hint that the video and audio |
| 77 |
capture devices belong together this index is used. |
| 78 |
\returns If there is no associated audio capture device return -1. |
| 79 |
|
| 80 |
\page phonon_AudioDataOutput The AudioDataOutput Class |
| 81 |
\ingroup Backend |
| 82 |
|
| 83 |
\page phonon_AudioOutput The AudioOutput Class |
| 84 |
\ingroup Backend |
| 85 |
|
| 86 |
\page phonon_VideoDataOutput The VideoDataOutput Class |
| 87 |
\ingroup Backend |
| 88 |
|
| 89 |
\page phonon_VideoWidget The VideoWidget Class |
| 90 |
\ingroup Backend |
| 91 |
|
| 92 |
\page phonon_Effect The Effect Class |
| 93 |
\ingroup Backend |
| 94 |
|
| 95 |
\page phonon_BrightnessControl The BrightnessControl Class |
| 96 |
\ingroup Backend |
| 97 |
|
| 98 |
\page phonon_VideoEffect The VideoEffect Class |
| 99 |
\ingroup Backend |
| 100 |
|
| 101 |
\page phonon_Visualization The Visualization Class |
| 102 |
\ingroup Backend |
| 103 |
|
| 104 |
\page phonon_VolumeFaderEffect The VolumeFaderEffect Class |
| 105 |
\ingroup Backend |
| 106 |
|
| 107 |
*/ |
