/**
* 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.
*/
* @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)
/**
* 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
*/