MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QMediaPlaylistNavigator Class Reference

The QMediaPlaylistNavigator class provides navigation for a media playlist. More...

 #include <QMediaPlaylistNavigator>

Inherits: QObject.

This class was introduced in Qt Mobility 1.0.

Properties

  • 1 property inherited from QObject

Public Functions

QMediaPlaylistNavigator ( QMediaPlaylistProvider * playlist, QObject * parent = 0 )
virtual ~QMediaPlaylistNavigator ()
int currentIndex () const
QMediaContent currentItem () const
QMediaContent itemAt ( int position ) const
int nextIndex ( int steps = 1 ) const
QMediaContent nextItem ( int steps = 1 ) const
QMediaPlaylist::PlaybackMode playbackMode () const
QMediaPlaylistProvider * playlist () const
int previousIndex ( int steps = 1 ) const
QMediaContent previousItem ( int steps = 1 ) const
void setPlaylist ( QMediaPlaylistProvider * playlist )
  • 29 public functions inherited from QObject

Public Slots

void jump ( int position )
void next ()
void previous ()
void setPlaybackMode ( QMediaPlaylist::PlaybackMode mode )
  • 1 public slot inherited from QObject

Signals

void activated ( const QMediaContent & media )
void currentIndexChanged ( int position )
void playbackModeChanged ( QMediaPlaylist::PlaybackMode mode )
void surroundingItemsChanged ()

Additional Inherited Members

  • 1 public variable inherited from QObject
  • 4 static public members inherited from QObject
  • 7 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QMediaPlaylistNavigator class provides navigation for a media playlist.

See also QMediaPlaylist and QMediaPlaylistProvider.

Property Documentation

currentIndex : int

Contains the position of the current media.

If no media is current, the property contains -1.

This property was introduced in Qt Mobility 1.0.

Access functions:

int currentIndex () const
void jump ( int position )

Notifier signal:

void currentIndexChanged ( int position )

See also nextIndex() and previousIndex().

currentItem : const QMediaContent

Contains the media at the current position in the playlist.

This property was introduced in Qt Mobility 1.0.

Access functions:

QMediaContent currentItem () const

See also currentIndex().

playbackMode : QMediaPlaylist::PlaybackMode

Contains the playback mode.

This property was introduced in Qt Mobility 1.0.

Access functions:

QMediaPlaylist::PlaybackMode playbackMode () const
void setPlaybackMode ( QMediaPlaylist::PlaybackMode mode )

Notifier signal:

void playbackModeChanged ( QMediaPlaylist::PlaybackMode mode )

Member Function Documentation

QMediaPlaylistNavigator::QMediaPlaylistNavigator ( QMediaPlaylistProvider * playlist, QObject * parent = 0 )

Constructs a media playlist navigator for a playlist.

The parent is passed to QObject.

This function was introduced in Qt Mobility 1.0.

QMediaPlaylistNavigator::~QMediaPlaylistNavigator () [virtual]

Destroys a media playlist navigator.

void QMediaPlaylistNavigator::activated ( const QMediaContent & media ) [signal]

Signals that the current media has changed.

This function was introduced in Qt Mobility 1.0.

void QMediaPlaylistNavigator::currentIndexChanged ( int position ) [signal]

Signals the position of the current media has changed.

This function was introduced in Qt Mobility 1.0.

QMediaContent QMediaPlaylistNavigator::itemAt ( int position ) const

Returns the media at a position in the playlist.

This function was introduced in Qt Mobility 1.0.

void QMediaPlaylistNavigator::next () [slot]

Advances to the next item in the playlist.

This function was introduced in Qt Mobility 1.0.

See also previous(), jump(), and playbackMode().

int QMediaPlaylistNavigator::nextIndex ( int steps = 1 ) const

Returns a position steps ahead of the current position accounting for the playbackMode().

If the position is beyond the end of the playlist, this value returned is -1.

This function was introduced in Qt Mobility 1.0.

See also currentIndex(), previousIndex(), and playbackMode().

QMediaContent QMediaPlaylistNavigator::nextItem ( int steps = 1 ) const

Returns the media that is steps positions ahead of the current position in the playlist.

This function was introduced in Qt Mobility 1.0.

See also nextIndex().

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

Signals that the playback mode has changed.

This function was introduced in Qt Mobility 1.0.

QMediaPlaylistProvider * QMediaPlaylistNavigator::playlist () const

Returns the playlist being navigated.

This function was introduced in Qt Mobility 1.0.

See also setPlaylist().

void QMediaPlaylistNavigator::previous () [slot]

Returns to the previous item in the playlist,

This function was introduced in Qt Mobility 1.0.

See also next(), jump(), and playbackMode().

int QMediaPlaylistNavigator::previousIndex ( int steps = 1 ) const

Returns a position steps behind the current position accounting for the playbackMode().

If the position is prior to the beginning of the playlist this will return -1.

This function was introduced in Qt Mobility 1.0.

See also currentIndex(), nextIndex(), and playbackMode().

QMediaContent QMediaPlaylistNavigator::previousItem ( int steps = 1 ) const

Returns the media that is steps positions behind the current position in the playlist.

This function was introduced in Qt Mobility 1.0.

See also previousIndex().

void QMediaPlaylistNavigator::setPlaylist ( QMediaPlaylistProvider * playlist )

Sets the playlist to navigate.

This function was introduced in Qt Mobility 1.0.

See also playlist().

void QMediaPlaylistNavigator::surroundingItemsChanged () [signal]

Signals that media immediately surrounding the current position has changed.

This function was introduced in Qt Mobility 1.0.