#include <Phonon/MediaObject>

Class Description

Interface for media playback of a given URL.

This class is the most important class in Phonon. Use it to open a media file at an arbitrary location, a CD or DVD or to stream media data from the application to the backend.

This class controls the state (play, pause, stop, seek) and you can use it to get a lot of information about the media data.

Notice that most functions of this class are asynchronous. That means if you call play() the object only starts playing when the stateChanged() signal tells you that the object changed into PlayingState. The states you can expect are documented for those methods.

A common usage example is the following:

media = new MediaObject(this);
connect(media, SIGNAL(finished()), SLOT(slotFinished());
media->setCurrentSource("/home/username/music/filename.ogg");
media->play();

If you want to play more than one media file (one after another) you can either tell MediaObject about all those files

media->setCurrentSource(":/sounds/startsound.ogg");
media->enqueue("/home/username/music/song.mp3");
media->enqueue(":/sounds/endsound.ogg");

or provide the next file just in time:

  media->setCurrentSource(":/sounds/startsound.ogg");
  connect(media, SIGNAL(aboutToFinish()), SLOT(enqueueNextSource()));
}
void enqueueNextSource()
{
  media->enqueue("/home/username/music/song.mp3");
}

Author: Matthias Kretz kretz.nosp@m.@kde.nosp@m..org

Definition at line 84 of file mediaobject.h.

Inheritance diagram for MediaObject:

Public Slots
void	setTickInterval (qint32 newTickInterval)

void	play ()
	Requests playback of the media data to start. More...

void	pause ()
	Requests playback to pause. More...

void	stop ()
	Requests playback to stop. More...

void	seek (qint64 time)
	Requests a seek to the time indicated. More...

void	clear ()
	Stops and removes all playing and enqueued media sources. More...

Public Slots inherited from QObject
void	deleteLater ()

Signals
void	stateChanged (Phonon::State newstate, Phonon::State oldstate)
	Emitted when the state of the MediaObject has changed. More...

void	tick (qint64 time)
	This signal gets emitted every tickInterval milliseconds. More...

void	metaDataChanged ()
	This signal is emitted whenever the audio/video data that is being played is associated with new meta data. More...

void	seekableChanged (bool isSeekable)
	Emitted whenever the return value of isSeekable() changes. More...

void	hasVideoChanged (bool hasVideo)
	Emitted whenever the return value of hasVideo() changes. More...

void	bufferStatus (int percentFilled)
	Tells about the status of the buffer. More...

void	finished ()
	Emitted when the object has finished playback. More...

void	currentSourceChanged (const Phonon::MediaSource &newSource)
	Emitted when the MediaObject makes a transition to the next MediaSource in the queue(). More...

void	aboutToFinish ()
	Emitted before the playback of the whole queue stops. More...

void	prefinishMarkReached (qint32 msecToEnd)
	Emitted when there are only `msecToEnd` milliseconds left for playback. More...

void	totalTimeChanged (qint64 newTotalTime)
	This signal is emitted as soon as the total time of the media file is known or has changed. More...

Signals inherited from QObject
void	destroyed (QObject *=0)

Public Member Functions
	~MediaObject ()
	Destroys the MediaObject. More...

State	state () const
	Get the current state. More...

bool	hasVideo () const
	Check whether the media data includes a video stream. More...

bool	isSeekable () const
	Check whether the current media may be seeked. More...

qint32	tickInterval () const

QStringList	metaData (const QString &key) const
	Returns the strings associated with the given `key`. More...

QStringList	metaData (Phonon::MetaData key) const
	Returns the strings associated with the given `key`. More...

QMultiMap< QString, QString >	metaData () const
	Returns all meta data. More...

QString	errorString () const
	Returns a human-readable description of the last error that occurred. More...

ErrorType	errorType () const
	Tells your program what to do about the error. More...

MediaSource	currentSource () const
	Returns the current media source. More...

void	setCurrentSource (const MediaSource &source)
	Set the media source the MediaObject should use. More...

QList< MediaSource >	queue () const
	Returns the queued media sources. More...

void	setQueue (const QList< MediaSource > &sources)
	Set the MediaSources to play when the current media has finished. More...

void	setQueue (const QList< QUrl > &urls)
	Set the MediaSources to play when the current media has finished. More...

void	enqueue (const MediaSource &source)
	Appends one source to the queue. More...

void	enqueue (const QList< MediaSource > &sources)
	Appends multiple sources to the queue. More...

