~phil.huang/cheese/bug876834

« back to all changes in this revision

Viewing changes to docs/reference/html/CheeseCamera.html

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha, Robert Ancell
  • Date: 2012-09-21 10:21:01 UTC
  • mfrom: (1.2.40)
  • Revision ID: package-import@ubuntu.com-20120921102101-hij5juzolafuv53p
Tags: 3.5.92-0ubuntu1
[ Robert Ancell ]
* New upstream bugfix release (LP: #1045539)
* debian/control:
  - libcheese3 -> libcheese7
  - libcheese-gtk21 -> libcheese-gtk-23
  - Bump build-depends on libgtk-3-dev, libgstreamer1.0-dev,
    libgstreamer-plugins-base1.0-dev, libclutter-gst-2.0-dev
  - Depend and build-depend on gstreamer1.0-plugins-bad. This is needed until
    gstreamer1.0-plugins-good is patched to included the camerabin plugins.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CheeseCamera</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
7
7
<link rel="home" href="index.html" title="Cheese Reference Manual">
8
8
<link rel="up" href="libcheese.html" title="libcheese">
9
9
<link rel="prev" href="cheese-Initializing-libcheese.html" title="Initializing libcheese">
147
147
<p>
148
148
Class for <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a>.
149
149
</p>
150
 
<div class="variablelist"><table border="0">
 
150
<div class="variablelist"><table border="0" class="variablelist">
 
151
<colgroup>
151
152
<col align="left" valign="top">
 
153
<col>
 
154
</colgroup>
152
155
<tbody>
153
156
<tr>
154
157
<td><p><span class="term"><em class="structfield"><code><a name="CheeseCameraClass.photo-saved"></a>photo_saved</code></em> ()</span></p></td>
188
191
<p>
189
192
Create a new <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a> object.
190
193
</p>
191
 
<div class="variablelist"><table border="0">
 
194
<div class="variablelist"><table border="0" class="variablelist">
 
195
<colgroup>
192
196
<col align="left" valign="top">
 
197
<col>
 
198
</colgroup>
193
199
<tbody>
194
200
<tr>
195
201
<td><p><span class="term"><em class="parameter"><code>video_texture</code></em> :</span></p></td>
225
231
Get the list of <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> objects, representing active video
226
232
capture devices on the system.
227
233
</p>
228
 
<div class="variablelist"><table border="0">
 
234
<div class="variablelist"><table border="0" class="variablelist">
 
235
<colgroup>
229
236
<col align="left" valign="top">
 
237
<col>
 
238
</colgroup>
230
239
<tbody>
231
240
<tr>
232
241
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
250
259
<p>
251
260
Get the <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> that is currently set on the <em class="parameter"><code>camera</code></em>.
252
261
</p>
253
 
<div class="variablelist"><table border="0">
 
262
<div class="variablelist"><table border="0" class="variablelist">
 
263
<colgroup>
254
264
<col align="left" valign="top">
 
265
<col>
 
266
</colgroup>
255
267
<tbody>
256
268
<tr>
257
269
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
274
286
Gets the list of <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> supported by the selected
275
287
<a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> on the <em class="parameter"><code>camera</code></em>.
276
288
</p>
277
 
<div class="variablelist"><table border="0">
 
289
<div class="variablelist"><table border="0" class="variablelist">
 
290
<colgroup>
278
291
<col align="left" valign="top">
 
292
<col>
 
293
</colgroup>
279
294
<tbody>
280
295
<tr>
281
296
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
300
315
Sets a <a class="link" href="CheeseCameraDevice.html#CheeseVideoFormat"><span class="type">CheeseVideoFormat</span></a> on a <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a>, restarting the video stream if
301
316
necessary.
302
317
</p>
303
 
<div class="variablelist"><table border="0">
 
318
<div class="variablelist"><table border="0" class="variablelist">
 
319
<colgroup>
304
320
<col align="left" valign="top">
 
321
<col>
 
322
</colgroup>
305
323
<tbody>
306
324
<tr>
307
325
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
323
341
<p>
324
342
Get the currently-selected <a class="link" href="CheeseCameraDevice.html" title="CheeseCameraDevice"><span class="type">CheeseCameraDevice</span></a> of the <em class="parameter"><code>camera</code></em>.
325
343
</p>
326
 
<div class="variablelist"><table border="0">
 
344
<div class="variablelist"><table border="0" class="variablelist">
 
345
<colgroup>
327
346
<col align="left" valign="top">
 
347
<col>
 
348
</colgroup>
328
349
<tbody>
329
350
<tr>
330
351
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
350
371
Set the active video capture device of the <em class="parameter"><code>camera</code></em>, matching by device node
351
372
path.
352
373
</p>
353
 
<div class="variablelist"><table border="0">
 
374
<div class="variablelist"><table border="0" class="variablelist">
 
375
<colgroup>
354
376
<col align="left" valign="top">
 
377
<col>
 
378
</colgroup>
355
379
<tbody>
356
380
<tr>
357
381
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
374
398
<p>
375
399
Set the <em class="parameter"><code>effect</code></em> on the <em class="parameter"><code>camera</code></em>.
376
400
</p>
377
 
<div class="variablelist"><table border="0">
 
401
<div class="variablelist"><table border="0" class="variablelist">
 
402
<colgroup>
378
403
<col align="left" valign="top">
 
404
<col>
 
405
</colgroup>
379
406
<tbody>
380
407
<tr>
381
408
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
403
430
Get the minimum, maximum and default values for the requested <em class="parameter"><code>property</code></em> of
404
431
the <em class="parameter"><code>camera</code></em>.
405
432
</p>
406
 
<div class="variablelist"><table border="0">
 
433
<div class="variablelist"><table border="0" class="variablelist">
 
434
<colgroup>
407
435
<col align="left" valign="top">
 
436
<col>
 
437
</colgroup>
408
438
<tbody>
409
439
<tr>
410
440
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
447
477
<p>
448
478
Set the requested <em class="parameter"><code>property</code></em> on the <em class="parameter"><code>camera</code></em> to <em class="parameter"><code>value</code></em>.
449
479
</p>
450
 
<div class="variablelist"><table border="0">
 
480
<div class="variablelist"><table border="0" class="variablelist">
 
481
<colgroup>
451
482
<col align="left" valign="top">
 
483
<col>
 
484
</colgroup>
452
485
<tbody>
453
486
<tr>
454
487
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
474
507
Get a string representation of the playing time
475
508
of the current video recording
476
509
</p>
477
 
<div class="variablelist"><table border="0">
 
510
<div class="variablelist"><table border="0" class="variablelist">
 
511
<colgroup>
478
512
<col align="left" valign="top">
 
513
<col>
 
514
</colgroup>
479
515
<tbody>
480
516
<tr>
481
517
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
499
535
<p>
500
536
Connect the supplied <em class="parameter"><code>texture</code></em> to the <em class="parameter"><code>camera</code></em>, using <em class="parameter"><code>effect</code></em>.
501
537
</p>
502
 
<div class="variablelist"><table border="0">
 
538
<div class="variablelist"><table border="0" class="variablelist">
 
539
<colgroup>
503
540
<col align="left" valign="top">
 
541
<col>
 
542
</colgroup>
504
543
<tbody>
505
544
<tr>
506
545
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
528
567
Set the state of the GStreamer pipeline associated with the <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a> to
529
568
playing.
530
569
</p>
531
 
<div class="variablelist"><table border="0">
 
570
<div class="variablelist"><table border="0" class="variablelist">
 
571
<colgroup>
532
572
<col align="left" valign="top">
 
573
<col>
 
574
</colgroup>
533
575
<tbody><tr>
534
576
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
535
577
<td>a <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a>
545
587
Set the state of the GStreamer pipeline associated with the <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a> to
546
588
NULL.
547
589
</p>
548
 
<div class="variablelist"><table border="0">
 
590
<div class="variablelist"><table border="0" class="variablelist">
 
591
<colgroup>
549
592
<col align="left" valign="top">
 
593
<col>
 
594
</colgroup>
550
595
<tbody><tr>
551
596
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
552
597
<td>a <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a>
562
607
<p>
563
608
Start a video recording with the <em class="parameter"><code>camera</code></em> and save it to <em class="parameter"><code>filename</code></em>.
564
609
</p>
565
 
<div class="variablelist"><table border="0">
 
610
<div class="variablelist"><table border="0" class="variablelist">
 
611
<colgroup>
566
612
<col align="left" valign="top">
 
613
<col>
 
614
</colgroup>
567
615
<tbody>
568
616
<tr>
569
617
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
586
634
<p>
587
635
Stop recording video on the <em class="parameter"><code>camera</code></em>.
588
636
</p>
589
 
<div class="variablelist"><table border="0">
 
637
<div class="variablelist"><table border="0" class="variablelist">
 
638
<colgroup>
590
639
<col align="left" valign="top">
 
640
<col>
 
641
</colgroup>
591
642
<tbody><tr>
592
643
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
593
644
<td>a <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a>
602
653
<p>
603
654
Toggle the playing/recording state of the <em class="parameter"><code>camera</code></em>.
604
655
</p>
605
 
<div class="variablelist"><table border="0">
 
656
<div class="variablelist"><table border="0" class="variablelist">
 
657
<colgroup>
606
658
<col align="left" valign="top">
 
659
<col>
 
660
</colgroup>
607
661
<tbody><tr>
608
662
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
609
663
<td>a <a class="link" href="CheeseCamera.html" title="CheeseCamera"><span class="type">CheeseCamera</span></a>
619
673
<p>
620
674
Save a photo taken with the <em class="parameter"><code>camera</code></em> to a new file at <em class="parameter"><code>filename</code></em>.
621
675
</p>
622
 
<div class="variablelist"><table border="0">
 
676
<div class="variablelist"><table border="0" class="variablelist">
 
677
<colgroup>
623
678
<col align="left" valign="top">
 
679
<col>
 
680
</colgroup>
624
681
<tbody>
625
682
<tr>
626
683
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
648
705
Take a photo with the <em class="parameter"><code>camera</code></em> and emit it in the ::capture-start signal as a
649
706
<span class="type">GdkPixbuf</span>.
650
707
</p>
651
 
<div class="variablelist"><table border="0">
 
708
<div class="variablelist"><table border="0" class="variablelist">
 
709
<colgroup>
652
710
<col align="left" valign="top">
 
711
<col>
 
712
</colgroup>
653
713
<tbody>
654
714
<tr>
655
715
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
673
733
<p>
674
734
Control whether the effects pipeline is enabled for <em class="parameter"><code>camera</code></em>.
675
735
</p>
676
 
<div class="variablelist"><table border="0">
 
736
<div class="variablelist"><table border="0" class="variablelist">
 
737
<colgroup>
677
738
<col align="left" valign="top">
 
739
<col>
 
740
</colgroup>
678
741
<tbody>
679
742
<tr>
680
743
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
702
765
Errors that can occur during camera setup, when calling
703
766
<a class="link" href="CheeseCamera.html#cheese-camera-setup" title="cheese_camera_setup ()"><code class="function">cheese_camera_setup()</code></a>.
704
767
</p>
705
 
<div class="variablelist"><table border="0">
 
768
<div class="variablelist"><table border="0" class="variablelist">
 
769
<colgroup>
706
770
<col align="left" valign="top">
 
771
<col>
 
772
</colgroup>
707
773
<tbody>
708
774
<tr>
709
775
<td><p><a name="CHEESE-CAMERA-ERROR-UNKNOWN:CAPS"></a><span class="term"><code class="literal">CHEESE_CAMERA_ERROR_UNKNOWN</code></span></p></td>
733
799
<p>
734
800
Setup a video capture device.
735
801
</p>
736
 
<div class="variablelist"><table border="0">
 
802
<div class="variablelist"><table border="0" class="variablelist">
 
803
<colgroup>
737
804
<col align="left" valign="top">
 
805
<col>
 
806
</colgroup>
738
807
<tbody>
739
808
<tr>
740
809
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
801
870
<p>
802
871
Emitted when a photo was saved to disk.
803
872
</p>
804
 
<div class="variablelist"><table border="0">
 
873
<div class="variablelist"><table border="0" class="variablelist">
 
874
<colgroup>
805
875
<col align="left" valign="top">
 
876
<col>
 
877
</colgroup>
806
878
<tbody>
807
879
<tr>
808
880
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
825
897
<p>
826
898
Emitted when a photo was taken.
827
899
</p>
828
 
<div class="variablelist"><table border="0">
 
900
<div class="variablelist"><table border="0" class="variablelist">
 
901
<colgroup>
829
902
<col align="left" valign="top">
 
903
<col>
 
904
</colgroup>
830
905
<tbody>
831
906
<tr>
832
907
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
849
924
<p>
850
925
Emitted when the state of the <em class="parameter"><code>camera</code></em> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html"><span class="type">GstElement</span></a> changed.
851
926
</p>
852
 
<div class="variablelist"><table border="0">
 
927
<div class="variablelist"><table border="0" class="variablelist">
 
928
<colgroup>
853
929
<col align="left" valign="top">
 
930
<col>
 
931
</colgroup>
854
932
<tbody>
855
933
<tr>
856
934
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>
872
950
<p>
873
951
Emitted when a video was saved to disk.
874
952
</p>
875
 
<div class="variablelist"><table border="0">
 
953
<div class="variablelist"><table border="0" class="variablelist">
 
954
<colgroup>
876
955
<col align="left" valign="top">
 
956
<col>
 
957
</colgroup>
877
958
<tbody>
878
959
<tr>
879
960
<td><p><span class="term"><em class="parameter"><code>camera</code></em> :</span></p></td>