Phonon.VideoPlayer

Synopsis

Functions

Slots

Signals

Detailed Description

The VideoPlayer widget is used to perform playback of video.

With VideoPlayer you can get results quickly and easily. You can do the standard playback tasks like PySide.phonon.Phonon::VideoPlayer.play() , PySide.phonon.Phonon::VideoPlayer.pause() , and PySide.phonon.Phonon::VideoPlayer.stop() , but also set a playback volume and seek - if the media and backend supports seeking.

VideoPlayer is provided for convenience and removes the need to create a media graph with a Phonon.MediaObject , Phonon.AudioOutput , and Phonon.VideoWidget . If you need functionality not supported by the player, you can build this graph yourself.

Keep in mind that when the VideoPlayer instance is deleted the playback will stop.

Note also that most of the functions in this class are asynchronous. For instance, a media source may not play immediately after you call the PySide.phonon.Phonon::VideoPlayer.play() function.

A play and forget code example:

<Code snippet "doc/src/snippets/code/doc_src_phonon-api.cpp:4" not found>

See also

Phonon Module MediaObject

class PySide.phonon.Phonon.VideoPlayer(category[, parent=None])
class PySide.phonon.Phonon.VideoPlayer([parent=None])
Parameters:

Constructs a new video widget with a parent using Phonon.VideoCategory as its category.

parent The PySide.QtCore.QObject parent.

PySide.phonon.Phonon.VideoPlayer.audioOutput()
Return type:PySide.phonon.Phonon::AudioOutput

Returns the audio output object being used by the player.

PySide.phonon.Phonon.VideoPlayer.currentTime()
Return type:PySide.QtCore.qint64

Get the current time (in milliseconds) of the file currently being played.

PySide.phonon.Phonon.VideoPlayer.finished()
PySide.phonon.Phonon.VideoPlayer.isPaused()
Return type:PySide.QtCore.bool

Returns true if it is currently paused; otherwise returns false if it is currently playing or stopped.

PySide.phonon.Phonon.VideoPlayer.isPlaying()
Return type:PySide.QtCore.bool

Returns true if it is currently playing; otherwise returns false if it is currently stopped or paused

PySide.phonon.Phonon.VideoPlayer.load(source)
Parameters:sourcePySide.phonon.Phonon::MediaSource
PySide.phonon.Phonon.VideoPlayer.mediaObject()
Return type:PySide.phonon.Phonon::MediaObject

Returns the media object being used by the player.

The media object can be accessed directly instead of using the VideoPlayer s convenience functions, e.g., PySide.phonon.Phonon::VideoPlayer.play() and PySide.phonon.Phonon::VideoPlayer.stop() . It is also possible to give the object to other Phonon widgets, e.g., a Phonon.SeekSlider or a Phonon.VolumeSlider .

See also

Phonon.SeekSlider Phonon.MediaObject

PySide.phonon.Phonon.VideoPlayer.pause()

Pauses the playback.

See also

MediaObject.pause()

PySide.phonon.Phonon.VideoPlayer.play(source)
Parameters:sourcePySide.phonon.Phonon::MediaSource
PySide.phonon.Phonon.VideoPlayer.play()

Continues playback of paused media. Restarts playback of a stopped (or newly loaded) media.

See also

MediaObject.play() PySide.phonon.Phonon::VideoPlayer.play()

PySide.phonon.Phonon.VideoPlayer.seek(ms)
Parameters:msPySide.QtCore.qint64

Seeks to the requested time. Note that the backend is free to ignore the seek request if the media source isn’t seekable; you can check this by asking the media object of the VideoPlayer .

player->mediaObject()->isSeekable();

The ms parameter is the time in milliseconds from the start of the media.

The call is asynchronous, so PySide.phonon.Phonon::VideoPlayer.currentTime() can still be the old value right after this method was called. If all you need is a slider that shows the current position and allows the user to seek, use the class SeekSlider .

See also

MediaObject.seek() MediaObject.isSeekable() PySide.phonon.Phonon::VideoPlayer.mediaObject()

PySide.phonon.Phonon.VideoPlayer.setVolume(volume)
Parameters:volumePySide.QtCore.float

Sets the volume of the output as voltage factor.

1.0 means 100%, 0.5 means 50% voltage/25% power, 0.0 means 0%

See also

PySide.phonon.Phonon::VideoPlayer.volume()

PySide.phonon.Phonon.VideoPlayer.stop()

Stops the playback.

See also

MediaObject.stop()

PySide.phonon.Phonon.VideoPlayer.totalTime()
Return type:PySide.QtCore.qint64

Get the total time (in milliseconds) of the file currently being played.

PySide.phonon.Phonon.VideoPlayer.videoWidget()
Return type:PySide.phonon.Phonon::VideoWidget

Returns the video widget being used by the player.

PySide.phonon.Phonon.VideoPlayer.volume()
Return type:PySide.QtCore.float

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%

See also

PySide.phonon.Phonon::VideoPlayer.setVolume()