diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2010-12-09 12:23:01 +0200 |
|---|---|---|
| committer | Thiago Santos <thiago.sousa.santos@collabora.co.uk> | 2010-12-23 12:11:59 -0300 |
| commit | ba2368d0bca85363cb66631642b1b5b5cf7cbf44 (patch) | |
| tree | 54b0e3aaa22ea0555a1e9d1f85cbda82718459c4 /gst/camerabin2 | |
| parent | 4b23fe6872ab59055f61193eeadd448dadce001c (diff) | |
basecamerasrc: write more details on the api docs
Diffstat (limited to 'gst/camerabin2')
| -rw-r--r-- | gst/camerabin2/gstbasecamerasrc.c | 28 | ||||
| -rw-r--r-- | gst/camerabin2/gstbasecamerasrc.h | 7 |
2 files changed, 27 insertions, 8 deletions
diff --git a/gst/camerabin2/gstbasecamerasrc.c b/gst/camerabin2/gstbasecamerasrc.c index 24e37ebf8..07487d8f5 100644 --- a/gst/camerabin2/gstbasecamerasrc.c +++ b/gst/camerabin2/gstbasecamerasrc.c @@ -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) diff --git a/gst/camerabin2/gstbasecamerasrc.h b/gst/camerabin2/gstbasecamerasrc.h index 134cdff52..dd74ba81a 100644 --- a/gst/camerabin2/gstbasecamerasrc.h +++ b/gst/camerabin2/gstbasecamerasrc.h @@ -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 */ |