/usr/share/qt5/doc/qtmultimedia/qmediaobject.html is in qtmultimedia5-doc-html 5.2.1-0ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.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>QMediaObject Class | QtMultimedia 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtmultimedia-index.html">Qt Multimedia</a></li>
<li><a href="qtmultimedia-module.html">C++ Classes</a></li>
<li>QMediaObject</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<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</h1>
<!-- $$$QMediaObject-brief -->
<p>The QMediaObject class provides a common base for multimedia objects. <a href="#details">More...</a></p>
<!-- @@@QMediaObject -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QMediaObject></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qaudiodecoder.html">QAudioDecoder</a>, <a href="qcamera.html">QCamera</a>, <a href="qmediaplayer.html">QMediaPlayer</a>, and <a href="qradiotuner.html">QRadioTuner</a>.</p>
</td></tr></table><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>
<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 QMultimedia::AvailabilityStatus </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#availability">availability</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </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"> 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>(const QString &<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>
<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#availabilityChanged-2">availabilityChanged</a></b>(QMultimedia::AvailabilityStatus<i> availability</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#metaDataChanged-2">metaDataChanged</a></b>(const QString &<i> key</i>, const QVariant &<i> value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediaobject.html#notifyInterval-prop">notifyIntervalChanged</a></b>(int<i> milliseconds</i>)</td></tr>
</table>
<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>
<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>It provides some basic functionality that is common to other high level classes like <a href="qmediaplayer.html">QMediaPlayer</a>, <a href="qaudiodecoder.html">QAudioDecoder</a> and <a href="qcamera.html">QCamera</a>, including availability and meta-data functionality, as well as functionality to connect media objects with support classes like <a href="qmediaplaylist.html">QMediaPlaylist</a>.</p>
<p>The higher level QMediaObject derived classes provide the actual multimedia functionality, by internally using 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. These controls can be accessed from the media object if necessary, but in general the useful functionality can be accessed from the higher level classes.</p>
<p>Most media objects when constructed will request a new <a href="qmediaservice.html">QMediaService</a> instance, but some like <a href="qmediarecorder.html">QMediaRecorder</a> and <a href="qaudiorecorder.html">QAudioRecorder</a> will share a service with another object.</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><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>notifyIntervalChanged</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">QObject</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 QObject.</p>
<p>This class is meant as a base class for multimedia objects so this constructor is protected.</p>
<!-- @@@QMediaObject -->
<!-- $$$~QMediaObject[overload1]$$$~QMediaObject -->
<h3 class="fn"><a name="dtor.QMediaObject"></a>QMediaObject::<span class="name">~QMediaObject</span>()</h3>
<p>Destroys this 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">QByteArray</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 <tt>notifyInterval</tt> milliseconds.</p>
<p><b>See also </b><a href="qmediaobject.html#notifyInterval-prop">notifyInterval</a>.</p>
<!-- @@@addPropertyWatch -->
<!-- $$$availability[overload1]$$$availability -->
<h3 class="fn"><a name="availability"></a><span class="type"><a href="qmultimedia.html#AvailabilityStatus-enum">QMultimedia::AvailabilityStatus</a></span> QMediaObject::<span class="name">availability</span>() const<tt> [virtual]</tt></h3>
<p>Returns the availability of the functionality offered by this object.</p>
<p>In some cases the functionality may not be available (for example, if the current operating system or platform does not provide the required functionality), or it may be temporarily unavailable (for example, audio playback during a phone call or similar).</p>
<!-- @@@availability -->
<!-- $$$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>
<!-- @@@availabilityChanged -->
<!-- $$$availabilityChanged$$$availabilityChangedQMultimedia::AvailabilityStatus -->
<h3 class="fn"><a name="availabilityChanged-2"></a><span class="type">void</span> QMediaObject::<span class="name">availabilityChanged</span>(<span class="type"><a href="qmultimedia.html#AvailabilityStatus-enum">QMultimedia::AvailabilityStatus</a></span><i> availability</i>)<tt> [signal]</tt></h3>
<p>Signal emitted when the availability of the service has changed to <i>availability</i>.</p>
<!-- @@@availabilityChanged -->
<!-- $$$availableMetaData[overload1]$$$availableMetaData -->
<h3 class="fn"><a name="availableMetaData"></a><span class="type">QStringList</span> QMediaObject::<span class="name">availableMetaData</span>() const</h3>
<p>Returns a list of keys there is meta-data available for.</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">QObject</span> *<i> object</i>)<tt> [virtual]</tt></h3>
<p>Bind <i>object</i> to this <a href="qmediaobject.html">QMediaObject</a> instance.</p>
<p>This method establishes a relationship between this 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>Most subclasses of <a href="qmediaobject.html">QMediaObject</a> provide more convenient functions that wrap this functionality, so this function rarely needs to be called directly.</p>
<p>The object passed must implement the <a href="qmediabindableinterface.html">QMediaBindableInterface</a> interface.</p>
<p><b>See also </b><a href="qmediabindableinterface.html">QMediaBindableInterface</a>.</p>
<!-- @@@bind -->
<!-- $$$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>
<!-- @@@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>
<!-- @@@isMetaDataAvailable -->
<!-- $$$metaData[overload1]$$$metaDataconstQString& -->
<h3 class="fn"><a name="metaData"></a><span class="type">QVariant</span> QMediaObject::<span class="name">metaData</span>(const <span class="type">QString</span> &<i> key</i>) const</h3>
<p>Returns the value associated with a meta-data <i>key</i>.</p>
<p>See the list of predefined <a href="qmediametadata.html">meta-data keys</a>.</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>
<!-- @@@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 this media object's meta-data has changed.</p>
<p>If multiple meta-data elements are changed, metaDataChanged(const QString &key, const QVariant &value) signal is emitted for each of them with metaDataChanged() changed emitted once.</p>
<!-- @@@metaDataChanged -->
<!-- $$$metaDataChanged$$$metaDataChangedconstQString&constQVariant& -->
<h3 class="fn"><a name="metaDataChanged-2"></a><span class="type">void</span> QMediaObject::<span class="name">metaDataChanged</span>(const <span class="type">QString</span> &<i> key</i>, const <span class="type">QVariant</span> &<i> value</i>)<tt> [signal]</tt></h3>
<p>Signal the changes of one meta-data element <i>value</i> with the given <i>key</i>.</p>
<!-- @@@metaDataChanged -->
<!-- $$$removePropertyWatch[overload1]$$$removePropertyWatchQByteArrayconst& -->
<h3 class="fn"><a name="removePropertyWatch"></a><span class="type">void</span> QMediaObject::<span class="name">removePropertyWatch</span>(<span class="type">QByteArray</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><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 this multimedia object.</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">QObject</span> *<i> object</i>)<tt> [virtual]</tt></h3>
<p>Detach <i>object</i> from the <a href="qmediaobject.html">QMediaObject</a> instance.</p>
<p>Unbind the helper object from this media object. A warning will be generated if the object was not previously bound to this object.</p>
<p><b>See also </b><a href="qmediabindableinterface.html">QMediaBindableInterface</a>.</p>
<!-- @@@unbind -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed 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.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|