/usr/share/qt5/doc/qtmultimedia/qmediastreamscontrol.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 | <?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" />
<!-- qmediastreamscontrol.cpp -->
<title>QMediaStreamsControl 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>QMediaStreamsControl</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="#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>
<h1 class="title">QMediaStreamsControl Class</h1>
<!-- $$$QMediaStreamsControl-brief -->
<p>The QMediaStreamsControl class provides a media stream selection control. <a href="#details">More...</a></p>
<!-- @@@QMediaStreamsControl -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QMediaStreamsControl></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"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediacontrol.html">QMediaControl</a>.</td></tr></table><ul>
<li><a href="qmediastreamscontrol-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<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>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<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>
<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="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>
<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="qmediastreamscontrol.html#QMediaStreamsControl">QMediaStreamsControl</a></b>(QObject *<i> parent</i> = 0)</td></tr>
</table>
<a name="macros"></a>
<h2>Macros</h2>
<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>
<a name="details"></a>
<!-- $$$QMediaStreamsControl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QMediaStreamsControl class provides a media stream selection control.</p>
<p>The QMediaStreamsControl class provides descriptions of the available media streams and allows individual streams to be activated and deactivated.</p>
<p>The interface name of QMediaStreamsControl is <tt>org.qt-project.qt.mediastreamscontrol/5.0</tt> as defined in <a href="qmediastreamscontrol.html#QMediaStreamsControl_iid">QMediaStreamsControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl">QMediaService::requestControl</a>().</p>
<!-- @@@QMediaStreamsControl -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$StreamType$$$UnknownStream$$$VideoStream$$$AudioStream$$$SubPictureStream$$$DataStream -->
<h3 class="fn"><a name="StreamType-enum"></a>enum QMediaStreamsControl::<span class="name">StreamType</span></h3>
<p>Media stream type.</p>
<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"><tt>QMediaStreamsControl::AudioStream</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Audio stream.</td></tr>
<tr><td class="topAlign"><tt>QMediaStreamsControl::VideoStream</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Video stream.</td></tr>
<tr><td class="topAlign"><tt>QMediaStreamsControl::SubPictureStream</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">Subpicture or teletext stream.</td></tr>
<tr><td class="topAlign"><tt>QMediaStreamsControl::UnknownStream</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The stream type is unknown.</td></tr>
<tr><td class="topAlign"><tt>QMediaStreamsControl::DataStream</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign"> </td></tr>
</table>
<!-- @@@StreamType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QMediaStreamsControl[overload1]$$$QMediaStreamsControlQObject* -->
<h3 class="fn"><a name="QMediaStreamsControl"></a>QMediaStreamsControl::<span class="name">QMediaStreamsControl</span>(<span class="type">QObject</span> *<i> parent</i> = 0)<tt> [protected]</tt></h3>
<p>Constructs a new media streams control with the given <i>parent</i>.</p>
<!-- @@@QMediaStreamsControl -->
<!-- $$$~QMediaStreamsControl[overload1]$$$~QMediaStreamsControl -->
<h3 class="fn"><a name="dtor.QMediaStreamsControl"></a>QMediaStreamsControl::<span class="name">~QMediaStreamsControl</span>()<tt> [virtual]</tt></h3>
<p>Destroys a media streams control.</p>
<!-- @@@~QMediaStreamsControl -->
<!-- $$$activeStreamsChanged[overload1]$$$activeStreamsChanged -->
<h3 class="fn"><a name="activeStreamsChanged"></a><span class="type">void</span> QMediaStreamsControl::<span class="name">activeStreamsChanged</span>()<tt> [signal]</tt></h3>
<p>The signal is emitted when the active streams list is changed.</p>
<!-- @@@activeStreamsChanged -->
<!-- $$$isActive[overload1]$$$isActiveint -->
<h3 class="fn"><a name="isActive"></a><span class="type">bool</span> QMediaStreamsControl::<span class="name">isActive</span>(<span class="type">int</span><i> stream</i>)<tt> [pure virtual]</tt></h3>
<p>Returns true if the media <i>stream</i> is active.</p>
<!-- @@@isActive -->
<!-- $$$metaData[overload1]$$$metaDataintconstQString& -->
<h3 class="fn"><a name="metaData"></a><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>)<tt> [pure virtual]</tt></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"><a name="setActive"></a><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>)<tt> [pure virtual]</tt></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"><a name="streamCount"></a><span class="type">int</span> QMediaStreamsControl::<span class="name">streamCount</span>()<tt> [pure virtual]</tt></h3>
<p>Returns the number of media streams.</p>
<!-- @@@streamCount -->
<!-- $$$streamType[overload1]$$$streamTypeint -->
<h3 class="fn"><a name="streamType"></a><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>)<tt> [pure virtual]</tt></h3>
<p>Return the type of a media <i>stream</i>.</p>
<!-- @@@streamType -->
<!-- $$$streamsChanged[overload1]$$$streamsChanged -->
<h3 class="fn"><a name="streamsChanged"></a><span class="type">void</span> QMediaStreamsControl::<span class="name">streamsChanged</span>()<tt> [signal]</tt></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"><a name="QMediaStreamsControl_iid"></a><span class="name">QMediaStreamsControl_iid</span></h3>
<p><tt>org.qt-project.qt.mediastreamscontrol/5.0</tt></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> 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>
|