<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativecameraflash.cpp -->
<title>CameraFlash QML Type | 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-qmlmodule.html">QML Types</a></td><td >CameraFlash QML Type</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="#properties">Properties</a></li>
<li class="level1"><a href="#signals">Signals</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">CameraFlash QML Type</h1>
<span class="subtitle"></span>
<!-- $$$CameraFlash-brief -->
<p>An interface for flash related camera settings. <a href="#details">More...</a></p>
<!-- @@@CameraFlash -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtMultimedia 5.8</td></tr></table></div><ul>
<li><a href="qml-qtmultimedia-cameraflash-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtmultimedia-cameraflash.html#mode-prop">mode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-cameraflash.html#ready-prop">ready</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-cameraflash.html#supportedModes-prop">supportedModes</a></b></b> : list<FlashMode></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtmultimedia-cameraflash.html#flashModeChanged-signal">flashModeChanged</a></b></b>(<i>int</i>)</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-cameraflash.html#flashReady-signal">flashReady</a></b></b>(<i>bool</i>)</li>
</ul>
<!-- $$$CameraFlash-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>This type allows you to operate the camera flash hardware and control the flash mode used. Not all cameras have flash hardware (and in some cases it is shared with the <a href="qml-qtmultimedia-torch.html">torch</a> hardware).</p>
<p>It should not be constructed separately, instead the <code>flash</code> property of a <a href="qml-multimedia.html#camera">Camera</a> should be used.</p>
<pre class="qml">
<span class="type"><a href="qml-qtmultimedia-camera.html">Camera</a></span> {
<span class="name">id</span>: <span class="name">camera</span>
<span class="name">exposure</span>.exposureCompensation: -<span class="number">1.0</span>
<span class="name">flash</span>.mode: <span class="name">Camera</span>.<span class="name">FlashRedEyeReduction</span>
}
</pre>
<!-- @@@CameraFlash -->
<h2>Property Documentation</h2>
<!-- $$$mode -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="mode-prop">
<td class="tblQmlPropNode"><p>
<a name="mode-prop"></a><span class="name">mode</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the camera flash mode.</p>
<p>The mode can be one of the following:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Value</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >Camera.FlashOff</td><td >Flash is Off.</td></tr>
<tr valign="top" class="even"><td >Camera.FlashOn</td><td >Flash is On.</td></tr>
<tr valign="top" class="odd"><td >Camera.FlashAuto</td><td >Automatic flash.</td></tr>
<tr valign="top" class="even"><td >Camera.FlashRedEyeReduction</td><td >Red eye reduction flash.</td></tr>
<tr valign="top" class="odd"><td >Camera.FlashFill</td><td >Use flash to fillin shadows.</td></tr>
<tr valign="top" class="even"><td >Camera.FlashTorch</td><td >Constant light source. If supported, torch can be enabled without loading the camera.</td></tr>
<tr valign="top" class="odd"><td >Camera.FlashVideoLight</td><td >Constant light source, useful for video capture. The light is turned on only while the camera is active.</td></tr>
<tr valign="top" class="even"><td >Camera.FlashSlowSyncFrontCurtain</td><td >Use the flash in conjunction with a slow shutter speed. This mode allows better exposure of distant objects and/or motion blur effect.</td></tr>
<tr valign="top" class="odd"><td >Camera.FlashSlowSyncRearCurtain</td><td >The similar mode to FlashSlowSyncFrontCurtain but flash is fired at the end of exposure.</td></tr>
<tr valign="top" class="even"><td >Camera.FlashManual</td><td >Flash power is manually set.</td></tr>
</table></div>
</div></div><!-- @@@mode -->
<br/>
<!-- $$$ready -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="ready-prop">
<td class="tblQmlPropNode"><p>
<a name="ready-prop"></a><span class="name">ready</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property indicates whether the flash is charged.</p>
</div></div><!-- @@@ready -->
<br/>
<!-- $$$supportedModes -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="supportedModes-prop">
<td class="tblQmlPropNode"><p>
<a name="supportedModes-prop"></a><span class="name">supportedModes</span> : <span class="type">list</span><<span class="type">FlashMode</span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the supported flash modes of the camera. If the list only contains Camera.FlashOff, no flash is supported.</p>
<pre class="cpp">
Camera {
id: camera
flash {
onSupportedModesChanged {
<span class="keyword">if</span> (flash<span class="operator">.</span>supportedModes<span class="operator">.</span>length <span class="operator">=</span><span class="operator">=</span> <span class="number">1</span>) {
<span class="comment">// no flash supported</span>
} <span class="keyword">else</span> {
<span class="comment">// some flash is supported</span>
}
}
}
}
</pre>
<p>This QML property was introduced in Qt 5.9.</p>
<p><b>See also </b><a href="qml-qtmultimedia-cameraflash.html#mode-prop">mode</a>.</p>
</div></div><!-- @@@supportedModes -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$flashModeChanged -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="flashModeChanged-signal">
<td class="tblQmlFuncNode"><p>
<a name="flashModeChanged-signal"></a><span class="name">flashModeChanged</span>(<i>int</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the <code>flashMode</code> property is changed. The corresponding handler is <code>onFlashModeChanged</code>.</p>
</div></div><!-- @@@flashModeChanged -->
<br/>
<!-- $$$flashReady -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="flashReady-signal">
<td class="tblQmlFuncNode"><p>
<a name="flashReady-signal"></a><span class="name">flashReady</span>(<i>bool</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when <a href="qcameraexposure.html">QCameraExposure</a> indicates that the flash is ready to use. The corresponding handler is <code>onFlashReadyChanged</code>.</p>
</div></div><!-- @@@flashReady -->
<br/>
</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>
