QMediaPlayer¶

PyQt5.QtMultimedia.QMediaPlayer: Inherits from QMediaObject.

Description¶

The QMediaPlayer class allows the playing of a media source.

The QMediaPlayer class is a high level media playback class. It can be used to playback such content as songs, movies and internet radio. The content to playback is specified as a QMediaContent object, which can be thought of as a main or canonical URL with additional information attached. When provided with a QMediaContent playback may be able to commence.

#     player = new QMediaPlayer;
#     connect(player, SIGNAL(positionChanged(qint64)), this, SLOT(positionChanged(qint64)));
#     player->setMedia(QUrl::fromLocalFile("/Users/me/Music/coolsong.mp3"));
#     player->setVolume(50);
#     player->play();

QVideoWidget can be used with QMediaPlayer for video rendering and QMediaPlaylist for accessing playlist functionality.

#     playlist = new QMediaPlaylist;
#     playlist->addMedia(QUrl("http://example.com/movie1.mp4"));
#     playlist->addMedia(QUrl("http://example.com/movie2.mp4"));
#     playlist->addMedia(QUrl("http://example.com/movie3.mp4"));
#     playlist->setCurrentIndex(1);

#     player = new QMediaPlayer;
#     player->setPlaylist(playlist);

#     videoWidget = new QVideoWidget;
#     player->setVideoOutput(videoWidget);
#     videoWidget->show();

#     player->play();

Since QMediaPlayer is a QMediaObject, you can use several of the QMediaObject functions for things like:

Accessing the currently playing media’s metadata (metaData() and QMediaMetaData)
Checking to see if the media playback service is currently available (availability())

Classes¶

Flags

Enums¶

Error

Defines a media player error condition.

Member	Value	Description
AccessDeniedError	4	There are not the appropriate permissions to play a media resource.
FormatError	2	The format of a media resource isn’t (fully) supported. Playback may still be possible, but without an audio or video component.
NetworkError	3	A network error occurred.
NoError	0	No error has occurred.
ResourceError	1	A media resource couldn’t be resolved.
ServiceMissingError	5	A valid playback service was not found, playback cannot proceed.

Flag

Member	Value	Description
LowLatency	0x01	The player is expected to be used with simple audio formats, but playback should start without significant delay. Such playback service can be used for beeps, ringtones, etc.
StreamPlayback	0x02	The player is expected to play QIODevice based streams. If passed to QMediaPlayer constructor, the service supporting streams playback will be chosen.
VideoSurface	0x04	The player is expected to be able to render to a QAbstractVideoSurface setVideoOutput().

MediaStatus

Defines the status of a media player’s current media.

Member	Value	Description
BufferedMedia	6	The player has fully buffered the current media. The player is in the PlayingState or PausedState.
BufferingMedia	5	The player is buffering data but has enough data buffered for playback to continue for the immediate future. The player is in the PlayingState or PausedState.
EndOfMedia	7	Playback has reached the end of the current media. The player is in the StoppedState.
InvalidMedia	8	The current media cannot be played. The player is in the StoppedState.
LoadedMedia	3	The current media has been loaded. The player is in the StoppedState.
LoadingMedia	2	The current media is being loaded. The player may be in any state.
NoMedia	1	The is no current media. The player is in the StoppedState.
StalledMedia	4	Playback of the current media has stalled due to insufficient buffering or some other temporary interruption. The player is in the PlayingState or PausedState.
UnknownMediaStatus	0	The status of the media cannot be determined.

State

Defines the current state of a media player.

Member	Value	Description
PausedState	2	The media player has paused playback, playback of the current track will resume from the position the player was paused at.
PlayingState	1	The media player is currently playing content.
StoppedState	0	The media player is not playing content, playback will begin from the start of the current track.

Methods¶

__init__(parent: QObject = None, flags: Union[Flags, Flag] = QMediaPlayer.Flags()): Construct a QMediaPlayer instance parented to parent and with flags.

audioRole() → Role: See also

setAudioRole().

availability() → AvailabilityStatus: TODO

bind(QObject) → bool: TODO

bufferStatus() → int: TODO

currentMedia() → QMediaContent: TODO

currentNetworkConfiguration() → QNetworkConfiguration: Returns the current network access point in use. If a default contructed QNetworkConfiguration is returned this feature is not available or that none of the current supplied configurations are in use.

customAudioRole() → str: See also

setCustomAudioRole().

duration() → int: TODO

error() → Error: Returns the current error state.

errorString() → str: TODO

@staticmethod hasSupport(str, codecs: Iterable[str] = [], flags: Union[Flags, Flag] = QMediaPlayer.Flags()) → SupportEstimate

Returns the level of support a media player has for a mimeType and a set of codecs.

The flags argument allows additional requirements such as performance indicators to be specified.

isAudioAvailable() → bool: TODO

isMuted() → bool: TODO

isSeekable() → bool: TODO

isVideoAvailable() → bool: TODO

media() → QMediaContent: See also

setMedia().

mediaStatus() → MediaStatus: TODO

mediaStream() → QIODevice

Returns the stream source of media data.

This is only valid if a stream was passed to setMedia().

Signals¶

audioAvailableChanged(bool): TODO

audioRoleChanged(Role): TODO

bufferStatusChanged(int): TODO

currentMediaChanged(QMediaContent): TODO

customAudioRoleChanged(str): TODO

durationChanged(int): TODO

error(): Returns the current error state.

error(Error): Returns the current error state.

mediaChanged(QMediaContent): TODO

mediaStatusChanged(MediaStatus): TODO

mutedChanged(bool): TODO

networkConfigurationChanged(QNetworkConfiguration): TODO

playbackRateChanged(float): TODO

positionChanged(int): TODO

seekableChanged(bool): TODO

stateChanged(State): TODO

videoAvailableChanged(bool): TODO

volumeChanged(int): TODO