Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QMediaServerSession Class Reference
[QtMediaModule]

The QMediaServerSession class is used to represent and control a session registered in the Media Server. More...

    #include <QMediaServerSession>

This class is under development and is subject to change.

Inherits QObject.

• List of all members, including inherited members

Public Functions

• virtual ~QMediaServerSession ()
• virtual QString domain () const = 0
• virtual QString errorString () = 0
• virtual QString id () const = 0
• virtual QStringList interfaces () = 0
• virtual bool isMuted () const = 0
• virtual quint32 length () = 0
• virtual void pause () = 0
• virtual QtopiaMedia::State playerState () const = 0
• virtual QString reportData () const = 0
• virtual void resume () = 0
• virtual void seek ( quint32 ms ) = 0
• virtual void setDomain ( QString const & domain ) = 0
• virtual void setMuted ( bool mute ) = 0
• virtual void setVolume ( int volume ) = 0
• virtual void start () = 0
• virtual void stop () = 0
• virtual void suspend () = 0
• virtual int volume () const = 0

• 29 public functions inherited from QObject

Signals

• void interfaceAvailable ( const QString & name )
• void interfaceUnavailable ( const QString & name )
• void lengthChanged ( quint32 ms )
• void playerStateChanged ( QtopiaMedia::State state )
• void positionChanged ( quint32 ms )
• void volumeChanged ( int volume )
• void volumeMuted ( bool muted )

• 1 signal inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public slot inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 7 protected functions inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QMediaServerSession class is used to represent and control a session registered in the Media Server.

See also QMediaEngine.

Member Function Documentation

QMediaServerSession::~QMediaServerSession ()   [virtual]

Destroy a QMediaServerSession object.

QString QMediaServerSession::domain () const   [pure virtual]

Returns the audio domain for this session.

See also setDomain().

QString QMediaServerSession::errorString ()   [pure virtual]

If the session is in the error state, a generic error string may be provided through this function.

QString QMediaServerSession::id () const   [pure virtual]

This function should return the Id of the session.

void QMediaServerSession::interfaceAvailable ( const QString & name )   [signal]

Inform listeners that an interface has been made available. The interface can be referenced in the media system by name.

void QMediaServerSession::interfaceUnavailable ( const QString & name )   [signal]

Inform listeners that an interface is no longer available for use. The interfaces is referenced in the media system by name

QStringList QMediaServerSession::interfaces ()   [pure virtual]

This function should return the names of the interfaces supported by this session.

bool QMediaServerSession::isMuted () const   [pure virtual]

Return the current mute state of the session.

quint32 QMediaServerSession::length ()   [pure virtual]

Return the length of the content.

void QMediaServerSession::lengthChanged ( quint32 ms )   [signal]

Inform listeners the length of the content is changed to ms milliseconds long.

void QMediaServerSession::pause ()   [pure virtual]

This function is called when the user is trying to pause the session. For some session types this may mean pausing decoding content, for others simply muting data.

QtopiaMedia::State QMediaServerSession::playerState () const   [pure virtual]

Return the current state of the session.

void QMediaServerSession::playerStateChanged ( QtopiaMedia::State state )   [signal]

Inform listeners that the current state of the session has changed. The new state is indicated by state.

void QMediaServerSession::positionChanged ( quint32 ms )   [signal]

Inform listeners that the current play position in the content has changed to ms, from the beginning.

QString QMediaServerSession::reportData () const   [pure virtual]

This is a general reporting mechanisim, the QString from this function will be placed in the Value Space for inspection.

void QMediaServerSession::resume ()   [pure virtual]

After a suspend, resume() is called to return the session to its previous state.

void QMediaServerSession::seek ( quint32 ms )   [pure virtual]

Seek the content to ms milliseconds from the beginning. If the session is not seekable it may ignore this function.

void QMediaServerSession::setDomain ( QString const & domain )   [pure virtual]

Sets the audio domain in which this session is active to domain.

See also domain().

void QMediaServerSession::setMuted ( bool mute )   [pure virtual]

When mute is true the volume on the session should be muted, when false, the previously set volume should be restored.

See also isMuted().

void QMediaServerSession::setVolume ( int volume )   [pure virtual]

Set the volume of the data to volume. This may involve adjusting device volume, or adjusting PCM volume, it is dependent on the nature of the session.

See also volume().

void QMediaServerSession::start ()   [pure virtual]

This function is called when the user is trying to start the session. It may have different meanings depending on the nature of the session. Generally the content must become active or playing, on start().

void QMediaServerSession::stop ()   [pure virtual]

This function is called as a result of the user trying to stop the session. It is similar to pause() excepting that the any position state, if applicable, should be reset.

void QMediaServerSession::suspend ()   [pure virtual]

The session may be asked to suspend its activities, at this point it should keep a record of state of the session, but otherwise release resources used by the session.

int QMediaServerSession::volume () const   [pure virtual]

Return the current volume.

See also setVolume().

void QMediaServerSession::volumeChanged ( int volume )   [signal]

Inform listeners the volume level has changed to volume.

void QMediaServerSession::volumeMuted ( bool muted )   [signal]

Inform listeners that the mute state of the session has changed to muted.