QMediaPlaylist

PyQt5.QtMultimedia.QMediaPlaylist

Inherits from QObject, QMediaBindableInterface.

Description

The QMediaPlaylist class provides a list of media content to play.

QMediaPlaylist is intended to be used with other media objects, like QMediaPlayer.

QMediaPlaylist allows to access the service intrinsic playlist functionality if available, otherwise it provides the local memory playlist implementation.

#     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();

Depending on playlist source implementation, most of the playlist mutating operations can be asynchronous.

See also

QMediaContent.

Enums

Error

This enum describes the QMediaPlaylist error codes.

Member	Value	Description
AccessDeniedError	4	Access denied error.
FormatError	1	Format error.
FormatNotSupportedError	2	Format not supported.
NetworkError	3	Network error.
NoError	0	No errors.

---

PlaybackMode

The describes the order items in playlist are played.

Member	Value	Description
CurrentItemInLoop	1	The current item is played repeatedly in a loop.
CurrentItemOnce	0	The current item is played only once.
Loop	3	Playback restarts at the first item after the last has finished playing.
Random	4	Play items in random order.
Sequential	2	Playback starts from the current and moves through each successive item until the last is reached and then stops. The next item is a null item when the last one is currently playing.

Methods

__init__(parent: QObject = None)

Create a new playlist object with the given parent.

---

addMedia(QMediaContent) → bool

TODO

---

addMedia(Iterable[QMediaContent]) → bool

TODO

---

clear() → bool

Remove all the items from the playlist.

Returns true if the operation is successful, otherwise return false.

---

currentIndex() → int

Returns position of the current media content in the playlist.

See also

setCurrentIndex().

---

currentMedia() → QMediaContent

Returns the current media content.

---

error() → Error

Returns the last error condition.

---

errorString() → str

Returns the string describing the last error condition.

---

insertMedia(int, QMediaContent) → bool

TODO

---

insertMedia(int, Iterable[QMediaContent]) → bool

TODO

---

isEmpty() → bool

Returns true if the playlist contains no items, otherwise returns false.

See also

mediaCount().

---

isReadOnly() → bool

Returns true if the playlist can be modified, otherwise returns false.

See also

mediaCount().

---

load(QNetworkRequest, format: str = None)

TODO

---

load(QUrl, format: str = None)

Load playlist from location. If format is specified, it is used, otherwise format is guessed from location name and data.

New items are appended to playlist.

loaded signal is emitted if playlist was loaded successfully, otherwise the playlist emits loadFailed.

---

load(QIODevice, format: str = None)

Load playlist from QIODevice device. If format is specified, it is used, otherwise format is guessed from device data.

New items are appended to playlist.

loaded signal is emitted if playlist was loaded successfully, otherwise the playlist emits loadFailed.

---

media(int) → QMediaContent

Returns the media content at index in the playlist.

---

mediaCount() → int

Returns the number of items in the playlist.

See also

isEmpty().

---

mediaObject() → QMediaObject

TODO

---

moveMedia(int, int) → bool

Move the item from position from to position to.

Returns true if the operation is successful, otherwise false.

---

next()

Advance to the next media content in playlist.

---

nextIndex(steps: int = 1) → int

Returns the index of the item, which would be current after calling next() steps times.

Returned value depends on the size of playlist, current position and playback mode.

See also

playbackMode(), previousIndex().

---

playbackMode() → PlaybackMode

See also

setPlaybackMode().

---

previous()

Return to the previous media content in playlist.

---

previousIndex(steps: int = 1) → int

Returns the index of the item, which would be current after calling previous() steps times.

See also

playbackMode(), nextIndex().

---

removeMedia(int) → bool

Remove the item from the playlist at position pos.

Returns true if the operation is successful, otherwise return false.

---

removeMedia(int, int) → bool

Remove items in the playlist from start to end inclusive.

Returns true if the operation is successful, otherwise return false.

---

save(QUrl, format: str = None) → bool

Save playlist to location. If format is specified, it is used, otherwise format is guessed from location name.

Returns true if playlist was saved successfully, otherwise returns false.

---

save(QIODevice, str) → bool

Save playlist to QIODevice device using format format.

Returns true if playlist was saved successfully, otherwise returns false.

---

setCurrentIndex(int)

Activate media content from playlist at position playlistPosition.

See also

currentIndex().

---

setMediaObject(QMediaObject) → bool

TODO

---

setPlaybackMode(PlaybackMode)

See also

playbackMode().

---

shuffle()

Shuffle items in the playlist.

Signals

currentIndexChanged(int)

TODO

---

currentMediaChanged(QMediaContent)

TODO

---

loaded()

TODO

---

loadFailed()

TODO

---

mediaAboutToBeInserted(int, int)

TODO

---

mediaAboutToBeRemoved(int, int)

TODO

---

mediaChanged(int, int)

TODO

---

mediaInserted(int, int)

TODO

---

mediaRemoved(int, int)

TODO

---

playbackModeChanged(PlaybackMode)

TODO