diff --git a/ChangeLog b/ChangeLog index 83de3566f1..480a3acf4e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2008-08-11 Stefan Kost + + * docs/libs/gst-plugins-base-libs-sections.txt: + * gst-libs/gst/audio/gstaudiosrc.h: + More docs and shuffling. What can we do with the hundreds of #defines. + 2008-08-11 Stefan Kost * gst-libs/gst/audio/audio.h: diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index 0548b15947..3a0dc9bc1d 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -313,13 +313,13 @@ gst_cast_float gstcolorbalance gst/interfaces/color.h GstColorBalance +GstColorBalanceClass GstColorBalanceType gst_color_balance_list_channels gst_color_balance_get_value gst_color_balance_set_value gst_color_balance_value_changed -GstColorBalanceClass GST_COLOR_BALANCE GST_COLOR_BALANCE_CLASS GST_COLOR_BALANCE_GET_CLASS @@ -336,8 +336,8 @@ gst_color_balance_type_get_type gstcolorbalancechannel gst/interfaces/colorbalancechannel.h GstColorBalanceChannel - GstColorBalanceChannelClass + GST_COLOR_BALANCE_CHANNEL GST_COLOR_BALANCE_CHANNEL_CLASS GST_IS_COLOR_BALANCE_CHANNEL @@ -381,6 +381,7 @@ gst_mixer_message_parse_volume_changed gst_mixer_message_parse_options_list_changed +GstMixer GstMixerClass GST_TYPE_MIXER GST_TYPE_MIXER_TYPE @@ -476,6 +477,7 @@ gst_property_probe_get_type gsttuner gst/interfaces/tuner.h GstTuner +GstTunerClass gst_tuner_list_channels gst_tuner_get_channel @@ -497,7 +499,6 @@ gst_tuner_norm_changed gst_tuner_frequency_changed gst_tuner_signal_changed -GstTunerClass GST_TYPE_TUNER GST_TUNER GST_TUNER_CLASS @@ -564,13 +565,13 @@ gst_video_orientation_get_type gstxoverlay gst/interfaces/xoverlay.h GstXOverlay +GstXOverlayClass gst_x_overlay_set_xwindow_id gst_x_overlay_got_xwindow_id gst_x_overlay_prepare_xwindow_id gst_x_overlay_expose gst_x_overlay_handle_events -GstXOverlayClass GST_TYPE_X_OVERLAY GST_X_OVERLAY GST_X_OVERLAY_CLASS @@ -791,6 +792,7 @@ GST_RIFF_xmpg GST_RIFF_y41p GST_RIFF_yuy2 GST_RIFF_yv12 + gst_riff_create_audio_caps gst_riff_create_audio_template_caps gst_riff_create_iavs_caps diff --git a/gst-libs/gst/audio/gstaudiosrc.h b/gst-libs/gst/audio/gstaudiosrc.h index 5cf8108511..d3b714dd44 100644 --- a/gst-libs/gst/audio/gstaudiosrc.h +++ b/gst-libs/gst/audio/gstaudiosrc.h @@ -20,21 +20,6 @@ * Boston, MA 02111-1307, USA. */ -/* a base class for simple audio srcs. - * - * This base class only requires subclasses to implement a set - * of simple functions. - * - * - open: open the device with the specified caps - * - read: read samples to the audio device - * - close: close the device - * - delay: the number of samples queued in the device - * - reset: unblock a read to the device and reset. - * - * All scheduling of samples and timestamps is done in this - * base class. - */ - #ifndef __GST_AUDIO_SRC_H__ #define __GST_AUDIO_SRC_H__ @@ -53,6 +38,12 @@ G_BEGIN_DECLS typedef struct _GstAudioSrc GstAudioSrc; typedef struct _GstAudioSrcClass GstAudioSrcClass; +/** + * GstAudioSrc: + * @element: parent class + * + * Base class for simple audio sources. + */ struct _GstAudioSrc { GstBaseAudioSrc element; @@ -63,6 +54,20 @@ struct _GstAudioSrc { gpointer _gst_reserved[GST_PADDING]; }; +/** + * GstAudioSrcClass: + * @parent_class: the parent class. + * @open: open the device with the specified caps + * @prepare: configure device with format + * @unprepare: undo the configuration + * @close: close the device + * @read: read samples to the audio device + * @delay: the number of samples queued in the device + * @reset: unblock a read to the device and reset. + * + * #GstAudioSrc class. Override the vmethod to implement + * functionality. + */ struct _GstAudioSrcClass { GstBaseAudioSrcClass parent_class;