<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcamera.cpp -->
<title>QCamera 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 >QCamera</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-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</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">QCamera Class</h1>
<!-- $$$QCamera-brief -->
<p>The <a href="qcamera.html">QCamera</a> class provides interface for system camera devices. <a href="#details">More...</a></p>
<!-- @@@QCamera -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCamera></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="qmediaobject.html">QMediaObject</a></td></tr></table></div><ul>
<li><a href="qcamera-members.html">List of all members, including inherited members</a></li>
<li><a href="qcamera-obsolete.html">Obsolete members</a></li>
</ul>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qcamera-frameraterange.html">FrameRateRange</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#CaptureMode-enum">CaptureMode</a></b> { CaptureViewfinder, CaptureStillImage, CaptureVideo }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#CaptureMode-enum">CaptureModes</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#Error-enum">Error</a></b> { NoError, CameraError, InvalidRequestError, ServiceMissingError, NotSupportedFeatureError }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#LockChangeReason-enum">LockChangeReason</a></b> { UserRequest, LockAcquired, LockFailed, LockLost, LockTemporaryLost }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#LockStatus-enum">LockStatus</a></b> { Unlocked, Searching, Locked }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#LockType-enum">LockType</a></b> { NoLock, LockExposure, LockWhiteBalance, LockFocus }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#LockType-enum">LockTypes</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#Position-enum">Position</a></b> { UnspecifiedPosition, BackFace, FrontFace }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#State-enum">State</a></b> { UnloadedState, LoadedState, ActiveState }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#Status-enum">Status</a></b> { ActiveStatus, StartingStatus, StoppingStatus, StandbyStatus, ..., UnavailableStatus }</td></tr>
</table></div>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><a href="qcamera.html#captureMode-prop">captureMode</a></b> : QCamera::CaptureModes</li>
<li class="fn"><b><a href="qcamera.html#lockStatus-prop">lockStatus</a></b> : const QCamera::LockStatus</li>
<li class="fn"><b><a href="qcamera.html#state-prop">state</a></b> : const QCamera::State</li>
<li class="fn"><b><a href="qcamera.html#status-prop">status</a></b> : const QCamera::Status</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qmediaobject.html#properties">QMediaObject</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="qcamera.html#QCamera">QCamera</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#QCamera-1">QCamera</a></b>(const QByteArray &<i>deviceName</i>, QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#QCamera-2">QCamera</a></b>(const QCameraInfo &<i>cameraInfo</i>, QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#QCamera-3">QCamera</a></b>(QCamera::Position <i>position</i>, QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#dtor.QCamera">~QCamera</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> CaptureModes </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#captureMode-prop">captureMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Error </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#error">error</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#errorString">errorString</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCameraExposure *</td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#exposure">exposure</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCameraFocus *</td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#focus">focus</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCameraImageProcessing *</td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#imageProcessing">imageProcessing</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#isCaptureModeSupported">isCaptureModeSupported</a></b>(CaptureModes <i>mode</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCamera::LockStatus </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#lockStatus">lockStatus</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCamera::LockStatus </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#lockStatus-1">lockStatus</a></b>(QCamera::LockType <i>lockType</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCamera::LockTypes </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#requestedLocks">requestedLocks</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#setViewfinder">setViewfinder</a></b>(QVideoWidget *<i>viewfinder</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#setViewfinder-1">setViewfinder</a></b>(QGraphicsVideoItem *<i>viewfinder</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#setViewfinder-2">setViewfinder</a></b>(QAbstractVideoSurface *<i>surface</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#setViewfinderSettings">setViewfinderSettings</a></b>(const QCameraViewfinderSettings &<i>settings</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> State </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#state-prop">state</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Status </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#status-prop">status</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCamera::LockTypes </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#supportedLocks">supportedLocks</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<FrameRateRange> </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#supportedViewfinderFrameRateRanges">supportedViewfinderFrameRateRanges</a></b>(const QCameraViewfinderSettings &<i>settings</i> = QCameraViewfinderSettings()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QVideoFrame::PixelFormat> </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#supportedViewfinderPixelFormats">supportedViewfinderPixelFormats</a></b>(const QCameraViewfinderSettings &<i>settings</i> = QCameraViewfinderSettings()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QSize> </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#supportedViewfinderResolutions">supportedViewfinderResolutions</a></b>(const QCameraViewfinderSettings &<i>settings</i> = QCameraViewfinderSettings()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QCameraViewfinderSettings> </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#supportedViewfinderSettings">supportedViewfinderSettings</a></b>(const QCameraViewfinderSettings &<i>settings</i> = QCameraViewfinderSettings()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCameraViewfinderSettings </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#viewfinderSettings">viewfinderSettings</a></b>() const</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QMultimedia::AvailabilityStatus </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#availability">availability</a></b>() const override</td></tr>
</table></div>
<ul>
<li class="fn">10 public functions inherited from <a href="qmediaobject.html#public-functions">QMediaObject</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#load">load</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#searchAndLock">searchAndLock</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#searchAndLock-1">searchAndLock</a></b>(QCamera::LockTypes <i>locks</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#captureMode-prop">setCaptureMode</a></b>(QCamera::CaptureModes <i>mode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#start">start</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#stop">stop</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#unload">unload</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#unlock">unlock</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#unlock-1">unlock</a></b>(QCamera::LockTypes <i>locks</i>)</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="qcamera.html#captureModeChanged">captureModeChanged</a></b>(QCamera::CaptureModes <i>mode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#error-1">error</a></b>(QCamera::Error <i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#lockFailed">lockFailed</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#lockStatusChanged">lockStatusChanged</a></b>(QCamera::LockStatus <i>status</i>, QCamera::LockChangeReason <i>reason</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#lockStatusChanged-1">lockStatusChanged</a></b>(QCamera::LockType <i>lock</i>, QCamera::LockStatus <i>status</i>, QCamera::LockChangeReason <i>reason</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#locked">locked</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#stateChanged">stateChanged</a></b>(QCamera::State <i>state</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcamera.html#statusChanged">statusChanged</a></b>(QCamera::Status <i>status</i>)</td></tr>
</table></div>
<ul>
<li class="fn">6 signals inherited from <a href="qmediaobject.html#signals">QMediaObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 protected functions inherited from <a href="qmediaobject.html#protected-functions">QMediaObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QCamera-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcamera.html">QCamera</a> class provides interface for system camera devices.</p>
<p><a href="qcamera.html">QCamera</a> can be used with <a href="qcameraviewfinder.html">QCameraViewfinder</a> for viewfinder display, <a href="qmediarecorder.html">QMediaRecorder</a> for video recording and <a href="qcameraimagecapture.html">QCameraImageCapture</a> for image taking.</p>
<p>You can use <a href="qcamerainfo.html">QCameraInfo</a> to list available cameras and choose which one to use.</p>
<pre class="cpp">
<span class="type">QList</span><span class="operator"><</span><span class="type"><a href="qcamerainfo.html">QCameraInfo</a></span><span class="operator">></span> cameras <span class="operator">=</span> <span class="type"><a href="qcamerainfo.html">QCameraInfo</a></span><span class="operator">::</span>availableCameras();
foreach (<span class="keyword">const</span> <span class="type"><a href="qcamerainfo.html">QCameraInfo</a></span> <span class="operator">&</span>cameraInfo<span class="operator">,</span> cameras) {
<span class="keyword">if</span> (cameraInfo<span class="operator">.</span>deviceName() <span class="operator">=</span><span class="operator">=</span> <span class="string">"mycamera"</span>)
camera <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qcamera.html#QCamera">QCamera</a></span>(cameraInfo);
}
</pre>
<p>See the <a href="cameraoverview.html">camera overview</a> for more information.</p>
</div>
<!-- @@@QCamera -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$CaptureMode$$$CaptureViewfinder$$$CaptureStillImage$$$CaptureVideo -->
<h3 class="flags" id="CaptureMode-enum"><a name="CaptureMode-enum"></a>enum QCamera::<span class="name">CaptureMode</span><br/>flags QCamera::<span class="name">CaptureModes</span></h3>
<div class="table"><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"><code>QCamera::CaptureViewfinder</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Camera is only configured to display viewfinder.</td></tr>
<tr><td class="topAlign"><code>QCamera::CaptureStillImage</code></td><td class="topAlign tblval"><code>0x01</code></td><td class="topAlign">Camera is configured for still frames capture.</td></tr>
<tr><td class="topAlign"><code>QCamera::CaptureVideo</code></td><td class="topAlign tblval"><code>0x02</code></td><td class="topAlign">Camera is configured for video capture.</td></tr>
</table></div>
<p>The CaptureModes type is a typedef for <a href="">QFlags</a><CaptureMode>. It stores an OR combination of CaptureMode values.</p>
<!-- @@@CaptureMode -->
<!-- $$$Error$$$NoError$$$CameraError$$$InvalidRequestError$$$ServiceMissingError$$$NotSupportedFeatureError -->
<h3 class="fn" id="Error-enum"><a name="Error-enum"></a>enum QCamera::<span class="name">Error</span></h3>
<div class="table"><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"><code>QCamera::NoError</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">No errors have occurred.</td></tr>
<tr><td class="topAlign"><code>QCamera::CameraError</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">An error has occurred.</td></tr>
<tr><td class="topAlign"><code>QCamera::InvalidRequestError</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">System resource doesn't support requested functionality.</td></tr>
<tr><td class="topAlign"><code>QCamera::ServiceMissingError</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">No camera service available.</td></tr>
<tr><td class="topAlign"><code>QCamera::NotSupportedFeatureError</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">The feature is not supported.</td></tr>
</table></div>
<!-- @@@Error -->
<!-- $$$LockChangeReason$$$UserRequest$$$LockAcquired$$$LockFailed$$$LockLost$$$LockTemporaryLost -->
<h3 class="fn" id="LockChangeReason-enum"><a name="LockChangeReason-enum"></a>enum QCamera::<span class="name">LockChangeReason</span></h3>
<div class="table"><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"><code>QCamera::UserRequest</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The lock status changed in result of user request, usually to unlock camera settings.</td></tr>
<tr><td class="topAlign"><code>QCamera::LockAcquired</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The lock status successfuly changed to <a href="qcamera.html#LockStatus-enum">QCamera::Locked</a>.</td></tr>
<tr><td class="topAlign"><code>QCamera::LockFailed</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The camera failed to acquire the requested lock in result of autofocus failure, exposure out of supported range, etc.</td></tr>
<tr><td class="topAlign"><code>QCamera::LockLost</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The camera is not able to maintain the requested lock any more. Lock status is changed to <a href="qcamera.html#LockStatus-enum">QCamera::Unlocked</a>.</td></tr>
<tr><td class="topAlign"><code>QCamera::LockTemporaryLost</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">The lock is lost, but the camera is working hard to reacquire it. This value may be used in continuous focusing mode, when the camera loses the focus, the focus lock state is changed to Qcamera::Searching with LockTemporaryLost reason.</td></tr>
</table></div>
<!-- @@@LockChangeReason -->
<!-- $$$LockStatus$$$Unlocked$$$Searching$$$Locked -->
<h3 class="fn" id="LockStatus-enum"><a name="LockStatus-enum"></a>enum QCamera::<span class="name">LockStatus</span></h3>
<div class="table"><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"><code>QCamera::Unlocked</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The application is not interested in camera settings value. The camera may keep this parameter without changes, this is common with camera focus, or adjust exposure and white balance constantly to keep the viewfinder image nice.</td></tr>
<tr><td class="topAlign"><code>QCamera::Searching</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The application has requested the camera focus, exposure or white balance lock with <a href="qcamera.html#searchAndLock">QCamera::searchAndLock</a>(). This state indicates the camera is focusing or calculating exposure and white balance.</td></tr>
<tr><td class="topAlign"><code>QCamera::Locked</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The camera focus, exposure or white balance is locked. The camera is ready to capture, application may check the exposure parameters.</td></tr>
</table></div>
<p>The locked state usually means the requested parameter stays the same, except of the cases when the parameter is requested to be constantly updated. For example in continuous focusing mode, the focus is considered locked as long and the object is in focus, even while the actual focusing distance may be constantly changing.</p>
<!-- @@@LockStatus -->
<!-- $$$LockType$$$NoLock$$$LockExposure$$$LockWhiteBalance$$$LockFocus -->
<h3 class="flags" id="LockType-enum"><a name="LockType-enum"></a>enum QCamera::<span class="name">LockType</span><br/>flags QCamera::<span class="name">LockTypes</span></h3>
<div class="table"><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"><code>QCamera::NoLock</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign"> </td></tr>
<tr><td class="topAlign"><code>QCamera::LockExposure</code></td><td class="topAlign tblval"><code>0x01</code></td><td class="topAlign">Lock camera exposure.</td></tr>
<tr><td class="topAlign"><code>QCamera::LockWhiteBalance</code></td><td class="topAlign tblval"><code>0x02</code></td><td class="topAlign">Lock the white balance.</td></tr>
<tr><td class="topAlign"><code>QCamera::LockFocus</code></td><td class="topAlign tblval"><code>0x04</code></td><td class="topAlign">Lock camera focus.</td></tr>
</table></div>
<p>The LockTypes type is a typedef for <a href="">QFlags</a><LockType>. It stores an OR combination of LockType values.</p>
<!-- @@@LockType -->
<!-- $$$Position$$$UnspecifiedPosition$$$BackFace$$$FrontFace -->
<h3 class="fn" id="Position-enum"><a name="Position-enum"></a>enum QCamera::<span class="name">Position</span></h3>
<p>This enum specifies the physical position of the camera on the system hardware.</p>
<div class="table"><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"><code>QCamera::UnspecifiedPosition</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The camera position is unspecified or unknown.</td></tr>
<tr><td class="topAlign"><code>QCamera::BackFace</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The camera is on the back face of the system hardware. For example on a mobile device, it means it is on the opposite side to that of the screen.</td></tr>
<tr><td class="topAlign"><code>QCamera::FrontFace</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The camera is on the front face of the system hardware. For example on a mobile device, it means it is on the same side as that of the screen. Viewfinder frames of front-facing cameras are mirrored horizontally, so the users can see themselves as looking into a mirror. Captured images or videos are not mirrored.</td></tr>
</table></div>
<p>This enum was introduced or modified in Qt 5.3.</p>
<p><b>See also </b><a href="qcamerainfo.html#position">QCameraInfo::position</a>().</p>
<!-- @@@Position -->
<!-- $$$State$$$UnloadedState$$$LoadedState$$$ActiveState -->
<h3 class="fn" id="State-enum"><a name="State-enum"></a>enum QCamera::<span class="name">State</span></h3>
<div class="table"><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"><code>QCamera::UnloadedState</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The initial camera state, with camera not loaded, the camera capabilities except of supported capture modes are unknown.</td></tr>
</table></div>
<p>While the supported settings are unknown in this state, it's allowed to set the camera capture settings like codec, resolution, or frame rate.</p>
<div class="table"><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"><code>QCamera::LoadedState</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The camera is loaded and ready to be configured.</td></tr>
</table></div>
<p>In the Idle state it's allowed to query camera capabilities, set capture resolution, codecs, etc.</p>
<p>The viewfinder is not active in the loaded state.</p>
<div class="table"><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"><code>QCamera::ActiveState</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">In the active state as soon as camera is started the viewfinder displays video frames and the camera is ready for capture.</td></tr>
</table></div>
<!-- @@@State -->
<!-- $$$Status$$$UnavailableStatus$$$UnloadedStatus$$$LoadingStatus$$$UnloadingStatus$$$LoadedStatus$$$StandbyStatus$$$StartingStatus$$$StoppingStatus$$$ActiveStatus -->
<h3 class="fn" id="Status-enum"><a name="Status-enum"></a>enum QCamera::<span class="name">Status</span></h3>
<div class="table"><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"><code>QCamera::ActiveStatus</code></td><td class="topAlign tblval"><code>8</code></td><td class="topAlign">The camera has been started and can produce data. The viewfinder displays video frames in active state.</td></tr>
</table></div>
<p>Depending on backend, changing some camera settings like capture mode, codecs or resolution in <a href="qcamera.html#State-enum">ActiveState</a> may lead to changing the camera status to LoadedStatus and StartingStatus while the settings are applied and back to ActiveStatus when the camera is ready.</p>
<div class="table"><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"><code>QCamera::StartingStatus</code></td><td class="topAlign tblval"><code>6</code></td><td class="topAlign">The camera is starting in result of state transition to <a href="qcamera.html#State-enum">QCamera::ActiveState</a>. The camera service is not ready to capture yet.</td></tr>
<tr><td class="topAlign"><code>QCamera::StoppingStatus</code></td><td class="topAlign tblval"><code>7</code></td><td class="topAlign">The camera is stopping in result of state transition from <a href="qcamera.html#State-enum">QCamera::ActiveState</a> to <a href="qcamera.html#State-enum">QCamera::LoadedState</a> or <a href="qcamera.html#State-enum">QCamera::UnloadedState</a>.</td></tr>
<tr><td class="topAlign"><code>QCamera::StandbyStatus</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">The camera is in the power saving standby mode. The camera may come to the standby mode after some time of inactivity in the <a href="qcamera.html#State-enum">QCamera::LoadedState</a> state.</td></tr>
<tr><td class="topAlign"><code>QCamera::LoadedStatus</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">The camera is loaded and ready to be configured. This status indicates the camera device is opened and it's possible to query for supported image and video capture settings, like resolution, framerate and codecs.</td></tr>
<tr><td class="topAlign"><code>QCamera::LoadingStatus</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The camera device loading in result of state transition from <a href="qcamera.html#State-enum">QCamera::UnloadedState</a> to <a href="qcamera.html#State-enum">QCamera::LoadedState</a> or <a href="qcamera.html#State-enum">QCamera::ActiveState</a>.</td></tr>
<tr><td class="topAlign"><code>QCamera::UnloadingStatus</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The camera device is unloading in result of state transition from <a href="qcamera.html#State-enum">QCamera::LoadedState</a> or <a href="qcamera.html#State-enum">QCamera::ActiveState</a> to <a href="qcamera.html#State-enum">QCamera::UnloadedState</a>.</td></tr>
<tr><td class="topAlign"><code>QCamera::UnloadedStatus</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The initial camera status, with camera not loaded. The camera capabilities including supported capture settings may be unknown.</td></tr>
<tr><td class="topAlign"><code>QCamera::UnavailableStatus</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The camera or camera backend is not available.</td></tr>
</table></div>
<!-- @@@Status -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$captureMode-prop$$$captureMode$$$setCaptureModeQCamera::CaptureModes$$$captureModeChangedQCamera::CaptureModes -->
<h3 class="fn" id="captureMode-prop"><a name="captureMode-prop"></a><span class="name">captureMode</span> : <span class="type"><a href="qcamera.html#CaptureMode-enum">QCamera::CaptureModes</a></span></h3>
<p>The type of media (video or still images), the camera is configured to capture.</p>
<p>It's allowed to change capture mode in any camera state, but if the camera is currently active, chaging capture mode is likely to lead to camera status chaged to <a href="qcamera.html#Status-enum">QCamera::LoadedStatus</a>, <a href="qcamera.html#Status-enum">QCamera::LoadingStatus</a>, and when the camera is ready to <a href="qcamera.html#Status-enum">QCamera::ActiveStatus</a>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> CaptureModes </td><td class="memItemRight bottomAlign"><span class="name"><b>captureMode</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCaptureMode</b></span>(QCamera::CaptureModes <i>mode</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qcamera.html#captureModeChanged">captureModeChanged</a></b></span>(QCamera::CaptureModes <i>mode</i>)</td></tr>
</table></div>
<!-- @@@captureMode -->
<!-- $$$lockStatus-prop$$$lockStatus$$$lockStatusQCamera::LockType$$$lockStatusChangedQCamera::LockStatusQCamera::LockChangeReason$$$lockStatusChangedQCamera::LockTypeQCamera::LockStatusQCamera::LockChangeReason -->
<h3 class="fn" id="lockStatus-prop"><a name="lockStatus-prop"></a><span class="name">lockStatus</span> : const <span class="type"><a href="qcamera.html#LockStatus-enum">QCamera::LockStatus</a></span></h3>
<p>This property holds the overall status for all the requested camera locks.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QCamera::LockStatus </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qcamera.html#lockStatus">lockStatus</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> QCamera::LockStatus </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qcamera.html#lockStatus-1">lockStatus</a></b></span>(QCamera::LockType <i>lockType</i>) const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qcamera.html#lockStatusChanged">lockStatusChanged</a></b></span>(QCamera::LockStatus <i>status</i>, QCamera::LockChangeReason <i>reason</i>)</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qcamera.html#lockStatusChanged-1">lockStatusChanged</a></b></span>(QCamera::LockType <i>lock</i>, QCamera::LockStatus <i>status</i>, QCamera::LockChangeReason <i>reason</i>)</td></tr>
</table></div>
<!-- @@@lockStatus -->
<!-- $$$state-prop$$$state$$$stateChangedQCamera::State -->
<h3 class="fn" id="state-prop"><a name="state-prop"></a><span class="name">state</span> : const <span class="type"><a href="qcamera.html#State-enum">QCamera::State</a></span></h3>
<p>This property holds the current state of the camera object.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> State </td><td class="memItemRight bottomAlign"><span class="name"><b>state</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qcamera.html#stateChanged">stateChanged</a></b></span>(QCamera::State <i>state</i>)</td></tr>
</table></div>
<!-- @@@state -->
<!-- $$$status-prop$$$status$$$statusChangedQCamera::Status -->
<h3 class="fn" id="status-prop"><a name="status-prop"></a><span class="name">status</span> : const <span class="type"><a href="qcamera.html#Status-enum">QCamera::Status</a></span></h3>
<p>This property holds the current status of the camera object.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Status </td><td class="memItemRight bottomAlign"><span class="name"><b>status</b></span>() const</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qcamera.html#statusChanged">statusChanged</a></b></span>(QCamera::Status <i>status</i>)</td></tr>
</table></div>
<!-- @@@status -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCamera[overload1]$$$QCameraQObject* -->
<h3 class="fn" id="QCamera"><a name="QCamera"></a>QCamera::<span class="name">QCamera</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Construct a <a href="qcamera.html">QCamera</a> with a <i>parent</i>.</p>
<!-- @@@QCamera -->
<!-- $$$QCamera$$$QCameraconstQByteArray&QObject* -->
<h3 class="fn" id="QCamera-1"><a name="QCamera-1"></a>QCamera::<span class="name">QCamera</span>(const <span class="type">QByteArray</span> &<i>deviceName</i>, <span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Construct a <a href="qcamera.html">QCamera</a> from <i>deviceName</i> and <i>parent</i>.</p>
<p>If no camera with that <i>deviceName</i> exists, the camera object will be invalid.</p>
<!-- @@@QCamera -->
<!-- $$$QCamera$$$QCameraconstQCameraInfo&QObject* -->
<h3 class="fn" id="QCamera-2"><a name="QCamera-2"></a>QCamera::<span class="name">QCamera</span>(const <span class="type"><a href="qcamerainfo.html">QCameraInfo</a></span> &<i>cameraInfo</i>, <span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Construct a <a href="qcamera.html">QCamera</a> from a camera description <i>cameraInfo</i> and <i>parent</i>.</p>
<p>This function was introduced in Qt 5.3.</p>
<!-- @@@QCamera -->
<!-- $$$QCamera$$$QCameraQCamera::PositionQObject* -->
<h3 class="fn" id="QCamera-3"><a name="QCamera-3"></a>QCamera::<span class="name">QCamera</span>(<span class="type"><a href="qcamera.html#Position-enum">QCamera::Position</a></span> <i>position</i>, <span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Construct a <a href="qcamera.html">QCamera</a> which uses a hardware camera located a the specified <i>position</i>.</p>
<p>For example on a mobile phone it can be used to easily choose between front-facing and back-facing cameras.</p>
<p>If no camera is available at the specified <i>position</i> or if <i>position</i> is <a href="qcamera.html#Position-enum">QCamera::UnspecifiedPosition</a>, the default camera is used.</p>
<p>This function was introduced in Qt 5.3.</p>
<!-- @@@QCamera -->
<!-- $$$~QCamera[overload1]$$$~QCamera -->
<h3 class="fn" id="dtor.QCamera"><a name="dtor.QCamera"></a>QCamera::<span class="name">~QCamera</span>()</h3>
<p>Destroys the camera object.</p>
<!-- @@@~QCamera -->
<!-- $$$availability[overload1]$$$availability -->
<h3 class="fn" id="availability"><a name="availability"></a><code>[override virtual] </code><span class="type"><a href="qmultimedia.html#AvailabilityStatus-enum">QMultimedia::AvailabilityStatus</a></span> QCamera::<span class="name">availability</span>() const</h3>
<p>Reimplemented from <a href="qmediaobject.html#availability">QMediaObject::availability</a>().</p>
<p>Returns the availability state of the camera service.</p>
<!-- @@@availability -->
<!-- $$$captureModeChanged -->
<h3 class="fn" id="captureModeChanged"><a name="captureModeChanged"></a><code>[signal] </code><span class="type">void</span> QCamera::<span class="name">captureModeChanged</span>(<span class="type"><a href="qcamera.html#CaptureMode-enum">QCamera::CaptureModes</a></span> <i>mode</i>)</h3>
<p>Signals the capture <i>mode</i> has changed.</p>
<p><b>Note:</b> Notifier signal for property <a href="qcamera.html#captureMode-prop">captureMode</a>. </p><!-- @@@captureModeChanged -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn" id="error"><a name="error"></a><span class="type"><a href="qcamera.html#Error-enum">Error</a></span> QCamera::<span class="name">error</span>() const</h3>
<p>Returns the error state of the object.</p>
<!-- @@@error -->
<!-- $$$error$$$errorQCamera::Error -->
<h3 class="fn" id="error-1"><a name="error-1"></a><code>[signal] </code><span class="type">void</span> QCamera::<span class="name">error</span>(<span class="type"><a href="qcamera.html#Error-enum">QCamera::Error</a></span> <i>value</i>)</h3>
<p>Signal emitted when error state changes to <i>value</i>.</p>
<p><b>Note:</b> Signal <i>error</i> is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:<pre class="cpp">
connect(camera<span class="operator">,</span> <span class="keyword">static_cast</span><span class="operator"><</span><span class="type">void</span>(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span><span class="operator">*</span>)(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>Error)<span class="operator">></span>(<span class="operator">&</span><span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>error)<span class="operator">,</span>
<span class="operator">[</span><span class="operator">=</span><span class="operator">]</span>(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>Error value){ <span class="comment">/* ... */</span> });
</pre>
<!-- @@@error -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn" id="errorString"><a name="errorString"></a><span class="type">QString</span> QCamera::<span class="name">errorString</span>() const</h3>
<p>Returns a string describing a camera's error state.</p>
<!-- @@@errorString -->
<!-- $$$exposure[overload1]$$$exposure -->
<h3 class="fn" id="exposure"><a name="exposure"></a><span class="type"><a href="qcameraexposure.html">QCameraExposure</a></span> *QCamera::<span class="name">exposure</span>() const</h3>
<p>Returns the camera exposure control object.</p>
<!-- @@@exposure -->
<!-- $$$focus[overload1]$$$focus -->
<h3 class="fn" id="focus"><a name="focus"></a><span class="type"><a href="qcamerafocus.html">QCameraFocus</a></span> *QCamera::<span class="name">focus</span>() const</h3>
<p>Returns the camera focus control object.</p>
<!-- @@@focus -->
<!-- $$$imageProcessing[overload1]$$$imageProcessing -->
<h3 class="fn" id="imageProcessing"><a name="imageProcessing"></a><span class="type"><a href="qcameraimageprocessing.html">QCameraImageProcessing</a></span> *QCamera::<span class="name">imageProcessing</span>() const</h3>
<p>Returns the camera image processing control object.</p>
<!-- @@@imageProcessing -->
<!-- $$$isCaptureModeSupported[overload1]$$$isCaptureModeSupportedCaptureModes -->
<h3 class="fn" id="isCaptureModeSupported"><a name="isCaptureModeSupported"></a><span class="type">bool</span> QCamera::<span class="name">isCaptureModeSupported</span>(<span class="type"><a href="qcamera.html#CaptureMode-enum">CaptureModes</a></span> <i>mode</i>) const</h3>
<p>Returns true if the capture <i>mode</i> is suported.</p>
<!-- @@@isCaptureModeSupported -->
<!-- $$$load[overload1]$$$load -->
<h3 class="fn" id="load"><a name="load"></a><code>[slot] </code><span class="type">void</span> QCamera::<span class="name">load</span>()</h3>
<p>Open the camera device. The camera state is changed to <a href="qcamera.html#Status-enum">QCamera::LoadedStatus</a>.</p>
<p>It's not necessary to explcitly load the camera, unless unless the application have to read the supported camera settings and change the default depending on the camera capabilities.</p>
<p>In all the other cases it's possible to start the camera directly from unloaded state.</p>
<!-- @@@load -->
<!-- $$$lockFailed[overload1]$$$lockFailed -->
<h3 class="fn" id="lockFailed"><a name="lockFailed"></a><code>[signal] </code><span class="type">void</span> QCamera::<span class="name">lockFailed</span>()</h3>
<p>Signals locking of at least one requested camera settings failed.</p>
<!-- @@@lockFailed -->
<!-- $$$lockStatus -->
<h3 class="fn" id="lockStatus"><a name="lockStatus"></a><span class="type"><a href="qcamera.html#LockStatus-enum">QCamera::LockStatus</a></span> QCamera::<span class="name">lockStatus</span>() const</h3>
<p>Returns the status of requested camera settings locks.</p>
<p><b>Note:</b> Getter function for property <a href="qcamera.html#lockStatus-prop">lockStatus</a>. </p><!-- @@@lockStatus -->
<!-- $$$lockStatus -->
<h3 class="fn" id="lockStatus-1"><a name="lockStatus-1"></a><span class="type"><a href="qcamera.html#LockStatus-enum">QCamera::LockStatus</a></span> QCamera::<span class="name">lockStatus</span>(<span class="type"><a href="qcamera.html#LockType-enum">QCamera::LockType</a></span> <i>lockType</i>) const</h3>
<p>Returns the lock status for a given <i>lockType</i>.</p>
<p><b>Note:</b> Getter function for property <a href="qcamera.html#lockStatus-prop">lockStatus</a>. </p><!-- @@@lockStatus -->
<!-- $$$lockStatusChanged -->
<h3 class="fn" id="lockStatusChanged"><a name="lockStatusChanged"></a><code>[signal] </code><span class="type">void</span> QCamera::<span class="name">lockStatusChanged</span>(<span class="type"><a href="qcamera.html#LockStatus-enum">QCamera::LockStatus</a></span> <i>status</i>, <span class="type"><a href="qcamera.html#LockChangeReason-enum">QCamera::LockChangeReason</a></span> <i>reason</i>)</h3>
<p>Signals the overall <i>status</i> for all the requested camera locks was changed with specified <i>reason</i>.</p>
<p><b>Note:</b> Signal <i>lockStatusChanged</i> is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:<pre class="cpp">
connect(camera<span class="operator">,</span> <span class="keyword">static_cast</span><span class="operator"><</span><span class="type">void</span>(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span><span class="operator">*</span>)(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockStatus<span class="operator">,</span> <span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockChangeReason)<span class="operator">></span>(<span class="operator">&</span><span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>lockStatusChanged)<span class="operator">,</span>
<span class="operator">[</span><span class="operator">=</span><span class="operator">]</span>(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockStatus status<span class="operator">,</span> <span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockChangeReason reason){ <span class="comment">/* ... */</span> });
</pre>
<p><b>Note:</b> Notifier signal for property <a href="qcamera.html#lockStatus-prop">lockStatus</a>. </p><!-- @@@lockStatusChanged -->
<!-- $$$lockStatusChanged -->
<h3 class="fn" id="lockStatusChanged-1"><a name="lockStatusChanged-1"></a><code>[signal] </code><span class="type">void</span> QCamera::<span class="name">lockStatusChanged</span>(<span class="type"><a href="qcamera.html#LockType-enum">QCamera::LockType</a></span> <i>lock</i>, <span class="type"><a href="qcamera.html#LockStatus-enum">QCamera::LockStatus</a></span> <i>status</i>, <span class="type"><a href="qcamera.html#LockChangeReason-enum">QCamera::LockChangeReason</a></span> <i>reason</i>)</h3>
<p>Signals the <i>lock</i> <i>status</i> was changed with specified <i>reason</i>.</p>
<p><b>Note:</b> Signal <i>lockStatusChanged</i> is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:<pre class="cpp">
connect(camera<span class="operator">,</span> <span class="keyword">static_cast</span><span class="operator"><</span><span class="type">void</span>(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span><span class="operator">*</span>)(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockType<span class="operator">,</span> <span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockStatus<span class="operator">,</span> <span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockChangeReason)<span class="operator">></span>(<span class="operator">&</span><span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>lockStatusChanged)<span class="operator">,</span>
<span class="operator">[</span><span class="operator">=</span><span class="operator">]</span>(<span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockType lock<span class="operator">,</span> <span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockStatus status<span class="operator">,</span> <span class="type"><a href="qcamera.html#QCamera">QCamera</a></span><span class="operator">::</span>LockChangeReason reason){ <span class="comment">/* ... */</span> });
</pre>
<p><b>Note:</b> Notifier signal for property <a href="qcamera.html#lockStatus-prop">lockStatus</a>. </p><!-- @@@lockStatusChanged -->
<!-- $$$locked[overload1]$$$locked -->
<h3 class="fn" id="locked"><a name="locked"></a><code>[signal] </code><span class="type">void</span> QCamera::<span class="name">locked</span>()</h3>
<p>Signals all the requested camera settings are locked.</p>
<!-- @@@locked -->
<!-- $$$requestedLocks[overload1]$$$requestedLocks -->
<h3 class="fn" id="requestedLocks"><a name="requestedLocks"></a><span class="type"><a href="qcamera.html#LockType-enum">QCamera::LockTypes</a></span> QCamera::<span class="name">requestedLocks</span>() const</h3>
<p>Returns the requested lock types.</p>
<!-- @@@requestedLocks -->
<!-- $$$searchAndLock[overload1]$$$searchAndLock -->
<h3 class="fn" id="searchAndLock"><a name="searchAndLock"></a><code>[slot] </code><span class="type">void</span> QCamera::<span class="name">searchAndLock</span>()</h3>
<p>Lock all the supported camera settings.</p>
<!-- @@@searchAndLock -->
<!-- $$$searchAndLock$$$searchAndLockQCamera::LockTypes -->
<h3 class="fn" id="searchAndLock-1"><a name="searchAndLock-1"></a><code>[slot] </code><span class="type">void</span> QCamera::<span class="name">searchAndLock</span>(<span class="type"><a href="qcamera.html#LockType-enum">QCamera::LockTypes</a></span> <i>locks</i>)</h3>
<p>Locks the camera settings with the requested <i>locks</i>, including focusing in the single autofocus mode, exposure and white balance if the exposure and white balance modes are not manual.</p>
<p>The camera settings are usually locked before taking one or multiple still images, in responce to the shutter button being half pressed.</p>
<p>The <a href="qcamera.html#locked">QCamera::locked</a>() signal is emitted when camera settings are successfully locked, otherwise <a href="qcamera.html#lockFailed">QCamera::lockFailed</a>() is emitted.</p>
<p><a href="qcamera.html">QCamera</a> also emits <a href="qcamera.html#lockStatusChanged">lockStatusChanged</a>(<a href="qcamera.html#LockType-enum">QCamera::LockType</a>, <a href="qcamera.html#LockStatus-enum">QCamera::LockStatus</a>) on individual lock status changes and <a href="qcamera.html#lockStatusChanged">lockStatusChanged</a>(<a href="qcamera.html#LockStatus-enum">QCamera::LockStatus</a>) signal on composite status changes.</p>
<p>Locking serves two roles: it initializes calculation of automatic parameter (focusing, calculating the correct exposure and white balance) and allows to keep some or all of those parameters during number of shots.</p>
<p>If the camera doesn't support keeping one of parameters between shots, the related lock state changes to <a href="qcamera.html#LockStatus-enum">QCamera::Unlocked</a>.</p>
<p>It's also acceptable to relock already locked settings, depending on the lock parameter this initiates new focusing, exposure or white balance calculation.</p>
<!-- @@@searchAndLock -->
<!-- $$$setViewfinder[overload1]$$$setViewfinderQVideoWidget* -->
<h3 class="fn" id="setViewfinder"><a name="setViewfinder"></a><span class="type">void</span> QCamera::<span class="name">setViewfinder</span>(<span class="type"><a href="qvideowidget.html">QVideoWidget</a></span> *<i>viewfinder</i>)</h3>
<p>Sets the <a href="qvideowidget.html">QVideoWidget</a> based camera <i>viewfinder</i>. The previously set viewfinder is detached.</p>
<!-- @@@setViewfinder -->
<!-- $$$setViewfinder$$$setViewfinderQGraphicsVideoItem* -->
<h3 class="fn" id="setViewfinder-1"><a name="setViewfinder-1"></a><span class="type">void</span> QCamera::<span class="name">setViewfinder</span>(<span class="type"><a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a></span> *<i>viewfinder</i>)</h3>
<p>Sets the <a href="qgraphicsvideoitem.html">QGraphicsVideoItem</a> based camera <i>viewfinder</i>. The previously set viewfinder is detached.</p>
<!-- @@@setViewfinder -->
<!-- $$$setViewfinder$$$setViewfinderQAbstractVideoSurface* -->
<h3 class="fn" id="setViewfinder-2"><a name="setViewfinder-2"></a><span class="type">void</span> QCamera::<span class="name">setViewfinder</span>(<span class="type"><a href="qabstractvideosurface.html">QAbstractVideoSurface</a></span> *<i>surface</i>)</h3>
<p>Sets a video <i>surface</i> as the viewfinder of a camera.</p>
<p>If a viewfinder has already been set on the camera the new surface will replace it.</p>
<!-- @@@setViewfinder -->
<!-- $$$setViewfinderSettings[overload1]$$$setViewfinderSettingsconstQCameraViewfinderSettings& -->
<h3 class="fn" id="setViewfinderSettings"><a name="setViewfinderSettings"></a><span class="type">void</span> QCamera::<span class="name">setViewfinderSettings</span>(const <span class="type"><a href="qcameraviewfindersettings.html">QCameraViewfinderSettings</a></span> &<i>settings</i>)</h3>
<p>Sets the viewfinder <i>settings</i>.</p>
<p>If some parameters are not specified, or null settings are passed, the camera will choose default values.</p>
<p>If the camera is used to capture videos or images, the viewfinder settings might be ignored if they conflict with the capture settings. You can check the actual viewfinder settings once the camera is in the <code>QCamera::ActiveStatus</code> status.</p>
<p>Changing the viewfinder settings while the camera is in the <a href="qcamera.html#State-enum">QCamera::ActiveState</a> state may cause the camera to be restarted.</p>
<p>This function was introduced in Qt 5.5.</p>
<p><b>See also </b><a href="qcamera.html#viewfinderSettings">viewfinderSettings</a>(), <a href="qcamera.html#supportedViewfinderResolutions">supportedViewfinderResolutions</a>(), <a href="qcamera.html#supportedViewfinderFrameRateRanges">supportedViewfinderFrameRateRanges</a>(), and <a href="qcamera.html#supportedViewfinderPixelFormats">supportedViewfinderPixelFormats</a>().</p>
<!-- @@@setViewfinderSettings -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn" id="start"><a name="start"></a><code>[slot] </code><span class="type">void</span> QCamera::<span class="name">start</span>()</h3>
<p>Starts the camera.</p>
<p>State is changed to <a href="qcamera.html#State-enum">QCamera::ActiveState</a> if camera is started successfully, otherwise <a href="qcamera.html#error">error</a>() signal is emitted.</p>
<p>While the camera state is changed to <a href="qcamera.html#State-enum">QCamera::ActiveState</a>, starting the camera service can be asynchronous with the actual status reported with <a href="qcamera.html#status-prop">QCamera::status</a> property.</p>
<!-- @@@start -->
<!-- $$$stateChanged -->
<h3 class="fn" id="stateChanged"><a name="stateChanged"></a><code>[signal] </code><span class="type">void</span> QCamera::<span class="name">stateChanged</span>(<span class="type"><a href="qcamera.html#State-enum">QCamera::State</a></span> <i>state</i>)</h3>
<p>Signals the camera <i>state</i> has changed.</p>
<p>Usually the state changes is caused by calling <a href="qcamera.html#load">load</a>(), <a href="qcamera.html#unload">unload</a>(), <a href="qcamera.html#start">start</a>() and <a href="qcamera.html#stop">stop</a>(), but the state can also be changed change as a result of camera error.</p>
<p><b>Note:</b> Notifier signal for property <a href="qcamera.html#state-prop">state</a>. </p><!-- @@@stateChanged -->
<!-- $$$statusChanged -->
<h3 class="fn" id="statusChanged"><a name="statusChanged"></a><code>[signal] </code><span class="type">void</span> QCamera::<span class="name">statusChanged</span>(<span class="type"><a href="qcamera.html#Status-enum">QCamera::Status</a></span> <i>status</i>)</h3>
<p>Signals the camera <i>status</i> has changed.</p>
<p><b>Note:</b> Notifier signal for property <a href="qcamera.html#status-prop">status</a>. </p><!-- @@@statusChanged -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn" id="stop"><a name="stop"></a><code>[slot] </code><span class="type">void</span> QCamera::<span class="name">stop</span>()</h3>
<p>Stops the camera. The camera state is changed from <a href="qcamera.html#State-enum">QCamera::ActiveState</a> to <a href="qcamera.html#State-enum">QCamera::LoadedState</a>.</p>
<!-- @@@stop -->
<!-- $$$supportedLocks[overload1]$$$supportedLocks -->
<h3 class="fn" id="supportedLocks"><a name="supportedLocks"></a><span class="type"><a href="qcamera.html#LockType-enum">QCamera::LockTypes</a></span> QCamera::<span class="name">supportedLocks</span>() const</h3>
<p>Returns the lock types, camera supports.</p>
<!-- @@@supportedLocks -->
<!-- $$$supportedViewfinderFrameRateRanges[overload1]$$$supportedViewfinderFrameRateRangesconstQCameraViewfinderSettings& -->
<h3 class="fn" id="supportedViewfinderFrameRateRanges"><a name="supportedViewfinderFrameRateRanges"></a><span class="type">QList</span><<span class="type"><a href="qcamera-frameraterange.html">FrameRateRange</a></span>> QCamera::<span class="name">supportedViewfinderFrameRateRanges</span>(const <span class="type"><a href="qcameraviewfindersettings.html">QCameraViewfinderSettings</a></span> &<i>settings</i> = QCameraViewfinderSettings()) const</h3>
<p>Returns a list of supported viewfinder frame rate ranges.</p>
<p>This is a convenience function which retrieves unique frame rate ranges from the supported settings.</p>
<p>If non null viewfinder <i>settings</i> are passed, the returned list is reduced to frame rate ranges supported with partial <i>settings</i> applied.</p>
<p>The camera must be loaded before calling this function, otherwise the returned list is empty.</p>
<p>This function was introduced in Qt 5.5.</p>
<p><b>See also </b><a href="qcameraviewfindersettings.html#minimumFrameRate">QCameraViewfinderSettings::minimumFrameRate</a>(), <a href="qcameraviewfindersettings.html#maximumFrameRate">QCameraViewfinderSettings::maximumFrameRate</a>(), and <a href="qcamera.html#setViewfinderSettings">setViewfinderSettings</a>().</p>
<!-- @@@supportedViewfinderFrameRateRanges -->
<!-- $$$supportedViewfinderPixelFormats[overload1]$$$supportedViewfinderPixelFormatsconstQCameraViewfinderSettings& -->
<h3 class="fn" id="supportedViewfinderPixelFormats"><a name="supportedViewfinderPixelFormats"></a><span class="type">QList</span><<span class="type"><a href="qvideoframe.html#PixelFormat-enum">QVideoFrame::PixelFormat</a></span>> QCamera::<span class="name">supportedViewfinderPixelFormats</span>(const <span class="type"><a href="qcameraviewfindersettings.html">QCameraViewfinderSettings</a></span> &<i>settings</i> = QCameraViewfinderSettings()) const</h3>
<p>Returns a list of supported viewfinder pixel formats.</p>
<p>This is a convenience function which retrieves unique pixel formats from the supported settings.</p>
<p>If non null viewfinder <i>settings</i> are passed, the returned list is reduced to pixel formats supported with partial <i>settings</i> applied.</p>
<p>The camera must be loaded before calling this function, otherwise the returned list is empty.</p>
<p>This function was introduced in Qt 5.5.</p>
<p><b>See also </b><a href="qcameraviewfindersettings.html#pixelFormat">QCameraViewfinderSettings::pixelFormat</a>() and <a href="qcamera.html#setViewfinderSettings">setViewfinderSettings</a>().</p>
<!-- @@@supportedViewfinderPixelFormats -->
<!-- $$$supportedViewfinderResolutions[overload1]$$$supportedViewfinderResolutionsconstQCameraViewfinderSettings& -->
<h3 class="fn" id="supportedViewfinderResolutions"><a name="supportedViewfinderResolutions"></a><span class="type">QList</span><<span class="type">QSize</span>> QCamera::<span class="name">supportedViewfinderResolutions</span>(const <span class="type"><a href="qcameraviewfindersettings.html">QCameraViewfinderSettings</a></span> &<i>settings</i> = QCameraViewfinderSettings()) const</h3>
<p>Returns a list of supported viewfinder resolutions.</p>
<p>This is a convenience function which retrieves unique resolutions from the supported settings.</p>
<p>If non null viewfinder <i>settings</i> are passed, the returned list is reduced to resolutions supported with partial <i>settings</i> applied.</p>
<p>The camera must be loaded before calling this function, otherwise the returned list is empty.</p>
<p>This function was introduced in Qt 5.5.</p>
<p><b>See also </b><a href="qcameraviewfindersettings.html#resolution">QCameraViewfinderSettings::resolution</a>() and <a href="qcamera.html#setViewfinderSettings">setViewfinderSettings</a>().</p>
<!-- @@@supportedViewfinderResolutions -->
<!-- $$$supportedViewfinderSettings[overload1]$$$supportedViewfinderSettingsconstQCameraViewfinderSettings& -->
<h3 class="fn" id="supportedViewfinderSettings"><a name="supportedViewfinderSettings"></a><span class="type">QList</span><<span class="type"><a href="qcameraviewfindersettings.html">QCameraViewfinderSettings</a></span>> QCamera::<span class="name">supportedViewfinderSettings</span>(const <span class="type"><a href="qcameraviewfindersettings.html">QCameraViewfinderSettings</a></span> &<i>settings</i> = QCameraViewfinderSettings()) const</h3>
<p>Returns a list of supported viewfinder settings.</p>
<p>The list is ordered by preference; preferred settings come first.</p>
<p>The optional <i>settings</i> argument can be used to conveniently filter the results. If <i>settings</i> is non null, the returned list is reduced to settings matching the given partial <i>settings</i>.</p>
<p>The camera must be loaded before calling this function, otherwise the returned list is empty.</p>
<p>This function was introduced in Qt 5.5.</p>
<p><b>See also </b><a href="qcamera.html#setViewfinderSettings">setViewfinderSettings</a>(), <a href="qcamera.html#supportedViewfinderResolutions">supportedViewfinderResolutions</a>(), <a href="qcamera.html#supportedViewfinderFrameRateRanges">supportedViewfinderFrameRateRanges</a>(), and <a href="qcamera.html#supportedViewfinderPixelFormats">supportedViewfinderPixelFormats</a>().</p>
<!-- @@@supportedViewfinderSettings -->
<!-- $$$unload[overload1]$$$unload -->
<h3 class="fn" id="unload"><a name="unload"></a><code>[slot] </code><span class="type">void</span> QCamera::<span class="name">unload</span>()</h3>
<p>Close the camera device and deallocate the related resources. The camera state is changed to <a href="qcamera.html#Status-enum">QCamera::UnloadedStatus</a>.</p>
<!-- @@@unload -->
<!-- $$$unlock[overload1]$$$unlock -->
<h3 class="fn" id="unlock"><a name="unlock"></a><code>[slot] </code><span class="type">void</span> QCamera::<span class="name">unlock</span>()</h3>
<p>Unlock all the requested camera locks.</p>
<!-- @@@unlock -->
<!-- $$$unlock$$$unlockQCamera::LockTypes -->
<h3 class="fn" id="unlock-1"><a name="unlock-1"></a><code>[slot] </code><span class="type">void</span> QCamera::<span class="name">unlock</span>(<span class="type"><a href="qcamera.html#LockType-enum">QCamera::LockTypes</a></span> <i>locks</i>)</h3>
<p>Unlocks the camera settings specified with <i>locks</i> or cancel the current locking if one is active.</p>
<!-- @@@unlock -->
<!-- $$$viewfinderSettings[overload1]$$$viewfinderSettings -->
<h3 class="fn" id="viewfinderSettings"><a name="viewfinderSettings"></a><span class="type"><a href="qcameraviewfindersettings.html">QCameraViewfinderSettings</a></span> QCamera::<span class="name">viewfinderSettings</span>() const</h3>
<p>Returns the viewfinder settings being used by the camera.</p>
<p>Settings may change when the camera is started, for example if the viewfinder settings are undefined or if unsupported values are set.</p>
<p>If viewfinder settings are not supported by the camera, it always returns a null <a href="qcameraviewfindersettings.html">QCameraViewfinderSettings</a> object.</p>
<p>This function was introduced in Qt 5.5.</p>
<p><b>See also </b><a href="qcamera.html#setViewfinderSettings">setViewfinderSettings</a>().</p>
<!-- @@@viewfinderSettings -->
</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>
