<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qmediastreamscontrol.cpp --> <title>QMediaStreamsControl 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 >QMediaStreamsControl</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-types">Public Types</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="#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">QMediaStreamsControl Class</h1> <!-- $$$QMediaStreamsControl-brief --> <p>The <a href="qmediastreamscontrol.html">QMediaStreamsControl</a> class provides a media stream selection control. <a href="#details">More...</a></p> <!-- @@@QMediaStreamsControl --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QMediaStreamsControl></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"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediacontrol.html">QMediaControl</a></td></tr></table></div><ul> <li><a href="qmediastreamscontrol-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-types"></a> <h2 id="public-types">Public Types</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#StreamType-enum">StreamType</a></b> { AudioStream, VideoStream, SubPictureStream, UnknownStream, DataStream }</td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#dtor.QMediaStreamsControl">~QMediaStreamsControl</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#isActive">isActive</a></b>(int <i>stream</i>) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#metaData">metaData</a></b>(int <i>stream</i>, const QString &<i>key</i>) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#setActive">setActive</a></b>(int <i>stream</i>, bool <i>state</i>) = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#streamCount">streamCount</a></b>() = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual StreamType </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#streamType">streamType</a></b>(int <i>stream</i>) = 0</td></tr> </table></div> <a name="signals"></a> <h2 id="signals">Signals</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#activeStreamsChanged">activeStreamsChanged</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qmediastreamscontrol.html#streamsChanged">streamsChanged</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="qmediastreamscontrol.html#QMediaStreamsControl">QMediaStreamsControl</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="qmediastreamscontrol.html#QMediaStreamsControl_iid">QMediaStreamsControl_iid</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$QMediaStreamsControl-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qmediastreamscontrol.html">QMediaStreamsControl</a> class provides a media stream selection control.</p> <p>The <a href="qmediastreamscontrol.html">QMediaStreamsControl</a> class provides descriptions of the available media streams and allows individual streams to be activated and deactivated.</p> <p>The interface name of <a href="qmediastreamscontrol.html">QMediaStreamsControl</a> is <code>org.qt-project.qt.mediastreamscontrol/5.0</code> as defined in <a href="qmediastreamscontrol.html#QMediaStreamsControl_iid">QMediaStreamsControl_iid</a>.</p> </div> <p><b>See also </b><a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>().</p> <!-- @@@QMediaStreamsControl --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$StreamType$$$UnknownStream$$$VideoStream$$$AudioStream$$$SubPictureStream$$$DataStream --> <h3 class="fn" id="StreamType-enum"><a name="StreamType-enum"></a>enum QMediaStreamsControl::<span class="name">StreamType</span></h3> <p>Media stream type.</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>QMediaStreamsControl::AudioStream</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Audio stream.</td></tr> <tr><td class="topAlign"><code>QMediaStreamsControl::VideoStream</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Video stream.</td></tr> <tr><td class="topAlign"><code>QMediaStreamsControl::SubPictureStream</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Subpicture or teletext stream.</td></tr> <tr><td class="topAlign"><code>QMediaStreamsControl::UnknownStream</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The stream type is unknown.</td></tr> <tr><td class="topAlign"><code>QMediaStreamsControl::DataStream</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign"> </td></tr> </table></div> <!-- @@@StreamType --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QMediaStreamsControl[overload1]$$$QMediaStreamsControlQObject* --> <h3 class="fn" id="QMediaStreamsControl"><a name="QMediaStreamsControl"></a><code>[protected] </code>QMediaStreamsControl::<span class="name">QMediaStreamsControl</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3> <p>Constructs a new media streams control with the given <i>parent</i>.</p> <!-- @@@QMediaStreamsControl --> <!-- $$$~QMediaStreamsControl[overload1]$$$~QMediaStreamsControl --> <h3 class="fn" id="dtor.QMediaStreamsControl"><a name="dtor.QMediaStreamsControl"></a><code>[virtual] </code>QMediaStreamsControl::<span class="name">~QMediaStreamsControl</span>()</h3> <p>Destroys a media streams control.</p> <!-- @@@~QMediaStreamsControl --> <!-- $$$activeStreamsChanged[overload1]$$$activeStreamsChanged --> <h3 class="fn" id="activeStreamsChanged"><a name="activeStreamsChanged"></a><code>[signal] </code><span class="type">void</span> QMediaStreamsControl::<span class="name">activeStreamsChanged</span>()</h3> <p>The signal is emitted when the active streams list is changed.</p> <!-- @@@activeStreamsChanged --> <!-- $$$isActive[overload1]$$$isActiveint --> <h3 class="fn" id="isActive"><a name="isActive"></a><code>[pure virtual] </code><span class="type">bool</span> QMediaStreamsControl::<span class="name">isActive</span>(<span class="type">int</span> <i>stream</i>)</h3> <p>Returns true if the media <i>stream</i> is active.</p> <!-- @@@isActive --> <!-- $$$metaData[overload1]$$$metaDataintconstQString& --> <h3 class="fn" id="metaData"><a name="metaData"></a><code>[pure virtual] </code><span class="type">QVariant</span> QMediaStreamsControl::<span class="name">metaData</span>(<span class="type">int</span> <i>stream</i>, const <span class="type">QString</span> &<i>key</i>)</h3> <p>Returns the meta-data value of <i>key</i> for a given <i>stream</i>.</p> <p>Useful metadata keys are <a href="qmediametadata.html#Title-var">QMediaMetaData::Title</a>, <a href="qmediametadata.html#Description-var">QMediaMetaData::Description</a> and <a href="qmediametadata.html#Language-var">QMediaMetaData::Language</a>.</p> <!-- @@@metaData --> <!-- $$$setActive[overload1]$$$setActiveintbool --> <h3 class="fn" id="setActive"><a name="setActive"></a><code>[pure virtual] </code><span class="type">void</span> QMediaStreamsControl::<span class="name">setActive</span>(<span class="type">int</span> <i>stream</i>, <span class="type">bool</span> <i>state</i>)</h3> <p>Sets the active <i>state</i> of a media <i>stream</i>.</p> <p>Setting the active state of a media stream to true will activate it. If any other stream of the same type was previously active it will be deactivated. Setting the active state fo a media stream to false will deactivate it.</p> <p><b>See also </b><a href="qmediastreamscontrol.html#isActive">isActive</a>().</p> <!-- @@@setActive --> <!-- $$$streamCount[overload1]$$$streamCount --> <h3 class="fn" id="streamCount"><a name="streamCount"></a><code>[pure virtual] </code><span class="type">int</span> QMediaStreamsControl::<span class="name">streamCount</span>()</h3> <p>Returns the number of media streams.</p> <!-- @@@streamCount --> <!-- $$$streamType[overload1]$$$streamTypeint --> <h3 class="fn" id="streamType"><a name="streamType"></a><code>[pure virtual] </code><span class="type"><a href="qmediastreamscontrol.html#StreamType-enum">StreamType</a></span> QMediaStreamsControl::<span class="name">streamType</span>(<span class="type">int</span> <i>stream</i>)</h3> <p>Return the type of a media <i>stream</i>.</p> <!-- @@@streamType --> <!-- $$$streamsChanged[overload1]$$$streamsChanged --> <h3 class="fn" id="streamsChanged"><a name="streamsChanged"></a><code>[signal] </code><span class="type">void</span> QMediaStreamsControl::<span class="name">streamsChanged</span>()</h3> <p>The signal is emitted when the available streams list is changed.</p> <!-- @@@streamsChanged --> </div> <div class="macros"> <h2>Macro Documentation</h2> <!-- $$$QMediaStreamsControl_iid[overload1]$$$QMediaStreamsControl_iid --> <h3 class="fn" id="QMediaStreamsControl_iid"><a name="QMediaStreamsControl_iid"></a><span class="name">QMediaStreamsControl_iid</span></h3> <p><code>org.qt-project.qt.mediastreamscontrol/5.0</code></p> <p>Defines the interface name of the <a href="qmediastreamscontrol.html">QMediaStreamsControl</a> class.</p> <!-- @@@QMediaStreamsControl_iid --> </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>