<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qcameraflashcontrol.cpp --> <title>QCameraFlashControl 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 >QCameraFlashControl</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="#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> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QCameraFlashControl Class</h1> <!-- $$$QCameraFlashControl-brief --> <p>The <a href="qcameraflashcontrol.html">QCameraFlashControl</a> class allows controlling a camera's flash. <a href="#details">More...</a></p> <!-- @@@QCameraFlashControl --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCameraFlashControl></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediacontrol.html">QMediaControl</a></td></tr></table></div><ul> <li><a href="qcameraflashcontrol-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="qcameraflashcontrol.html#dtor.QCameraFlashControl">~QCameraFlashControl</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QCameraExposure::FlashModes </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#flashMode">flashMode</a></b>() const = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#isFlashModeSupported">isFlashModeSupported</a></b>(QCameraExposure::FlashModes <i>mode</i>) const = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#isFlashReady">isFlashReady</a></b>() const = 0</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#setFlashMode">setFlashMode</a></b>(QCameraExposure::FlashModes <i>mode</i>) = 0</td></tr> </table></div> <a name="signals"></a> <h2 id="signals">Signals</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#flashReady">flashReady</a></b>(bool <i>ready</i>)</td></tr> </table></div> <a name="protected-functions"></a> <h2 id="protected-functions">Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#QCameraFlashControl">QCameraFlashControl</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr> </table></div> <a name="macros"></a> <h2 id="macros">Macros</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcameraflashcontrol.html#QCameraFlashControl_iid">QCameraFlashControl_iid</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$QCameraFlashControl-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qcameraflashcontrol.html">QCameraFlashControl</a> class allows controlling a camera's flash.</p> <p>You can set the type of flash effect used when an image is captured, and test to see if the flash hardware is ready to fire.</p> <p>You can retrieve this control from the camera object in the usual way:</p> <p>Some camera devices may not have flash hardware, or may not be configurable. In that case, there will be no <a href="qcameraflashcontrol.html">QCameraFlashControl</a> available.</p> <p>The interface name of <a href="qcameraflashcontrol.html">QCameraFlashControl</a> is <code>org.qt-project.qt.cameraflashcontrol/5.0</code> as defined in <a href="qcameraflashcontrol.html#QCameraFlashControl_iid">QCameraFlashControl_iid</a>.</p> </div> <p><b>See also </b><a href="qcamera.html">QCamera</a>.</p> <!-- @@@QCameraFlashControl --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QCameraFlashControl[overload1]$$$QCameraFlashControlQObject* --> <h3 class="fn" id="QCameraFlashControl"><a name="QCameraFlashControl"></a><code>[protected] </code>QCameraFlashControl::<span class="name">QCameraFlashControl</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3> <p>Constructs a camera flash control object with <i>parent</i>.</p> <!-- @@@QCameraFlashControl --> <!-- $$$~QCameraFlashControl[overload1]$$$~QCameraFlashControl --> <h3 class="fn" id="dtor.QCameraFlashControl"><a name="dtor.QCameraFlashControl"></a>QCameraFlashControl::<span class="name">~QCameraFlashControl</span>()</h3> <p>Destroys the camera control object.</p> <!-- @@@~QCameraFlashControl --> <!-- $$$flashMode[overload1]$$$flashMode --> <h3 class="fn" id="flashMode"><a name="flashMode"></a><code>[pure virtual] </code><span class="type"><a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashModes</a></span> QCameraFlashControl::<span class="name">flashMode</span>() const</h3> <p>Returns the current flash mode.</p> <p><b>See also </b><a href="qcameraflashcontrol.html#setFlashMode">setFlashMode</a>().</p> <!-- @@@flashMode --> <!-- $$$flashReady[overload1]$$$flashReadybool --> <h3 class="fn" id="flashReady"><a name="flashReady"></a><code>[signal] </code><span class="type">void</span> QCameraFlashControl::<span class="name">flashReady</span>(<span class="type">bool</span> <i>ready</i>)</h3> <p>Signal emitted when flash state changes to <i>ready</i>.</p> <!-- @@@flashReady --> <!-- $$$isFlashModeSupported[overload1]$$$isFlashModeSupportedQCameraExposure::FlashModes --> <h3 class="fn" id="isFlashModeSupported"><a name="isFlashModeSupported"></a><code>[pure virtual] </code><span class="type">bool</span> QCameraFlashControl::<span class="name">isFlashModeSupported</span>(<span class="type"><a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashModes</a></span> <i>mode</i>) const</h3> <p>Return true if the reqested flash <i>mode</i> is supported. Some <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashMode</a> values can be combined, for example <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashManual</a> | <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashSlowSyncRearCurtain</a></p> <!-- @@@isFlashModeSupported --> <!-- $$$isFlashReady[overload1]$$$isFlashReady --> <h3 class="fn" id="isFlashReady"><a name="isFlashReady"></a><code>[pure virtual] </code><span class="type">bool</span> QCameraFlashControl::<span class="name">isFlashReady</span>() const</h3> <p>Returns true if flash is charged.</p> <!-- @@@isFlashReady --> <!-- $$$setFlashMode[overload1]$$$setFlashModeQCameraExposure::FlashModes --> <h3 class="fn" id="setFlashMode"><a name="setFlashMode"></a><code>[pure virtual] </code><span class="type">void</span> QCameraFlashControl::<span class="name">setFlashMode</span>(<span class="type"><a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashModes</a></span> <i>mode</i>)</h3> <p>Set the current flash <i>mode</i>.</p> <p>Usually a single <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashMode</a> flag is used, but some non conflicting flags combination are also allowed, like <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashManual</a> | <a href="qcameraexposure.html#FlashMode-enum">QCameraExposure::FlashSlowSyncRearCurtain</a>.</p> <p><b>See also </b><a href="qcameraflashcontrol.html#flashMode">flashMode</a>().</p> <!-- @@@setFlashMode --> </div> <div class="macros"> <h2>Macro Documentation</h2> <!-- $$$QCameraFlashControl_iid[overload1]$$$QCameraFlashControl_iid --> <h3 class="fn" id="QCameraFlashControl_iid"><a name="QCameraFlashControl_iid"></a><span class="name">QCameraFlashControl_iid</span></h3> <p><code>org.qt-project.qt.cameraflashcontrol/5.0</code></p> <p>Defines the interface name of the <a href="qcameraflashcontrol.html">QCameraFlashControl</a> class.</p> <!-- @@@QCameraFlashControl_iid --> </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>