Home · All Classes · All Functions ·

QMediaObject Class Reference

The QMediaObject class provides a common base for multimedia objects. More...

    #include <QMediaObject>

This class is under development and is subject to change.

Inherits QObject.

Inherited by QAudioCaptureSource, QCamera, QMediaImageViewer, QMediaPlayer, QMediaRecorder, QRadioTuner, and QStillImageCapture.


Properties


Public Functions

~QMediaObject ()
virtual QtMedia::AvailabilityError availabilityError () const
QStringList availableExtendedMetaData () const
QList<QtMedia::MetaData> availableMetaData () const
QVariant extendedMetaData ( const QString & key ) const
virtual bool isAvailable () const
bool isMetaDataAvailable () const
bool isMetaDataWritable () const
QVariant metaData ( QtMedia::MetaData key ) const
int notifyInterval () const
virtual QMediaService * service () const
void setExtendedMetaData ( const QString & key, const QVariant & value )
void setMetaData ( QtMedia::MetaData key, const QVariant & value )
void setNotifyInterval ( int milliSeconds )

Signals

void availabilityChanged ( bool available )
void metaDataAvailableChanged ( bool available )
void metaDataChanged ()
void metaDataWritableChanged ( bool writable )
void notifyIntervalChanged ( int milliseconds )

Protected Functions

QMediaObject ( QObject * parent, QMediaService * service )
void addPropertyWatch ( QByteArray const & name )
void removePropertyWatch ( QByteArray const & name )

Additional Inherited Members


Detailed Description

The QMediaObject class provides a common base for multimedia objects.

QMediaObject derived classes provide access to the functionality of a QMediaService. Each media object hosts a QMediaService and uses the QMediaControl interfaces implemented by the service to implement its API. Most media objects when constructed will request a new QMediaService instance from a QMediaServiceProvider, but some like QMediaRecorder will share a service with another object.

QMediaObject itself provides an API for accessing a media service's meta-data and a means of connecting other media objects, and peripheral classes like QVideoWidget and QMediaPlaylist.

See also QMediaService and QMediaControl.


Property Documentation

metaDataAvailable : const bool

This property holds whether access to a media object's meta-data is available.

If this is true there is meta-data available, otherwise there is no meta-data available.

Access functions:

bool isMetaDataAvailable () const

Notifier signal:

void metaDataAvailableChanged ( bool available )

metaDataWritable : const bool

This property holds whether a media object's meta-data is writable.

If this is true the meta-data is writable, otherwise the meta-data is read-only.

Access functions:

bool isMetaDataWritable () const

Notifier signal:

void metaDataWritableChanged ( bool writable )

notifyInterval : int

The interval at which notifiable properties will update.

The interval is expressed in milliseconds, the default value is 1000.

Access functions:

int notifyInterval () const
void setNotifyInterval ( int milliSeconds )

Notifier signal:

void notifyIntervalChanged ( int milliseconds )

See also addPropertyWatch() and removePropertyWatch().


Member Function Documentation

QMediaObject::QMediaObject ( QObject * parent, QMediaService * service )   [protected]

Constructs a media object which uses the functionality provided by a media service.

The parent is passed to QObject.

This class is meant as a base class for Multimedia objects so this constructor is protected.

QMediaObject::~QMediaObject ()

Destroys a media object.

void QMediaObject::addPropertyWatch ( QByteArray const & name )   [protected]

Watch the property name. The property's notify signal will be emitted once every notifyInterval milliseconds.

See also notifyInterval.

void QMediaObject::availabilityChanged ( bool available )   [signal]

Signal emitted when the availability state has changed to available

QtMedia::AvailabilityError QMediaObject::availabilityError () const   [virtual]

Returns the service availability error state.

QStringList QMediaObject::availableExtendedMetaData () const

Returns a list of keys there is extended meta-data available for.

QList<QtMedia::MetaData> QMediaObject::availableMetaData () const

Returns a list of keys there is meta-data available for.

QVariant QMediaObject::extendedMetaData ( const QString & key ) const

Returns the value associated with a meta-data key.

The naming and type of extended meta-data is not standardized, so the values and meaning of keys may vary between backends.

See also setExtendedMetaData().

bool QMediaObject::isAvailable () const   [virtual]

Returns true if the service is available for use.

QVariant QMediaObject::metaData ( QtMedia::MetaData key ) const

Returns the value associated with a meta-data key.

See also setMetaData().

void QMediaObject::metaDataAvailableChanged ( bool available )   [signal]

Signals that the available state of a media object's meta-data has changed.

void QMediaObject::metaDataChanged ()   [signal]

Signals that a media object's meta-data has changed.

void QMediaObject::metaDataWritableChanged ( bool writable )   [signal]

Signals that the writable state of a media object's meta-data has changed.

void QMediaObject::notifyIntervalChanged ( int milliseconds )   [signal]

Signal a change in the notify interval period to milliseconds.

void QMediaObject::removePropertyWatch ( QByteArray const & name )   [protected]

Remove property name from the list of properties whose changes are regularly signaled.

See also notifyInterval.

QMediaService * QMediaObject::service () const   [virtual]

Returns the media service that provides the functionality of a multimedia object.

void QMediaObject::setExtendedMetaData ( const QString & key, const QVariant & value )

Sets a value for a meta-data key.

The naming and type of extended meta-data is not standardized, so the values and meaning of keys may vary between backends.

See also extendedMetaData().

void QMediaObject::setMetaData ( QtMedia::MetaData key, const QVariant & value )

Sets a value for a meta-data key.

See also metaData().


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.0