<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmediaobject.cpp -->
<title>Qt Mobility 1.2: QMediaObject Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtmultimediakit.html">QtMultimediaKit</a></li>
<li>QMediaObject</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QMediaObject Class Reference</h1>
<!-- $$$QMediaObject-brief -->
<p>The QMediaObject class provides a common base for multimedia objects. <a href="#details">More...</a></p>
<!-- @@@QMediaObject -->
<pre class="cpp"> <span class="preprocessor">#include <QMediaObject></span></pre><p><b>Inherits: </b><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>.</p>
<p><b>Inherited by: </b><a href="qaudiocapturesource.html">QAudioCaptureSource</a>, <a href="qcamera.html">QCamera</a>, <a href="qmediaimageviewer.html">QMediaImageViewer</a>, <a href="qmediaplayer.html">QMediaPlayer</a>, and <a href="qradiotuner.html">QRadioTuner</a>.</p>
<p>This class was introduced in Qt Mobility 1.0.</p>
<ul>
<li><a href="qmediaobject-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="qmediaobject.html#notifyInterval-prop">notifyInterval</a></b> : int</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#dtor.QMediaObject">~QMediaObject</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QtMultimediaKit::AvailabilityError </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#availabilityError">availabilityError</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#availableExtendedMetaData">availableExtendedMetaData</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QtMultimediaKit::MetaData> </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#availableMetaData">availableMetaData</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#bind">bind</a></b> ( QObject * <i>object</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#extendedMetaData">extendedMetaData</a></b> ( const QString & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#isAvailable">isAvailable</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#isMetaDataAvailable">isMetaDataAvailable</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#metaData">metaData</a></b> ( QtMultimediaKit::MetaData <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#notifyInterval-prop">notifyInterval</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QMediaService * </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#service">service</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#notifyInterval-prop">setNotifyInterval</a></b> ( int <i>milliSeconds</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#unbind">unbind</a></b> ( QObject * <i>object</i> )</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#availabilityChanged">availabilityChanged</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#metaDataAvailableChanged">metaDataAvailableChanged</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#metaDataChanged">metaDataChanged</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#notifyIntervalChanged">notifyIntervalChanged</a></b> ( int <i>milliseconds</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#QMediaObject">QMediaObject</a></b> ( QObject * <i>parent</i>, QMediaService * <i>service</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#addPropertyWatch">addPropertyWatch</a></b> ( QByteArray const & <i>name</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#removePropertyWatch">removePropertyWatch</a></b> ( QByteArray const & <i>name</i> )</td></tr>
</table>
<ul>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QMediaObject-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QMediaObject class provides a common base for multimedia objects.</p>
<p>QMediaObject derived classes provide access to the functionality of a <a href="qmediaservice.html">QMediaService</a>. Each media object hosts a <a href="qmediaservice.html">QMediaService</a> and uses the <a href="qmediacontrol.html">QMediaControl</a> interfaces implemented by the service to implement its API. Most media objects when constructed will request a new <a href="qmediaservice.html">QMediaService</a> instance from a <a href="qmediaserviceprovider.html">QMediaServiceProvider</a>, but some like <a href="qmediarecorder.html">QMediaRecorder</a> will share a service with another object.</p>
<p>QMediaObject itself provides an API for accessing a media service's <a href="qmediaobject.html#metaData">meta-data</a> and a means of connecting other media objects, and peripheral classes like <a href="qvideowidget.html">QVideoWidget</a> and <a href="qmediaplaylist.html">QMediaPlaylist</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html">QMediaService</a> and <a href="qmediacontrol.html">QMediaControl</a>.</p>
<!-- @@@QMediaObject -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$notifyInterval-prop$$$notifyInterval$$$setNotifyIntervalint$$$notifyIntervalChangedint -->
<h3 class="fn"><a name="notifyInterval-prop"></a><span class="name">notifyInterval</span> : <span class="type">int</span></h3>
<p>The interval at which notifiable properties will update.</p>
<p>The interval is expressed in milliseconds, the default value is 1000.</p>
<p>This property was introduced in Qt Mobility 1.0.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>notifyInterval</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setNotifyInterval</b></span> ( int <i>milliSeconds</i> )</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qmediaobject.html#notifyIntervalChanged">notifyIntervalChanged</a></b></span> ( int <i>milliseconds</i> )</td></tr>
</table>
<p><b>See also </b><a href="qmediaobject.html#addPropertyWatch">addPropertyWatch</a>() and <a href="qmediaobject.html#removePropertyWatch">removePropertyWatch</a>().</p>
<!-- @@@notifyInterval -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMediaObject[overload1]$$$QMediaObjectQObject*QMediaService* -->
<h3 class="fn"><a name="QMediaObject"></a>QMediaObject::<span class="name">QMediaObject</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>parent</i>, <span class="type"><a href="qmediaservice.html">QMediaService</a></span> * <i>service</i> )<tt> [protected]</tt></h3>
<p>Constructs a media object which uses the functionality provided by a media <i>service</i>.</p>
<p>The <i>parent</i> is passed to <a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>.</p>
<p>This class is meant as a base class for Multimedia objects so this constructor is protected.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@QMediaObject -->
<!-- $$$~QMediaObject[overload1]$$$~QMediaObject -->
<h3 class="fn"><a name="dtor.QMediaObject"></a>QMediaObject::<span class="name">~QMediaObject</span> ()</h3>
<p>Destroys a media object.</p>
<!-- @@@~QMediaObject -->
<!-- $$$addPropertyWatch[overload1]$$$addPropertyWatchQByteArrayconst& -->
<h3 class="fn"><a name="addPropertyWatch"></a><span class="type">void</span> QMediaObject::<span class="name">addPropertyWatch</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qbytearray.html">QByteArray</a></span> const & <i>name</i> )<tt> [protected]</tt></h3>
<p>Watch the property <i>name</i>. The property's notify signal will be emitted once every <a href="qmediaobject.html#notifyInterval-prop">notifyInterval</a> milliseconds.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaobject.html#notifyInterval-prop">notifyInterval</a>.</p>
<!-- @@@addPropertyWatch -->
<!-- $$$availabilityChanged[overload1]$$$availabilityChangedbool -->
<h3 class="fn"><a name="availabilityChanged"></a><span class="type">void</span> QMediaObject::<span class="name">availabilityChanged</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<p>Signal emitted when the availability state has changed to <i>available</i></p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@availabilityChanged -->
<!-- $$$availabilityError[overload1]$$$availabilityError -->
<h3 class="fn"><a name="availabilityError"></a><span class="type"><a href="qtmultimediakit.html#AvailabilityError-enum">QtMultimediaKit::AvailabilityError</a></span> QMediaObject::<span class="name">availabilityError</span> () const<tt> [virtual]</tt></h3>
<p>Returns the service availability error state.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@availabilityError -->
<!-- $$$availableExtendedMetaData[overload1]$$$availableExtendedMetaData -->
<h3 class="fn"><a name="availableExtendedMetaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> QMediaObject::<span class="name">availableExtendedMetaData</span> () const</h3>
<p>Returns a list of keys there is extended meta-data available for.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@availableExtendedMetaData -->
<!-- $$$availableMetaData[overload1]$$$availableMetaData -->
<h3 class="fn"><a name="availableMetaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a></span>> QMediaObject::<span class="name">availableMetaData</span> () const</h3>
<p>Returns a list of keys there is meta-data available for.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@availableMetaData -->
<!-- $$$bind[overload1]$$$bindQObject* -->
<h3 class="fn"><a name="bind"></a><span class="type">bool</span> QMediaObject::<span class="name">bind</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>object</i> )<tt> [virtual]</tt></h3>
<p>Bind <i>object</i> to the <a href="qmediaobject.html">QMediaObject</a> instance.</p>
<p>This method establishes a relationship between the media object and a helper object. The nature of the relationship depends on both parties. This methods returns true if the helper was successfully bound, false otherwise.</p>
<p>The object passed must implement the <a href="qmediabindableinterface.html">QMediaBindableInterface</a> interface.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediabindableinterface.html">QMediaBindableInterface</a>.</p>
<!-- @@@bind -->
<!-- $$$extendedMetaData[overload1]$$$extendedMetaDataconstQString& -->
<h3 class="fn"><a name="extendedMetaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QMediaObject::<span class="name">extendedMetaData</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>key</i> ) const</h3>
<p>Returns the value associated with a meta-data <i>key</i>.</p>
<p>The naming and type of extended meta-data is not standardized, so the values and meaning of keys may vary between backends.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@extendedMetaData -->
<!-- $$$isAvailable[overload1]$$$isAvailable -->
<h3 class="fn"><a name="isAvailable"></a><span class="type">bool</span> QMediaObject::<span class="name">isAvailable</span> () const<tt> [virtual]</tt></h3>
<p>Returns true if the service is available for use.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@isAvailable -->
<!-- $$$isMetaDataAvailable[overload1]$$$isMetaDataAvailable -->
<h3 class="fn"><a name="isMetaDataAvailable"></a><span class="type">bool</span> QMediaObject::<span class="name">isMetaDataAvailable</span> () const</h3>
<p>Returns true if there is meta-data associated with this media object, else false.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@isMetaDataAvailable -->
<!-- $$$metaData[overload1]$$$metaDataQtMultimediaKit::MetaData -->
<h3 class="fn"><a name="metaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QMediaObject::<span class="name">metaData</span> ( <span class="type"><a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a></span> <i>key</i> ) const</h3>
<p>Returns the value associated with a meta-data <i>key</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@metaData -->
<!-- $$$metaDataAvailableChanged[overload1]$$$metaDataAvailableChangedbool -->
<h3 class="fn"><a name="metaDataAvailableChanged"></a><span class="type">void</span> QMediaObject::<span class="name">metaDataAvailableChanged</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<p>Signals that the <i>available</i> state of a media object's meta-data has changed.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@metaDataAvailableChanged -->
<!-- $$$metaDataChanged[overload1]$$$metaDataChanged -->
<h3 class="fn"><a name="metaDataChanged"></a><span class="type">void</span> QMediaObject::<span class="name">metaDataChanged</span> ()<tt> [signal]</tt></h3>
<p>Signals that a media object's meta-data has changed.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@metaDataChanged -->
<!-- $$$notifyIntervalChanged[overload1]$$$notifyIntervalChangedint -->
<h3 class="fn"><a name="notifyIntervalChanged"></a><span class="type">void</span> QMediaObject::<span class="name">notifyIntervalChanged</span> ( <span class="type">int</span> <i>milliseconds</i> )<tt> [signal]</tt></h3>
<p>Signal a change in the notify interval period to <i>milliseconds</i>.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@notifyIntervalChanged -->
<!-- $$$removePropertyWatch[overload1]$$$removePropertyWatchQByteArrayconst& -->
<h3 class="fn"><a name="removePropertyWatch"></a><span class="type">void</span> QMediaObject::<span class="name">removePropertyWatch</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qbytearray.html">QByteArray</a></span> const & <i>name</i> )<tt> [protected]</tt></h3>
<p>Remove property <i>name</i> from the list of properties whose changes are regularly signaled.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediaobject.html#notifyInterval-prop">notifyInterval</a>.</p>
<!-- @@@removePropertyWatch -->
<!-- $$$service[overload1]$$$service -->
<h3 class="fn"><a name="service"></a><span class="type"><a href="qmediaservice.html">QMediaService</a></span> * QMediaObject::<span class="name">service</span> () const<tt> [virtual]</tt></h3>
<p>Returns the media service that provides the functionality of a multimedia object.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<!-- @@@service -->
<!-- $$$unbind[overload1]$$$unbindQObject* -->
<h3 class="fn"><a name="unbind"></a><span class="type">void</span> QMediaObject::<span class="name">unbind</span> ( <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></span> * <i>object</i> )<tt> [virtual]</tt></h3>
<p>Detach <i>object</i> from the <a href="qmediaobject.html">QMediaObject</a> instance.</p>
<p>Disconnect the help object from the media object.</p>
<p>This function was introduced in Qt Mobility 1.0.</p>
<p><b>See also </b><a href="qmediabindableinterface.html">QMediaBindableInterface</a>.</p>
<!-- @@@unbind -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2008-2011 Nokia Corporation and/or its
subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide.</p>
<p>
All other trademarks are property of their respective owners. <a title="Privacy Policy"
href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
<br />
<p>
Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.</p>
<p>
Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
Free Documentation License version 1.3</a>
as published by the Free Software Foundation.</p>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
1050