void	enqueue (const QList< QUrl > &urls)
	Appends multiple sources to the queue. More...

void	clearQueue ()
	Clears the queue of sources. More...

qint64	currentTime () const
	Get the current time (in milliseconds) of the file currently being played. More...

qint64	totalTime () const
	Get the total time (in milliseconds) of the file currently being played. More...

qint64	remainingTime () const
	Get the remaining time (in milliseconds) of the file currently being played. More...

qint32	prefinishMark () const

void	setPrefinishMark (qint32 msecToEnd)

qint32	transitionTime () const

void	setTransitionTime (qint32 msec)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=0)

virtual	~QObject ()

virtual bool	event (QEvent *)

virtual bool	eventFilter (QObject , QEvent )

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	signalsBlocked () const

bool	blockSignals (bool b)

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString()) const

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

const QObjectList &	children () const

void	setParent (QObject *)

void	installEventFilter (QObject *)

void	removeEventFilter (QObject *)

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectTree ()

void	dumpObjectInfo ()

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	setUserData (uint id, QObjectUserData *data)

QObjectUserData *	userData (uint id) const

QObject *	parent () const

bool	inherits (const char *classname) const

Public Member Functions inherited from MediaNode
virtual	~MediaNode ()

bool	isValid () const
	Tells whether the backend provides an implementation of this class. More...

QList< Path >	inputPaths () const

QList< Path >	outputPaths () const

Properties
qint32	transitionTime
	Defines the time between media sources. More...

qint32	prefinishMark
	Get a signal before playback finishes. More...

qint32	tickInterval
	The time interval in milliseconds between two ticks. More...

Properties inherited from QObject
QString	objectName

Friends
class	FrontendInterfacePrivate

Additional Inherited Members
Static Public Member Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

virtual void	timerEvent (QTimerEvent *)

virtual void	childEvent (QChildEvent *)

virtual void	customEvent (QEvent *)

virtual void	connectNotify (const char *signal)

virtual void	disconnectNotify (const char *signal)

	QObject (QObjectPrivate &dd, QObject *parent=0)

Protected Member Functions inherited from MediaNode
	MediaNode (MediaNodePrivate &dd)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from MediaNode
MediaNodePrivate *const	k_ptr

Static Protected Attributes inherited from QObject
static const QMetaObject	staticQtMetaObject

Constructor & Destructor Documentation

~MediaObject ( )

Destroys the MediaObject.

Member Function Documentation

State state ( ) const

Get the current state.

Returns: The state of the object.

See also: State; stateChanged

bool hasVideo ( ) const

Check whether the media data includes a video stream.

Warning: This information cannot be known immediately. It is best to also listen to the hasVideoChanged signal.

  connect(media, SIGNAL(hasVideoChanged(bool)), hasVideoChanged(bool));
  media->setCurrentSource("somevideo.avi");
  media->hasVideo(); // returns false;
}
void hasVideoChanged(bool b)
{
  // b == true
  media->hasVideo(); // returns true;
}

Returns: true if the media contains video data. false otherwise.

See also: hasVideoChanged

bool isSeekable ( ) const

Check whether the current media may be seeked.

Warning: This information cannot be known immediately. It is best to also listen to the seekableChanged signal.

  connect(media, SIGNAL(seekableChanged(bool)), seekableChanged(bool));
  media->setCurrentSource("somevideo.avi");
  media->isSeekable(); // returns false;
}
void seekableChanged(bool b)
{
  // b == true
  media->isSeekable(); // returns true;
}

Returns: true when the current media may be seeked. false otherwise.

See also: seekableChanged()

qint32 tickInterval ( ) const

QStringList metaData ( const QString & key ) const

Returns the strings associated with the given key.

Backends should use the keys specified in the Ogg Vorbis documentation: http://xiph.org/vorbis/doc/v-comment.html

Therefore the following should work with every backend:

A typical usage looks like this:

setMetaArtist (media->metaData("ARTIST"     ));
setMetaAlbum  (media->metaData("ALBUM"      ));
setMetaTitle  (media->metaData("TITLE"      ));
setMetaDate   (media->metaData("DATE"       ));
setMetaGenre  (media->metaData("GENRE"      ));
setMetaTrack  (media->metaData("TRACKNUMBER"));
setMetaComment(media->metaData("DESCRIPTION"));

For Audio CDs you can query

metaData("MUSICBRAINZ_DISCID");

to get a DiscID hash that you can use with the MusicBrainz service: http://musicbrainz.org/doc/ClientHOWTO

