MediaController Class Reference
(Phonon::MediaController)
[Phonon module]

Detailed Description

The MediaController class controls optional features of a media file/device.

Some media sources have content that the MediaObject does not provide control over, for instance, chapters in a DVD file. The functionality the media controller offers is dependent on the type of media source that is played back. Commonly, the media controller allows you to:

• Navigate between chapters.
• Navigate between titles.
• Select between angles.

The Feature enum explains these terms in more detail, and their context in playback of CD and DVD.

The media controller keeps a MediaObject, of which media source is played back. You can still call the media object's functions, e.g., stop(); this is all handled correctly by the media controller. You have the option of letting the media controller play all titles of a source in sequence by setting the autoplay titles option.

To start a playback using a media object, you call play() on the media object. To play a specific title, use setCurrentTitle() and then call play().

Warning: The Phonon::MediaController class is not yet supported by Qt backends.

Author: Matthias Kretz <kretz@kde.org>

Member Type Documentation

enum MediaController::Feature
flags MediaController::Features

The values of this enum are interpreted differently depending on the type of media source, e.g., DVD or CD. We give examples for these sources.

The Features type is a typedef for QFlags<Feature>. It stores an OR combination of Feature values.

Member Function Documentation

MediaController::MediaController ( MediaObject * parent )

Constructs a new MediaController with the media object (parent) to be used by the media controller.

See also MediaObject and Feature.

MediaController::~MediaController ()

void MediaController::angleChanged ( int angleNumber )   [signal]

This signal is emitted whenever the current angle changes. The new angle number is given by angleNumber.

See also Feature.

bool MediaController::autoplayTitles () const

Returns true if titles will automatically be played when the media is played; otherwise returns false.

The media controller will play the titles of the media source in sequence when the media object's play() function is called. If the autoplay option is disabled, the media object will play the MediaController::currentTitle(){current title} and then finish the playback.

See also setAutoplayTitles() and currentTitle().

int MediaController::availableAngles () const

Returns the available angles that is available for the current media source.

See also Feature.

void MediaController::availableAnglesChanged ( int availableAngles )   [signal]

This signal is emitted whenever the number of available angles changes. The new number of available angles is given by availableAngles.

See also Feature.

int MediaController::availableChapters () const

Returns the number of chapters the current media source contains.

See also Feature.

void MediaController::availableChaptersChanged ( int availableChapters )   [signal]

This signal is emitted whenever the number of available chapters changes. The new number of available chapters is given by availableChapters.

See also Feature.

int MediaController::availableTitles () const

Returns the number of titles that the current media source contains.

See also Feature.

void MediaController::availableTitlesChanged ( int availableTitles )   [signal]

This signal is emitted whenever the number of available titles changes. The new number of available titles is given by availableTitles.

See also Feature.

void MediaController::chapterChanged ( int chapterNumber )   [signal]

This signal is emitted whenever the current chapter changes. The new chapter number is given by chapterNumber.

See also Feature.

int MediaController::currentAngle () const

Returns the angle that is currently used.

See also setCurrentAngle() and Feature.

int MediaController::currentChapter () const

Returns the chapter that is currently being played back.

See also setCurrentChapter() and Feature.

int MediaController::currentTitle () const

Returns the title that is currently played back.

The current title is 0 (the first) by default.

See also setCurrentTitle() and Feature.

void MediaController::nextTitle ()   [slot]

Skips to the next title.

If it was playing before the title change it will start playback on the next title if autoplayTitles is enabled.

See also Feature.

void MediaController::previousTitle ()   [slot]

Skips to the previous title.

If it was playing before the title change it will start playback on the previous title if autoplayTitles is enabled.

See also Feature.

void MediaController::setAutoplayTitles ( bool enable )   [slot]

Sets the titles to play automatically when the media is played if enable is true; otherwise disables this option.

The media controller will play the titles of the media source in sequence when the media object's play() function is called. If the autoplay option is disabled, the media object will play the MediaController::currentTitle(){current title} and then finish the playback.

See also autoplayTitles() and currentTitle().

void MediaController::setCurrentAngle ( int angleNumber )   [slot]

Sets the current angle to the given angleNumber if the media file or device supports navigation by angle number.

See also currentAngle() and Feature.

void MediaController::setCurrentChapter ( int chapterNumber )   [slot]

Sets the current chapter to the given chapterNumber if the media file or device supports navigation by chapter number.

See also currentChapter() and Feature.

void MediaController::setCurrentTitle ( int titleNumber )   [slot]

Skips to the given title titleNumber.

If it was playing before the title change it will start playback on the new title if autoplayTitles is enabled.

See also currentTitle() and Feature.

Features MediaController::supportedFeatures () const

void MediaController::titleChanged ( int titleNumber )   [signal]

This signal is emitted whenever the current title changes. The new title number is given by titleNumber.

See also Feature.