mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-06-07 16:08:51 +00:00
docs: add missing documentation for various pieces
This commit is contained in:
parent
dad50ad1fe
commit
6bee2cb4ee
10 changed files with 141 additions and 12 deletions
|
@ -116,6 +116,53 @@ typedef enum
|
||||||
GST_BUFTYPE_MPEG4_AAC,
|
GST_BUFTYPE_MPEG4_AAC,
|
||||||
} GstBufferFormatType;
|
} GstBufferFormatType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstBufferFormat:
|
||||||
|
* @GST_UNKNOWN: unspecified
|
||||||
|
* @GST_S8: integer signed 8 bit
|
||||||
|
* @GST_U8: integer unsigned 8 bit
|
||||||
|
* @GST_S16_LE: integer signed 16 bit little endian
|
||||||
|
* @GST_S16_BE: integer signed 16 bit big endian
|
||||||
|
* @GST_U16_LE: integer unsigned 16 bit little endian
|
||||||
|
* @GST_U16_BE: integer unsigned 16 bit big endian
|
||||||
|
* @GST_S24_LE: integer signed 24 bit little endian
|
||||||
|
* @GST_S24_BE: integer signed 24 bit big endian
|
||||||
|
* @GST_U24_LE: integer unsigned 24 bit little endian
|
||||||
|
* @GST_U24_BE: integer unsigned 24 bit big endian
|
||||||
|
* @GST_S32_LE: integer signed 32 bit little endian
|
||||||
|
* @GST_S32_BE: integer signed 32 bit big endian
|
||||||
|
* @GST_U32_LE: integer unsigned 32 bit little endian
|
||||||
|
* @GST_U32_BE: integer unsigned 32 bit big endian
|
||||||
|
* @GST_S24_3LE: integer signed 24 bit little endian packed in 3 bytes
|
||||||
|
* @GST_S24_3BE: integer signed 24 bit big endian packed in 3 bytes
|
||||||
|
* @GST_U24_3LE: integer unsigned 24 bit little endian packed in 3 bytes
|
||||||
|
* @GST_U24_3BE: integer unsigned 24 bit big endian packed in 3 bytes
|
||||||
|
* @GST_S20_3LE: integer signed 20 bit little endian packed in 3 bytes
|
||||||
|
* @GST_S20_3BE: integer signed 20 bit big endian packed in 3 bytes
|
||||||
|
* @GST_U20_3LE: integer unsigned 20 bit little endian packed in 3 bytes
|
||||||
|
* @GST_U20_3BE: integer unsigned 20 bit big endian packed in 3 bytes
|
||||||
|
* @GST_S18_3LE: integer signed 18 bit little endian packed in 3 bytes
|
||||||
|
* @GST_S18_3BE: integer signed 18 bit big endian packed in 3 bytes
|
||||||
|
* @GST_U18_3LE: integer unsigned 18 bit little endian packed in 3 bytes
|
||||||
|
* @GST_U18_3BE: integer unsigned 18 bit big endian packed in 3 bytes
|
||||||
|
* @GST_FLOAT32_LE: floating 32 bit little endian
|
||||||
|
* @GST_FLOAT32_BE: floating 32 bit big endian
|
||||||
|
* @GST_FLOAT64_LE: floating 64 bit little endian
|
||||||
|
* @GST_FLOAT64_BE: floating 64 bit big endian
|
||||||
|
* @GST_MU_LAW: mu-law
|
||||||
|
* @GST_A_LAW: a-law
|
||||||
|
* @GST_IMA_ADPCM: ima adpcm
|
||||||
|
* @GST_MPEG: mpeg audio (but not aac)
|
||||||
|
* @GST_GSM: gsm
|
||||||
|
* @GST_IEC958: IEC958 frames
|
||||||
|
* @GST_AC3: ac3
|
||||||
|
* @GST_EAC3: eac3
|
||||||
|
* @GST_DTS: dts
|
||||||
|
* @GST_MPEG2_AAC: mpeg-2 aac
|
||||||
|
* @GST_MPEG4_AAC: mpeg-4 aac
|
||||||
|
*
|
||||||
|
* The detailed format of the samples in the ringbuffer.
|
||||||
|
*/
|
||||||
typedef enum
|
typedef enum
|
||||||
{
|
{
|
||||||
GST_UNKNOWN,
|
GST_UNKNOWN,
|
||||||
|
|
|
@ -115,6 +115,17 @@ struct _GstCddaBaseSrc {
|
||||||
gpointer _gst_reserved2[GST_PADDING/2];
|
gpointer _gst_reserved2[GST_PADDING/2];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstCddaBaseSrcClass:
|
||||||
|
* @pushsrc_class: the parent class
|
||||||
|
* @open: opening the device
|
||||||
|
* @close: closing the device
|
||||||
|
* @read_sector: reading a sector
|
||||||
|
* @get_default_device: getting the default device
|
||||||
|
* @probe_devices: probing possible devices
|
||||||
|
*
|
||||||
|
* Cdda source base class.
|
||||||
|
*/
|
||||||
struct _GstCddaBaseSrcClass {
|
struct _GstCddaBaseSrcClass {
|
||||||
GstPushSrcClass pushsrc_class;
|
GstPushSrcClass pushsrc_class;
|
||||||
|
|
||||||
|
|
|
@ -66,6 +66,17 @@ typedef enum
|
||||||
GST_COLOR_BALANCE_SOFTWARE
|
GST_COLOR_BALANCE_SOFTWARE
|
||||||
} GstColorBalanceType;
|
} GstColorBalanceType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstColorBalanceClass:
|
||||||
|
* @klass: the parent interface
|
||||||
|
* @balance_type: implementation type
|
||||||
|
* @list_channels: list handled channels
|
||||||
|
* @set_value: set a channel value
|
||||||
|
* @get_value: get a channel value
|
||||||
|
* @value_changed: default handler for value changed notification
|
||||||
|
*
|
||||||
|
* Color-balance interface.
|
||||||
|
*/
|
||||||
struct _GstColorBalanceClass {
|
struct _GstColorBalanceClass {
|
||||||
GTypeInterface klass;
|
GTypeInterface klass;
|
||||||
|
|
||||||
|
@ -85,6 +96,7 @@ struct _GstColorBalanceClass {
|
||||||
GstColorBalanceChannel *channel,
|
GstColorBalanceChannel *channel,
|
||||||
gint value);
|
gint value);
|
||||||
|
|
||||||
|
/*< private >*/
|
||||||
gpointer _gst_reserved[GST_PADDING];
|
gpointer _gst_reserved[GST_PADDING];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -57,7 +57,13 @@ struct _GstColorBalanceChannel {
|
||||||
gint max_value;
|
gint max_value;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstColorBalanceChannelClass:
|
||||||
|
* @parent: the parent interface
|
||||||
|
* @value_changed: default handler for value changed notification
|
||||||
|
*
|
||||||
|
* Color-balance channel class.
|
||||||
|
*/
|
||||||
struct _GstColorBalanceChannelClass {
|
struct _GstColorBalanceChannelClass {
|
||||||
GObjectClass parent;
|
GObjectClass parent;
|
||||||
|
|
||||||
|
@ -65,6 +71,7 @@ struct _GstColorBalanceChannelClass {
|
||||||
void (* value_changed) (GstColorBalanceChannel *channel,
|
void (* value_changed) (GstColorBalanceChannel *channel,
|
||||||
gint value);
|
gint value);
|
||||||
|
|
||||||
|
/*< private >*/
|
||||||
gpointer _gst_reserved[GST_PADDING];
|
gpointer _gst_reserved[GST_PADDING];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -47,6 +47,13 @@ G_BEGIN_DECLS
|
||||||
typedef struct _GstMixer GstMixer;
|
typedef struct _GstMixer GstMixer;
|
||||||
typedef struct _GstMixerClass GstMixerClass;
|
typedef struct _GstMixerClass GstMixerClass;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstMixerType:
|
||||||
|
* @GST_MIXER_HARDWARE: mixing is implemented with dedicated hardware.
|
||||||
|
* @GST_MIXER_SOFTWARE: mixing is implemented via software processing.
|
||||||
|
*
|
||||||
|
* Mixer classification.
|
||||||
|
*/
|
||||||
typedef enum
|
typedef enum
|
||||||
{
|
{
|
||||||
GST_MIXER_HARDWARE,
|
GST_MIXER_HARDWARE,
|
||||||
|
|
|
@ -49,22 +49,25 @@ typedef struct _GstMixerOptionsClass GstMixerOptionsClass;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstMixerOptions:
|
* GstMixerOptions:
|
||||||
* @parent: Parent object
|
|
||||||
* @values: List of option strings. Do not access this member directly,
|
* @values: List of option strings. Do not access this member directly,
|
||||||
* always use gst_mixer_options_get_values() instead.
|
* always use gst_mixer_options_get_values() instead.
|
||||||
|
*
|
||||||
|
* Mixer control object.
|
||||||
*/
|
*/
|
||||||
struct _GstMixerOptions {
|
struct _GstMixerOptions {
|
||||||
GstMixerTrack parent;
|
GstMixerTrack parent;
|
||||||
|
|
||||||
|
/*< public >*/
|
||||||
/* list of strings (do not access directly) (FIXME 0.11: make private) */
|
/* list of strings (do not access directly) (FIXME 0.11: make private) */
|
||||||
GList *values;
|
GList *values;
|
||||||
|
|
||||||
|
/*< private >*/
|
||||||
gpointer _gst_reserved[GST_PADDING];
|
gpointer _gst_reserved[GST_PADDING];
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstMixerOptionsClass:
|
* GstMixerOptionsClass:
|
||||||
* @parent: Parent class
|
* @parent: the parent interface
|
||||||
* @get_values: Optional implementation of gst_mixer_options_get_values().
|
* @get_values: Optional implementation of gst_mixer_options_get_values().
|
||||||
* (Since: 0.10.18)
|
* (Since: 0.10.18)
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -39,12 +39,20 @@ G_BEGIN_DECLS
|
||||||
typedef struct _GstNavigation GstNavigation;
|
typedef struct _GstNavigation GstNavigation;
|
||||||
typedef struct _GstNavigationInterface GstNavigationInterface;
|
typedef struct _GstNavigationInterface GstNavigationInterface;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstNavigationInterface:
|
||||||
|
* @g_iface: the parent interface
|
||||||
|
* @send_event: sending a navigation event
|
||||||
|
*
|
||||||
|
* Color-balance interface.
|
||||||
|
*/
|
||||||
struct _GstNavigationInterface {
|
struct _GstNavigationInterface {
|
||||||
GTypeInterface g_iface;
|
GTypeInterface g_iface;
|
||||||
|
|
||||||
/* virtual functions */
|
/* virtual functions */
|
||||||
void (*send_event) (GstNavigation *navigation, GstStructure *structure);
|
void (*send_event) (GstNavigation *navigation, GstStructure *structure);
|
||||||
|
|
||||||
|
/*< private >*/
|
||||||
gpointer _gst_reserved[GST_PADDING];
|
gpointer _gst_reserved[GST_PADDING];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -130,6 +138,14 @@ typedef enum {
|
||||||
#define GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU GST_NAVIGATION_COMMAND_MENU7
|
#define GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU GST_NAVIGATION_COMMAND_MENU7
|
||||||
|
|
||||||
/* Queries */
|
/* Queries */
|
||||||
|
/**
|
||||||
|
* GstNavigationQueryType:
|
||||||
|
* @GST_NAVIGATION_QUERY_INVALID: invalid query
|
||||||
|
* @GST_NAVIGATION_QUERY_COMMANDS: command query
|
||||||
|
* @GST_NAVIGATION_QUERY_ANGLES: viewing angle query
|
||||||
|
*
|
||||||
|
* Tyoes of navigation interface queries.
|
||||||
|
*/
|
||||||
typedef enum
|
typedef enum
|
||||||
{
|
{
|
||||||
GST_NAVIGATION_QUERY_INVALID = 0,
|
GST_NAVIGATION_QUERY_INVALID = 0,
|
||||||
|
|
|
@ -45,6 +45,25 @@ G_BEGIN_DECLS
|
||||||
typedef struct _GstTuner GstTuner;
|
typedef struct _GstTuner GstTuner;
|
||||||
typedef struct _GstTunerClass GstTunerClass;
|
typedef struct _GstTunerClass GstTunerClass;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstTunerClass:
|
||||||
|
* @klass: the parent interface
|
||||||
|
* @list_channels: list available channels
|
||||||
|
* @set_channel: set to a channel
|
||||||
|
* @get_channel: return the current channel
|
||||||
|
* @list_norms: list available norms
|
||||||
|
* @set_norm: set a norm
|
||||||
|
* @get_norm: return the current norm
|
||||||
|
* @set_frequency: set the frequency
|
||||||
|
* @get_frequency: return the current frequency
|
||||||
|
* @signal_strength: get the signal strength
|
||||||
|
* @channel_changed: default handler for channel changed notification
|
||||||
|
* @norm_changed: default handler for norm changed notification
|
||||||
|
* @frequency_changed: default handler for frequency changed notification
|
||||||
|
* @signal_changed: default handler for signal-strength changed notification
|
||||||
|
*
|
||||||
|
* Tuner interface.
|
||||||
|
*/
|
||||||
struct _GstTunerClass {
|
struct _GstTunerClass {
|
||||||
GTypeInterface klass;
|
GTypeInterface klass;
|
||||||
|
|
||||||
|
@ -80,6 +99,7 @@ struct _GstTunerClass {
|
||||||
GstTunerChannel *channel,
|
GstTunerChannel *channel,
|
||||||
gint signal);
|
gint signal);
|
||||||
|
|
||||||
|
/*< private >*/
|
||||||
gpointer _gst_reserved[GST_PADDING];
|
gpointer _gst_reserved[GST_PADDING];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -47,6 +47,12 @@ struct _GstVideoFilter {
|
||||||
gboolean inited;
|
gboolean inited;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstVideoFilterClass:
|
||||||
|
* @parent_class: the parent class structure
|
||||||
|
*
|
||||||
|
* The video filter class structure.
|
||||||
|
*/
|
||||||
struct _GstVideoFilterClass {
|
struct _GstVideoFilterClass {
|
||||||
GstBaseTransformClass parent_class;
|
GstBaseTransformClass parent_class;
|
||||||
};
|
};
|
||||||
|
|
|
@ -84,7 +84,6 @@ struct _GstVideoRectangle {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* GstVideoSink:
|
* GstVideoSink:
|
||||||
* @element: the parent object structure (which is GstBaseSink)
|
|
||||||
* @height: video height (derived class needs to set this)
|
* @height: video height (derived class needs to set this)
|
||||||
* @width: video width (derived class needs to set this)
|
* @width: video width (derived class needs to set this)
|
||||||
*
|
*
|
||||||
|
@ -94,6 +93,7 @@ struct _GstVideoRectangle {
|
||||||
struct _GstVideoSink {
|
struct _GstVideoSink {
|
||||||
GstBaseSink element; /* FIXME 0.11: this should not be called 'element' */
|
GstBaseSink element; /* FIXME 0.11: this should not be called 'element' */
|
||||||
|
|
||||||
|
/*< public >*/
|
||||||
gint width, height;
|
gint width, height;
|
||||||
|
|
||||||
/*< private >*/
|
/*< private >*/
|
||||||
|
|
Loading…
Reference in a new issue