gst-libs/gst/: Reducing number of dundocumented symbols.

Original commit message from CVS:
* gst-libs/gst/audio/audio.h:
* gst-libs/gst/audio/gstaudiofilter.h:
* gst-libs/gst/audio/gstringbuffer.h:
* gst-libs/gst/interfaces/propertyprobe.h:
* gst-libs/gst/tag/gsttagdemux.h:
Reducing number of dundocumented symbols.
This commit is contained in:
Stefan Kost 2008-08-11 08:34:56 +00:00
parent 26ad0ba982
commit f73aa5b817
6 changed files with 58 additions and 4 deletions

View file

@ -1,3 +1,12 @@
2008-08-11 Stefan Kost <ensonic@users.sf.net>
* gst-libs/gst/audio/audio.h:
* gst-libs/gst/audio/gstaudiofilter.h:
* gst-libs/gst/audio/gstringbuffer.h:
* gst-libs/gst/interfaces/propertyprobe.h:
* gst-libs/gst/tag/gsttagdemux.h:
Reducing number of dundocumented symbols.
2008-08-11 Stefan Kost <ensonic@users.sf.net>
* gst-libs/gst/audio/audio.c:

View file

@ -77,6 +77,12 @@ G_BEGIN_DECLS
*/
#define GST_AUDIO_DEF_RATE 44100
/**
* GST_AUDIO_INT_PAD_TEMPLATE_CAPS:
*
* Template caps for integer audio. Can be used when defining a
* #GstStaticPadTemplate
*/
#define GST_AUDIO_INT_PAD_TEMPLATE_CAPS \
"audio/x-raw-int, " \
"rate = (int) [ 1, MAX ], " \
@ -86,7 +92,12 @@ G_BEGIN_DECLS
"depth = (int) [ 1, 32 ], " \
"signed = (boolean) { true, false }"
/* "standard" int audio is native order, 16 bit stereo. */
/**
* GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS:
*
* Template caps for 16bit integer stereo audio in native byte-order.
* Can be used when defining a #GstStaticPadTemplate
*/
#define GST_AUDIO_INT_STANDARD_PAD_TEMPLATE_CAPS \
"audio/x-raw-int, " \
"rate = (int) [ 1, MAX ], " \
@ -96,6 +107,12 @@ G_BEGIN_DECLS
"depth = (int) 16, " \
"signed = (boolean) true"
/**
* GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS:
*
* Template caps for float audio. Can be used when defining a
* #GstStaticPadTemplate
*/
#define GST_AUDIO_FLOAT_PAD_TEMPLATE_CAPS \
"audio/x-raw-float, " \
"rate = (int) [ 1, MAX ], " \
@ -103,7 +120,12 @@ G_BEGIN_DECLS
"endianness = (int) { LITTLE_ENDIAN , BIG_ENDIAN }, " \
"width = (int) { 32, 64 }"
/* "standard" float audio is native order, 32 bit mono. */
/**
* GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS:
*
* Template caps for 32bit float mono audio in native byte-order.
* Can be used when defining a #GstStaticPadTemplate
*/
#define GST_AUDIO_FLOAT_STANDARD_PAD_TEMPLATE_CAPS \
"audio/x-raw-float, " \
"width = (int) 32, " \

View file

@ -61,6 +61,7 @@ struct _GstAudioFilter {
/**
* GstAudioFilterClass:
* @basetransformclass: parent class
* @setup: virtual function called whenever the format changes
*
* In addition to the @setup virtual function, you should also override the

View file

@ -181,6 +181,8 @@ typedef enum
* @segtotal: the total number of segments
* @bytes_per_sample: number of bytes in one sample
* @silence_sample: bytes representing one sample of silence
* @seglatency: number of segments queued in the lower level device,
* defaults to segtotal
*
* The structure containing the format specification of the ringbuffer.
*/
@ -285,6 +287,7 @@ struct _GstRingBuffer {
/**
* GstRingBufferClass:
* @parent_class: parent class
* @open_device: open the device, don't set any params or allocate anything
* @acquire: allocate the resources for the ringbuffer using the given spec
* @release: free resources of the ringbuffer

View file

@ -35,9 +35,26 @@ G_BEGIN_DECLS
#define GST_PROPERTY_PROBE_GET_IFACE(obj) \
(G_TYPE_INSTANCE_GET_INTERFACE ((obj), GST_TYPE_PROPERTY_PROBE, GstPropertyProbeInterface))
/**
* GstPropertyProbe:
*
* Opaque #GstPropertyProbe data structure.
*/
typedef struct _GstPropertyProbe GstPropertyProbe; /* dummy typedef */
typedef struct _GstPropertyProbeInterface GstPropertyProbeInterface;
typedef struct _GstPropertyProbeInterface {
/**
* GstPropertyProbeInterface:
* @klass: parent interface type.
* @probe_needed: default signal handler
* @get_properties: virtual method to get list of pobable properties
* @needs_probe: virtual method to tell if probe need update
* @probe_property: virtual method to probe a property
* @get_values: virtual method to get probe results for a property
*
* #GstPropertyProbeInterface interface.
*/
struct _GstPropertyProbeInterface {
GTypeInterface klass;
/* signals */
@ -56,8 +73,9 @@ typedef struct _GstPropertyProbeInterface {
guint prop_id,
const GParamSpec *pspec);
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
} GstPropertyProbeInterface;
};
GType gst_property_probe_get_type (void);

View file

@ -53,6 +53,7 @@ typedef enum {
/**
* GstTagDemux:
* @element: parent element
*
* Opaque #GstTagDemux structure.
*