/usr/share/qt5/doc/qtmultimedia/qaudioencodersettingscontrol.html is in qtmultimedia5-doc-html 5.9.5-0ubuntu1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaudioencodersettingscontrol.cpp -->
<title>QAudioEncoderSettingsControl 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 >QAudioEncoderSettingsControl</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.5 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">QAudioEncoderSettingsControl Class</h1>
<!-- $$$QAudioEncoderSettingsControl-brief -->
<p>The <a href="qaudioencodersettingscontrol.html">QAudioEncoderSettingsControl</a> class provides access to the settings of a media service that performs audio encoding. <a href="#details">More...</a></p>
<!-- @@@QAudioEncoderSettingsControl -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAudioEncoderSettingsControl></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="qaudioencodersettingscontrol-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"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettingscontrol.html#dtor.QAudioEncoderSettingsControl">~QAudioEncoderSettingsControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QAudioEncoderSettings </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettingscontrol.html#audioSettings">audioSettings</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettingscontrol.html#codecDescription">codecDescription</a></b>(const QString &<i>codec</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettingscontrol.html#setAudioSettings">setAudioSettings</a></b>(const QAudioEncoderSettings &<i>settings</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettingscontrol.html#supportedAudioCodecs">supportedAudioCodecs</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList<int> </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettingscontrol.html#supportedSampleRates">supportedSampleRates</a></b>(const QAudioEncoderSettings &<i>settings</i>, bool *<i>continuous</i> = Q_NULLPTR) const = 0</td></tr>
</table></div>
<ul>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<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="qaudioencodersettingscontrol.html#QAudioEncoderSettingsControl">QAudioEncoderSettingsControl</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
</table></div>
<ul>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
</ul>
<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="qaudioencodersettingscontrol.html#QAudioEncoderSettingsControl_iid">QAudioEncoderSettingsControl_iid</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAudioEncoderSettingsControl-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qaudioencodersettingscontrol.html">QAudioEncoderSettingsControl</a> class provides access to the settings of a media service that performs audio encoding.</p>
<p>If a <a href="qmediaservice.html">QMediaService</a> supports encoding audio data it will implement <a href="qaudioencodersettingscontrol.html">QAudioEncoderSettingsControl</a>. This control provides information about the limits of restricted audio encoder options and allows the selection of a set of audio encoder settings as specified in a <a href="qaudioencodersettings.html">QAudioEncoderSettings</a> object.</p>
<p>The functionality provided by this control is exposed to application code through the <a href="qmediarecorder.html">QMediaRecorder</a> class.</p>
<p>The interface name of <a href="qaudioencodersettingscontrol.html">QAudioEncoderSettingsControl</a> is <code>org.qt-project.qt.audioencodersettingscontrol/5.0</code> as defined in <a href="qaudioencodersettingscontrol.html#QAudioEncoderSettingsControl_iid">QAudioEncoderSettingsControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>() and <a href="qmediarecorder.html">QMediaRecorder</a>.</p>
<!-- @@@QAudioEncoderSettingsControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAudioEncoderSettingsControl[overload1]$$$QAudioEncoderSettingsControlQObject* -->
<h3 class="fn" id="QAudioEncoderSettingsControl"><a name="QAudioEncoderSettingsControl"></a><code>[protected] </code>QAudioEncoderSettingsControl::<span class="name">QAudioEncoderSettingsControl</span>(<span class="type"><a href="../qtcore/qobject.html#QObject">QObject</a></span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Create a new audio encoder settings control object with the given <i>parent</i>.</p>
<!-- @@@QAudioEncoderSettingsControl -->
<!-- $$$~QAudioEncoderSettingsControl[overload1]$$$~QAudioEncoderSettingsControl -->
<h3 class="fn" id="dtor.QAudioEncoderSettingsControl"><a name="dtor.QAudioEncoderSettingsControl"></a><code>[virtual] </code>QAudioEncoderSettingsControl::<span class="name">~QAudioEncoderSettingsControl</span>()</h3>
<p>Destroys the audio encoder settings control.</p>
<!-- @@@~QAudioEncoderSettingsControl -->
<!-- $$$audioSettings[overload1]$$$audioSettings -->
<h3 class="fn" id="audioSettings"><a name="audioSettings"></a><code>[pure virtual] </code><span class="type"><a href="qaudioencodersettings.html">QAudioEncoderSettings</a></span> QAudioEncoderSettingsControl::<span class="name">audioSettings</span>() const</h3>
<p>Returns the audio encoder settings.</p>
<p>The returned value may be different tha passed to <a href="qaudioencodersettingscontrol.html#setAudioSettings">QAudioEncoderSettingsControl::setAudioSettings</a>() if the settings contains the default or undefined parameters. In this case if the undefined parameters are already resolved, they should be returned.</p>
<p><b>See also </b><a href="qaudioencodersettingscontrol.html#setAudioSettings">setAudioSettings</a>().</p>
<!-- @@@audioSettings -->
<!-- $$$codecDescription[overload1]$$$codecDescriptionconstQString& -->
<h3 class="fn" id="codecDescription"><a name="codecDescription"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QAudioEncoderSettingsControl::<span class="name">codecDescription</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>codec</i>) const</h3>
<p>Returns description of audio <i>codec</i>.</p>
<!-- @@@codecDescription -->
<!-- $$$setAudioSettings[overload1]$$$setAudioSettingsconstQAudioEncoderSettings& -->
<h3 class="fn" id="setAudioSettings"><a name="setAudioSettings"></a><code>[pure virtual] </code><span class="type">void</span> QAudioEncoderSettingsControl::<span class="name">setAudioSettings</span>(const <span class="type"><a href="qaudioencodersettings.html">QAudioEncoderSettings</a></span> &<i>settings</i>)</h3>
<p>Sets the selected audio <i>settings</i>.</p>
<p><b>See also </b><a href="qaudioencodersettingscontrol.html#audioSettings">audioSettings</a>().</p>
<!-- @@@setAudioSettings -->
<!-- $$$supportedAudioCodecs[overload1]$$$supportedAudioCodecs -->
<h3 class="fn" id="supportedAudioCodecs"><a name="supportedAudioCodecs"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qstringlist.html">QStringList</a></span> QAudioEncoderSettingsControl::<span class="name">supportedAudioCodecs</span>() const</h3>
<p>Returns the list of supported audio codec names.</p>
<!-- @@@supportedAudioCodecs -->
<!-- $$$supportedSampleRates[overload1]$$$supportedSampleRatesconstQAudioEncoderSettings&bool* -->
<h3 class="fn" id="supportedSampleRates"><a name="supportedSampleRates"></a><code>[pure virtual] </code><span class="type"><a href="../qtcore/qlist.html">QList</a></span><<span class="type">int</span>> QAudioEncoderSettingsControl::<span class="name">supportedSampleRates</span>(const <span class="type"><a href="qaudioencodersettings.html">QAudioEncoderSettings</a></span> &<i>settings</i>, <span class="type">bool</span> *<i>continuous</i> = Q_NULLPTR) const</h3>
<p>Returns the list of supported audio sample rates, if known.</p>
<p>If non null audio <i>settings</i> parameter is passed, the returned list is reduced to sample rates supported with partial settings applied.</p>
<p>It can be used for example to query the list of sample rates, supported by specific audio codec.</p>
<p>If the encoder supports arbitrary sample rates within the supported rates range, *<i>continuous</i> is set to true, otherwise *<i>continuous</i> is set to false.</p>
<!-- @@@supportedSampleRates -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QAudioEncoderSettingsControl_iid[overload1]$$$QAudioEncoderSettingsControl_iid -->
<h3 class="fn" id="QAudioEncoderSettingsControl_iid"><a name="QAudioEncoderSettingsControl_iid"></a><span class="name">QAudioEncoderSettingsControl_iid</span></h3>
<p><code>org.qt-project.qt.audioencodersettingscontrol/5.0</code></p>
<p>Defines the interface name of the <a href="qaudioencodersettingscontrol.html">QAudioEncoderSettingsControl</a> class.</p>
<!-- @@@QAudioEncoderSettingsControl_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>
|