[0.11] gst-plugins-bad: docs: Add more sections to the gst-libs API docs

Wim Taymans wtay at kemper.freedesktop.org
Tue Sep 6 07:14:36 PDT 2011 

Module: gst-plugins-bad
Branch: 0.11
Commit: 5655bdc75d28e3435edb313c684d769699144399
URL:    http://cgit.freedesktop.org/gstreamer/gst-plugins-bad/commit/?id=5655bdc75d28e3435edb313c684d769699144399

Author: Edward Hervey <edward.hervey at collabora.co.uk>
Date:   Wed Aug 31 10:10:21 2011 +0200

docs: Add more sections to the gst-libs API docs

---

 docs/libs/Makefile.am                       |    7 +-
 docs/libs/gst-plugins-bad-libs-docs.sgml    |    8 +
 docs/libs/gst-plugins-bad-libs-sections.txt |  289 +++++++++++++++++++++++++++
 3 files changed, 303 insertions(+), 1 deletions(-)

diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index e8e43a8..e93bbda 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -66,7 +66,12 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
 # this is useful ;)
 
 SCANOBJ_DEPS = \
-	$(top_builddir)/gst-libs/gst/codecparsers/libgstcodecparsers- at GST_MAJORMINOR@.la
+	$(top_builddir)/gst-libs/gst/codecparsers/libgstcodecparsers- at GST_MAJORMINOR@.la \
+	$(top_builddir)/gst-libs/gst/basecamerabinsrc/libgstbasecamerabinsrc- at GST_MAJORMINOR@.la \
+	$(top_builddir)/gst-libs/gst/interfaces/libgstphotography- at GST_MAJORMINOR@.la \
+	$(top_builddir)/gst-libs/gst/signalprocessor/libgstsignalprocessor- at GST_MAJORMINOR@.la \
+	$(top_builddir)/gst-libs/gst/video/libgstbasevideo- at GST_MAJORMINOR@.la
+
 
 # Header files to ignore when scanning.
 IGNORE_HFILES =
diff --git a/docs/libs/gst-plugins-bad-libs-docs.sgml b/docs/libs/gst-plugins-bad-libs-docs.sgml
index b31d641..f137ca3 100644
--- a/docs/libs/gst-plugins-bad-libs-docs.sgml
+++ b/docs/libs/gst-plugins-bad-libs-docs.sgml
@@ -31,6 +31,14 @@
       <xi:include href="xml/gsth264parser.xml" />
       <xi:include href="xml/gstmpegvideoparser.xml" />
     </chapter>
+
+    <chapter id="video">
+      <title>Base video element classes</title>
+      <xi:include href="xml/gstbasevideocodec.xml" />
+      <xi:include href="xml/gstbasevideodecoder.xml" />
+      <xi:include href="xml/gstbasevideoencoder.xml" />
+      <xi:include href="xml/gstbasevideoutils.xml" />
+    </chapter>
   </part>
 
   <part id="gstreamer-libs-hierarchy">
diff --git a/docs/libs/gst-plugins-bad-libs-sections.txt b/docs/libs/gst-plugins-bad-libs-sections.txt
index 251d453..f582562 100644
--- a/docs/libs/gst-plugins-bad-libs-sections.txt
+++ b/docs/libs/gst-plugins-bad-libs-sections.txt
@@ -37,6 +37,7 @@ gst_h264_parser_parse_sps
 gst_h264_parser_parse_pps
 gst_h264_parser_parse_sei
 gst_h264_nal_parser_new
+gst_h264_nal_parser_free
 gst_h264_parse_sps
 gst_h264_parse_pps
 <SUBSECTION Standard>
@@ -70,3 +71,291 @@ gst_mpeg_video_parse_quant_matrix_extension
 <SUBSECTION Standard>
 <SUBSECTION Private>
 </SECTION>
