<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmediacontrol.cpp -->
<title>QMediaControl Class | Qt Multimedia 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QMediaControl</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QMediaControl Class</h1>
<!-- $$$QMediaControl-brief -->
<p>The <a href="qmediacontrol.html">QMediaControl</a> class provides a base interface for media service controls. <a href="#details">More...</a></p>
<!-- @@@QMediaControl -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QMediaControl></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qaudiodecodercontrol.html">QAudioDecoderControl</a>, <a href="qaudioencodersettingscontrol.html">QAudioEncoderSettingsControl</a>, <a href="qaudioinputselectorcontrol.html">QAudioInputSelectorControl</a>, <a href="qaudiooutputselectorcontrol.html">QAudioOutputSelectorControl</a>, <a href="qaudiorolecontrol.html">QAudioRoleControl</a>, <a href="qcameracapturebufferformatcontrol.html">QCameraCaptureBufferFormatControl</a>, <a href="qcameracapturedestinationcontrol.html">QCameraCaptureDestinationControl</a>, <a href="qcameracontrol.html">QCameraControl</a>, <a href="qcameraexposurecontrol.html">QCameraExposureControl</a>, <a href="qcamerafeedbackcontrol.html">QCameraFeedbackControl</a>, <a href="qcameraflashcontrol.html">QCameraFlashControl</a>, <a href="qcamerafocuscontrol.html">QCameraFocusControl</a>, <a href="qcameraimagecapturecontrol.html">QCameraImageCaptureControl</a>, <a href="qcameraimageprocessingcontrol.html">QCameraImageProcessingControl</a>, <a href="qcamerainfocontrol.html">QCameraInfoControl</a>, <a href="qcameralockscontrol.html">QCameraLocksControl</a>, <a href="qcameraviewfindersettingscontrol.html">QCameraViewfinderSettingsControl</a>, <a href="qcameraviewfindersettingscontrol2.html">QCameraViewfinderSettingsControl2</a>, <a href="qcamerazoomcontrol.html">QCameraZoomControl</a>, <a href="qimageencodercontrol.html">QImageEncoderControl</a>, <a href="qmediaaudioprobecontrol.html">QMediaAudioProbeControl</a>, <a href="qmediaavailabilitycontrol.html">QMediaAvailabilityControl</a>, <a href="qmediacontainercontrol.html">QMediaContainerControl</a>, <a href="qmediagaplessplaybackcontrol.html">QMediaGaplessPlaybackControl</a>, <a href="qmedianetworkaccesscontrol.html">QMediaNetworkAccessControl</a>, <a href="qmediaplayercontrol.html">QMediaPlayerControl</a>, <a href="qmediarecordercontrol.html">QMediaRecorderControl</a>, <a href="qmediastreamscontrol.html">QMediaStreamsControl</a>, <a href="qmediavideoprobecontrol.html">QMediaVideoProbeControl</a>, <a href="qmetadatareadercontrol.html">QMetaDataReaderControl</a>, <a href="qmetadatawritercontrol.html">QMetaDataWriterControl</a>, <a href="qradiodatacontrol.html">QRadioDataControl</a>, <a href="qradiotunercontrol.html">QRadioTunerControl</a>, <a href="qvideodeviceselectorcontrol.html">QVideoDeviceSelectorControl</a>, <a href="qvideoencodersettingscontrol.html">QVideoEncoderSettingsControl</a>, <a href="qvideorenderercontrol.html">QVideoRendererControl</a>, <a href="qvideowidgetcontrol.html">QVideoWidgetControl</a>, and <a href="qvideowindowcontrol.html">QVideoWindowControl</a></p>
</td></tr></table></div><ul>
<li><a href="qmediacontrol-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmediacontrol.html#dtor.QMediaControl">~QMediaControl</a></b>()</td></tr>
</table></div>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmediacontrol.html#QMediaControl">QMediaControl</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
</table></div>
<a name="macros"></a>
<h2 id="macros">Macros</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qmediacontrol.html#Q_MEDIA_DECLARE_CONTROL">Q_MEDIA_DECLARE_CONTROL</a></b>(<i>Class</i>, <i>IId</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QMediaControl-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qmediacontrol.html">QMediaControl</a> class provides a base interface for media service controls.</p>
<p>Media controls provide an interface to individual features provided by a media service. Most services implement a principal control which exposes the core functionality of the service and a number of optional controls which expose any additional functionality.</p>
<p>A pointer to a control implemented by a media service can be obtained using the <a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>() member of <a href="qmediaservice.html">QMediaService</a>. If the service doesn't implement a control it will instead return a null pointer.</p>
<pre class="cpp">
<span class="type"><a href="qmediaplayercontrol.html">QMediaPlayerControl</a></span> <span class="operator">*</span>control <span class="operator">=</span> qobject_cast<span class="operator"><</span><span class="type"><a href="qmediaplayercontrol.html">QMediaPlayerControl</a></span> <span class="operator">*</span><span class="operator">></span>(
mediaService<span class="operator">-</span><span class="operator">></span>requestControl(<span class="string">"org.qt-project.qt.mediaplayercontrol/5.0"</span>));
</pre>
<p>Alternatively if the IId of the control has been declared using <a href="qmediacontrol.html#Q_MEDIA_DECLARE_CONTROL">Q_MEDIA_DECLARE_CONTROL</a> the template version of <a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>() can be used to request the service without explicitly passing the IId or using qobject_cast().</p>
<pre class="cpp">
<span class="type"><a href="qmediaplayercontrol.html">QMediaPlayerControl</a></span> <span class="operator">*</span>control <span class="operator">=</span> mediaService<span class="operator">-</span><span class="operator">></span>requestControl<span class="operator"><</span><span class="type"><a href="qmediaplayercontrol.html">QMediaPlayerControl</a></span> <span class="operator">*</span><span class="operator">></span>();
</pre>
<p>Most application code will not interface directly with a media service's controls, instead the <a href="qmediaobject.html">QMediaObject</a> which owns the service acts as an intermediary between one or more controls and the application.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html">QMediaService</a> and <a href="qmediaobject.html">QMediaObject</a>.</p>
<!-- @@@QMediaControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMediaControl[overload1]$$$QMediaControlQObject* -->
<h3 class="fn" id="QMediaControl"><a name="QMediaControl"></a><code>[protected] </code>QMediaControl::<span class="name">QMediaControl</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a media control with the given <i>parent</i>.</p>
<!-- @@@QMediaControl -->
<!-- $$$~QMediaControl[overload1]$$$~QMediaControl -->
<h3 class="fn" id="dtor.QMediaControl"><a name="dtor.QMediaControl"></a>QMediaControl::<span class="name">~QMediaControl</span>()</h3>
<p>Destroys a media control.</p>
<!-- @@@~QMediaControl -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$Q_MEDIA_DECLARE_CONTROL[overload1]$$$Q_MEDIA_DECLARE_CONTROL -->
<h3 class="fn" id="Q_MEDIA_DECLARE_CONTROL"><a name="Q_MEDIA_DECLARE_CONTROL"></a><span class="name">Q_MEDIA_DECLARE_CONTROL</span>(<i>Class</i>, <i>IId</i>)</h3>
<p>The Q_MEDIA_DECLARE_CONTROL macro declares an <i>IId</i> for a <i>Class</i> that inherits from <a href="qmediacontrol.html">QMediaControl</a>.</p>
<p>Declaring an IId for a <a href="qmediacontrol.html">QMediaControl</a> allows an instance of that control to be requested from <a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>() without explicitly passing the IId.</p>
<pre class="cpp">
<span class="type"><a href="qmediaplayercontrol.html">QMediaPlayerControl</a></span> <span class="operator">*</span>control <span class="operator">=</span> mediaService<span class="operator">-</span><span class="operator">></span>requestControl<span class="operator"><</span><span class="type"><a href="qmediaplayercontrol.html">QMediaPlayerControl</a></span> <span class="operator">*</span><span class="operator">></span>();
</pre>
<p><b>See also </b><a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>().</p>
<!-- @@@Q_MEDIA_DECLARE_CONTROL -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
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> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
