Phonon.MediaController

Synopsis

Functions

• def autoplayTitles ()
• def availableAngles ()
• def availableAudioChannels ()
• def availableChapters ()
• def availableMenus ()
• def availableSubtitles ()
• def availableTitles ()
• def currentAngle ()
• def currentAudioChannel ()
• def currentChapter ()
• def currentSubtitle ()
• def currentTitle ()
• def setCurrentAudioChannel (stream)
• def setCurrentMenu (menu)
• def setCurrentSubtitle (stream)
• def supportedFeatures ()

Slots

• def nextTitle ()
• def previousTitle ()
• def setAutoplayTitles (arg__1)
• def setCurrentAngle (angleNumber)
• def setCurrentChapter (chapterNumber)
• def setCurrentTitle (titleNumber)

Signals

• def angleChanged (angleNumber)
• def availableAnglesChanged (availableAngles)
• def availableAudioChannelsChanged ()
• def availableChaptersChanged (availableChapters)
• def availableMenusChanged (menus)
• def availableSubtitlesChanged ()
• def availableTitlesChanged (availableTitles)
• def chapterChanged (chapterNumber)
• def titleChanged (titleNumber)

Static functions

• def navigationMenuToString (menu)

Detailed Description

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

Some media sources have content that the Phonon.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 Phonon.MediaController.Feature enum explains these terms in more detail, and their context in playback of CD and DVD.

The media controller keeps a Phonon.MediaObject , of which media source is played back. You can still call the media object’s functions, e.g., PySide.phonon.Phonon.MediaObject.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 PySide.phonon.Phonon.MediaObject.play() on the media object. To play a specific title, use PySide.phonon.Phonon::MediaController.setCurrentTitle() and then call PySide.phonon.Phonon.MediaObject.play() .

Warning

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

See also

Phonon Module

class PySide.phonon.Phonon.MediaController(parent)

Parameters:parent – PySide.phonon.Phonon::MediaObject

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

See also

MediaObject Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.NavigationMenu

PySide.phonon.Phonon.MediaController.Feature

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.

Constant	Description
Phonon.MediaController.Angles	In the VOB (DVD) format, it is possible to to give several video streams of the same scene, each of which displays the scene from a different angle. The DVD viewer can then change between these angles.
Phonon.MediaController.Chapters	In the VOB format, chapters are points in a single video stream that can be played and seeked to separately.
Phonon.MediaController.Titles	On a CD, a title is a separate sound track. On DVD, a title is a separate VOB file.

PySide.phonon.Phonon.MediaController.angleChanged(angleNumber)

Parameters:angleNumber – PySide.QtCore.int

PySide.phonon.Phonon.MediaController.autoplayTitles()

Return type:PySide.QtCore.bool

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 PySide.phonon.Phonon.MediaObject.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

PySide.phonon.Phonon::MediaController.setAutoplayTitles() PySide.phonon.Phonon::MediaController.currentTitle()

PySide.phonon.Phonon.MediaController.availableAngles()

Return type:PySide.QtCore.int

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

See also

Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.availableAnglesChanged(availableAngles)

Parameters:availableAngles – PySide.QtCore.int

PySide.phonon.Phonon.MediaController.availableAudioChannels()

Return type:

PySide.phonon.Phonon.MediaController.availableAudioChannelsChanged()

PySide.phonon.Phonon.MediaController.availableChapters()

Return type:PySide.QtCore.int

Returns the number of chapters the current media source contains.

See also

Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.availableChaptersChanged(availableChapters)

Parameters:availableChapters – PySide.QtCore.int

PySide.phonon.Phonon.MediaController.availableMenus()

Return type:

PySide.phonon.Phonon.MediaController.availableMenusChanged(menus)

Parameters:menus –

PySide.phonon.Phonon.MediaController.availableSubtitles()

Return type:

PySide.phonon.Phonon.MediaController.availableSubtitlesChanged()

PySide.phonon.Phonon.MediaController.availableTitles()

Return type:PySide.QtCore.int

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

See also

Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.availableTitlesChanged(availableTitles)

Parameters:availableTitles – PySide.QtCore.int

PySide.phonon.Phonon.MediaController.chapterChanged(chapterNumber)

Parameters:chapterNumber – PySide.QtCore.int

PySide.phonon.Phonon.MediaController.currentAngle()

Return type:PySide.QtCore.int

Returns the angle that is currently used.

See also

PySide.phonon.Phonon::MediaController.setCurrentAngle() Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.currentAudioChannel()

Return type:PySide.phonon.Phonon::AudioChannelDescription

PySide.phonon.Phonon.MediaController.currentChapter()

Return type:PySide.QtCore.int

Returns the chapter that is currently being played back.

See also

PySide.phonon.Phonon::MediaController.setCurrentChapter() Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.currentSubtitle()

Return type:PySide.phonon.Phonon::SubtitleDescription

PySide.phonon.Phonon.MediaController.currentTitle()

Return type:PySide.QtCore.int

Returns the title that is currently played back.

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

See also

PySide.phonon.Phonon::MediaController.setCurrentTitle() Phonon.MediaController.Feature

static PySide.phonon.Phonon.MediaController.navigationMenuToString(menu)

Parameters:menu – PySide.phonon.Phonon::MediaController.NavigationMenu Return type:unicode

PySide.phonon.Phonon.MediaController.nextTitle()

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

Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.previousTitle()

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

Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.setAutoplayTitles(arg__1)

Parameters:arg__1 – PySide.QtCore.bool

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 PySide.phonon.Phonon.MediaObject.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

PySide.phonon.Phonon::MediaController.autoplayTitles() PySide.phonon.Phonon::MediaController.currentTitle()

PySide.phonon.Phonon.MediaController.setCurrentAngle(angleNumber)

Parameters:angleNumber – PySide.QtCore.int

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

See also

PySide.phonon.Phonon::MediaController.currentAngle() Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.setCurrentAudioChannel(stream)

Parameters:stream – PySide.phonon.Phonon::AudioChannelDescription

PySide.phonon.Phonon.MediaController.setCurrentChapter(chapterNumber)

Parameters:chapterNumber – PySide.QtCore.int

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

See also

PySide.phonon.Phonon::MediaController.currentChapter() Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.setCurrentMenu(menu)

Parameters:menu – PySide.phonon.Phonon::MediaController.NavigationMenu

PySide.phonon.Phonon.MediaController.setCurrentSubtitle(stream)

Parameters:stream – PySide.phonon.Phonon::SubtitleDescription

PySide.phonon.Phonon.MediaController.setCurrentTitle(titleNumber)

Parameters:titleNumber – PySide.QtCore.int

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

PySide.phonon.Phonon::MediaController.currentTitle() Phonon.MediaController.Feature

PySide.phonon.Phonon.MediaController.supportedFeatures()

Return type:PySide.phonon.Phonon::MediaController.Features

PySide.phonon.Phonon.MediaController.titleChanged(titleNumber)

Parameters:titleNumber – PySide.QtCore.int