<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcameraimagecapturecontrol.cpp -->
<title>QCameraImageCaptureControl Class | Qt Multimedia 5.12.2</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.12</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QCameraImageCaptureControl</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtmultimedia-index.html">Qt 5.12.2 Reference Documentation</a></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="#static-public-members">Static Public Members</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">QCameraImageCaptureControl Class</h1>
<!-- $$$QCameraImageCaptureControl-brief -->
<p>The <a href="qcameraimagecapturecontrol.html">QCameraImageCaptureControl</a> class provides a control interface for image capture services. <a href="#details">More...</a></p>
<!-- @@@QCameraImageCaptureControl -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCameraImageCaptureControl></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="qcameraimagecapturecontrol-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"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#dtor.QCameraImageCaptureControl">~QCameraImageCaptureControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#cancelCapture">cancelCapture</a></b>() = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#capture">capture</a></b>(const QString &<i>fileName</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QCameraImageCapture::DriveMode </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#driveMode">driveMode</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#isReadyForCapture">isReadyForCapture</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#setDriveMode">setDriveMode</a></b>(QCameraImageCapture::DriveMode <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="qcameraimagecapturecontrol.html#error">error</a></b>(int <i>id</i>, int <i>error</i>, const QString &<i>errorString</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#imageAvailable">imageAvailable</a></b>(int <i>requestId</i>, const QVideoFrame &<i>buffer</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#imageCaptured">imageCaptured</a></b>(int <i>requestId</i>, const QImage &<i>preview</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#imageExposed">imageExposed</a></b>(int <i>requestId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#imageMetadataAvailable">imageMetadataAvailable</a></b>(int <i>id</i>, const QString &<i>key</i>, const QVariant &<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#imageSaved">imageSaved</a></b>(int <i>requestId</i>, const QString &<i>fileName</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#readyForCaptureChanged">readyForCaptureChanged</a></b>(bool <i>ready</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#staticMetaObject-var">staticMetaObject</a></b></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="qcameraimagecapturecontrol.html#QCameraImageCaptureControl">QCameraImageCaptureControl</a></b>(QObject *<i>parent</i> = 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="qcameraimagecapturecontrol.html#QCameraImageCaptureControl_iid">QCameraImageCaptureControl_iid</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QCameraImageCaptureControl-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcameraimagecapturecontrol.html">QCameraImageCaptureControl</a> class provides a control interface for image capture services.</p>
<p>The interface name of <a href="qcameraimagecapturecontrol.html">QCameraImageCaptureControl</a> is <code>org.qt-project.qt.cameraimagecapturecontrol/5.0</code> as defined in <a href="qcameraimagecapturecontrol.html#QCameraImageCaptureControl_iid">QCameraImageCaptureControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>().</p>
<!-- @@@QCameraImageCaptureControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCameraImageCaptureControl[overload1]$$$QCameraImageCaptureControlQObject* -->
<h3 class="fn" id="QCameraImageCaptureControl"><a name="QCameraImageCaptureControl"></a><code>[protected] </code>QCameraImageCaptureControl::<span class="name">QCameraImageCaptureControl</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new image capture control object with the given <i>parent</i></p>
<!-- @@@QCameraImageCaptureControl -->
<!-- $$$~QCameraImageCaptureControl[overload1]$$$~QCameraImageCaptureControl -->
<h3 class="fn" id="dtor.QCameraImageCaptureControl"><a name="dtor.QCameraImageCaptureControl"></a><code>[virtual] </code>QCameraImageCaptureControl::<span class="name">~QCameraImageCaptureControl</span>()</h3>
<p>Destroys an image capture control.</p>
<!-- @@@~QCameraImageCaptureControl -->
<!-- $$$cancelCapture[overload1]$$$cancelCapture -->
<h3 class="fn" id="cancelCapture"><a name="cancelCapture"></a><code>[pure virtual] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">cancelCapture</span>()</h3>
<!-- @@@cancelCapture -->
<!-- $$$capture[overload1]$$$captureconstQString& -->
<h3 class="fn" id="capture"><a name="capture"></a><code>[pure virtual] </code><span class="type">int</span> QCameraImageCaptureControl::<span class="name">capture</span>(const <span class="type">QString</span> &<i>fileName</i>)</h3>
<!-- @@@capture -->
<!-- $$$driveMode[overload1]$$$driveMode -->
<h3 class="fn" id="driveMode"><a name="driveMode"></a><code>[pure virtual] </code><span class="type"><a href="qcameraimagecapture.html#DriveMode-enum">QCameraImageCapture::DriveMode</a></span> QCameraImageCaptureControl::<span class="name">driveMode</span>() const</h3>
<p><b>See also </b><a href="qcameraimagecapturecontrol.html#setDriveMode">setDriveMode</a>().</p>
<!-- @@@driveMode -->
<!-- $$$error[overload1]$$$errorintintconstQString& -->
<h3 class="fn" id="error"><a name="error"></a><code>[signal] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">error</span>(<span class="type">int</span> <i>id</i>, <span class="type">int</span> <i>error</i>, const <span class="type">QString</span> &<i>errorString</i>)</h3>
<!-- @@@error -->
<!-- $$$imageAvailable[overload1]$$$imageAvailableintconstQVideoFrame& -->
<h3 class="fn" id="imageAvailable"><a name="imageAvailable"></a><code>[signal] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">imageAvailable</span>(<span class="type">int</span> <i>requestId</i>, const <span class="type"><a href="qvideoframe.html">QVideoFrame</a></span> &<i>buffer</i>)</h3>
<!-- @@@imageAvailable -->
<!-- $$$imageCaptured[overload1]$$$imageCapturedintconstQImage& -->
<h3 class="fn" id="imageCaptured"><a name="imageCaptured"></a><code>[signal] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">imageCaptured</span>(<span class="type">int</span> <i>requestId</i>, const <span class="type">QImage</span> &<i>preview</i>)</h3>
<!-- @@@imageCaptured -->
<!-- $$$imageExposed[overload1]$$$imageExposedint -->
<h3 class="fn" id="imageExposed"><a name="imageExposed"></a><code>[signal] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">imageExposed</span>(<span class="type">int</span> <i>requestId</i>)</h3>
<!-- @@@imageExposed -->
<!-- $$$imageMetadataAvailable[overload1]$$$imageMetadataAvailableintconstQString&constQVariant& -->
<h3 class="fn" id="imageMetadataAvailable"><a name="imageMetadataAvailable"></a><code>[signal] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">imageMetadataAvailable</span>(<span class="type">int</span> <i>id</i>, const <span class="type">QString</span> &<i>key</i>, const <span class="type">QVariant</span> &<i>value</i>)</h3>
<!-- @@@imageMetadataAvailable -->
<!-- $$$imageSaved[overload1]$$$imageSavedintconstQString& -->
<h3 class="fn" id="imageSaved"><a name="imageSaved"></a><code>[signal] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">imageSaved</span>(<span class="type">int</span> <i>requestId</i>, const <span class="type">QString</span> &<i>fileName</i>)</h3>
<!-- @@@imageSaved -->
<!-- $$$isReadyForCapture[overload1]$$$isReadyForCapture -->
<h3 class="fn" id="isReadyForCapture"><a name="isReadyForCapture"></a><code>[pure virtual] </code><span class="type">bool</span> QCameraImageCaptureControl::<span class="name">isReadyForCapture</span>() const</h3>
<!-- @@@isReadyForCapture -->
<!-- $$$readyForCaptureChanged[overload1]$$$readyForCaptureChangedbool -->
<h3 class="fn" id="readyForCaptureChanged"><a name="readyForCaptureChanged"></a><code>[signal] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">readyForCaptureChanged</span>(<span class="type">bool</span> <i>ready</i>)</h3>
<!-- @@@readyForCaptureChanged -->
<!-- $$$setDriveMode[overload1]$$$setDriveModeQCameraImageCapture::DriveMode -->
<h3 class="fn" id="setDriveMode"><a name="setDriveMode"></a><code>[pure virtual] </code><span class="type">void</span> QCameraImageCaptureControl::<span class="name">setDriveMode</span>(<span class="type"><a href="qcameraimagecapture.html#DriveMode-enum">QCameraImageCapture::DriveMode</a></span> <i>mode</i>)</h3>
<p><b>See also </b><a href="qcameraimagecapturecontrol.html#driveMode">driveMode</a>().</p>
<!-- @@@setDriveMode -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QCameraImageCaptureControl_iid[overload1]$$$QCameraImageCaptureControl_iid -->
<h3 class="fn" id="QCameraImageCaptureControl_iid"><a name="QCameraImageCaptureControl_iid"></a><span class="name">QCameraImageCaptureControl_iid</span></h3>
<p><code>org.qt-project.qt.cameraimagecapturecontrol/5.0</code></p>
<p>Defines the interface name of the <a href="qcameraimagecapturecontrol.html">QCameraImageCaptureControl</a> class.</p>
<!-- @@@QCameraImageCaptureControl_iid -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 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>