QStringList metaData ( Phonon::MetaData key ) const

Returns the strings associated with the given key.

Same as above except that the keys are defined in the Phonon::MetaData enum.

QMultiMap<QString, QString> metaData ( ) const

Returns all meta data.

QString errorString ( ) const

Returns a human-readable description of the last error that occurred.

ErrorType errorType ( ) const

Tells your program what to do about the error.

See also: Phonon::ErrorType

MediaSource currentSource ( ) const

Returns the current media source.

See also: setCurrentSource

void setCurrentSource ( const MediaSource & source )

Set the media source the MediaObject should use.

Parameters

source The MediaSource object to the media data. You can just as well use a QUrl or QString (for a local file) here. Setting an empty (invalid) source, will stop and remove the current source.

QUrl url("http://www.example.com/music.ogg");

media->setCurrentSource(url);

See also: currentSource

QList<MediaSource> queue ( ) const

Returns the queued media sources.

This list does not include the current source (returned by currentSource).

void setQueue ( const QList< MediaSource > & sources )

Set the MediaSources to play when the current media has finished.

This function will overwrite the current queue.

See also: clearQueue; enqueue

void setQueue ( const QList< QUrl > & urls )

Set the MediaSources to play when the current media has finished.

This function overwrites the current queue.

See also: clearQueue; enqueue

void enqueue ( const MediaSource & source )

Appends one source to the queue.

Use this function to provide the next source just in time after the aboutToFinish signal was emitted.

See also: aboutToFinish; setQueue; clearQueue

void enqueue ( const QList< MediaSource > & sources )

Appends multiple sources to the queue.

See also: setQueue; clearQueue

void enqueue ( const QList< QUrl > & urls )

Appends multiple sources to the queue.

See also: setQueue; clearQueue

void clearQueue ( )

Clears the queue of sources.

qint64 currentTime ( ) const

Get the current time (in milliseconds) of the file currently being played.

Returns: The current time in milliseconds.

See also: tick

qint64 totalTime ( ) const

Get the total time (in milliseconds) of the file currently being played.

Returns: The total time in milliseconds.

See also: totalTimeChanged

qint64 remainingTime ( ) const

Get the remaining time (in milliseconds) of the file currently being played.

Returns: The remaining time in milliseconds.

qint32 prefinishMark ( ) const

void setPrefinishMark ( qint32 msecToEnd )

qint32 transitionTime ( ) const

void setTransitionTime ( qint32 msec )

void setTickInterval ( qint32 newTickInterval )

slot

void play ( )

slot

Requests playback of the media data to start.

Playback only starts when stateChanged() signals that it goes into PlayingState, though.

Possible states right after this call:

BufferingState
PlayingState
ErrorState

void pause ( )

slot

Requests playback to pause.

If it was paused before nothing changes.

Possible states right after this call:

PlayingState
PausedState
ErrorState

void stop ( )

slot

Requests playback to stop.

If it was stopped before nothing changes.

Possible states right after this call:

the state it was in before (e.g. PlayingState)
StoppedState
ErrorState

void seek ( qint64 time )

slot

Requests a seek to the time indicated.

You can only seek if state() == PlayingState, BufferingState or PausedState.

The call is asynchronous, so currentTime can still be the old value right after this method was called. If all you need is a slider that shows the current position and allows the user to seek use the class SeekSlider.

Parameters

time	The time in milliseconds where to continue playing.

Possible states right after this call:

BufferingState
PlayingState
ErrorState

See also: SeekSlider

void clear ( )

slot

Stops and removes all playing and enqueued media sources.

See also: setCurrentSource

void stateChanged	(	Phonon::State	newstate,
		Phonon::State	oldstate
	)

signal

Emitted when the state of the MediaObject has changed.

Parameters

newstate	The state the Player is in now.
oldstate	The state the Player was in before.

void tick ( qint64 time )

signal

This signal gets emitted every tickInterval milliseconds.

Parameters

time	The position of the media file in milliseconds.

See also: setTickInterval, tickInterval

void metaDataChanged ( )

signal

This signal is emitted whenever the audio/video data that is being played is associated with new meta data.

E.g. for radio streams this happens when the next song is played.

You can get the new meta data with the metaData methods.

void seekableChanged ( bool isSeekable )

signal

Emitted whenever the return value of isSeekable() changes.

Normally you'll check isSeekable() first and then let this signal tell you whether seeking is possible now or not. That way you don't have to poll isSeekable().

Parameters