+
+<SECTION>
+<FILE>photography</FILE>
+GST_PHOTOGRAPHY_AUTOFOCUS_DONE
+GST_PHOTOGRAPHY_SHAKE_RISK
+GST_PHOTOGRAPHY_PROP_WB_MODE
+GST_PHOTOGRAPHY_PROP_COLOUR_TONE
+GST_PHOTOGRAPHY_PROP_SCENE_MODE
+GST_PHOTOGRAPHY_PROP_FLASH_MODE
+GST_PHOTOGRAPHY_PROP_NOISE_REDUCTION
+GST_PHOTOGRAPHY_PROP_FOCUS_STATUS
+GST_PHOTOGRAPHY_PROP_CAPABILITIES
+GST_PHOTOGRAPHY_PROP_SHAKE_RISK
+GST_PHOTOGRAPHY_PROP_EV_COMP
+GST_PHOTOGRAPHY_PROP_ISO_SPEED
+GST_PHOTOGRAPHY_PROP_APERTURE
+GST_PHOTOGRAPHY_PROP_EXPOSURE
+GST_PHOTOGRAPHY_PROP_IMAGE_CAPTURE_SUPPORTED_CAPS
+GST_PHOTOGRAPHY_PROP_IMAGE_PREVIEW_SUPPORTED_CAPS
+GST_PHOTOGRAPHY_PROP_FLICKER_MODE
+GST_PHOTOGRAPHY_PROP_FOCUS_MODE
+GST_PHOTOGRAPHY_PROP_ZOOM
+GstPhotographyNoiseReduction
+GstWhiteBalanceMode
+GstColourToneMode
+GstSceneMode
+GstFlashMode
+GstFocusStatus
+GstPhotoCaps
+GstPhotoShakeRisk
+GstFlickerReductionMode
+GstFocusMode
+GstPhotoCapturePrepared
+get_ev_compensation
+get_iso_speed
+get_aperture
+get_exposure
+get_white_balance_mode
+get_colour_tone_mode
+get_scene_mode
+get_flash_mode
+get_zoom
+get_flicker_mode
+get_focus_mode
+set_ev_compensation
+set_iso_speed
+set_aperture
+set_exposure
+set_white_balance_mode
+set_colour_tone_mode
+set_scene_mode
+set_flash_mode
+set_zoom
+set_flicker_mode
+set_focus_mode
+get_capabilities
+prepare_for_capture
+set_autofocus
+set_config
+get_config
+get_noise_reduction
+set_noise_reduction
+gst_photography_get_ev_compensation
+gst_photography_get_iso_speed
+gst_photography_get_aperture
+gst_photography_get_exposure
+gst_photography_get_white_balance_mode
+gst_photography_get_colour_tone_mode
+gst_photography_get_scene_mode
+gst_photography_get_flash_mode
+gst_photography_get_noise_reduction
+gst_photography_get_zoom
+gst_photography_get_flicker_mode
+gst_photography_get_focus_mode
+gst_photography_set_ev_compensation
+gst_photography_set_iso_speed
+gst_photography_set_aperture
+gst_photography_set_exposure
+gst_photography_set_white_balance_mode
+gst_photography_set_colour_tone_mode
+gst_photography_set_scene_mode
+gst_photography_set_flash_mode
+gst_photography_set_noise_reduction
+gst_photography_set_zoom
+gst_photography_set_flicker_mode
+gst_photography_set_focus_mode
+gst_photography_get_capabilities
+gst_photography_prepare_for_capture
+gst_photography_set_autofocus
+gst_photography_set_config
+gst_photography_get_config
+GstPhotography
+<SUBSECTION Standard>
+GST_PHOTOGRAPHY
+GST_IS_PHOTOGRAPHY
+GST_TYPE_PHOTOGRAPHY
+gst_photography_get_type
+GST_PHOTOGRAPHY_GET_IFACE
+</SECTION>
+
+<SECTION>
+<FILE>gstbasecamerasrc</FILE>
+<TITLE>GstBaseCameraSrc</TITLE>
+GST_BASE_CAMERA_SRC_CAST
+GST_BASE_CAMERA_SRC_VIEWFINDER_PAD_NAME
+GST_BASE_CAMERA_SRC_IMAGE_PAD_NAME
+GST_BASE_CAMERA_SRC_VIDEO_PAD_NAME
+GST_BASE_CAMERA_SRC_PREVIEW_MESSAGE_NAME
+GstBaseCameraSrc
+GstBaseCameraSrcClass
+MIN_ZOOM
+MAX_ZOOM
+ZOOM_1X
+gst_base_camera_src_get_photography
+gst_base_camera_src_get_color_balance
+gst_base_camera_src_set_mode
+gst_base_camera_src_setup_zoom
+gst_base_camera_src_setup_preview
+gst_base_camera_src_finish_capture
+gst_base_camera_src_post_preview
+<SUBSECTION Standard>
+GST_BASE_CAMERA_SRC
+GST_IS_BASE_CAMERA_SRC
+GST_TYPE_BASE_CAMERA_SRC
+gst_base_camera_src_get_type
+GST_BASE_CAMERA_SRC_CLASS
+GST_IS_BASE_CAMERA_SRC_CLASS
+GST_BASE_CAMERA_SRC_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstbasevideoencoder</FILE>
+<TITLE>GstBaseVideoEncoder</TITLE>
+GST_BASE_VIDEO_ENCODER_SINK_NAME
+GST_BASE_VIDEO_ENCODER_SRC_NAME
+GST_BASE_VIDEO_ENCODER_FLOW_DROPPED
+GstBaseVideoEncoder
+GstBaseVideoEncoderClass
+gst_base_video_encoder_get_state
+gst_base_video_encoder_get_oldest_frame
+gst_base_video_encoder_finish_frame
+gst_base_video_encoder_set_latency
+gst_base_video_encoder_set_latency_fields
+<SUBSECTION Standard>
+GST_BASE_VIDEO_ENCODER
+GST_IS_BASE_VIDEO_ENCODER
+GST_TYPE_BASE_VIDEO_ENCODER
+gst_base_video_encoder_get_type
+GST_BASE_VIDEO_ENCODER_CLASS
+GST_IS_BASE_VIDEO_ENCODER_CLASS
+GST_BASE_VIDEO_ENCODER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstbasevideodecoder</FILE>
+<TITLE>GstBaseVideoDecoder</TITLE>
+GST_BASE_VIDEO_DECODER_SINK_NAME
+GST_BASE_VIDEO_DECODER_SRC_NAME
+GST_BASE_VIDEO_DECODER_FLOW_NEED_DATA
+GST_BASE_VIDEO_DECODER_FLOW_DROPPED
+GST_BASE_AUDIO_DECODER_ERROR
+GstBaseVideoDecoder
+GstBaseVideoDecoderClass
+gst_base_video_decoder_class_set_capture_pattern
+gst_base_video_decoder_get_frame
+gst_base_video_decoder_get_oldest_frame
+gst_base_video_decoder_add_to_frame
+gst_base_video_decoder_lost_sync
+gst_base_video_decoder_have_frame
+gst_base_video_decoder_set_sync_point
+gst_base_video_decoder_set_src_caps
+gst_base_video_decoder_alloc_src_buffer
+gst_base_video_decoder_alloc_src_frame
+gst_base_video_decoder_get_state
+gst_base_video_decoder_get_max_decode_time
+gst_base_video_decoder_finish_frame
+<SUBSECTION Standard>
+GST_BASE_VIDEO_DECODER
+GST_IS_BASE_VIDEO_DECODER
+GST_TYPE_BASE_VIDEO_DECODER
+gst_base_video_decoder_get_type
+GST_BASE_VIDEO_DECODER_CLASS
+GST_IS_BASE_VIDEO_DECODER_CLASS
+GST_BASE_VIDEO_DECODER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstbasevideocodec</FILE>
+<TITLE>GstBaseVideoCodec</TITLE>
+GST_BASE_VIDEO_CODEC_SINK_NAME
+GST_BASE_VIDEO_CODEC_SRC_NAME
+GST_BASE_VIDEO_CODEC_SRC_PAD
+GST_BASE_VIDEO_CODEC_SINK_PAD
+GST_BASE_VIDEO_CODEC_FLOW_NEED_DATA
+GST_BASE_VIDEO_CODEC_STREAM_LOCK
+GST_BASE_VIDEO_CODEC_STREAM_UNLOCK
+GstVideoState
+GstVideoFrame
+GstBaseVideoCodec
+GstBaseVideoCodecClass
+gst_base_video_codec_new_frame
+gst_base_video_codec_free_frame
+<SUBSECTION Standard>
+GST_BASE_VIDEO_CODEC
+GST_IS_BASE_VIDEO_CODEC
+GST_TYPE_BASE_VIDEO_CODEC
+gst_base_video_codec_get_type
+GST_BASE_VIDEO_CODEC_CLASS
+GST_IS_BASE_VIDEO_CODEC_CLASS
+GST_BASE_VIDEO_CODEC_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gstsignalprocessor</FILE>
+<TITLE>GstSignalProcessor</TITLE>
+GstSignalProcessorClassFlags
+GST_SIGNAL_PROCESSOR_CLASS_CAN_PROCESS_IN_PLACE
+GST_SIGNAL_PROCESSOR_CLASS_SET_CAN_PROCESS_IN_PLACE
+GstSignalProcessorState
+GST_SIGNAL_PROCESSOR_IS_INITIALIZED
+GST_SIGNAL_PROCESSOR_IS_RUNNING
+GstSignalProcessorGroup
+GstSignalProcessor
+GstSignalProcessorClass
+gst_signal_processor_class_add_pad_template
+<SUBSECTION Standard>
+GST_SIGNAL_PROCESSOR
+GST_IS_SIGNAL_PROCESSOR
+GST_TYPE_SIGNAL_PROCESSOR
+gst_signal_processor_get_type
+GST_SIGNAL_PROCESSOR_CLASS
+GST_IS_SIGNAL_PROCESSOR_CLASS
+GST_SIGNAL_PROCESSOR_GET_CLASS
+</SECTION>
+
+
+<SECTION>
+<FILE>photography-enumtypes</FILE>
+gst_photography_noise_reduction_get_type
+GST_TYPE_PHOTOGRAPHY_NOISE_REDUCTION
+gst_white_balance_mode_get_type
+GST_TYPE_WHITE_BALANCE_MODE
+gst_colour_tone_mode_get_type
+GST_TYPE_COLOUR_TONE_MODE
+gst_scene_mode_get_type
+GST_TYPE_SCENE_MODE
+gst_flash_mode_get_type
+GST_TYPE_FLASH_MODE
+gst_focus_status_get_type
+GST_TYPE_FOCUS_STATUS
+gst_photo_caps_get_type
+GST_TYPE_PHOTO_CAPS
+gst_photo_shake_risk_get_type
+GST_TYPE_PHOTO_SHAKE_RISK
+gst_flicker_reduction_mode_get_type
+GST_TYPE_FLICKER_REDUCTION_MODE
+gst_focus_mode_get_type
+GST_TYPE_FOCUS_MODE
+</SECTION>
+
+<SECTION>
+<FILE>gstcamerabin-enum</FILE>
+DEFAULT_WIDTH
+DEFAULT_HEIGHT
+DEFAULT_CAPTURE_WIDTH
+DEFAULT_CAPTURE_HEIGHT
+DEFAULT_FPS_N
+DEFAULT_FPS_D
+DEFAULT_ZOOM
+GstCameraBinMode
+GST_TYPE_CAMERABIN_MODE
+gst_camerabin_mode_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gstcamerabinpreview</FILE>
+gst_camerabin_create_preview_pipeline
+gst_camerabin_destroy_preview_pipeline
+gst_camerabin_preview_pipeline_post
+gst_camerabin_preview_set_caps
+</SECTION>
+
+<SECTION>
+<FILE>gstbasevideoutils</FILE>
+gst_base_video_rawvideo_convert
+gst_base_video_encoded_video_convert
+gst_video_state_get_timestamp
+</SECTION>

More information about the gstreamer-commits mailing list