Home · All Classes · All Functions ·

QMediaPlaylist Class Reference

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

    #include <QMediaPlaylist>

This class is under development and is subject to change.

Inherits QObject.


Public Types

enum Error { NoError, FormatError, FormatNotSupportedError, NetworkError, AccessDeniedError }
enum PlaybackMode { CurrentItemOnce, CurrentItemInLoop, Linear, Loop, Random }

Properties


Public Functions

QMediaPlaylist ( QMediaObject * mediaObject = 0, QObject * parent = 0 )
virtual ~QMediaPlaylist ()
bool appendItem ( const QMediaContent & content )
bool appendItems ( const QList<QMediaContent> & items )
bool clear ()
QMediaContent currentMedia () const
int currentPosition () const
Error error () const
QString errorString () const
bool insertItem ( int pos, const QMediaContent & content )
bool insertItems ( int pos, const QList<QMediaContent> & items )
bool isEmpty () const
bool isReadOnly () const
void load ( const QUrl & location, const char * format = 0 )
void load ( QIODevice * device, const char * format = 0 )
QMediaContent media ( int position ) const
int nextPosition ( int steps = 1 ) const
PlaybackMode playbackMode () const
int previousPosition ( int steps = 1 ) const
bool removeItem ( int pos )
bool removeItems ( int start, int end )
bool save ( const QUrl & location, const char * format = 0 )
bool save ( QIODevice * device, const char * format )
void setPlaybackMode ( PlaybackMode mode )
int size () const

Public Slots

void next ()
void previous ()
void setCurrentPosition ( int playlistPosition )
void shuffle ()

Signals

void currentMediaChanged ( const QMediaContent & content )
void itemsAboutToBeInserted ( int start, int end )
void itemsAboutToBeRemoved ( int start, int end )
void itemsChanged ( int start, int end )
void itemsInserted ( int start, int end )
void itemsRemoved ( int start, int end )
void loadFailed ()
void loaded ()
void playbackModeChanged ( QMediaPlaylist::PlaybackMode mode )
void playlistPositionChanged ( int position )

Additional Inherited Members


Detailed Description

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

QMediaPlaylist is intended to be used with other media objects, like QMediaPlayer or QMediaImageViewer. QMediaPlaylist allows to access the service intrinsic playlist functionality if available, otherwise it provides the the local memory playlist implementation.

    player = new QMediaPlayer;

    playlist = new QMediaPlaylist(player);
    playlist->append(QUrl("http://example.com/movie1.mp4"));
    playlist->append(QUrl("http://example.com/movie2.mp4"));
    playlist->append(QUrl("http://example.com/movie3.mp4"));

    playlist->setCurrentPosition(1);

    player->play();

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

See also QMediaContent.


Member Type Documentation

enum QMediaPlaylist::Error

This enum describes the QMediaPlaylist error codes.

ConstantValueDescription
QMediaPlaylist::NoError0No errors.
QMediaPlaylist::FormatError1Format error.
QMediaPlaylist::FormatNotSupportedError2Format not supported.
QMediaPlaylist::NetworkError3Network error.
QMediaPlaylist::AccessDeniedError4Access denied error.

enum QMediaPlaylist::PlaybackMode

The QMediaPlaylist::PlaybackMode describes the order items in playlist are played.

ConstantValueDescription
QMediaPlaylist::CurrentItemOnce0The current item is played only once.
QMediaPlaylist::CurrentItemInLoop1The current item is played in the loop.
QMediaPlaylist::Linear2Playback starts from the first to the last items and stops. next item is a null item when the last one is currently playing.
QMediaPlaylist::Loop3Playback continues from the first item after the last one finished playing.
QMediaPlaylist::Random4Play items in random order.


Property Documentation

currentMedia : const QMediaContent

This property holds current media content.

Access functions:

QMediaContent currentMedia () const

Notifier signal:

void currentMediaChanged ( const QMediaContent & content )

currentPosition : int

This property holds current position.

Access functions:

int currentPosition () const
void setCurrentPosition ( int playlistPosition )

Notifier signal:

void playlistPositionChanged ( int position )

playbackMode : QMediaPlaylist::PlaybackMode

This property defines the order, items in playlist are played.

Access functions:

PlaybackMode playbackMode () const
void setPlaybackMode ( PlaybackMode mode )

Notifier signal:

void playbackModeChanged ( QMediaPlaylist::PlaybackMode mode )

See also QMediaPlaylist::PlaybackMode.


Member Function Documentation

