mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-20 00:31:13 +00:00
Code Issues 1 Projects Releases Wiki Activity

basecamerasrc: write more details on the api docs

Browse source
This commit is contained in:
Stefan Kost 2010-12-09 12:23:01 +02:00 committed by Thiago Santos
parent 4b23fe6872
commit ba2368d0bc
2 changed files with 27 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
gst/camerabin2/gstbasecamerasrc.c
View file

@ -23,8 +23,30 @@
/**
* SECTION:element-basecamerasrc
*
* Base class for the camera src bin used by camerabin. Indented to be
* subclassed when plugging in more sophisticated cameras.
* Base class for the camera source bin used by camerabin for capture.
* Sophisticated camera hardware can derive from this baseclass and map the
* features to this interface.
*
* The design mandates that the subclasses implement the following features and
* behaviour:
* <itemizedlist>
* <listitem><para>
* 3 pads: viewfinder, image capture, video capture
* </para></listitem>
* <listitem><para>
* </para></listitem>
* </itemizedlist>
*
* During construct_pipeline() vmethod a subclass can add several elements into
* the bin and expose 3 srcs pads as ghostpads implementing the 3 pad templates.
*
* It is also possible to add regular pads from the subclass and implement the
* dataflow methods on these pads. This way all functionality can be implemneted
* directly in the subclass without extra elements.
*
* The src will receive the capture mode from #GstCameraBin2 on the
* #GstBaseCameraSrc:mode property. Possible capture modes are defined in
* #GstCameraBinMode.
*/
@ -130,7 +152,7 @@ gst_base_camera_src_get_color_balance (GstBaseCameraSrc * self)
* @self: the camerasrc bin
* @mode: the mode
*
* XXX
* Set the chosen #GstCameraBinMode capture mode.
*/
gboolean
gst_base_camera_src_set_mode (GstBaseCameraSrc * self, GstCameraBinMode mode)

7
gst/camerabin2/gstbasecamerasrc.h
View file

@ -92,11 +92,8 @@ struct _GstBaseCameraSrc
/**
* GstBaseCameraSrcClass:
* @construct_pipeline: construct pipeline must be implemented by derived
* class, and return by reference vfsrc, imgsrc, and vidsrc pads of the
* contained pipeline, which will be ghosted to the src pads of the
* camerasrc bin (and optionally the preview src pads?)
* @setup_pipeline:
* @construct_pipeline: construct pipeline must be implemented by derived class
* @setup_pipeline: configure pipeline for the chosen settings
* @set_zoom: set the zoom
* @set_mode: set the mode
*/