/usr/share/qt5/doc/qtmultimedia/qvideoencodersettings.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 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | <?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" />
<!-- qmediaencodersettings.cpp -->
<title>QVideoEncoderSettings 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>QVideoEncoderSettings</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-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QVideoEncoderSettings Class</h1>
<!-- $$$QVideoEncoderSettings-brief -->
<p>The QVideoEncoderSettings class provides a set of video encoder settings. <a href="#details">More...</a></p>
<!-- @@@QVideoEncoderSettings -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QVideoEncoderSettings></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr></table><ul>
<li><a href="qvideoencodersettings-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#QVideoEncoderSettings">QVideoEncoderSettings</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#QVideoEncoderSettings-2">QVideoEncoderSettings</a></b>(const QVideoEncoderSettings &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#dtor.QVideoEncoderSettings">~QVideoEncoderSettings</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#bitRate">bitRate</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#codec">codec</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMultimedia::EncodingMode </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#encodingMode">encodingMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.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="qvideoencodersettings.html#encodingOptions">encodingOptions</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#frameRate">frameRate</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#isNull">isNull</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMultimedia::EncodingQuality </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#quality">quality</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#resolution">resolution</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#setBitRate">setBitRate</a></b>(int<i> value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.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="qvideoencodersettings.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="qvideoencodersettings.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="qvideoencodersettings.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="qvideoencodersettings.html#setFrameRate">setFrameRate</a></b>(qreal<i> rate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.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="qvideoencodersettings.html#setResolution">setResolution</a></b>(const QSize &<i> resolution</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#setResolution-2">setResolution</a></b>(int<i> width</i>, int<i> height</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#operator-not-eq">operator!=</a></b>(const QVideoEncoderSettings &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVideoEncoderSettings & </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#operator-eq">operator=</a></b>(const QVideoEncoderSettings &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettings.html#operator-eq-eq">operator==</a></b>(const QVideoEncoderSettings &<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QVideoEncoderSettings-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QVideoEncoderSettings class provides a set of video encoder settings.</p>
<p>A video encoder settings object is used to specify the video encoder settings used by <a href="qmediarecorder.html">QMediaRecorder</a>. Video encoder settings are selected by constructing a QVideoEncoderSettings 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">QVideoEncoderSettings</span> videoSettings;
videoSettings<span class="operator">.</span>setCodec(<span class="string">"video/mpeg2"</span>);
videoSettings<span class="operator">.</span>setResolution(<span class="number">640</span><span class="operator">,</span> <span class="number">480</span>);
recorder<span class="operator">-</span><span class="operator">></span>setVideoSettings(videoSettings);</pre>
</div>
<p><b>See also </b><a href="qmediarecorder.html">QMediaRecorder</a> and <a href="qvideoencodersettingscontrol.html">QVideoEncoderSettingsControl</a>.</p>
<!-- @@@QVideoEncoderSettings -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QVideoEncoderSettings[overload1]$$$QVideoEncoderSettings -->
<h3 class="fn"><a name="QVideoEncoderSettings"></a>QVideoEncoderSettings::<span class="name">QVideoEncoderSettings</span>()</h3>
<p>Constructs a null video encoder settings object.</p>
<!-- @@@QVideoEncoderSettings -->
<!-- $$$QVideoEncoderSettings$$$QVideoEncoderSettingsconstQVideoEncoderSettings& -->
<h3 class="fn"><a name="QVideoEncoderSettings-2"></a>QVideoEncoderSettings::<span class="name">QVideoEncoderSettings</span>(const <span class="type">QVideoEncoderSettings</span> &<i> other</i>)</h3>
<p>Constructs a copy of the video encoder settings object <i>other</i>.</p>
<!-- @@@QVideoEncoderSettings -->
<!-- $$$~QVideoEncoderSettings[overload1]$$$~QVideoEncoderSettings -->
<h3 class="fn"><a name="dtor.QVideoEncoderSettings"></a>QVideoEncoderSettings::<span class="name">~QVideoEncoderSettings</span>()</h3>
<p>Destroys a video encoder settings object.</p>
<!-- @@@~QVideoEncoderSettings -->
<!-- $$$bitRate[overload1]$$$bitRate -->
<h3 class="fn"><a name="bitRate"></a><span class="type">int</span> QVideoEncoderSettings::<span class="name">bitRate</span>() const</h3>
<p>Returns bit rate of the encoded video stream in bits per second.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#setBitRate">setBitRate</a>().</p>
<!-- @@@bitRate -->
<!-- $$$codec[overload1]$$$codec -->
<h3 class="fn"><a name="codec"></a><span class="type">QString</span> QVideoEncoderSettings::<span class="name">codec</span>() const</h3>
<p>Returns the video codec.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#setCodec">setCodec</a>().</p>
<!-- @@@codec -->
<!-- $$$encodingMode[overload1]$$$encodingMode -->
<h3 class="fn"><a name="encodingMode"></a><span class="type"><a href="qmultimedia.html#EncodingMode-enum">QMultimedia::EncodingMode</a></span> QVideoEncoderSettings::<span class="name">encodingMode</span>() const</h3>
<p>Returns the video encoding mode.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#setEncodingMode">setEncodingMode</a>() and <a href="qmultimedia.html#EncodingMode-enum">QMultimedia::EncodingMode</a>.</p>
<!-- @@@encodingMode -->
<!-- $$$encodingOption[overload1]$$$encodingOptionconstQString& -->
<h3 class="fn"><a name="encodingOption"></a><span class="type">QVariant</span> QVideoEncoderSettings::<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="qvideoencodersettings.html#setEncodingOption">setEncodingOption</a>() and <a href="qvideoencodersettings.html#encodingOptions">encodingOptions</a>().</p>
<!-- @@@encodingOption -->
<!-- $$$encodingOptions[overload1]$$$encodingOptions -->
<h3 class="fn"><a name="encodingOptions"></a><span class="type">QVariantMap</span> QVideoEncoderSettings::<span class="name">encodingOptions</span>() const</h3>
<p>Returns the all the encoding options as QVariantMap.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#encodingOption">encodingOption</a>() and <a href="qvideoencodersettings.html#setEncodingOptions">setEncodingOptions</a>().</p>
<!-- @@@encodingOptions -->
<!-- $$$frameRate[overload1]$$$frameRate -->
<h3 class="fn"><a name="frameRate"></a><span class="type">qreal</span> QVideoEncoderSettings::<span class="name">frameRate</span>() const</h3>
<p>Returns the video frame rate.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#setFrameRate">setFrameRate</a>().</p>
<!-- @@@frameRate -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn"><a name="isNull"></a><span class="type">bool</span> QVideoEncoderSettings::<span class="name">isNull</span>() const</h3>
<p>Identifies if a video encoder settings object is uninitalized.</p>
<p>Returns true if the settings are null, and false if they are not.</p>
<!-- @@@isNull -->
<!-- $$$quality[overload1]$$$quality -->
<h3 class="fn"><a name="quality"></a><span class="type"><a href="qmultimedia.html#EncodingQuality-enum">QMultimedia::EncodingQuality</a></span> QVideoEncoderSettings::<span class="name">quality</span>() const</h3>
<p>Returns the video encoding quality.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#setQuality">setQuality</a>().</p>
<!-- @@@quality -->
<!-- $$$resolution[overload1]$$$resolution -->
<h3 class="fn"><a name="resolution"></a><span class="type">QSize</span> QVideoEncoderSettings::<span class="name">resolution</span>() const</h3>
<p>Returns the resolution of the encoded video.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#setResolution">setResolution</a>().</p>
<!-- @@@resolution -->
<!-- $$$setBitRate[overload1]$$$setBitRateint -->
<h3 class="fn"><a name="setBitRate"></a><span class="type">void</span> QVideoEncoderSettings::<span class="name">setBitRate</span>(<span class="type">int</span><i> value</i>)</h3>
<p>Sets the bit rate of the encoded video stream to <i>value</i>.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#bitRate">bitRate</a>().</p>
<!-- @@@setBitRate -->
<!-- $$$setCodec[overload1]$$$setCodecconstQString& -->
<h3 class="fn"><a name="setCodec"></a><span class="type">void</span> QVideoEncoderSettings::<span class="name">setCodec</span>(const <span class="type">QString</span> &<i> codec</i>)</h3>
<p>Sets the video <i>codec</i>.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#codec">codec</a>().</p>
<!-- @@@setCodec -->
<!-- $$$setEncodingMode[overload1]$$$setEncodingModeQMultimedia::EncodingMode -->
<h3 class="fn"><a name="setEncodingMode"></a><span class="type">void</span> QVideoEncoderSettings::<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 video encoding <i>mode</i>.</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 rest of encoding settings are respected regardless of encoding mode.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#encodingMode">encodingMode</a>() and <a href="qmultimedia.html#EncodingMode-enum">QMultimedia::EncodingMode</a>.</p>
<!-- @@@setEncodingMode -->
<!-- $$$setEncodingOption[overload1]$$$setEncodingOptionconstQString&constQVariant& -->
<h3 class="fn"><a name="setEncodingOption"></a><span class="type">void</span> QVideoEncoderSettings::<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> <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="qvideoencodersettings.html#encodingOption">encodingOption</a>() and <a href="qvideoencodersettings.html#setEncodingOptions">setEncodingOptions</a>().</p>
<!-- @@@setEncodingOption -->
<!-- $$$setEncodingOptions[overload1]$$$setEncodingOptionsconstQVariantMap& -->
<h3 class="fn"><a name="setEncodingOptions"></a><span class="type">void</span> QVideoEncoderSettings::<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="qvideoencodersettings.html#encodingOptions">encodingOptions</a>(), <a href="qvideoencodersettings.html#encodingOption">encodingOption</a>(), and <a href="qvideoencodersettings.html#setEncodingOption">setEncodingOption</a>().</p>
<!-- @@@setEncodingOptions -->
<!-- $$$setFrameRate[overload1]$$$setFrameRateqreal -->
<h3 class="fn"><a name="setFrameRate"></a><span class="type">void</span> QVideoEncoderSettings::<span class="name">setFrameRate</span>(<span class="type">qreal</span><i> rate</i>)</h3>
<p>Sets the video frame <i>rate</i>.</p>
<p>A value of 0 indicates the encoder should make an optimal choice based on what is available from the video source and the limitations of the codec.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#frameRate">frameRate</a>().</p>
<!-- @@@setFrameRate -->
<!-- $$$setQuality[overload1]$$$setQualityQMultimedia::EncodingQuality -->
<h3 class="fn"><a name="setQuality"></a><span class="type">void</span> QVideoEncoderSettings::<span class="name">setQuality</span>(<span class="type"><a href="qmultimedia.html#EncodingQuality-enum">QMultimedia::EncodingQuality</a></span><i> quality</i>)</h3>
<p>Sets the video encoding <i>quality</i>.</p>
<p>Setting the video 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="qvideoencodersettings.html#encodingMode">encoding mode</a>. The <i>quality</i> settings parameter is only used in the <a href="qmultimedia.html#EncodingMode-enum">constant quality</a> <a href="qvideoencodersettings.html#encodingMode">encoding mode</a>.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#quality">quality</a>().</p>
<!-- @@@setQuality -->
<!-- $$$setResolution[overload1]$$$setResolutionconstQSize& -->
<h3 class="fn"><a name="setResolution"></a><span class="type">void</span> QVideoEncoderSettings::<span class="name">setResolution</span>(const <span class="type">QSize</span> &<i> resolution</i>)</h3>
<p>Sets the <i>resolution</i> of the encoded video.</p>
<p>An empty QSize indicates the encoder should make an optimal choice based on what is available from the video source and the limitations of the codec.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#resolution">resolution</a>().</p>
<!-- @@@setResolution -->
<!-- $$$setResolution$$$setResolutionintint -->
<h3 class="fn"><a name="setResolution-2"></a><span class="type">void</span> QVideoEncoderSettings::<span class="name">setResolution</span>(<span class="type">int</span><i> width</i>, <span class="type">int</span><i> height</i>)</h3>
<p>Sets the <i>width</i> and <i>height</i> of the resolution of the encoded video.</p>
<p>This is an overloaded function.</p>
<!-- @@@setResolution -->
<!-- $$$operator!=[overload1]$$$operator!=constQVideoEncoderSettings& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QVideoEncoderSettings::<span class="name">operator!=</span>(const <span class="type">QVideoEncoderSettings</span> &<i> other</i>) const</h3>
<p>Determines if <i>other</i> is of equal value to a video encoder settings object.</p>
<p>Returns true if the settings objects are not of equal value, and false if they are of equal value.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQVideoEncoderSettings& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QVideoEncoderSettings</span> & QVideoEncoderSettings::<span class="name">operator=</span>(const <span class="type">QVideoEncoderSettings</span> &<i> other</i>)</h3>
<p>Assigns the value of <i>other</i> to a video encoder settings object.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQVideoEncoderSettings& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QVideoEncoderSettings::<span class="name">operator==</span>(const <span class="type">QVideoEncoderSettings</span> &<i> other</i>) const</h3>
<p>Determines if <i>other</i> is of equal value to a video 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> 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>
|