KDE 4.0 API Reference Phonon
VideoPlayer Class Reference
[Playback, Video]
#include <Phonon/VideoPlayer>
Detailed Description
Playback class for simple tasks.With VideoPlayer you can get results quickly and easily. You can do the standard playback tasks like play, pause and stop, but also set a playback volume and seek (there's no guarantee that the seek will work, though).
Keep in mind that when the VideoPlayer instance is deleted the playback will stop.
A play and forget code example:
VideoPlayer *player = new VideoPlayer(Phonon::VideoCategory, parentWidget); connect(player, SIGNAL(finished()), player, SLOT(deleteLater())); player->play(url);
Public Slots | |
| void | load (const MediaSource &source) |
| void | play (const MediaSource &source) |
| void | play () |
| void | pause () |
| void | stop () |
| void | seek (qint64 ms) |
| void | setVolume (float volume) |
| MediaObject * | mediaObject () const |
| AudioOutput * | audioOutput () const |
| VideoWidget * | videoWidget () const |
Signals | |
| void | finished () |
Public Member Functions | |
| VideoPlayer (Phonon::Category category, QWidget *parent=0) | |
| ~VideoPlayer () | |
| qint64 | totalTime () const |
| qint64 | currentTime () const |
| float | volume () const |
| bool | isPlaying () const |
| bool | isPaused () const |
Constructor & Destructor Documentation
| VideoPlayer | ( | Phonon::Category | category, | |
| QWidget * | parent = 0 | |||
| ) | [explicit] |
Constructs a new VideoPlayer instance.
- Parameters:
-
category The category used for the audio output device. parent The QObject parent.
| ~VideoPlayer | ( | ) |
On destruction the playback is stopped, also the audio output is removed so that the desktop mixer will not show the application anymore.
If you need a persistent audio output don't use VideoPlayer but MediaObject, VideoPath and VideoOutput.
Member Function Documentation
| qint64 totalTime | ( | ) | const |
Get the total time (in milliseconds) of the file currently being played.
| qint64 currentTime | ( | ) | const |
Get the current time (in milliseconds) of the file currently being played.
| float volume | ( | ) | const |
This is the current volume of the output as voltage factor.
1.0 means 100%, 0.5 means 50% voltage/25% power, 0.0 means 0%
| bool isPlaying | ( | ) | const |
- Returns:
trueif it is currently playing
- Returns:
falseif it is currently stopped or paused
| bool isPaused | ( | ) | const |
- Returns:
trueif it is currently paused
- Returns:
falseif it is currently playing or stopped
| void load | ( | const MediaSource & | source | ) | [slot] |
Starts preloading the media data and fill audiobuffers in the backend.
When there's already a media playing (or paused) it will be stopped (the finished signal will not be emitted).
| void play | ( | const MediaSource & | source | ) | [slot] |
Play the media at the given URL.
Starts playback as fast as possible. This can take a considerable time depending on the URL and the backend.
If you need low latency between calling play() and the sound actually starting to play on your output device you need to use MediaObject and be able to set the URL before calling play(). Note that
audioPlayer->load(url); audioPlayer->play();
| void play | ( | ) | [slot] |
Continues playback of a paused media.
Restarts playback of a stopped media.
| void pause | ( | ) | [slot] |
Pauses the playback.
| void stop | ( | ) | [slot] |
Stops the playback.
| void seek | ( | qint64 | ms | ) | [slot] |
Seeks to the requested time.
Note that the backend is free to ignore the seek request if the media source isn't seekable.
- Parameters:
-
ms Time in milliseconds from the start of the media.
| void setVolume | ( | float | volume | ) | [slot] |
Sets the volume of the output as voltage factor.
1.0 means 100%, 0.5 means 50% voltage/25% power, 0.0 means 0%
| MediaObject* mediaObject | ( | ) | const [slot] |
getter for the MediaObject.
| AudioOutput* audioOutput | ( | ) | const [slot] |
getter for the AudioOutput.
| VideoWidget* videoWidget | ( | ) | const [slot] |
getter for the VideoWidget.
| void finished | ( | ) | [signal] |
This signal is emitted when the playback finished.
The documentation for this class was generated from the following file:
- videoplayer.h
