← Back to branch summary

~ubuntu-branches/ubuntu/quantal/qtmobility/quantal

« back to all changes in this revision

Viewing changes to doc/html/qcameraimagecapture.html

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-11-16 16:18:07 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20101116161807-k2dzt2nyse975r3l
Tags: 1.1.0-0ubuntu1
* New upstream release
* Syncronise with Debian, no remaining changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qcameraimagecapture.html
47
47
    </div>
48
48
    <div id="shortCut">
49
49
      <ul>
50
 
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1 BETA</a></span></li>
 
50
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1</a></span></li>
51
51
        <li class="shortCut-topleft-active"><a href="http://doc.qt.nokia.com">ALL VERSIONS        </a></li>
52
52
      </ul>
53
53
     </div>
154
154
<h1 class="title">QCameraImageCapture Class Reference</h1>
155
155
<p>The QCameraImageCapture class is used for the recording of media content. <a href="#details">More...</a></p>
156
156
<pre class="highlightedCode brush: cpp"> #include &lt;QCameraImageCapture&gt;</pre><p><b>This class is under development and is subject to change.</b></p>
157
 
<p>Inherits <a href="qmediabindableinterface.html">QMediaBindableInterface</a>.</p>
 
157
<p>Inherits <a href="http://qt.nokia.com/doc/4.6/qobject.html">QObject</a> and <a href="qmediabindableinterface.html">QMediaBindableInterface</a>.</p>
158
158
<ul>
159
159
<li><a href="qcameraimagecapture-members.html">List of all members, including inherited members</a></li>
160
160
</ul>
171
171
<ul>
172
172
<li class="fn"><b><a href="qcameraimagecapture.html#readyForCapture-prop">readyForCapture</a></b> : const bool</li>
173
173
</ul>
 
174
<ul>
 
175
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#properties">QObject</a></li>
 
176
</ul>
174
177
<hr />
175
178
<a name="public-functions"></a>
176
179
<h2>Public Functions</h2>
195
198
<tr><td class="memItemLeft rightAlign topAlign"> virtual QMediaObject * </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapture.html#mediaObject">mediaObject</a></b> () const</td></tr>
196
199
</table>
197
200
<ul>
 
201
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-functions">QObject</a></li>
198
202
<li class="fn">1 public function inherited from <a href="qmediabindableinterface.html#public-functions">QMediaBindableInterface</a></li>
199
203
</ul>
200
204
<hr />
204
208
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapture.html#cancelCapture">cancelCapture</a></b> ()</td></tr>
205
209
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapture.html#capture">capture</a></b> ( const QString &amp; <i>file</i> = QString() )</td></tr>
206
210
</table>
 
211
<ul>
 
212
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-slots">QObject</a></li>
 
213
</ul>
207
214
<hr />
208
215
<a name="signals"></a>
209
216
<h2>Signals</h2>
214
221
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapture.html#imageSaved">imageSaved</a></b> ( int <i>id</i>, const QString &amp; <i>fileName</i> )</td></tr>
215
222
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapture.html#readyForCaptureChanged">readyForCaptureChanged</a></b> ( bool <i>ready</i> )</td></tr>
216
223
</table>
 
224
<ul>
 
225
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#signals">QObject</a></li>
 
226
</ul>
217
227
<hr />
218
228
<a name="reimplemented-protected-functions"></a>
219
229
<h2>Reimplemented Protected Functions</h2>
221
231
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcameraimagecapture.html#setMediaObject">setMediaObject</a></b> ( QMediaObject * <i>mediaObject</i> )</td></tr>
222
232
</table>
223
233
<ul>
224
 
<li class="fn">1 protected function inherited from <a href="qmediabindableinterface.html#protected-functions">QMediaBindableInterface</a></li>
 
234
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-functions">QObject</a></li>
 
235
<li class="fn">1 protected function inherited from <a href="qmediabindableinterface.html#protected-functions">QMediaBindableInterface</a></li>
 
236
</ul>
 
237
<h3>Additional Inherited Members</h3>
 
238
<ul>
 
239
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-variables">QObject</a></li>
 
240
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#static-public-members">QObject</a></li>
 
241
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-functions">QObject</a></li>
 
242
<li class="fn">1 protected function inherited from <a href="qmediabindableinterface.html#protected-functions">QMediaBindableInterface</a></li>
 
243
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-variables">QObject</a></li>
225
244
</ul>
226
245
<a name="details"></a>
227
246
<hr />
253
272
<div class="types"/>
254
273
<h2>Member Type Documentation</h2>
255
274
<h3 class="fn"><a name="DriveMode-enum"></a>enum QCameraImageCapture::DriveMode</h3>
 
