/usr/share/qt5/doc/qtmultimedia/qcameraexposurecontrol.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 | <?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" />
<!-- qcameraexposurecontrol.cpp -->
<title>QCameraExposureControl 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>QCameraExposureControl</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">QCameraExposureControl Class</h1>
<!-- $$$QCameraExposureControl-brief -->
<p>The QCameraExposureControl class allows controlling camera exposure parameters. <a href="#details">More...</a></p>
<!-- @@@QCameraExposureControl -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QCameraExposureControl></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="qcameraexposurecontrol-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="qcameraexposurecontrol.html#ExposureParameter-enum">ExposureParameter</a></b> { ISO, Aperture, ShutterSpeed, ExposureCompensation, ..., ExtendedExposureParameter }</td></tr>
</table>
<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="qcameraexposurecontrol.html#dtor.QCameraExposureControl">~QCameraExposureControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qcameraexposurecontrol.html#actualValue">actualValue</a></b>(ExposureParameter<i> parameter</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraexposurecontrol.html#isParameterSupported">isParameterSupported</a></b>(ExposureParameter<i> parameter</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qcameraexposurecontrol.html#requestedValue">requestedValue</a></b>(ExposureParameter<i> parameter</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraexposurecontrol.html#setValue">setValue</a></b>(ExposureParameter<i> parameter</i>, const QVariant &<i> value</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariantList </td><td class="memItemRight bottomAlign"><b><a href="qcameraexposurecontrol.html#supportedParameterRange">supportedParameterRange</a></b>(ExposureParameter<i> parameter</i>, bool *<i> continuous</i>) const = 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="qcameraexposurecontrol.html#actualValueChanged">actualValueChanged</a></b>(int<i> parameter</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraexposurecontrol.html#parameterRangeChanged">parameterRangeChanged</a></b>(int<i> parameter</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraexposurecontrol.html#requestedValueChanged">requestedValueChanged</a></b>(int<i> parameter</i>)</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="qcameraexposurecontrol.html#QCameraExposureControl">QCameraExposureControl</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="qcameraexposurecontrol.html#QCameraExposureControl_iid">QCameraExposureControl_iid</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QCameraExposureControl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QCameraExposureControl class allows controlling camera exposure parameters.</p>
<p>The <a href="qcameraexposure.html">QCameraExposure</a> class is the usual method of adjusting exposure related parameters when using camera functionality. This class provides a more complete but less easy to use interface, and also forms the interface to implement when writing a new implementation of <a href="qcamera.html">QCamera</a> functionality.</p>
<p>You can adjust a number of parameters that will affect images and video taken with the corresponding <a href="qcamera.html">QCamera</a> object - see the <a href="qcameraexposurecontrol.html#ExposureParameter-enum">ExposureParameter</a> enumeration.</p>
<p>The interface name of QCameraExposureControl is <tt>org.qt-project.qt.cameraexposurecontrol/5.0</tt> as defined in <a href="qcameraexposurecontrol.html#QCameraExposureControl_iid">QCameraExposureControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qcameraexposure.html">QCameraExposure</a> and <a href="qcamera.html">QCamera</a>.</p>
<!-- @@@QCameraExposureControl -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ExposureParameter$$$ISO$$$Aperture$$$ShutterSpeed$$$ExposureCompensation$$$FlashPower$$$FlashCompensation$$$TorchPower$$$SpotMeteringPoint$$$ExposureMode$$$MeteringMode$$$ExtendedExposureParameter -->
<h3 class="fn"><a name="ExposureParameter-enum"></a>enum QCameraExposureControl::<span class="name">ExposureParameter</span></h3>
<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>QCameraExposureControl::ISO</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Camera ISO sensitivity, specified as integer value.</td></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::Aperture</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Lens aperture is specified as an qreal F number. The supported apertures list can change depending on the focal length, in such a case the exposureParameterRangeChanged() signal is emitted.</td></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::ShutterSpeed</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Shutter speed in seconds, specified as qreal.</td></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::ExposureCompensation</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">Exposure compensation, specified as qreal EV value.</td></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::FlashPower</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">Manual flash power, specified as qreal value. Accepted power range is [0..1.0], with 0 value means no flash and 1.0 corresponds to full flash power.</td></tr>
</table>
<p>This value is only used in the <a href="qcameraexposure.html#FlashMode-enum">manual flash mode</a>.</p>
<table class="valuelist"><tr valign="top" class="even"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::TorchPower</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">Manual torch power, specified as qreal value. Accepted power range is [0..1.0], with 0 value means no light and 1.0 corresponds to full torch power.</td></tr>
</table>
<p>This value is only used in the <a href="qcameraexposure.html#FlashMode-enum">torch flash mode</a>.</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>QCameraExposureControl::FlashCompensation</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">Flash compensation, specified as qreal EV value.</td></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::SpotMeteringPoint</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">The relative frame coordinate of the point to use for exposure metering in spot metering mode, specified as a QPointF.</td></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::ExposureMode</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">Camera exposure mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::MeteringMode</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">Camera metering mode.</td></tr>
<tr><td class="topAlign"><tt>QCameraExposureControl::ExtendedExposureParameter</tt></td><td class="topAlign"><tt>1000</tt></td><td class="topAlign">The base value for platform specific extended parameters. For such parameters the sequential values starting from ExtendedExposureParameter shuld be used.</td></tr>
</table>
<!-- @@@ExposureParameter -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCameraExposureControl[overload1]$$$QCameraExposureControlQObject* -->
<h3 class="fn"><a name="QCameraExposureControl"></a>QCameraExposureControl::<span class="name">QCameraExposureControl</span>(<span class="type">QObject</span> *<i> parent</i> = 0)<tt> [protected]</tt></h3>
<p>Constructs a camera exposure control object with <i>parent</i>.</p>
<!-- @@@QCameraExposureControl -->
<!-- $$$~QCameraExposureControl[overload1]$$$~QCameraExposureControl -->
<h3 class="fn"><a name="dtor.QCameraExposureControl"></a>QCameraExposureControl::<span class="name">~QCameraExposureControl</span>()</h3>
<p>Destroys the camera exposure control object.</p>
<!-- @@@~QCameraExposureControl -->
<!-- $$$actualValue[overload1]$$$actualValueExposureParameter -->
<h3 class="fn"><a name="actualValue"></a><span class="type">QVariant</span> QCameraExposureControl::<span class="name">actualValue</span>(<span class="type"><a href="qcameraexposurecontrol.html#ExposureParameter-enum">ExposureParameter</a></span><i> parameter</i>) const<tt> [pure virtual]</tt></h3>
<p>Returns the actual exposure <i>parameter</i> value, or invalid QVariant() if the value is unknown or not supported.</p>
<p>The actual parameter value may differ for the requested one if automatic mode is selected or camera supports only limited set of values within the supported range.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@actualValue -->
<!-- $$$actualValueChanged[overload1]$$$actualValueChangedint -->
<h3 class="fn"><a name="actualValueChanged"></a><span class="type">void</span> QCameraExposureControl::<span class="name">actualValueChanged</span>(<span class="type">int</span><i> parameter</i>)<tt> [signal]</tt></h3>
<p>Signal emitted when the actual exposure <i>parameter</i> value has changed, usually in result of auto exposure algorithms or manual exposure parameter applied.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@actualValueChanged -->
<!-- $$$isParameterSupported[overload1]$$$isParameterSupportedExposureParameter -->
<h3 class="fn"><a name="isParameterSupported"></a><span class="type">bool</span> QCameraExposureControl::<span class="name">isParameterSupported</span>(<span class="type"><a href="qcameraexposurecontrol.html#ExposureParameter-enum">ExposureParameter</a></span><i> parameter</i>) const<tt> [pure virtual]</tt></h3>
<p>Returns true is exposure <i>parameter</i> is supported by backend.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@isParameterSupported -->
<!-- $$$parameterRangeChanged[overload1]$$$parameterRangeChangedint -->
<h3 class="fn"><a name="parameterRangeChanged"></a><span class="type">void</span> QCameraExposureControl::<span class="name">parameterRangeChanged</span>(<span class="type">int</span><i> parameter</i>)<tt> [signal]</tt></h3>
<p>Signal emitted when the supported range of exposure <i>parameter</i> values has changed.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@parameterRangeChanged -->
<!-- $$$requestedValue[overload1]$$$requestedValueExposureParameter -->
<h3 class="fn"><a name="requestedValue"></a><span class="type">QVariant</span> QCameraExposureControl::<span class="name">requestedValue</span>(<span class="type"><a href="qcameraexposurecontrol.html#ExposureParameter-enum">ExposureParameter</a></span><i> parameter</i>) const<tt> [pure virtual]</tt></h3>
<p>Returns the requested exposure <i>parameter</i> value.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@requestedValue -->
<!-- $$$requestedValueChanged[overload1]$$$requestedValueChangedint -->
<h3 class="fn"><a name="requestedValueChanged"></a><span class="type">void</span> QCameraExposureControl::<span class="name">requestedValueChanged</span>(<span class="type">int</span><i> parameter</i>)<tt> [signal]</tt></h3>
<p>Signal emitted when the requested exposure <i>parameter</i> value has changed, usually in result of <a href="qcameraexposurecontrol.html#setValue">setValue</a>() call.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@requestedValueChanged -->
<!-- $$$setValue[overload1]$$$setValueExposureParameterconstQVariant& -->
<h3 class="fn"><a name="setValue"></a><span class="type">bool</span> QCameraExposureControl::<span class="name">setValue</span>(<span class="type"><a href="qcameraexposurecontrol.html#ExposureParameter-enum">ExposureParameter</a></span><i> parameter</i>, const <span class="type">QVariant</span> &<i> value</i>)<tt> [pure virtual]</tt></h3>
<p>Set the exposure <i>parameter</i> to <i>value</i>. If a null or invalid QVariant is passed, backend should choose the value automatically, and if possible report the actual value to user with <a href="qcameraexposurecontrol.html#actualValue">QCameraExposureControl::actualValue</a>().</p>
<p>Returns true if parameter is supported and value is correct.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@setValue -->
<!-- $$$supportedParameterRange[overload1]$$$supportedParameterRangeExposureParameterbool* -->
<h3 class="fn"><a name="supportedParameterRange"></a><span class="type">QVariantList</span> QCameraExposureControl::<span class="name">supportedParameterRange</span>(<span class="type"><a href="qcameraexposurecontrol.html#ExposureParameter-enum">ExposureParameter</a></span><i> parameter</i>, <span class="type">bool</span> *<i> continuous</i>) const<tt> [pure virtual]</tt></h3>
<p>Returns the list of supported <i>parameter</i> values;</p>
<p>If the camera supports arbitrary exposure parameter value within the supported range, *<i>continuous</i> is set to true, otherwise *<i>continuous</i> is set to false.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@supportedParameterRange -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QCameraExposureControl_iid[overload1]$$$QCameraExposureControl_iid -->
<h3 class="fn"><a name="QCameraExposureControl_iid"></a><span class="name">QCameraExposureControl_iid</span></h3>
<p><tt>org.qt-project.qt.cameraexposurecontrol/5.0</tt></p>
<p>Defines the interface name of the <a href="qcameraexposurecontrol.html">QCameraExposureControl</a> class.</p>
<!-- @@@QCameraExposureControl_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>
|