Warning, /libraries/phonon/phonon/backend.dox is written in an unsupported language. File is not indexed.
0001 /** 0002 \page phonon_Backend The Backend Class 0003 \ingroup Backend 0004 0005 \section phonon_Backend_requiredfunctions Required Functions 0006 \li bool \ref phonon_Backend_supportsOSD "supportsOSD()" 0007 \li bool \ref phonon_Backend_supportsFourcc "supportsFourcc( quint32 )" 0008 \li bool \ref phonon_Backend_supportsSubtitles "supportsSubtitles()" 0009 \li bool \ref phonon_Backend_supportsVideo "supportsVideo()" 0010 \li QStringList \ref phonon_Backend_availableMimeTypes "availableMimeTypes()" 0011 0012 \section Member Function Documentation 0013 0014 \subsection phonon_Backend_supportsFourcc bool supportsFourcc( quint32 fourcc ) 0015 Tells whether the FOURCC (four character code) is supported for 0016 the \ref phonon_VideoDataOutput "VideoDataOutput" interface. If you return \c true, you have to be 0017 able to return VideoFrame objects accordingly from 0018 \ref phonon_VideoDataOutput "VideoDataOutput". 0019 \param fourcc A four character code defining a video frame format. 0020 \returns \c true if your \ref phonon_VideoDataOutput "VideoDataOutput" can 0021 output video frames in the requested format. 0022 \returns \c false if the video frames can not be converted into the requested 0023 format. 0024 0025 \subsection phonon_Backend_availableMimeTypes QStringList availableMimeTypes() 0026 Lists the MIME types the backend can read and decode. 0027 0028 \subsection phonon_Backend_xIndexes QSet<int> <device/codec/effect/...>Indexes() 0029 Returns a set of indexes that identify the devices/codecs/effects/... the 0030 backend supports. This list needs to be compiled from looking at 0031 available hardware and virtual devices/plugins/... . The implementation 0032 should use cached information, but you need to invalidate the cache 0033 whenever the hardware configuration changes or new virtual devices come 0034 available/new plugins are installed/... . 0035 0036 \return The indexes of the available devices/codecs/effects/... 0037 0038 \see \ref phonon_Backend_xName 0039 \see \ref phonon_Backend_xDescription 0040 0041 \subsection phonon_Backend_xName QString <device/codec/effect/...>Name( int index ) 0042 Returns the name of the given device/codec/effect/... 0043 0044 \param index The index of one device/codec/effect/... this is one index 0045 out of \ref phonon_Backend_xIndexes 0046 0047 \returns A translated user visible string to name the device. 0048 0049 \see \ref phonon_Backend_xIndexes 0050 \see \ref phonon_Backend_xDescription 0051 \subsection phonon_Backend_xDescription QString <device/codec/effect/...>Description( int index ) 0052 Returns the description of the given device/codec/effect/... 0053 0054 \param index The index of one device/codec/effect/... this is one index 0055 out of \ref phonon_Backend_xIndexes 0056 0057 \returns A translated user visible string to describe the device. 0058 0059 \see \ref phonon_Backend_xIndexes 0060 \see \ref phonon_Backend_xName 0061 0062 \subsection phonon_Backend_audioCaptureDeviceVideoIndex qint32 audioCaptureDeviceVideoIndex( int index ) 0063 \param index The index of the device. This is one of the indexes the backend 0064 returned via \ref phonon_Backend_xIndexes 0065 \returns An index of a video capture device that is associated with the given 0066 audio capture device. For example a webcam might have both a video and an audio 0067 capture device, and in order give the user a hint that the audio and video 0068 capture devices belong together this index is used. 0069 \returns If there is no associated video capture device return -1. 0070 0071 \subsection phonon_Backend_videoCaptureDeviceAudioIndex qint32 videoCaptureDeviceAudioIndex( int index ) 0072 \param index The index of the device. This is one of the indexes the backend 0073 returned via \ref phonon_Backend_xIndexes 0074 \returns An index of a audio capture device that is associated with the given 0075 video capture device. For example a webcam might have both a audio and an video 0076 capture device, and in order give the user a hint that the video and audio 0077 capture devices belong together this index is used. 0078 \returns If there is no associated audio capture device return -1. 0079 0080 \page phonon_AudioDataOutput The AudioDataOutput Class 0081 \ingroup Backend 0082 0083 \page phonon_AudioOutput The AudioOutput Class 0084 \ingroup Backend 0085 0086 \page phonon_VideoDataOutput The VideoDataOutput Class 0087 \ingroup Backend 0088 0089 \page phonon_VideoWidget The VideoWidget Class 0090 \ingroup Backend 0091 0092 \page phonon_Effect The Effect Class 0093 \ingroup Backend 0094 0095 \page phonon_BrightnessControl The BrightnessControl Class 0096 \ingroup Backend 0097 0098 \page phonon_VideoEffect The VideoEffect Class 0099 \ingroup Backend 0100 0101 \page phonon_Visualization The Visualization Class 0102 \ingroup Backend 0103 0104 \page phonon_VolumeFaderEffect The VolumeFaderEffect Class 0105 \ingroup Backend 0106 0107 */