Phonon::MediaObjectInterface

Search for usage in LXR

Phonon::MediaObjectInterface Class Referenceabstract

#include <phonon/MediaObjectInterface>

Public Member Functions

virtual qint64 currentTime () const =0
 
virtual QString errorString () const =0
 
virtual Phonon::ErrorType errorType () const =0
 
virtual bool hasVideo () const =0
 
virtual bool isSeekable () const =0
 
virtual void pause ()=0
 
virtual void play ()=0
 
virtual qint32 prefinishMark () const =0
 
virtual qint64 remainingTime () const
 
virtual void seek (qint64 milliseconds)=0
 
virtual void setNextSource (const MediaSource &source)=0
 
virtual void setPrefinishMark (qint32)=0
 
virtual void setSource (const MediaSource &)=0
 
virtual void setTickInterval (qint32 interval)=0
 
virtual void setTransitionTime (qint32)=0
 
virtual MediaSource source () const =0
 
virtual Phonon::State state () const =0
 
virtual void stop ()=0
 
virtual qint32 tickInterval () const =0
 
virtual qint64 totalTime () const =0
 
virtual qint32 transitionTime () const =0
 

Detailed Description

Backend interface for media sources.

The backend implementation has to provide two signals, that are not defined in this interface:

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

    Emitted when the state of the MediaObject has changed. In case you're not interested in the old state you can also connect to a slot that only has one State argument.

    Parameters
    newstateThe state the Player is in now.
    oldstateThe state the Player was in before.
  • void tick(qint64 time)

    This signal gets emitted every tickInterval milliseconds.

    Parameters
    timeThe position of the media file in milliseconds.
    See also
    setTickInterval()
    tickInterval()
Author
Matthias Kretz kretz.nosp@m.@kde.nosp@m..org
See also
MediaObject

Definition at line 65 of file mediaobjectinterface.h.

Constructor & Destructor Documentation

◆ ~MediaObjectInterface()

virtual Phonon::MediaObjectInterface::~MediaObjectInterface ( )
inlinevirtual

Definition at line 68 of file mediaobjectinterface.h.

Member Function Documentation

◆ currentTime()

virtual qint64 Phonon::MediaObjectInterface::currentTime ( ) const
pure virtual

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

◆ errorString()

virtual QString Phonon::MediaObjectInterface::errorString ( ) const
pure virtual

A translated string describing the error.

◆ errorType()

virtual Phonon::ErrorType Phonon::MediaObjectInterface::errorType ( ) const
pure virtual

Tells your program what to do about the error.

See also
Phonon::ErrorType

◆ hasVideo()

virtual bool Phonon::MediaObjectInterface::hasVideo ( ) const
pure virtual

Check whether the media data includes a video stream.

Returns
returns true if the media contains video data

◆ isSeekable()

virtual bool Phonon::MediaObjectInterface::isSeekable ( ) const
pure virtual

If the current media may be seeked returns true.

Returns
whether the current media may be seeked.

◆ pause()

virtual void Phonon::MediaObjectInterface::pause ( )
pure virtual

Requests the playback to pause.

This method is only called if the state transition to PausedState is possible.

The backend should react as fast as possible. Go to PausedState as soon as playback is paused.

◆ play()

virtual void Phonon::MediaObjectInterface::play ( )
pure virtual

Requests the playback to start.

This method is only called if the state transition to PlayingState is possible.

The backend should react immediately by either going into PlayingState or BufferingState if the former is not possible.

◆ remainingTime()

virtual qint64 Phonon::MediaObjectInterface::remainingTime ( ) const
inlinevirtual

Definition at line 225 of file mediaobjectinterface.h.

◆ seek()

virtual void Phonon::MediaObjectInterface::seek ( qint64 milliseconds)
pure virtual

Requests the playback to be seeked to the given time.

The backend does not have to finish seeking while in this function (i.e. the backend does not need to block the thread until the seek is finished; even worse it might lead to deadlocks when using a ByteStream which gets its data from the thread this function would block).

As soon as the seek is done the currentTime() function and the tick() signal will report it.

Parameters
millisecondsThe time where playback should seek to in milliseconds.

◆ setNextSource()

virtual void Phonon::MediaObjectInterface::setNextSource ( const MediaSource & source)
pure virtual

Sets the next source to be used for transitions.

When a next source is set playback should continue with the new source. In that case finished and prefinishMarkReached are not emitted.

Parameters
sourceThe source to transition to (crossfade/gapless/gap). If source is an invalid MediaSource object then the queue is empty and the playback should stop normally.
Warning
Keep the MediaSource object around as long as the backend uses the AbstractMediaStream returned by the MediaSource. In case that no other reference to the MediaSource exists and it is set to MediaSource::autoDelete, the AbstractMediaStream is deleted when the last MediaSource ref is deleted.

◆ setSource()

virtual void Phonon::MediaObjectInterface::setSource ( const MediaSource & )
pure virtual

Sets the current source.

When this function is called the MediaObject is expected to stop all current activity and start loading the new source (i.e. go into LoadingState).

It is expected that the backend now starts preloading the media data, filling the audio and video buffers and making all media meta data available. It will also trigger the totalTimeChanged signal.

If the backend does not know how to handle the source it needs to change state to Phonon::ErrorState. Don't bother about handling KIO URLs. It is enough to handle AbstractMediaStream sources correctly.

Warning
Keep the MediaSource object around as long as the backend uses the AbstractMediaStream returned by the MediaSource. In case that no other reference to the MediaSource exists and it is set to MediaSource::autoDelete, the AbstractMediaStream is deleted when the last MediaSource ref is deleted.

◆ setTickInterval()

virtual void Phonon::MediaObjectInterface::setTickInterval ( qint32 interval)
pure virtual

Change the interval the tick signal is emitted.

If you set interval to 0 the signal gets disabled.

Parameters
intervaltick interval in milliseconds
Returns
Returns the tick interval that it was set to (might not be the same as you asked for).

◆ source()

virtual MediaSource Phonon::MediaObjectInterface::source ( ) const
pure virtual

Returns the current source.

◆ state()

virtual Phonon::State Phonon::MediaObjectInterface::state ( ) const
pure virtual

Get the current state.

◆ stop()

virtual void Phonon::MediaObjectInterface::stop ( )
pure virtual

Requests the playback to be stopped.

This method is only called if the state transition to StoppedState is possible.

The backend should react as fast as possible. Go to StoppedState as soon as playback is stopped.

A subsequent call to play() will start playback at the beginning of the media.

◆ tickInterval()

virtual qint32 Phonon::MediaObjectInterface::tickInterval ( ) const
pure virtual

Return the time interval in milliseconds between two ticks.

Returns
Returns the tick interval that it was set to (might not be the same as you asked for).

◆ totalTime()

virtual qint64 Phonon::MediaObjectInterface::totalTime ( ) const
pure virtual

Returns the total time of the media in milliseconds.

If the total time is not know return -1. Do not block until it is known, instead emit the totalTimeChanged signal as soon as the total time is known or changes.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 24 2024 11:53:29 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.