QMediaPlaylist::QMediaPlaylist ( QMediaObject * mediaObject = 0, QObject * parent = 0 )

Create a new playlist object for with the given parent. If mediaObject is null or doesn't have an intrinsic playlist, internal local memory playlist source will be created.

QMediaPlaylist::~QMediaPlaylist ()   [virtual]

Destroys the playlist.

bool QMediaPlaylist::appendItem ( const QMediaContent & content )

Append the media content to the playlist.

Returns true if the operation is successfull, other wise return false.

bool QMediaPlaylist::appendItems ( const QList<QMediaContent> & items )

Append multiple media content items to the playlist.

Returns true if the operation is successfull, other wise return false.

bool QMediaPlaylist::clear ()

Remove all the items from the playlist.

Returns true if the operation is successfull, other wise return false.

void QMediaPlaylist::currentMediaChanged ( const QMediaContent & content )   [signal]

Signal emitted when current media changes to content.

Error QMediaPlaylist::error () const

Returns the last error condition.

QString QMediaPlaylist::errorString () const

Returns the string describing the last error condition.

bool QMediaPlaylist::insertItem ( int pos, const QMediaContent & content )

Insert the media content to the playlist at position pos.

Returns true if the operation is successful, otherwise false.

bool QMediaPlaylist::insertItems ( int pos, const QList<QMediaContent> & items )

Insert multiple media content items to the playlist at position pos.

Returns true if the operation is successful, otherwise false.

bool QMediaPlaylist::isEmpty () const

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

See also size().

bool QMediaPlaylist::isReadOnly () const

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

See also size().

void QMediaPlaylist::itemsAboutToBeInserted ( int start, int end )   [signal]

Signal emitted when item to be inserted at start and ending at end.

void QMediaPlaylist::itemsAboutToBeRemoved ( int start, int end )   [signal]

Signal emitted when item to de deleted ar start and ending at end.

void QMediaPlaylist::itemsChanged ( int start, int end )   [signal]

This signal is emitted after media has been changed in the playlist between start and end positions inclusive.

void QMediaPlaylist::itemsInserted ( int start, int end )   [signal]

This signal is emitted after media has been inserted into the playlist. The new items are those between start and end inclusive.

void QMediaPlaylist::itemsRemoved ( int start, int end )   [signal]

This signal is emitted after media has been removed from the playlist. The removed items are those between start and end inclusive.

void QMediaPlaylist::load ( const QUrl & location, const char * format = 0 )

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.

Returns true if playlist was loaded succesfully, otherwise returns false.

void QMediaPlaylist::load ( QIODevice * device, const char * format = 0 )

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.

Returns true if playlist was loaded succesfully, otherwise returns false.

void QMediaPlaylist::loadFailed ()   [signal]

Signal emitted if failed to load playlist.

void QMediaPlaylist::loaded ()   [signal]

Signal emitted when playlist finished loading.

QMediaContent QMediaPlaylist::media ( int position ) const

Returns the media content at index position in the playlist.

void QMediaPlaylist::next ()   [slot]

Advance to the next media content in playlist.

int QMediaPlaylist::nextPosition ( int steps = 1 ) const

Returns the position of item, which were current after calling next() steps times.

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

See also QMediaPlaylist::playbackMode.

void QMediaPlaylist::playbackModeChanged ( QMediaPlaylist::PlaybackMode mode )   [signal]

Signal emitted when playback mode changed to mode.

void QMediaPlaylist::playlistPositionChanged ( int position )   [signal]

Signal emitted when playlist position changed to position.

void QMediaPlaylist::previous ()   [slot]

Return to the previous media content in playlist.

int QMediaPlaylist::previousPosition ( int steps = 1 ) const

Returns the position of item, which were current after calling previous() steps times.

See also QMediaPlaylist::playbackMode.

bool QMediaPlaylist::removeItem ( int pos )

Remove the item from the playlist at position pos.

Returns true if the operation is successfull, other wise return false.

bool QMediaPlaylist::removeItems ( int start, int end )

Remove the items from the playlist from position start to end inclusive.

Returns true if the operation is successfull, other wise return false.

bool QMediaPlaylist::save ( const QUrl & location, const char * format = 0 )

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

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

bool QMediaPlaylist::save ( QIODevice * device, const char * format )

Save playlist to QIODevice device using format format.

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

void QMediaPlaylist::shuffle ()   [slot]

Shuffle items in the playlist.

int QMediaPlaylist::size () const

Returns the number of items in the playlist.

See also isEmpty().


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.0 (Technical Preview)