isSeekable true if the stream is seekable (i.e. calling seek() works) false if the stream is not seekable (i.e. all calls to seek() will be ignored)

void hasVideoChanged ( bool hasVideo )

signal

Emitted whenever the return value of hasVideo() changes.

Normally you'll check hasVideo() first and then let this signal tell you whether video is available now or not. That way you don't have to poll hasVideo().

Parameters

hasVideo true The stream contains video and adding a VideoWidget will show a video. false There is no video data in the stream and adding a VideoWidget will show an empty (black) VideoWidget.

void bufferStatus ( int percentFilled )

signal

Tells about the status of the buffer.

You can use this signal to show a progress bar to the user when in BufferingState:

progressBar->setRange(0, 100); // this is the default

connect(media, SIGNAL(bufferStatus(int)), progressBar, SLOT(setValue(int)));

Parameters

percentFilled A number between 0 and 100 telling you how much the buffer is filled.

void finished ( )

signal

Emitted when the object has finished playback.

It is not emitted if you call stop(), pause() or load(), but only on end-of-queue or a critical error.

Warning: This signal is not emitted when the current source has finished and there's another source in the queue. It is only emitted when the queue is empty.

See also: currentSourceChanged; aboutToFinish; prefinishMarkReached

void currentSourceChanged ( const Phonon::MediaSource & newSource )

signal

Emitted when the MediaObject makes a transition to the next MediaSource in the queue().

In other words, it is emitted when an individual MediaSource is finished.

Parameters

newSource The source that starts to play at the time the signal is emitted.

void aboutToFinish ( )

signal

Emitted before the playback of the whole queue stops.

When this signal is emitted you still have time to provide the next MediaSource (using enqueue()) so that playback continues.

This signal can be used to provide the next MediaSource just in time for the transition still to work.

See also: enqueue

void prefinishMarkReached ( qint32 msecToEnd )

signal

Emitted when there are only msecToEnd milliseconds left for playback.

Parameters

msecToEnd The remaining time until the playback queue finishes.

Warning: This signal is not emitted when there is another source in the queue. It is only emitted when the queue is empty.

See also: setPrefinishMark; prefinishMark; aboutToFinish; finished

void totalTimeChanged ( qint64 newTotalTime )

signal

This signal is emitted as soon as the total time of the media file is known or has changed.

For most non-local media data the total time of the media can only be known after some time. Initially the totalTime function can not return useful information. You have to wait for this signal to know the real total time.

Parameters

newTotalTime The length of the media file in milliseconds.

See also: totalTime

Friends And Related Function Documentation

friend class FrontendInterfacePrivate

friend

Definition at line 86 of file mediaobject.h.

Property Documentation

qint32 transitionTime

readwrite

Defines the time between media sources.

A positive transition time defines a gap of silence between queued media sources.

A transition time of 0 ms requests gapless playback (sample precise queueing of the next source).

A negative transition time defines a crossfade between the queued media sources.

Defaults to 0 (gapless playback).

Warning: This feature might not work reliably on every platform.

Definition at line 106 of file mediaobject.h.

qint32 prefinishMark

readwrite

Get a signal before playback finishes.

This property specifies the time in milliseconds the prefinishMarkReached signal is emitted before the playback finishes. A value of 0 disables the signal.

Defaults to 0 (disabled).

Warning: For some media data the total time cannot be determined accurately, therefore the accuracy of the prefinishMarkReached signal can be bad sometimes. Still, it is better to use this method than to look at totalTime() and currentTime() to emulate the behaviour because the backend might have more information available than your application does through totalTime and currentTime.

See also: prefinishMarkReached

Definition at line 127 of file mediaobject.h.

qint32 tickInterval

readwrite

The time interval in milliseconds between two ticks.

The tick interval is the time that elapses between the emission of two tick signals. If you set the interval to 0 the tick signal gets disabled.

Defaults to 0 (disabled).

Warning: The back-end is free to choose a different tick interval close to what you asked for. This means that the following code may fail:
int x = 200;

media->setTickInterval(x);

Q_ASSERT(x == producer->tickInterval());

On the other hand the following is guaranteed:
int x = 200;

media->setTickInterval(x);

Q_ASSERT(x >= producer->tickInterval() &&

x <= 2 * producer->tickInterval());

See also: tick

Definition at line 154 of file mediaobject.h.

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

phonon/mediaobject.h

MediaObject Class Reference

Class Description

Public Slots

Signals

Public Member Functions

Properties

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Property Documentation