<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcameraviewfindersettingscontrol.cpp -->
<title>QCameraViewfinderSettingsControl 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 >QCameraViewfinderSettingsControl</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="#public-functions">Public Functions</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">QCameraViewfinderSettingsControl Class</h1>
<!-- $$$QCameraViewfinderSettingsControl-brief -->
<p>The <a href="qcameraviewfindersettingscontrol.html">QCameraViewfinderSettingsControl</a> class provides an abstract class for controlling camera viewfinder parameters. <a href="#details">More...</a></p>
<!-- @@@QCameraViewfinderSettingsControl -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCameraViewfinderSettingsControl></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="qcameraviewfindersettingscontrol-members.html">List of all members, including inherited 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"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcameraviewfindersettingscontrol.html#ViewfinderParameter-enum">ViewfinderParameter</a></b> { Resolution, PixelAspectRatio, MinimumFrameRate, MaximumFrameRate, PixelFormat, UserParameter }</td></tr>
</table></div>
<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="qcameraviewfindersettingscontrol.html#dtor.QCameraViewfinderSettingsControl">~QCameraViewfinderSettingsControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraviewfindersettingscontrol.html#isViewfinderParameterSupported">isViewfinderParameterSupported</a></b>(ViewfinderParameter <i>parameter</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcameraviewfindersettingscontrol.html#setViewfinderParameter">setViewfinderParameter</a></b>(ViewfinderParameter <i>parameter</i>, const QVariant &<i>value</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="qcameraviewfindersettingscontrol.html#viewfinderParameter">viewfinderParameter</a></b>(ViewfinderParameter <i>parameter</i>) const = 0</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="qcameraviewfindersettingscontrol.html#QCameraViewfinderSettingsControl">QCameraViewfinderSettingsControl</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
</table></div>
<a name="macros"></a>
<h2 id="macros">Macros</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcameraviewfindersettingscontrol.html#QCameraViewfinderSettingsControl_iid">QCameraViewfinderSettingsControl_iid</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QCameraViewfinderSettingsControl-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qcameraviewfindersettingscontrol.html">QCameraViewfinderSettingsControl</a> class provides an abstract class for controlling camera viewfinder parameters.</p>
<p>The interface name of <a href="qcameraviewfindersettingscontrol.html">QCameraViewfinderSettingsControl</a> is <code>org.qt-project.qt.cameraviewfindersettingscontrol/5.0</code> as defined in <a href="qcameraviewfindersettingscontrol.html#QCameraViewfinderSettingsControl_iid">QCameraViewfinderSettingsControl_iid</a>.</p>
<p><b>Warning:</b> New backends should implement <a href="qcameraviewfindersettingscontrol2.html">QCameraViewfinderSettingsControl2</a> instead. Application developers should request this control only if <a href="qcameraviewfindersettingscontrol2.html">QCameraViewfinderSettingsControl2</a> is not available.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>(), <a href="qcameraviewfindersettingscontrol2.html">QCameraViewfinderSettingsControl2</a>, and <a href="qcamera.html">QCamera</a>.</p>
<!-- @@@QCameraViewfinderSettingsControl -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$ViewfinderParameter$$$Resolution$$$PixelAspectRatio$$$MinimumFrameRate$$$MaximumFrameRate$$$PixelFormat$$$UserParameter -->
<h3 class="fn" id="ViewfinderParameter-enum"><a name="ViewfinderParameter-enum"></a>enum QCameraViewfinderSettingsControl::<span class="name">ViewfinderParameter</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>QCameraViewfinderSettingsControl::Resolution</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Viewfinder resolution, QSize.</td></tr>
<tr><td class="topAlign"><code>QCameraViewfinderSettingsControl::PixelAspectRatio</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Pixel aspect ratio, QSize as in <a href="qvideosurfaceformat.html#pixelAspectRatio">QVideoSurfaceFormat::pixelAspectRatio</a></td></tr>
<tr><td class="topAlign"><code>QCameraViewfinderSettingsControl::MinimumFrameRate</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Minimum viewfinder frame rate, qreal</td></tr>
<tr><td class="topAlign"><code>QCameraViewfinderSettingsControl::MaximumFrameRate</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Maximum viewfinder frame rate, qreal</td></tr>
<tr><td class="topAlign"><code>QCameraViewfinderSettingsControl::PixelFormat</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">Viewfinder pixel format, <a href="qvideoframe.html#PixelFormat-enum">QVideoFrame::PixelFormat</a></td></tr>
<tr><td class="topAlign"><code>QCameraViewfinderSettingsControl::UserParameter</code></td><td class="topAlign tblval"><code>1000</code></td><td class="topAlign">The base value for platform specific extended parameters. For such parameters the sequential values starting from UserParameter should be used.</td></tr>
</table></div>
<!-- @@@ViewfinderParameter -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCameraViewfinderSettingsControl[overload1]$$$QCameraViewfinderSettingsControlQObject* -->
<h3 class="fn" id="QCameraViewfinderSettingsControl"><a name="QCameraViewfinderSettingsControl"></a><code>[protected] </code>QCameraViewfinderSettingsControl::<span class="name">QCameraViewfinderSettingsControl</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a camera viewfinder control object with <i>parent</i>.</p>
<!-- @@@QCameraViewfinderSettingsControl -->
<!-- $$$~QCameraViewfinderSettingsControl[overload1]$$$~QCameraViewfinderSettingsControl -->
<h3 class="fn" id="dtor.QCameraViewfinderSettingsControl"><a name="dtor.QCameraViewfinderSettingsControl"></a>QCameraViewfinderSettingsControl::<span class="name">~QCameraViewfinderSettingsControl</span>()</h3>
<p>Destroys the camera viewfinder control object.</p>
<!-- @@@~QCameraViewfinderSettingsControl -->
<!-- $$$isViewfinderParameterSupported[overload1]$$$isViewfinderParameterSupportedViewfinderParameter -->
<h3 class="fn" id="isViewfinderParameterSupported"><a name="isViewfinderParameterSupported"></a><code>[pure virtual] </code><span class="type">bool</span> QCameraViewfinderSettingsControl::<span class="name">isViewfinderParameterSupported</span>(<span class="type"><a href="qcameraviewfindersettingscontrol.html#ViewfinderParameter-enum">ViewfinderParameter</a></span> <i>parameter</i>) const</h3>
<p>Returns true if configuration of viewfinder <i>parameter</i> is supported by camera backend.</p>
<!-- @@@isViewfinderParameterSupported -->
<!-- $$$setViewfinderParameter[overload1]$$$setViewfinderParameterViewfinderParameterconstQVariant& -->
<h3 class="fn" id="setViewfinderParameter"><a name="setViewfinderParameter"></a><code>[pure virtual] </code><span class="type">void</span> QCameraViewfinderSettingsControl::<span class="name">setViewfinderParameter</span>(<span class="type"><a href="qcameraviewfindersettingscontrol.html#ViewfinderParameter-enum">ViewfinderParameter</a></span> <i>parameter</i>, const <span class="type">QVariant</span> &<i>value</i>)</h3>
<p>Set the prefferred <i>value</i> of viewfinder <i>parameter</i>.</p>
<p>Calling this while the camera is active may result in the camera being stopped and reloaded. If video recording is in progress, this call may be ignored.</p>
<p>If an unsupported parameter is specified the camera may fail to load, or the setting may be ignored.</p>
<p>Viewfinder parameters may also depend on other camera settings, especially in video capture mode. If camera configuration conflicts with viewfinder settings, the camara configuration is usually preferred.</p>
<p><b>See also </b><a href="qcameraviewfindersettingscontrol.html#viewfinderParameter">viewfinderParameter</a>().</p>
<!-- @@@setViewfinderParameter -->
<!-- $$$viewfinderParameter[overload1]$$$viewfinderParameterViewfinderParameter -->
<h3 class="fn" id="viewfinderParameter"><a name="viewfinderParameter"></a><code>[pure virtual] </code><span class="type">QVariant</span> QCameraViewfinderSettingsControl::<span class="name">viewfinderParameter</span>(<span class="type"><a href="qcameraviewfindersettingscontrol.html#ViewfinderParameter-enum">ViewfinderParameter</a></span> <i>parameter</i>) const</h3>
<p>Returns the value of viewfinder <i>parameter</i>.</p>
<p><b>See also </b><a href="qcameraviewfindersettingscontrol.html#setViewfinderParameter">setViewfinderParameter</a>().</p>
<!-- @@@viewfinderParameter -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QCameraViewfinderSettingsControl_iid[overload1]$$$QCameraViewfinderSettingsControl_iid -->
<h3 class="fn" id="QCameraViewfinderSettingsControl_iid"><a name="QCameraViewfinderSettingsControl_iid"></a><span class="name">QCameraViewfinderSettingsControl_iid</span></h3>
<p><code>org.qt-project.qt.cameraviewfindersettingscontrol/5.0</code></p>
<p>Defines the interface name of the <a href="qcameraviewfindersettingscontrol.html">QCameraViewfinderSettingsControl</a> class.</p>
<!-- @@@QCameraViewfinderSettingsControl_iid -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