275
<table class="valuelist"><tr class="odd"><tr><th>Constant</th><th>Value</th><th>Description</th></tr>
 
276
<tr><td  class="topAlign"><tt>QCameraImageCapture::SingleImageCapture</tt></td><td class=" topAlign"><tt>0</tt></td><td  class="topAlign">Drive mode is capturing a single picture.</td></tr>
 
277
</table>
256
278
<h3 class="fn"><a name="Error-enum"></a>enum QCameraImageCapture::Error</h3>
257
279
<table class="valuelist"><tr class="odd"><tr><th>Constant</th><th>Value</th><th>Description</th></tr>
258
280
<tr><td  class="topAlign"><tt>QCameraImageCapture::NoError</tt></td><td class=" topAlign"><tt>0</tt></td><td  class="topAlign">No Errors.</td></tr>
280
302
<hr />
281
303
<div class="func"/>
282
304
<h2>Member Function Documentation</h2>
283
 
<h3 class="fn"><a name="QCameraImageCapture"></a>QCameraImageCapture::QCameraImageCapture ( <a href="qmediaobject.html">QMediaObject</a> * <i>mediaObject</i>, QObject * <i>parent</i> = 0 )</h3>
 
305
<h3 class="fn"><a name="QCameraImageCapture"></a>QCameraImageCapture::QCameraImageCapture ( <a href="qmediaobject.html">QMediaObject</a> * <i>mediaObject</i>, <a href="http://qt.nokia.com/doc/4.6/qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
284
306
<p>Constructs a media recorder which records the media produced by <i>mediaObject</i>.</p>
285
307
<p>The <i>parent</i> is passed to <a href="qmediaobject.html">QMediaObject</a>.</p>
286
308
<h3 class="fn"><a name="dtor.QCameraImageCapture"></a>QCameraImageCapture::~QCameraImageCapture ()</h3>
289
311
<p>Returns the availability error code.</p>
290
312
<h3 class="fn"><a name="cancelCapture"></a>void QCameraImageCapture::cancelCapture ()<tt> [slot]</tt></h3>
291
313
<p>Cancel incomplete capture requests. Already captured and queused for proicessing images may be discarded.</p>
292
 
<h3 class="fn"><a name="capture"></a>int QCameraImageCapture::capture ( const QString &amp; <i>file</i> = QString() )<tt> [slot]</tt></h3>
 
314
<h3 class="fn"><a name="capture"></a>int QCameraImageCapture::capture ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>file</i> = QString() )<tt> [slot]</tt></h3>
293
315
<p>Capture the image and save it to <i>file</i>. This operation is asynchronous in majority of cases, followed by signals <a href="qcameraimagecapture.html#imageCaptured">QCameraImageCapture::imageCaptured</a>(), <a href="qcameraimagecapture.html#imageSaved">QCameraImageCapture::imageSaved</a>() or <a href="qcameraimagecapture.html#error">QCameraImageCapture::error</a>().</p>
294
316
<p>If an empty <i>file</i> is passed, the camera backend choses the default location and naming scheme for photos on the system, if only file name without full path is specified, the image will be saved to the default directory, with a full path reported with <a href="qcameraimagecapture.html#imageCaptured">imageCaptured</a>() and <a href="qcameraimagecapture.html#imageSaved">imageSaved</a>() signals.</p>
295
317
<p>QCameraImageCapture::capture returns the capture Id parameter, used with <a href="qcameraimagecapture.html#imageExposed">imageExposed</a>(), <a href="qcameraimagecapture.html#imageCaptured">imageCaptured</a>() and <a href="qcameraimagecapture.html#imageSaved">imageSaved</a>() signals.</p>
299
321
<h3 class="fn"><a name="error"></a><a href="qcameraimagecapture.html#Error-enum">Error</a> QCameraImageCapture::error () const</h3>
300
322
<p>Returns the current error state.</p>
301
323
<p>See also <a href="qcameraimagecapture.html#errorString">errorString</a>().</p>
302
 
<h3 class="fn"><a name="error-2"></a>void QCameraImageCapture::error ( int <i>id</i>, <a href="qcameraimagecapture.html#Error-enum">QCameraImageCapture::Error</a> <i>error</i>, const QString &amp; <i>errorString</i> )<tt> [signal]</tt></h3>
 
324
<h3 class="fn"><a name="error-2"></a>void QCameraImageCapture::error ( int <i>id</i>, <a href="qcameraimagecapture.html#Error-enum">QCameraImageCapture::Error</a> <i>error</i>, const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>errorString</i> )<tt> [signal]</tt></h3>
303
325
<p>Signals that the capture request <i>id</i> has failed with an <i>error</i> and <i>errorString</i> description.</p>
304
 
