MediaController Class Reference


Detailed Description

Controls optional features of a media file/device like title, chapter, angle.

Author:
Matthias Kretz <kretz@kde.org>

Definition at line 48 of file mediacontroller.h.

#include <Phonon/MediaController>

Inheritance diagram for MediaController:
Inheritance graph
[legend]

List of all members.

Public Types

enum   Feature { Angles = 1, Chapters = 2, Titles = 4 }

Public Slots

void  setCurrentAngle (int angleNumber)
void  setCurrentChapter (int chapterNumber)
void  setCurrentTitle (int titleNumber)
  Skips to the given title titleNumber.
void  setAutoplayTitles (bool)
void  nextTitle ()
  Skips to the next title.
void  previousTitle ()
  Skips to the previous title.

Signals

void  availableSubtitlesChanged ()
void  availableAudioChannelsChanged ()
void  availableAnglesChanged (int availableAngles)
void  angleChanged (int angleNumber)
void  availableChaptersChanged (int availableChapters)
void  chapterChanged (int chapterNumber)
void  availableTitlesChanged (int availableTitles)
void  titleChanged (int titleNumber)

Public Member Functions

  MediaController (MediaObject *parent)
  ~MediaController ()
Features  supportedFeatures () const
int  availableAngles () const
int  currentAngle () const
int  availableChapters () const
int  currentChapter () const
int  availableTitles () const
int  currentTitle () const
bool  autoplayTitles () const
AudioChannelDescription  currentAudioChannel () const
  Returns the selected audio stream.
SubtitleDescription  currentSubtitle () const
  Returns the selected subtitle stream.
QList< AudioChannelDescription availableAudioChannels () const
  Returns the audio streams that can be selected by the user.
QList< SubtitleDescription availableSubtitles () const
  Returns the subtitle streams that can be selected by the user.
void  setCurrentAudioChannel (const Phonon::AudioChannelDescription &stream)
  Selects an audio stream from the media.
void  setCurrentSubtitle (const Phonon::SubtitleDescription &stream)
  Selects a subtitle stream from the media.

Protected Attributes

MediaControllerPrivate *const  d

Member Enumeration Documentation


Constructor & Destructor Documentation

MediaController ( MediaObject parent )

Member Function Documentation

Features supportedFeatures ( ) const
int availableAngles ( ) const
int currentAngle ( ) const
int availableChapters ( ) const
int currentChapter ( ) const
int availableTitles ( ) const
int currentTitle ( ) const
bool autoplayTitles ( ) const
AudioChannelDescription currentAudioChannel ( ) const

Returns the selected audio stream.

See also:
availableAudioChannels
setCurrentAudioChannel
SubtitleDescription currentSubtitle ( ) const

Returns the selected subtitle stream.

See also:
availableSubtitles
setCurrentSubtitle
QList<AudioChannelDescription> availableAudioChannels ( ) const

Returns the audio streams that can be selected by the user.

The strings can directly be used in the user interface.

See also:
selectedAudioChannel
setCurrentAudioChannel
QList<SubtitleDescription> availableSubtitles ( ) const

Returns the subtitle streams that can be selected by the user.

The strings can directly be used in the user interface.

See also:
selectedSubtitle
setCurrentSubtitle
void setCurrentAudioChannel ( const Phonon::AudioChannelDescription stream )

Selects an audio stream from the media.

Some media formats allow multiple audio streams to be stored in the same file. Normally only one should be played back.

Parameters:
stream Description of an audio stream
See also:
availableAudioChannels()
currentAudioChannel()
void setCurrentSubtitle ( const Phonon::SubtitleDescription stream )

Selects a subtitle stream from the media.

Some media formats allow multiple subtitle streams to be stored in the same file. Normally only one should be displayed.

Parameters:
stream description of a subtitle stream
See also:
availableSubtitles()
currentSubtitle()
void setCurrentAngle ( int  angleNumber ) [slot]
void setCurrentChapter ( int  chapterNumber ) [slot]
void 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.

void setAutoplayTitles ( bool  ) [slot]
void 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.

void 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.

void availableSubtitlesChanged ( ) [signal]
void availableAudioChannelsChanged ( ) [signal]
void availableAnglesChanged ( int  availableAngles ) [signal]
void angleChanged ( int  angleNumber ) [signal]
void availableChaptersChanged ( int  availableChapters ) [signal]
void chapterChanged ( int  chapterNumber ) [signal]
void availableTitlesChanged ( int  availableTitles ) [signal]
void titleChanged ( int  titleNumber ) [signal]

Member Data Documentation

MediaControllerPrivate* const d [protected]

Definition at line 176 of file mediacontroller.h.


The documentation for this class was generated from the following file:

MediaController MediaController MediaController MediaController MediaController MediaController MediaController MediaController MediaController MediaController
MediaController MediaController MediaController MediaController MediaController MediaController MediaController MediaController MediaController MediaController