Warning, /libraries/phonon/phonon/mediaobject.dox is written in an unsupported language. File is not indexed.
0001 /** 0002 \page phonon_MediaObject The MediaObject class 0003 0004 \section phonon_MediaObject_derived Media Data Producing Class 0005 0006 There is the class that produces the media data (often called a source in 0007 media frameworks). 0008 0009 \section phonon_MediaObject_requiredfunctions Required Functions 0010 \li qint32 \ref phonon_MediaObject_prefinishMark "prefinishMark()" 0011 \li void \ref phonon_MediaObject_setPrefinishMark "setPrefinishMark(qint32)" 0012 0013 \section phonon_MediaObject_optionalfunctions Optional Functions 0014 \li qint64 \ref phonon_MediaObject_remainingTime "remainingTime()" 0015 0016 \section phonon_MediaObject_signals Signals 0017 \li void \ref phonon_MediaObject_totalTimeChanged "totalTimeChanged(qint64 totalTime)" 0018 \li void \ref phonon_MediaObject_prefinishMarkReached "prefinishMarkReached(qint32 msec)" 0019 \li void \ref phonon_MediaObject_finished "finished()" 0020 0021 \section phonon_MediaObject_memberdocs Member Function Documentation 0022 0023 \see \ref phonon_MediaObject_totalTimeChanged 0024 0025 \subsection phonon_MediaObject_prefinishMark qint32 prefinishMark() 0026 Returns the time in milliseconds the \ref phonon_MediaObject_prefinishMarkReached 0027 "prefinishMarkReached" signal is emitted before the playback if finished and \ref 0028 phonon_MediaObject_finished "finished" is emitted. 0029 0030 \subsection phonon_MediaObject_setPrefinishMark void setPrefinishMark(qint32 msec) 0031 Sets the time in milliseconds the \ref phonon_MediaObject_prefinishMarkReached 0032 "prefinishMarkReached" signal is emitted before the playback if finished and \ref 0033 phonon_MediaObject_finished "finished" is emitted. 0034 0035 \param msec The time in milliseconds. If the value is less than or equal to 0 0036 the \ref phonon_MediaObject_prefinishMarkReached "prefinishMarkReached" signal is disabled. 0037 0038 \subsection phonon_MediaObject_remainingTime qint64 remainingTime() 0039 Get the remaining time (in milliseconds) of the file currently being played. If 0040 the method is not implemented in the backend the frontend will use the 0041 difference between \link Phonon::MediaObjectInterface::totalTime() MediaObjectInterface::totalTime() \endlink and 0042 \link Phonon::MediaObjectInterface::currentTime() MediaObjectInterface::currentTime() \endlink. 0043 0044 \section phonon_MediaObject_signaldocs Signals Documentation 0045 \subsection phonon_MediaObject_prefinishMarkReached void prefinishMarkReached(qint32 msec) 0046 Emitted when the file has finished playing on its own. 0047 I.e. it is not emitted if you call stop(), pause() or 0048 load(), but only on end-of-file or a critical error. 0049 void finished() 0050 0051 \param msec The remaining time until the playback finishes 0052 0053 \subsection phonon_MediaObject_totalTimeChanged void totalTimeChanged(qint64 totalTime) 0054 This signal is emitted as soon as the length of the media file is 0055 known or has changed. For most non-local media data the length of 0056 the media can only be known after some time. At that time the 0057 totalTime function can not return useful information. You have 0058 to wait for this signal to know the real length. 0059 0060 \param totalTimeChanged The total time of the media file in milliseconds. 0061 0062 \see \link Phonon::MediaObjectInterface::totalTime() MediaObjectInterface::totalTime() \endlink 0063 0064 \subsection phonon_MediaObject_finished void finished() 0065 This signal is emitted when the playback of the media finished (on its own). 0066 It is not emitted if stop() or pause() are called - only on end-of-file or a 0067 critical error (for example the media data stream is corrupted and playback of 0068 the media has to be finished). 0069 0070 \see \ref phonon_MediaObject_prefinishMarkReached 0071 */