mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-20 22:28:22 +00:00
Code Issues 1 Projects Releases Wiki Activity

camerabin: smal api doc update

Browse source
This commit is contained in:
Stefan Kost 2010-12-02 15:45:02 +02:00
parent e96b8a7b5f
commit 6e9763a090
1 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
gst/camerabin/gstcamerabin.c
View file

@ -42,6 +42,7 @@
* <refsect2> * <refsect2>
* <title>Image capture</title> * <title>Image capture</title>
* <para> * <para>
* Image capture is selected by switching #GstCameraBin:mode to %MODE_IMAGE.
* Taking still images is initiated with the #GstCameraBin::capture-start action * Taking still images is initiated with the #GstCameraBin::capture-start action
* signal. Once the image has been captured, "image-captured" gst message is * signal. Once the image has been captured, "image-captured" gst message is
* posted to the bus and capturing another image is possible. If application * posted to the bus and capturing another image is possible. If application
@ -63,7 +64,8 @@
* <refsect2> * <refsect2>
* <title>Video capture</title> * <title>Video capture</title>
* <para> * <para>
* Video capture is started with the #GstCameraBin::capture-start action signal * Video capture is selected by switching #GstCameraBin:mode to %MODE_VIDEO.
* The capture is started with the #GstCameraBin::capture-start action signal
* too. In addition to image capture one can use #GstCameraBin::capture-pause to * too. In addition to image capture one can use #GstCameraBin::capture-pause to
* pause recording and #GstCameraBin::capture-stop to end recording. * pause recording and #GstCameraBin::capture-stop to end recording.
* *
@ -87,17 +89,18 @@
* <refsect2> * <refsect2>
* <title>Video and image previews</title> * <title>Video and image previews</title>
* <para> * <para>
* GstCameraBin contains "preview-caps" property, which is used to determine * GstCameraBin contains #GstCameraBin:preview-caps property, which is used to
* whether the application wants a preview image of the captured picture or * determine whether the application wants a preview image of the captured
* video. When set, a GstMessage named "preview-image" will be sent. This * picture or video. When set, a GstMessage named "preview-image" will be sent.
* message will contain a GstBuffer holding the preview image, converted * This message will contain a GstBuffer holding the preview image, converted
* to a format defined by those preview caps. The ownership of the preview * to a format defined by those preview caps. The ownership of the preview
* image is kept in GstCameraBin, so application should ref the preview buffer * image is kept in GstCameraBin, so application should ref the preview buffer
* object if it needs to use it elsewhere than in message handler. * object if it needs to use it elsewhere than in message handler.
* *
* Defining preview caps is done by selecting the capturing mode first and * Defining preview caps is done by selecting the capturing #GstCameraBin:mode
* then setting the property. Camerabin remembers caps separately for both * first and then setting the property. Camerabin remembers caps separately for
* modes, so it is not necessary to set the caps again after changing the mode. * both modes, so it is not necessary to set the caps again after changing the
* mode.
* </para> * </para>
* </refsect2> * </refsect2>
* <refsect2> * <refsect2>