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

More docs and shuffling. What can we do with the hundreds of #defines.

Browse source 
Original commit message from CVS:
* 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.
This commit is contained in:
Stefan Kost 2008-08-11 09:20:33 +00:00
parent f73aa5b817
commit 01554ac056
3 changed files with 32 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
2008-08-11 Stefan Kost <ensonic@users.sf.net>
* 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 <ensonic@users.sf.net>
* gst-libs/gst/audio/audio.h:

10
docs/libs/gst-plugins-base-libs-sections.txt
View file

@ -313,13 +313,13 @@ gst_cast_float
<FILE>gstcolorbalance</FILE>
<INCLUDE>gst/interfaces/color.h</INCLUDE>
GstColorBalance
GstColorBalanceClass
GstColorBalanceType
gst_color_balance_list_channels
gst_color_balance_get_value
gst_color_balance_set_value
gst_color_balance_value_changed
<SUBSECTION Standard>
GstColorBalanceClass
GST_COLOR_BALANCE
GST_COLOR_BALANCE_CLASS
GST_COLOR_BALANCE_GET_CLASS
@ -336,8 +336,8 @@ gst_color_balance_type_get_type
<FILE>gstcolorbalancechannel</FILE>
<INCLUDE>gst/interfaces/colorbalancechannel.h</INCLUDE>
GstColorBalanceChannel
<SUBSECTION Standard>
GstColorBalanceChannelClass
<SUBSECTION Standard>
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
<SUBSECTION Standard>
GstMixer
GstMixerClass
GST_TYPE_MIXER
GST_TYPE_MIXER_TYPE
@ -476,6 +477,7 @@ gst_property_probe_get_type
<FILE>gsttuner</FILE>
<INCLUDE>gst/interfaces/tuner.h</INCLUDE>
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
<SUBSECTION Standard>
GstTunerClass
GST_TYPE_TUNER
GST_TUNER
GST_TUNER_CLASS
@ -564,13 +565,13 @@ gst_video_orientation_get_type
<FILE>gstxoverlay</FILE>
<INCLUDE>gst/interfaces/xoverlay.h</INCLUDE>
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
<SUBSECTION Standard>
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

35
gst-libs/gst/audio/gstaudiosrc.h
View file

@ -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;