Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 654

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.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>Qt Mobility 1.2: QCameraImageCaptureControl Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtmultimediakit.html">QtMultimediaKit</a></li>
<li>QCameraImageCaptureControl</li>
    </ul>
  </div>
</div>
<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 Reference</h1>
<!-- $$$QCameraImageCaptureControl-brief -->
<p>The QCameraImageCaptureControl class provides a control interface for image capture services. <a href="#details">More...</a></p>
<!-- @@@QCameraImageCaptureControl -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QCameraImageCaptureControl&gt;</span></pre><p><b>Inherits: </b><a href="qmediacontrol.html">QMediaControl</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<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 &amp; <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>
<ul>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<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 &amp; <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 &amp; <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 &amp; <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>, QtMultimediaKit::MetaData <i>key</i>, const QVariant &amp; <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapturecontrol.html#imageMetadataAvailable-2">imageMetadataAvailable</a></b> ( int <i>id</i>, const QString &amp; <i>key</i>, const QVariant &amp; <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 &amp; <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>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<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>
<ul>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
</ul>
<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>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<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>com.nokia.Qt.QCameraImageCaptureControl/1.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"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></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>
<p>This function was introduced in Qt Mobility 1.1.</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"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <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>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>
<p>This function was introduced in Qt Mobility 1.1.</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>This function was introduced in Qt Mobility 1.1.</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"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <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>This function was introduced in Qt Mobility 1.1.</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> &amp; <i>buffer</i> )<tt> [signal]</tt></h3>
<p>Signals that a captured <i>buffer</i> with a <i>requestId</i> is available.</p>
<p>This function was introduced in Qt Mobility 1.2.</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"><a href="http://qt.nokia.com/doc/4.7/qimage.html">QImage</a></span> &amp; <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>
<p>This function was introduced in Qt Mobility 1.1.</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>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@imageExposed -->
<!-- $$$imageMetadataAvailable[overload1]$$$imageMetadataAvailableintQtMultimediaKit::MetaDataconstQVariant& -->
<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>, <span class="type"><a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a></span> <i>key</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> &amp; <i>value</i> )<tt> [signal]</tt></h3>
<p>Signals that a metadata for an image with request <i>id</i> is available. This signal is emitted for metadata <i>value</i> with a <i>key</i> listed in <a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a> enum.</p>
<p>This signal should be emitted between imageExposed and imageSaved signals.</p>
<p>This function was introduced in Qt Mobility 1.2.</p>
<!-- @@@imageMetadataAvailable -->
<!-- $$$imageMetadataAvailable$$$imageMetadataAvailableintconstQString&constQVariant& -->
<h3 class="fn"><a name="imageMetadataAvailable-2"></a><span class="type">void</span> QCameraImageCaptureControl::<span class="name">imageMetadataAvailable</span> ( <span class="type">int</span> <i>id</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>key</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> &amp; <i>value</i> )<tt> [signal]</tt></h3>
<p>Signals that a metadata for an image with request <i>id</i> is available. This signal is emitted for extended metadata <i>value</i> with a <i>key</i> not listed in <a href="qtmultimediakit.html#MetaData-enum">QtMultimediaKit::MetaData</a> enum.</p>
<p>This signal should be emitted between imageExposed and imageSaved signals.</p>
<p>This function was introduced in Qt Mobility 1.2.</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"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <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>
<p>This function was introduced in Qt Mobility 1.1.</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>This function was introduced in Qt Mobility 1.1.</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>
<p>This function was introduced in Qt Mobility 1.1.</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>This function was introduced in Qt Mobility 1.1.</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>com.nokia.Qt.QCameraImageCaptureControl/1.0</tt></p>
<p>Defines the interface name of the <a href="qcameraimagecapturecontrol.html">QCameraImageCaptureControl</a> class.</p>
<!-- @@@QCameraImageCaptureControl_iid -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used 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.</p>
</div>
</body>
</html>