/usr/share/qt5/doc/qtmultimedia/qimageencodersettings.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 | <?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>QImageEncoderSettings 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>QImageEncoderSettings</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">QImageEncoderSettings Class</h1>
<!-- $$$QImageEncoderSettings-brief -->
<p>The QImageEncoderSettings class provides a set of image encoder settings. <a href="#details">More...</a></p>
<!-- @@@QImageEncoderSettings -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QImageEncoderSettings></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="qimageencodersettings-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="qimageencodersettings.html#QImageEncoderSettings">QImageEncoderSettings</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.html#QImageEncoderSettings-2">QImageEncoderSettings</a></b>(const QImageEncoderSettings &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.html#dtor.QImageEncoderSettings">~QImageEncoderSettings</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.html#codec">codec</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.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="qimageencodersettings.html#encodingOptions">encodingOptions</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.html#isNull">isNull</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMultimedia::EncodingQuality </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.html#quality">quality</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.html#resolution">resolution</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.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="qimageencodersettings.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="qimageencodersettings.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="qimageencodersettings.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="qimageencodersettings.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="qimageencodersettings.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="qimageencodersettings.html#operator-not-eq">operator!=</a></b>(const QImageEncoderSettings &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QImageEncoderSettings & </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.html#operator-eq">operator=</a></b>(const QImageEncoderSettings &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qimageencodersettings.html#operator-eq-eq">operator==</a></b>(const QImageEncoderSettings &<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QImageEncoderSettings-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QImageEncoderSettings class provides a set of image encoder settings.</p>
<p>A image encoder settings object is used to specify the image encoder settings used by <a href="qcameraimagecapture.html">QCameraImageCapture</a>. Image encoder settings are selected by constructing a QImageEncoderSettings object, setting the desired properties and then passing it to a <a href="qcameraimagecapture.html">QCameraImageCapture</a> instance using the QCameraImageCapture::setImageSettings() function.</p>
<pre class="cpp"><span class="type">QImageEncoderSettings</span> imageSettings;
imageSettings<span class="operator">.</span>setCodec(<span class="string">"image/jpeg"</span>);
imageSettings<span class="operator">.</span>setResolution(<span class="number">1600</span><span class="operator">,</span> <span class="number">1200</span>);
imageCapture<span class="operator">-</span><span class="operator">></span>setEncodingSettings(imageSettings);</pre>
</div>
<p><b>See also </b><a href="qimageencodercontrol.html">QImageEncoderControl</a>.</p>
<!-- @@@QImageEncoderSettings -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QImageEncoderSettings[overload1]$$$QImageEncoderSettings -->
<h3 class="fn"><a name="QImageEncoderSettings"></a>QImageEncoderSettings::<span class="name">QImageEncoderSettings</span>()</h3>
<p>Constructs a null image encoder settings object.</p>
<!-- @@@QImageEncoderSettings -->
<!-- $$$QImageEncoderSettings$$$QImageEncoderSettingsconstQImageEncoderSettings& -->
<h3 class="fn"><a name="QImageEncoderSettings-2"></a>QImageEncoderSettings::<span class="name">QImageEncoderSettings</span>(const <span class="type">QImageEncoderSettings</span> &<i> other</i>)</h3>
<p>Constructs a copy of the image encoder settings object <i>other</i>.</p>
<!-- @@@QImageEncoderSettings -->
<!-- $$$~QImageEncoderSettings[overload1]$$$~QImageEncoderSettings -->
<h3 class="fn"><a name="dtor.QImageEncoderSettings"></a>QImageEncoderSettings::<span class="name">~QImageEncoderSettings</span>()</h3>
<p>Destroys a image encoder settings object.</p>
<!-- @@@~QImageEncoderSettings -->
<!-- $$$codec[overload1]$$$codec -->
<h3 class="fn"><a name="codec"></a><span class="type">QString</span> QImageEncoderSettings::<span class="name">codec</span>() const</h3>
<p>Returns the image codec.</p>
<p><b>See also </b><a href="qimageencodersettings.html#setCodec">setCodec</a>().</p>
<!-- @@@codec -->
<!-- $$$encodingOption[overload1]$$$encodingOptionconstQString& -->
<h3 class="fn"><a name="encodingOption"></a><span class="type">QVariant</span> QImageEncoderSettings::<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="qimageencodersettings.html#setEncodingOption">setEncodingOption</a>() and <a href="qimageencodersettings.html#encodingOptions">encodingOptions</a>().</p>
<!-- @@@encodingOption -->
<!-- $$$encodingOptions[overload1]$$$encodingOptions -->
<h3 class="fn"><a name="encodingOptions"></a><span class="type">QVariantMap</span> QImageEncoderSettings::<span class="name">encodingOptions</span>() const</h3>
<p>Returns the all the encoding options as QVariantMap.</p>
<p><b>See also </b><a href="qimageencodersettings.html#encodingOption">encodingOption</a>() and <a href="qimageencodersettings.html#setEncodingOptions">setEncodingOptions</a>().</p>
<!-- @@@encodingOptions -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn"><a name="isNull"></a><span class="type">bool</span> QImageEncoderSettings::<span class="name">isNull</span>() const</h3>
<p>Identifies if a image 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> QImageEncoderSettings::<span class="name">quality</span>() const</h3>
<p>Returns the image encoding quality.</p>
<p><b>See also </b><a href="qimageencodersettings.html#setQuality">setQuality</a>().</p>
<!-- @@@quality -->
<!-- $$$resolution[overload1]$$$resolution -->
<h3 class="fn"><a name="resolution"></a><span class="type">QSize</span> QImageEncoderSettings::<span class="name">resolution</span>() const</h3>
<p>Returns the resolution of the encoded image.</p>
<p><b>See also </b><a href="qimageencodersettings.html#setResolution">setResolution</a>().</p>
<!-- @@@resolution -->
<!-- $$$setCodec[overload1]$$$setCodecconstQString& -->
<h3 class="fn"><a name="setCodec"></a><span class="type">void</span> QImageEncoderSettings::<span class="name">setCodec</span>(const <span class="type">QString</span> &<i> codec</i>)</h3>
<p>Sets the image <i>codec</i>.</p>
<p><b>See also </b><a href="qimageencodersettings.html#codec">codec</a>().</p>
<!-- @@@setCodec -->
<!-- $$$setEncodingOption[overload1]$$$setEncodingOptionconstQString&constQVariant& -->
<h3 class="fn"><a name="setEncodingOption"></a><span class="type">void</span> QImageEncoderSettings::<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="qimageencodersettings.html#encodingOption">encodingOption</a>() and <a href="qimageencodersettings.html#setEncodingOptions">setEncodingOptions</a>().</p>
<!-- @@@setEncodingOption -->
<!-- $$$setEncodingOptions[overload1]$$$setEncodingOptionsconstQVariantMap& -->
<h3 class="fn"><a name="setEncodingOptions"></a><span class="type">void</span> QImageEncoderSettings::<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="qimageencodersettings.html#encodingOptions">encodingOptions</a>(), <a href="qimageencodersettings.html#encodingOption">encodingOption</a>(), and <a href="qimageencodersettings.html#setEncodingOption">setEncodingOption</a>().</p>
<!-- @@@setEncodingOptions -->
<!-- $$$setQuality[overload1]$$$setQualityQMultimedia::EncodingQuality -->
<h3 class="fn"><a name="setQuality"></a><span class="type">void</span> QImageEncoderSettings::<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 image encoding <i>quality</i>.</p>
<p><b>See also </b><a href="qimageencodersettings.html#quality">quality</a>().</p>
<!-- @@@setQuality -->
<!-- $$$setResolution[overload1]$$$setResolutionconstQSize& -->
<h3 class="fn"><a name="setResolution"></a><span class="type">void</span> QImageEncoderSettings::<span class="name">setResolution</span>(const <span class="type">QSize</span> &<i> resolution</i>)</h3>
<p>Sets the <i>resolution</i> of the encoded image.</p>
<p>An empty QSize indicates the encoder should make an optimal choice based on what is available from the image source and the limitations of the codec.</p>
<p><b>See also </b><a href="qimageencodersettings.html#resolution">resolution</a>().</p>
<!-- @@@setResolution -->
<!-- $$$setResolution$$$setResolutionintint -->
<h3 class="fn"><a name="setResolution-2"></a><span class="type">void</span> QImageEncoderSettings::<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 image.</p>
<p>This is an overloaded function.</p>
<!-- @@@setResolution -->
<!-- $$$operator!=[overload1]$$$operator!=constQImageEncoderSettings& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QImageEncoderSettings::<span class="name">operator!=</span>(const <span class="type">QImageEncoderSettings</span> &<i> other</i>) const</h3>
<p>Determines if <i>other</i> is of equal value to a image 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=constQImageEncoderSettings& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QImageEncoderSettings</span> & QImageEncoderSettings::<span class="name">operator=</span>(const <span class="type">QImageEncoderSettings</span> &<i> other</i>)</h3>
<p>Assigns the value of <i>other</i> to a image encoder settings object.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQImageEncoderSettings& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QImageEncoderSettings::<span class="name">operator==</span>(const <span class="type">QImageEncoderSettings</span> &<i> other</i>) const</h3>
<p>Determines if <i>other</i> is of equal value to a image 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>
|