<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qmediaencodersettings.cpp -->
<title>QAudioEncoderSettings 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 >QAudioEncoderSettings</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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QAudioEncoderSettings Class</h1>
<!-- $$$QAudioEncoderSettings-brief -->
<p>The <a href="qaudioencodersettings.html">QAudioEncoderSettings</a> class provides a set of audio encoder settings. <a href="#details">More...</a></p>
<!-- @@@QAudioEncoderSettings -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAudioEncoderSettings></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr></table></div><ul>
<li><a href="qaudioencodersettings-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="qaudioencodersettings.html#QAudioEncoderSettings">QAudioEncoderSettings</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#QAudioEncoderSettings-1">QAudioEncoderSettings</a></b>(const QAudioEncoderSettings &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#dtor.QAudioEncoderSettings">~QAudioEncoderSettings</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#bitRate">bitRate</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#channelCount">channelCount</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#codec">codec</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMultimedia::EncodingMode </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#encodingMode">encodingMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#encodingOption">encodingOption</a></b>(const QString &<i>option</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#encodingOptions">encodingOptions</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#isNull">isNull</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMultimedia::EncodingQuality </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#quality">quality</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#sampleRate">sampleRate</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setBitRate">setBitRate</a></b>(int <i>rate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setChannelCount">setChannelCount</a></b>(int <i>channels</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setCodec">setCodec</a></b>(const QString &<i>codec</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setEncodingMode">setEncodingMode</a></b>(QMultimedia::EncodingMode <i>mode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setEncodingOption">setEncodingOption</a></b>(const QString &<i>option</i>, const QVariant &<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setEncodingOptions">setEncodingOptions</a></b>(const QVariantMap &<i>options</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setQuality">setQuality</a></b>(QMultimedia::EncodingQuality <i>quality</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#setSampleRate">setSampleRate</a></b>(int <i>rate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#operator-not-eq">operator!=</a></b>(const QAudioEncoderSettings &<i>other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAudioEncoderSettings &</td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#operator-eq">operator=</a></b>(const QAudioEncoderSettings &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qaudioencodersettings.html#operator-eq-eq">operator==</a></b>(const QAudioEncoderSettings &<i>other</i>) const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QAudioEncoderSettings-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qaudioencodersettings.html">QAudioEncoderSettings</a> class provides a set of audio encoder settings.</p>
<p>A audio encoder settings object is used to specify the audio encoder settings used by <a href="qmediarecorder.html">QMediaRecorder</a>. Audio encoder settings are selected by constructing a <a href="qaudioencodersettings.html">QAudioEncoderSettings</a> object, setting the desired properties and then passing it to a <a href="qmediarecorder.html">QMediaRecorder</a> instance using the <a href="qmediarecorder.html#setEncodingSettings">QMediaRecorder::setEncodingSettings</a>() function.</p>
<pre class="cpp">
<span class="type"><a href="qaudioencodersettings.html#QAudioEncoderSettings">QAudioEncoderSettings</a></span> audioSettings;
audioSettings<span class="operator">.</span>setCodec(<span class="string">"audio/mpeg"</span>);
audioSettings<span class="operator">.</span>setChannelCount(<span class="number">2</span>);
recorder<span class="operator">-</span><span class="operator">></span>setAudioSettings(audioSettings);
</pre>
</div>
<p><b>See also </b><a href="qmediarecorder.html">QMediaRecorder</a> and <a href="qaudioencodersettingscontrol.html">QAudioEncoderSettingsControl</a>.</p>
<!-- @@@QAudioEncoderSettings -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAudioEncoderSettings[overload1]$$$QAudioEncoderSettings -->
<h3 class="fn" id="QAudioEncoderSettings"><a name="QAudioEncoderSettings"></a>QAudioEncoderSettings::<span class="name">QAudioEncoderSettings</span>()</h3>
<p>Construct a null audio encoder settings object.</p>
<!-- @@@QAudioEncoderSettings -->
<!-- $$$QAudioEncoderSettings$$$QAudioEncoderSettingsconstQAudioEncoderSettings& -->
<h3 class="fn" id="QAudioEncoderSettings-1"><a name="QAudioEncoderSettings-1"></a>QAudioEncoderSettings::<span class="name">QAudioEncoderSettings</span>(const <span class="type"><a href="qaudioencodersettings.html#QAudioEncoderSettings">QAudioEncoderSettings</a></span> &<i>other</i>)</h3>
<p>Constructs a copy of the audio encoder settings object <i>other</i>.</p>
<!-- @@@QAudioEncoderSettings -->
<!-- $$$~QAudioEncoderSettings[overload1]$$$~QAudioEncoderSettings -->
<h3 class="fn" id="dtor.QAudioEncoderSettings"><a name="dtor.QAudioEncoderSettings"></a>QAudioEncoderSettings::<span class="name">~QAudioEncoderSettings</span>()</h3>
<p>Destroys an audio encoder settings object.</p>
<!-- @@@~QAudioEncoderSettings -->
<!-- $$$bitRate[overload1]$$$bitRate -->
<h3 class="fn" id="bitRate"><a name="bitRate"></a><span class="type">int</span> QAudioEncoderSettings::<span class="name">bitRate</span>() const</h3>
<p>Returns the bit rate of the compressed audio stream in bits per second.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setBitRate">setBitRate</a>().</p>
<!-- @@@bitRate -->
<!-- $$$channelCount[overload1]$$$channelCount -->
<h3 class="fn" id="channelCount"><a name="channelCount"></a><span class="type">int</span> QAudioEncoderSettings::<span class="name">channelCount</span>() const</h3>
<p>Returns the number of audio channels.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setChannelCount">setChannelCount</a>().</p>
<!-- @@@channelCount -->
<!-- $$$codec[overload1]$$$codec -->
<h3 class="fn" id="codec"><a name="codec"></a><span class="type">QString</span> QAudioEncoderSettings::<span class="name">codec</span>() const</h3>
<p>Returns the audio codec.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setCodec">setCodec</a>().</p>
<!-- @@@codec -->
<!-- $$$encodingMode[overload1]$$$encodingMode -->
<h3 class="fn" id="encodingMode"><a name="encodingMode"></a><span class="type"><a href="qmultimedia.html#EncodingMode-enum">QMultimedia::EncodingMode</a></span> QAudioEncoderSettings::<span class="name">encodingMode</span>() const</h3>
<p>Returns the audio encoding mode.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setEncodingMode">setEncodingMode</a>() and <a href="qmultimedia.html#EncodingMode-enum">QMultimedia::EncodingMode</a>.</p>
<!-- @@@encodingMode -->
<!-- $$$encodingOption[overload1]$$$encodingOptionconstQString& -->
<h3 class="fn" id="encodingOption"><a name="encodingOption"></a><span class="type">QVariant</span> QAudioEncoderSettings::<span class="name">encodingOption</span>(const <span class="type">QString</span> &<i>option</i>) const</h3>
<p>Returns the value of encoding <i>option</i>.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setEncodingOption">setEncodingOption</a>() and <a href="qaudioencodersettings.html#encodingOptions">encodingOptions</a>().</p>
<!-- @@@encodingOption -->
<!-- $$$encodingOptions[overload1]$$$encodingOptions -->
<h3 class="fn" id="encodingOptions"><a name="encodingOptions"></a><span class="type">QVariantMap</span> QAudioEncoderSettings::<span class="name">encodingOptions</span>() const</h3>
<p>Returns the all the encoding options as QVariantMap.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#encodingOption">encodingOption</a>() and <a href="qaudioencodersettings.html#setEncodingOptions">setEncodingOptions</a>().</p>
<!-- @@@encodingOptions -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn" id="isNull"><a name="isNull"></a><span class="type">bool</span> QAudioEncoderSettings::<span class="name">isNull</span>() const</h3>
<p>Identifies if an audio settings object is initialized.</p>
<p>Returns true if the settings object is null, and false if it is not.</p>
<!-- @@@isNull -->
<!-- $$$quality[overload1]$$$quality -->
<h3 class="fn" id="quality"><a name="quality"></a><span class="type"><a href="qmultimedia.html#EncodingQuality-enum">QMultimedia::EncodingQuality</a></span> QAudioEncoderSettings::<span class="name">quality</span>() const</h3>
<p>Returns the audio encoding quality.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setQuality">setQuality</a>().</p>
<!-- @@@quality -->
<!-- $$$sampleRate[overload1]$$$sampleRate -->
<h3 class="fn" id="sampleRate"><a name="sampleRate"></a><span class="type">int</span> QAudioEncoderSettings::<span class="name">sampleRate</span>() const</h3>
<p>Returns the audio sample rate in Hz.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#setSampleRate">setSampleRate</a>().</p>
<!-- @@@sampleRate -->
<!-- $$$setBitRate[overload1]$$$setBitRateint -->
<h3 class="fn" id="setBitRate"><a name="setBitRate"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setBitRate</span>(<span class="type">int</span> <i>rate</i>)</h3>
<p>Sets the audio bit <i>rate</i> in bits per second.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#bitRate">bitRate</a>().</p>
<!-- @@@setBitRate -->
<!-- $$$setChannelCount[overload1]$$$setChannelCountint -->
<h3 class="fn" id="setChannelCount"><a name="setChannelCount"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setChannelCount</span>(<span class="type">int</span> <i>channels</i>)</h3>
<p>Sets the number of audio <i>channels</i>.</p>
<p>A value of -1 indicates the encoder should make an optimal choice based on what is available from the audio source and the limitations of the codec.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#channelCount">channelCount</a>().</p>
<!-- @@@setChannelCount -->
<!-- $$$setCodec[overload1]$$$setCodecconstQString& -->
<h3 class="fn" id="setCodec"><a name="setCodec"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setCodec</span>(const <span class="type">QString</span> &<i>codec</i>)</h3>
<p>Sets the audio <i>codec</i>.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#codec">codec</a>().</p>
<!-- @@@setCodec -->
<!-- $$$setEncodingMode[overload1]$$$setEncodingModeQMultimedia::EncodingMode -->
<h3 class="fn" id="setEncodingMode"><a name="setEncodingMode"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setEncodingMode</span>(<span class="type"><a href="qmultimedia.html#EncodingMode-enum">QMultimedia::EncodingMode</a></span> <i>mode</i>)</h3>
<p>Sets the audio encoding <i>mode</i> setting.</p>
<p>If <a href="qmultimedia.html#EncodingMode-enum">QMultimedia::ConstantQualityEncoding</a> is set, the quality encoding parameter is used and bit rate is ignored, otherwise the bitrate is used.</p>
<p>The audio codec, channels count and sample rate settings are used in all the encoding modes.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#encodingMode">encodingMode</a>() and <a href="qmultimedia.html#EncodingMode-enum">QMultimedia::EncodingMode</a>.</p>
<!-- @@@setEncodingMode -->
<!-- $$$setEncodingOption[overload1]$$$setEncodingOptionconstQString&constQVariant& -->
<h3 class="fn" id="setEncodingOption"><a name="setEncodingOption"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setEncodingOption</span>(const <span class="type">QString</span> &<i>option</i>, const <span class="type">QVariant</span> &<i>value</i>)</h3>
<p>Set the encoding <i>option</i> to <i>value</i>.</p>
<p>The supported set and meaning of encoding options are system and selected codec specific.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#encodingOption">encodingOption</a>() and <a href="qaudioencodersettings.html#setEncodingOptions">setEncodingOptions</a>().</p>
<!-- @@@setEncodingOption -->
<!-- $$$setEncodingOptions[overload1]$$$setEncodingOptionsconstQVariantMap& -->
<h3 class="fn" id="setEncodingOptions"><a name="setEncodingOptions"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setEncodingOptions</span>(const <span class="type">QVariantMap</span> &<i>options</i>)</h3>
<p>Replace all the encoding options with <i>options</i>.</p>
<p>The supported set and meaning of encoding options are system and selected codec specific.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#encodingOptions">encodingOptions</a>(), <a href="qaudioencodersettings.html#encodingOption">encodingOption</a>(), and <a href="qaudioencodersettings.html#setEncodingOption">setEncodingOption</a>().</p>
<!-- @@@setEncodingOptions -->
<!-- $$$setQuality[overload1]$$$setQualityQMultimedia::EncodingQuality -->
<h3 class="fn" id="setQuality"><a name="setQuality"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setQuality</span>(<span class="type"><a href="qmultimedia.html#EncodingQuality-enum">QMultimedia::EncodingQuality</a></span> <i>quality</i>)</h3>
<p>Set the audio encoding <i>quality</i>.</p>
<p>Setting the audio quality parameter allows backend to choose the balanced set of encoding parameters to achieve the desired quality level.</p>
<p>The <i>quality</i> settings parameter is only used in the <a href="qmultimedia.html#EncodingMode-enum">constant quality</a> <a href="qaudioencodersettings.html#encodingMode">encoding mode</a>.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#quality">quality</a>().</p>
<!-- @@@setQuality -->
<!-- $$$setSampleRate[overload1]$$$setSampleRateint -->
<h3 class="fn" id="setSampleRate"><a name="setSampleRate"></a><span class="type">void</span> QAudioEncoderSettings::<span class="name">setSampleRate</span>(<span class="type">int</span> <i>rate</i>)</h3>
<p>Sets the audio sample <i>rate</i> in Hz.</p>
<p>A value of -1 indicates the encoder should make an optimal choice based on what is avaialbe from the audio source and the limitations of the codec.</p>
<p><b>See also </b><a href="qaudioencodersettings.html#sampleRate">sampleRate</a>().</p>
<!-- @@@setSampleRate -->
<!-- $$$operator!=[overload1]$$$operator!=constQAudioEncoderSettings& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QAudioEncoderSettings::<span class="name">operator!=</span>(const <span class="type"><a href="qaudioencodersettings.html#QAudioEncoderSettings">QAudioEncoderSettings</a></span> &<i>other</i>) const</h3>
<p>Determines if <i>other</i> is of equal value to an audio encoder settings object.</p>
<p>Returns true if the settings objects are not of equal value, and true if they are of equal value.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQAudioEncoderSettings& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qaudioencodersettings.html#QAudioEncoderSettings">QAudioEncoderSettings</a></span> &QAudioEncoderSettings::<span class="name">operator=</span>(const <span class="type"><a href="qaudioencodersettings.html#QAudioEncoderSettings">QAudioEncoderSettings</a></span> &<i>other</i>)</h3>
<p>Assigns the value of <i>other</i> to an audio encoder settings object.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQAudioEncoderSettings& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QAudioEncoderSettings::<span class="name">operator==</span>(const <span class="type"><a href="qaudioencodersettings.html#QAudioEncoderSettings">QAudioEncoderSettings</a></span> &<i>other</i>) const</h3>
<p>Determines if <i>other</i> is of equal value to an audio encoder settings object.</p>
<p>Returns true if the settings objects are of equal value, and false if they are not of equal value.</p>
<!-- @@@operator== -->
</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>