<h3 class="fn"><a name="errorString"></a>QString QCameraImageCapture::errorString () const</h3>
 
326
<h3 class="fn"><a name="errorString"></a><a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> QCameraImageCapture::errorString () const</h3>
305
327
<p>Returns a string describing the current error state.</p>
306
328
<p>See also <a href="qcameraimagecapture.html#error">error</a>().</p>
307
 
<h3 class="fn"><a name="imageCaptured"></a>void QCameraImageCapture::imageCaptured ( int <i>id</i>, const QImage &amp; <i>preview</i> )<tt> [signal]</tt></h3>
 
329
<h3 class="fn"><a name="imageCaptured"></a>void QCameraImageCapture::imageCaptured ( int <i>id</i>, const <a href="http://qt.nokia.com/doc/4.6/qimage.html">QImage</a> &amp; <i>preview</i> )<tt> [signal]</tt></h3>
308
330
<p>Signal emited when the frame with request <i>id</i> was captured, but not processed and saved yet. Frame <i>preview</i> can be displayed to user.</p>
309
 
<h3 class="fn"><a name="imageCodecDescription"></a>QString QCameraImageCapture::imageCodecDescription ( const QString &amp; <i>codec</i> ) const</h3>
 
331
<h3 class="fn"><a name="imageCodecDescription"></a><a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> QCameraImageCapture::imageCodecDescription ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>codec</i> ) const</h3>
310
332
<p>Returns a description of an image <i>codec</i>.</p>
311
333
<h3 class="fn"><a name="imageExposed"></a>void QCameraImageCapture::imageExposed ( int <i>id</i> )<tt> [signal]</tt></h3>
312
334
<p>Signal emited when the frame with request <i>id</i> was exposed.</p>
313
 
<h3 class="fn"><a name="imageSaved"></a>void QCameraImageCapture::imageSaved ( int <i>id</i>, const QString &amp; <i>fileName</i> )<tt> [signal]</tt></h3>
 
335
<h3 class="fn"><a name="imageSaved"></a>void QCameraImageCapture::imageSaved ( int <i>id</i>, const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>fileName</i> )<tt> [signal]</tt></h3>
314
336
<p>Signal emited when the frame with request <i>id</i> was saved to <i>fileName</i>.</p>
315
337
<h3 class="fn"><a name="isAvailable"></a>bool QCameraImageCapture::isAvailable () const</h3>
316
338
<p>Returns true if the images capture service ready to use.</p>
326
348
<h3 class="fn"><a name="setMediaObject"></a>bool QCameraImageCapture::setMediaObject ( <a href="qmediaobject.html">QMediaObject</a> * <i>mediaObject</i> )<tt> [virtual protected]</tt></h3>
327
349
<p>Reimplemented from <a href="qmediabindableinterface.html#setMediaObject">QMediaBindableInterface::setMediaObject</a>().</p>
328
350
<p>See also <a href="qcameraimagecapture.html#mediaObject">mediaObject</a>().</p>
329
 
<h3 class="fn"><a name="supportedImageCodecs"></a>QStringList QCameraImageCapture::supportedImageCodecs () const</h3>
 
351
<h3 class="fn"><a name="supportedImageCodecs"></a><a href="http://qt.nokia.com/doc/4.6/qstringlist.html">QStringList</a> QCameraImageCapture::supportedImageCodecs () const</h3>
330
352
<p>Returns a list of supported image codecs.</p>
331
 
<h3 class="fn"><a name="supportedResolutions"></a>QList&lt;QSize&gt; QCameraImageCapture::supportedResolutions ( const <a href="qimageencodersettings.html">QImageEncoderSettings</a> &amp; <i>settings</i> = QImageEncoderSettings(), bool * <i>continuous</i> = 0 ) const</h3>
 
353
<h3 class="fn"><a name="supportedResolutions"></a><a href="http://qt.nokia.com/doc/4.6/qlist.html">QList</a>&lt;<a href="http://qt.nokia.com/doc/4.6/qsize.html">QSize</a>&gt; QCameraImageCapture::supportedResolutions ( const <a href="qimageencodersettings.html">QImageEncoderSettings</a> &amp; <i>settings</i> = QImageEncoderSettings(), bool * <i>continuous</i> = 0 ) const</h3>
332
354
<p>Returns a list of resolutions images can be encoded at.</p>
333
355
<p>If non null image <i>settings</i> parameter is passed, the returned list is reduced to resolution supported with partial settings like image codec or quality applied.</p>
334
356
<p>If the encoder supports arbitrary resolutions within the supported range, *<i>continuous</i> is set to true, otherwise *<i>continuous</i> is set to false.</p>