/usr/share/qt5/doc/qtmultimedia/qcameraimagecapturecontrol.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 | <?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" />
<!-- qcameraimagecapturecontrol.cpp -->
<title>QCameraImageCaptureControl 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>QCameraImageCaptureControl</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="#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">QCameraImageCaptureControl Class</h1>
<!-- $$$QCameraImageCaptureControl-brief -->
<p>The QCameraImageCaptureControl class provides a control interface for image capture services. <a href="#details">More...</a></p>
<!-- @@@QCameraImageCaptureControl -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QCameraImageCaptureControl></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="qcameraimagecapturecontrol-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="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>
<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="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>
<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="qcameraimagecapturecontrol.html#QCameraImageCaptureControl">QCameraImageCaptureControl</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="qcameraimagecapturecontrol.html#QCameraImageCaptureControl_iid">QCameraImageCaptureControl_iid</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QCameraImageCaptureControl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QCameraImageCaptureControl class provides a control interface for image capture services.</p>
<p>The interface name of QCameraImageCaptureControl is <tt>org.qt-project.qt.cameraimagecapturecontrol/5.0</tt> as defined in <a href="qcameraimagecapturecontrol.html#QCameraImageCaptureControl_iid">QCameraImageCaptureControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl">QMediaService::requestControl</a>().</p>
<!-- @@@QCameraImageCaptureControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCameraImageCaptureControl[overload1]$$$QCameraImageCaptureControlQObject* -->
<h3 class="fn"><a name="QCameraImageCaptureControl"></a>QCameraImageCaptureControl::<span class="name">QCameraImageCaptureControl</span>(<span class="type">QObject</span> *<i> parent</i> = 0)<tt> [protected]</tt></h3>
<p>Constructs a new image capture control object with the given <i>parent</i></p>
<!-- @@@QCameraImageCaptureControl -->
<!-- $$$~QCameraImageCaptureControl[overload1]$$$~QCameraImageCaptureControl -->
<h3 class="fn"><a name="dtor.QCameraImageCaptureControl"></a>QCameraImageCaptureControl::<span class="name">~QCameraImageCaptureControl</span>()</h3>
<p>Destroys an image capture control.</p>
<!-- @@@~QCameraImageCaptureControl -->
<!-- $$$cancelCapture[overload1]$$$cancelCapture -->
<h3 class="fn"><a name="cancelCapture"></a><span class="type">void</span> QCameraImageCaptureControl::<span class="name">cancelCapture</span>()<tt> [pure virtual]</tt></h3>
<p>Cancel pending capture requests.</p>
<!-- @@@cancelCapture -->
<!-- $$$capture[overload1]$$$captureconstQString& -->
<h3 class="fn"><a name="capture"></a><span class="type">int</span> QCameraImageCaptureControl::<span class="name">capture</span>(const <span class="type">QString</span> &<i> fileName</i>)<tt> [pure virtual]</tt></h3>
<p>Initiates the capture of an image to <i>fileName</i>. The <i>fileName</i> can be relative or empty, in this case the service should use the system specific place and file naming scheme.</p>
<p>The Camera service should save all the capture parameters like exposure settings or image processing parameters, so changes to camera paramaters after capture() is called do not affect previous capture requests.</p>
<p>Returns the capture request id number, which is used later with <a href="qcameraimagecapturecontrol.html#imageExposed">imageExposed</a>(), <a href="qcameraimagecapturecontrol.html#imageCaptured">imageCaptured</a>() and <a href="qcameraimagecapturecontrol.html#imageSaved">imageSaved</a>() signals.</p>
<!-- @@@capture -->
<!-- $$$driveMode[overload1]$$$driveMode -->
<h3 class="fn"><a name="driveMode"></a><span class="type"><a href="qcameraimagecapture.html#DriveMode-enum">QCameraImageCapture::DriveMode</a></span> QCameraImageCaptureControl::<span class="name">driveMode</span>() const<tt> [pure virtual]</tt></h3>
<p>Returns the current camera drive mode.</p>
<p><b>See also </b><a href="qcameraimagecapturecontrol.html#setDriveMode">setDriveMode</a>().</p>
<!-- @@@driveMode -->
<!-- $$$error[overload1]$$$errorintintconstQString& -->
<h3 class="fn"><a name="error"></a><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>)<tt> [signal]</tt></h3>
<p>Signals the capture request <i>id</i> failed with <i>error</i> code and message <i>errorString</i>.</p>
<p><b>See also </b><a href="qcameraimagecapture.html#Error-enum">QCameraImageCapture::Error</a>.</p>
<!-- @@@error -->
<!-- $$$imageAvailable[overload1]$$$imageAvailableintconstQVideoFrame& -->
<h3 class="fn"><a name="imageAvailable"></a><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>)<tt> [signal]</tt></h3>
<p>Signals that a captured <i>buffer</i> with a <i>requestId</i> is available.</p>
<!-- @@@imageAvailable -->
<!-- $$$imageCaptured[overload1]$$$imageCapturedintconstQImage& -->
<h3 class="fn"><a name="imageCaptured"></a><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>)<tt> [signal]</tt></h3>
<p>Signals that an image with it <i>requestId</i> has been captured and a <i>preview</i> is available.</p>
<!-- @@@imageCaptured -->
<!-- $$$imageExposed[overload1]$$$imageExposedint -->
<h3 class="fn"><a name="imageExposed"></a><span class="type">void</span> QCameraImageCaptureControl::<span class="name">imageExposed</span>(<span class="type">int</span><i> requestId</i>)<tt> [signal]</tt></h3>
<p>Signals that an image with it <i>requestId</i> has just been exposed. This signal can be used for the shutter sound or other indicaton.</p>
<!-- @@@imageExposed -->
<!-- $$$imageMetadataAvailable[overload1]$$$imageMetadataAvailableintconstQString&constQVariant& -->
<h3 class="fn"><a name="imageMetadataAvailable"></a><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>)<tt> [signal]</tt></h3>
<p>Signals that a metadata for an image with request <i>id</i> is available. Signal also contains the <i>key</i> and <i>value</i> of the metadata.</p>
<p>This signal should be emitted between imageExposed and imageSaved signals.</p>
<!-- @@@imageMetadataAvailable -->
<!-- $$$imageSaved[overload1]$$$imageSavedintconstQString& -->
<h3 class="fn"><a name="imageSaved"></a><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>)<tt> [signal]</tt></h3>
<p>Signals that a captured image with a <i>requestId</i> has been saved to <i>fileName</i>.</p>
<!-- @@@imageSaved -->
<!-- $$$isReadyForCapture[overload1]$$$isReadyForCapture -->
<h3 class="fn"><a name="isReadyForCapture"></a><span class="type">bool</span> QCameraImageCaptureControl::<span class="name">isReadyForCapture</span>() const<tt> [pure virtual]</tt></h3>
<p>Identifies if a capture control is ready to perform a capture immediately (all the resources necessary for image capture are allocated, hardware initialized, flash is charged, etc).</p>
<p>Returns true if the camera is ready for capture; and false if it is not.</p>
<p>It's permissible to call <a href="qcameraimagecapturecontrol.html#capture">capture</a>() while the camera status is <a href="qcamera.html#Status-enum">QCamera::ActiveStatus</a> regardless of isReadyForCapture property value. If camera is not ready to capture image immediately, the capture request is queued with all the related camera settings to be executed as soon as possible.</p>
<!-- @@@isReadyForCapture -->
<!-- $$$readyForCaptureChanged[overload1]$$$readyForCaptureChangedbool -->
<h3 class="fn"><a name="readyForCaptureChanged"></a><span class="type">void</span> QCameraImageCaptureControl::<span class="name">readyForCaptureChanged</span>(<span class="type">bool</span><i> ready</i>)<tt> [signal]</tt></h3>
<p>Signals that a capture control's <i>ready</i> state has changed.</p>
<!-- @@@readyForCaptureChanged -->
<!-- $$$setDriveMode[overload1]$$$setDriveModeQCameraImageCapture::DriveMode -->
<h3 class="fn"><a name="setDriveMode"></a><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>)<tt> [pure virtual]</tt></h3>
<p>Sets the current camera drive <i>mode</i>.</p>
<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"><a name="QCameraImageCaptureControl_iid"></a><span class="name">QCameraImageCaptureControl_iid</span></h3>
<p><tt>org.qt-project.qt.cameraimagecapturecontrol/5.0</tt></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> 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>
|