mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 03:31:05 +00:00
Code Issues 1 Projects Releases Wiki Activity

Updated docs

Browse source 
Original commit message from CVS:
Updated docs
This commit is contained in:
Wim Taymans 2000-11-07 21:18:52 +00:00
parent 415ced1c0b
commit e990c2c7d5
4 changed files with 237 additions and 211 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/gst/Makefile.am
View file

@ -10,7 +10,7 @@ DOC_MAIN_SGML_FILE=gstreamer-docs.sgml
DOC_SOURCE_DIR=$(top_srcdir)/gst DOC_SOURCE_DIR=$(top_srcdir)/gst
CFLAGS = $(GLIB_CFLAGS) $(GTK_CFLAGS) -I$(top_srcdir) CFLAGS = $(GLIB_CFLAGS) $(GTK_CFLAGS) -I$(top_srcdir)
LDFLAGS = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/libgst.la $(top_srcdir)/gst/elements/libgstelements.la LDFLAGS = $(GLIB_LIBS) $(GTK_LIBS) $(top_srcdir)/gst/.libs/libgst.so $(top_srcdir)/gst/elements/.libs/libgstelements.so
EXTRA_DIST=gstreamer.types.in EXTRA_DIST=gstreamer.types.in
@ -89,7 +89,7 @@ gstreamer-decl.txt:
$(MAKE) scan $(MAKE) scan
scanobj: $(srcdir)/$(DOC_MODULE).types scanobj: $(srcdir)/$(DOC_MODULE).types
-CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) gtkdoc-scanobj --module=$(DOC_MODULE) -CFLAGS="$(CFLAGS)" LDFLAGS="$(LDFLAGS)" gtkdoc-scanobj --module=$(DOC_MODULE)
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)

273
docs/gst/gstreamer-decl.txt
View file

@ -43,7 +43,7 @@ struct cothread_state {
int *sp; int *sp;
int *top_sp; int *top_sp;
int *pc; int *pc;
sigjmp_buf jmp; jmp_buf jmp;
}; };
</STRUCT> </STRUCT>
<STRUCT> <STRUCT>
@ -52,6 +52,7 @@ struct cothread_context {
cothread_state *threads[COTHREAD_MAXTHREADS]; cothread_state *threads[COTHREAD_MAXTHREADS];
int nthreads; int nthreads;
int current; int current;
GHashTable *data;
}; };
</STRUCT> </STRUCT>
<FUNCTION> <FUNCTION>
@ -67,7 +68,7 @@ cothread_context *ctx
<FUNCTION> <FUNCTION>
<NAME>cothread_setfunc</NAME> <NAME>cothread_setfunc</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
cothread_state *thread,cothread_func func,int argc,char **argv cothread_state *thread, cothread_func func,int argc, char **argv
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>cothread_switch</NAME> <NAME>cothread_switch</NAME>
@ -75,6 +76,16 @@ cothread_state *thread,cothread_func func,int argc,char **argv
cothread_state *thread cothread_state *thread
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>cothread_set_data</NAME>
<RETURNS>void </RETURNS>
cothread_state *thread, gchar *key, gpointer data
</FUNCTION>
<FUNCTION>
<NAME>cothread_get_data</NAME>
<RETURNS>gpointer </RETURNS>
cothread_state *thread, gchar *key
</FUNCTION>
<FUNCTION>
<NAME>cothread_main</NAME> <NAME>cothread_main</NAME>
<RETURNS>cothread_state *</RETURNS> <RETURNS>cothread_state *</RETURNS>
cothread_context *ctx cothread_context *ctx
@ -87,12 +98,12 @@ int *argc,char **argv[]
<FUNCTION> <FUNCTION>
<NAME>gst_main</NAME> <NAME>gst_main</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_main_quit</NAME> <NAME>gst_main_quit</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
void
</FUNCTION> </FUNCTION>
<MACRO> <MACRO>
<NAME>DEBUG</NAME> <NAME>DEBUG</NAME>
@ -172,17 +183,17 @@ gchar *name
<FUNCTION> <FUNCTION>
<NAME>gst_bin_add</NAME> <NAME>gst_bin_add</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstBin *bin,GstElement *element GstBin *bin, GstElement *element
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_bin_remove</NAME> <NAME>gst_bin_remove</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstBin *bin,GstElement *element GstBin *bin, GstElement *element
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_bin_get_by_name</NAME> <NAME>gst_bin_get_by_name</NAME>
<RETURNS>GstElement *</RETURNS> <RETURNS>GstElement *</RETURNS>
GstBin *bin,gchar *name GstBin *bin, gchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_bin_get_list</NAME> <NAME>gst_bin_get_list</NAME>
@ -190,6 +201,11 @@ GstBin *bin,gchar *name
GstBin *bin GstBin *bin
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_bin_create_plan</NAME>
<RETURNS>void </RETURNS>
GstBin *bin
</FUNCTION>
<FUNCTION>
<NAME>gst_bin_set_state_type</NAME> <NAME>gst_bin_set_state_type</NAME>
<RETURNS>gboolean </RETURNS> <RETURNS>gboolean </RETURNS>
GstBin *bin,GstElementState state,GtkType type GstBin *bin,GstElementState state,GtkType type
@ -200,11 +216,6 @@ GstBin *bin,GstElementState state,GtkType type
GstBin *bin GstBin *bin
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_bin_create_plan</NAME>
<RETURNS>void </RETURNS>
GstBin *bin
</FUNCTION>
<FUNCTION>
<NAME>gst_bin_use_cothreads</NAME> <NAME>gst_bin_use_cothreads</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstBin *bin, gboolean enabled GstBin *bin, gboolean enabled
@ -327,7 +338,7 @@ struct GstBuffer {
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_new</NAME> <NAME>gst_buffer_new</NAME>
<RETURNS>GstBuffer *</RETURNS> <RETURNS>GstBuffer *</RETURNS>
void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_new_from_pool</NAME> <NAME>gst_buffer_new_from_pool</NAME>
@ -337,7 +348,7 @@ GstBufferPool *pool
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_create_sub</NAME> <NAME>gst_buffer_create_sub</NAME>
<RETURNS>GstBuffer *</RETURNS> <RETURNS>GstBuffer *</RETURNS>
GstBuffer *parent,guint32 offset,guint32 size GstBuffer *parent, guint32 offset, guint32 size
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_append</NAME> <NAME>gst_buffer_append</NAME>
@ -352,7 +363,7 @@ GstBuffer *buffer
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_ref_by_count</NAME> <NAME>gst_buffer_ref_by_count</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstBuffer *buffer,int count GstBuffer *buffer, int count
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_unref</NAME> <NAME>gst_buffer_unref</NAME>
@ -367,7 +378,12 @@ GstBuffer *buffer
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_add_meta</NAME> <NAME>gst_buffer_add_meta</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstBuffer *buffer,GstMeta *meta GstBuffer *buffer, GstMeta *meta
</FUNCTION>
<FUNCTION>
<NAME>gst_buffer_remove_meta</NAME>
<RETURNS>void </RETURNS>
GstBuffer *buffer, GstMeta *meta
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_get_first_meta</NAME> <NAME>gst_buffer_get_first_meta</NAME>
@ -379,11 +395,6 @@ GstBuffer *buffer
<RETURNS>GSList *</RETURNS> <RETURNS>GSList *</RETURNS>
GstBuffer *buffer GstBuffer *buffer
</FUNCTION> </FUNCTION>
<FUNCTION>
<NAME>gst_buffer_remove_meta</NAME>
<RETURNS>void </RETURNS>
GstBuffer *buffer,GstMeta *meta
</FUNCTION>
<TYPEDEF> <TYPEDEF>
<NAME>GstClockTime</NAME> <NAME>GstClockTime</NAME>
typedef guint64 GstClockTime; typedef guint64 GstClockTime;
@ -548,7 +559,7 @@ typedef enum {
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_IS_ELEMENT_CLASS</NAME> <NAME>GST_IS_ELEMENT_CLASS</NAME>
#define GST_IS_ELEMENT_CLASS(obj) \ #define GST_IS_ELEMENT_CLASS(klass) \
(GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT)) (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
</MACRO> </MACRO>
<ENUM> <ENUM>
@ -556,6 +567,7 @@ typedef enum {
typedef enum { typedef enum {
GST_ELEMENT_MULTI_IN = (1 << 4), GST_ELEMENT_MULTI_IN = (1 << 4),
GST_ELEMENT_THREAD_SUGGESTED = (1 << 5), GST_ELEMENT_THREAD_SUGGESTED = (1 << 5),
GST_ELEMENT_NO_SEEK = (1 << 6),
} GstElementFlags; } GstElementFlags;
</ENUM> </ENUM>
<MACRO> <MACRO>
@ -635,6 +647,10 @@ void
<RETURNS>GstElement *</RETURNS> <RETURNS>GstElement *</RETURNS>
void void
</FUNCTION> </FUNCTION>
<MACRO>
<NAME>gst_element_destroy</NAME>
#define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
</MACRO>
<FUNCTION> <FUNCTION>
<NAME>gst_element_set_loop_function</NAME> <NAME>gst_element_set_loop_function</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
@ -643,17 +659,17 @@ GstElement *element,GstElementLoopFunction loop
<FUNCTION> <FUNCTION>
<NAME>gst_element_set_name</NAME> <NAME>gst_element_set_name</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstElement *element,gchar *name GstElement *element, gchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_get_name</NAME> <NAME>gst_element_get_name</NAME>
<RETURNS>gchar *</RETURNS> <RETURNS>const gchar *</RETURNS>
GstElement *element GstElement *element
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_set_manager</NAME> <NAME>gst_element_set_manager</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstElement *element,GstElement *manager GstElement *element, GstElement *manager
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_get_manager</NAME> <NAME>gst_element_get_manager</NAME>
@ -663,17 +679,12 @@ GstElement *element
<FUNCTION> <FUNCTION>
<NAME>gst_element_add_pad</NAME> <NAME>gst_element_add_pad</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstElement *element,GstPad *pad GstElement *element, GstPad *pad
</FUNCTION>
<FUNCTION>
<NAME>gst_element_add_ghost_pad</NAME>
<RETURNS>void </RETURNS>
GstElement *element,GstPad *pad
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_get_pad</NAME> <NAME>gst_element_get_pad</NAME>
<RETURNS>GstPad *</RETURNS> <RETURNS>GstPad *</RETURNS>
GstElement *element,gchar *name GstElement *element, gchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_get_pad_list</NAME> <NAME>gst_element_get_pad_list</NAME>
@ -681,33 +692,39 @@ GstElement *element,gchar *name
GstElement *element GstElement *element
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_add_ghost_pad</NAME>
<RETURNS>void </RETURNS>
GstElement *element, GstPad *pad
</FUNCTION>
<FUNCTION>
<NAME>gst_element_connect</NAME> <NAME>gst_element_connect</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstElement *src,gchar *srcpadname,GstElement *dest,gchar *destpadname GstElement *src, gchar *srcpadname,GstElement *dest, gchar *destpadname
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_set_state</NAME> <NAME>gst_element_set_state</NAME>
<RETURNS>gint </RETURNS> <RETURNS>gint </RETURNS>
GstElement *element,GstElementState state GstElement *element, GstElementState state
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_error</NAME> <NAME>gst_element_error</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstElement *element,gchar *error GstElement *element, gchar *error
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_get_factory</NAME> <NAME>gst_element_get_factory</NAME>
<RETURNS>GstElementFactory *</RETURNS> <RETURNS>GstElementFactory *</RETURNS>
GstElement *element GstElement *element
</FUNCTION> </FUNCTION>
<MACRO> <FUNCTION>
<NAME>gst_element_destroy</NAME> <NAME>gst_element_loopfunc_wrapper</NAME>
#define gst_element_destroy(element) gst_object_destroy(GST_OBJECT(element)) <RETURNS>int </RETURNS>
</MACRO> int argc,char **argv
</FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_save_thyself</NAME> <NAME>gst_element_save_thyself</NAME>
<RETURNS>xmlNodePtr </RETURNS> <RETURNS>xmlNodePtr </RETURNS>
GstElement *element,xmlNodePtr parent GstElement *element, xmlNodePtr parent
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_element_load_thyself</NAME> <NAME>gst_element_load_thyself</NAME>
@ -742,7 +759,7 @@ gchar *name
<FUNCTION> <FUNCTION>
<NAME>gst_elementfactory_get_list</NAME> <NAME>gst_elementfactory_get_list</NAME>
<RETURNS>GList *</RETURNS> <RETURNS>GList *</RETURNS>
void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_elementfactory_create</NAME> <NAME>gst_elementfactory_create</NAME>
@ -752,7 +769,7 @@ GstElementFactory *factory,gchar *name
<FUNCTION> <FUNCTION>
<NAME>gst_elementfactory_make</NAME> <NAME>gst_elementfactory_make</NAME>
<RETURNS>GstElement *</RETURNS> <RETURNS>GstElement *</RETURNS>
gchar *factoryname,gchar *name gchar *factoryname, gchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_elementfactory_save_thyself</NAME> <NAME>gst_elementfactory_save_thyself</NAME>
@ -764,11 +781,6 @@ GstElementFactory *factory, xmlNodePtr parent
<RETURNS>GstElementFactory *</RETURNS> <RETURNS>GstElementFactory *</RETURNS>
xmlNodePtr parent xmlNodePtr parent
</FUNCTION> </FUNCTION>
<FUNCTION>
<NAME>gst_element_loopfunc_wrapper</NAME>
<RETURNS>int </RETURNS>
int argc,char **argv
</FUNCTION>
<MACRO> <MACRO>
<NAME>GST_TYPE_FILTER</NAME> <NAME>GST_TYPE_FILTER</NAME>
#define GST_TYPE_FILTER \ #define GST_TYPE_FILTER \
@ -1021,23 +1033,23 @@ GstObject *object
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_TYPE_PAD</NAME> <NAME>GST_TYPE_PAD</NAME>
#define GST_TYPE_PAD (gst_pad_get_type()) #define GST_TYPE_PAD (gst_pad_get_type ())
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_PAD</NAME> <NAME>GST_PAD</NAME>
#define GST_PAD(obj) (GTK_CHECK_CAST((obj),GST_TYPE_PAD,GstPad)) #define GST_PAD(obj) (GTK_CHECK_CAST ((obj), GST_TYPE_PAD,GstPad))
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_PAD_CLASS</NAME> <NAME>GST_PAD_CLASS</NAME>
#define GST_PAD_CLASS(klass) (GTK_CHECK_CLASS_CAST((klass),GST_TYPE_PAD,GstPadClass)) #define GST_PAD_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD,GstPadClass))
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_IS_PAD</NAME> <NAME>GST_IS_PAD</NAME>
#define GST_IS_PAD(obj) (GTK_CHECK_TYPE((obj),GST_TYPE_PAD)) #define GST_IS_PAD(obj) (GTK_CHECK_TYPE ((obj), GST_TYPE_PAD))
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_IS_PAD_CLASS</NAME> <NAME>GST_IS_PAD_CLASS</NAME>
#define GST_IS_PAD_CLASS(obj) (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_PAD)) #define GST_IS_PAD_CLASS(obj) (GTK_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
</MACRO> </MACRO>
<MACRO> <MACRO>
<NAME>GST_PAD_CONNECTED</NAME> <NAME>GST_PAD_CONNECTED</NAME>
@ -1064,6 +1076,11 @@ GstPad *pad,GstBuffer *buf
GstPad *pad GstPad *pad
</USER_FUNCTION> </USER_FUNCTION>
<USER_FUNCTION> <USER_FUNCTION>
<NAME>GstPadPullRegionFunction</NAME>
<RETURNS>void </RETURNS>
GstPad *pad, gulong offset, gulong size
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GstPadPushFunction</NAME> <NAME>GstPadPushFunction</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *pad GstPad *pad
@ -1097,6 +1114,7 @@ struct GstPad {
GstPadChainFunction chainfunc; GstPadChainFunction chainfunc;
GstPadPullFunction pullfunc; GstPadPullFunction pullfunc;
GstPadPullRegionFunction pullregionfunc;
GstPadPushFunction pushfunc; GstPadPushFunction pushfunc;
GstPadQoSFunction qosfunc; GstPadQoSFunction qosfunc;
@ -1112,13 +1130,12 @@ void
<FUNCTION> <FUNCTION>
<NAME>gst_pad_new</NAME> <NAME>gst_pad_new</NAME>
<RETURNS>GstPad *</RETURNS> <RETURNS>GstPad *</RETURNS>
gchar *name,GstPadDirection direction gchar *name, GstPadDirection direction
</FUNCTION> </FUNCTION>
<FUNCTION> <MACRO>
<NAME>gst_pad_destroy</NAME> <NAME>gst_pad_destroy</NAME>
<RETURNS>void </RETURNS> #define gst_pad_destroy(pad) gst_object_destroy (GST_OBJECT (pad))
GstPad *pad </MACRO>
</FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_get_direction</NAME> <NAME>gst_pad_get_direction</NAME>
<RETURNS>GstPadDirection </RETURNS> <RETURNS>GstPadDirection </RETURNS>
@ -1127,7 +1144,7 @@ GstPad *pad
<FUNCTION> <FUNCTION>
<NAME>gst_pad_set_chain_function</NAME> <NAME>gst_pad_set_chain_function</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *pad,GstPadChainFunction chain GstPad *pad, GstPadChainFunction chain
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_set_pull_function</NAME> <NAME>gst_pad_set_pull_function</NAME>
@ -1147,36 +1164,22 @@ GstPad *pad
<FUNCTION> <FUNCTION>
<NAME>gst_pad_set_type_id</NAME> <NAME>gst_pad_set_type_id</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *pad,guint16 id GstPad *pad, guint16 id
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_set_name</NAME> <NAME>gst_pad_set_name</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *pad,gchar *name GstPad *pad, const gchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_get_name</NAME> <NAME>gst_pad_get_name</NAME>
<RETURNS>gchar *</RETURNS> <RETURNS>const gchar *</RETURNS>
GstPad *pad GstPad *pad
</FUNCTION> </FUNCTION>
<MACRO>
<NAME>gst_pad_destroy</NAME>
#define gst_pad_destroy(pad) gst_object_destroy(GST_OBJECT(pad))
</MACRO>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_set_parent</NAME> <NAME>gst_pad_set_parent</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *pad,GstObject *parent GstPad *pad, GstObject *parent
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_add_ghost_parent</NAME>
<RETURNS>void </RETURNS>
GstPad *pad,GstObject *parent
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_remove_ghost_parent</NAME>
<RETURNS>void </RETURNS>
GstPad *pad,GstObject *parent
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_get_parent</NAME> <NAME>gst_pad_get_parent</NAME>
@ -1184,6 +1187,16 @@ GstPad *pad,GstObject *parent
GstPad *pad GstPad *pad
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_add_ghost_parent</NAME>
<RETURNS>void </RETURNS>
GstPad *pad, GstObject *parent
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_remove_ghost_parent</NAME>
<RETURNS>void </RETURNS>
GstPad *pad, GstObject *parent
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_get_ghost_parents</NAME> <NAME>gst_pad_get_ghost_parents</NAME>
<RETURNS>GList *</RETURNS> <RETURNS>GList *</RETURNS>
GstPad *pad GstPad *pad
@ -1196,17 +1209,17 @@ GstPad *pad
<FUNCTION> <FUNCTION>
<NAME>gst_pad_connect</NAME> <NAME>gst_pad_connect</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *srcpad,GstPad *sinkpad GstPad *srcpad, GstPad *sinkpad
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_disconnect</NAME> <NAME>gst_pad_disconnect</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *srcpad,GstPad *sinkpad GstPad *srcpad, GstPad *sinkpad
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_push</NAME> <NAME>gst_pad_push</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *pad,GstBuffer *buffer GstPad *pad, GstBuffer *buffer
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_pull</NAME> <NAME>gst_pad_pull</NAME>
@ -1214,6 +1227,11 @@ GstPad *pad,GstBuffer *buffer
GstPad *pad GstPad *pad
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_pull_region</NAME>
<RETURNS>GstBuffer *</RETURNS>
GstPad *pad, gulong offset, gulong size
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_handle_qos</NAME> <NAME>gst_pad_handle_qos</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPad *pad, glong qos_message GstPad *pad, glong qos_message
@ -1221,7 +1239,7 @@ GstPad *pad, glong qos_message
<FUNCTION> <FUNCTION>
<NAME>gst_pad_save_thyself</NAME> <NAME>gst_pad_save_thyself</NAME>
<RETURNS>xmlNodePtr </RETURNS> <RETURNS>xmlNodePtr </RETURNS>
GstPad *pad,xmlNodePtr parent GstPad *pad, xmlNodePtr parent
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pad_load_and_connect</NAME> <NAME>gst_pad_load_and_connect</NAME>
@ -1287,11 +1305,6 @@ guchar *name
#define gst_pipeline_destroy(pipeline) gst_object_destroy(GST_OBJECT(pipeline)) #define gst_pipeline_destroy(pipeline) gst_object_destroy(GST_OBJECT(pipeline))
</MACRO> </MACRO>
<FUNCTION> <FUNCTION>
<NAME>gst_pipeline_autoplug</NAME>
<RETURNS>gboolean </RETURNS>
GstPipeline *pipeline
</FUNCTION>
<FUNCTION>
<NAME>gst_pipeline_add_src</NAME> <NAME>gst_pipeline_add_src</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPipeline *pipeline, GstElement *src GstPipeline *pipeline, GstElement *src
@ -1302,6 +1315,11 @@ GstPipeline *pipeline, GstElement *src
GstPipeline *pipeline, GstElement *sink GstPipeline *pipeline, GstElement *sink
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_pipeline_autoplug</NAME>
<RETURNS>gboolean </RETURNS>
GstPipeline *pipeline
</FUNCTION>
<FUNCTION>
<NAME>gst_pipeline_iterate</NAME> <NAME>gst_pipeline_iterate</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPipeline *pipeline GstPipeline *pipeline
@ -1336,14 +1354,9 @@ GModule *module
gchar *name gchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_plugin_set_longname</NAME>
<RETURNS>void </RETURNS>
GstPlugin *plugin,gchar *longname
</FUNCTION>
<FUNCTION>
<NAME>gst_plugin_load_all</NAME> <NAME>gst_plugin_load_all</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_plugin_load</NAME> <NAME>gst_plugin_load</NAME>
@ -1361,14 +1374,19 @@ gchar *name
gchar *name gchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_plugin_set_longname</NAME>
<RETURNS>void </RETURNS>
GstPlugin *plugin, gchar *longname
</FUNCTION>
<FUNCTION>
<NAME>gst_plugin_add_factory</NAME> <NAME>gst_plugin_add_factory</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPlugin *plugin,GstElementFactory *factory GstPlugin *plugin, GstElementFactory *factory
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_plugin_add_type</NAME> <NAME>gst_plugin_add_type</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstPlugin *plugin,GstTypeFactory *factory GstPlugin *plugin, GstTypeFactory *factory
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_plugin_find</NAME> <NAME>gst_plugin_find</NAME>
@ -1378,7 +1396,7 @@ const gchar *name
<FUNCTION> <FUNCTION>
<NAME>gst_plugin_get_list</NAME> <NAME>gst_plugin_get_list</NAME>
<RETURNS>GList *</RETURNS> <RETURNS>GList *</RETURNS>
void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_plugin_find_elementfactory</NAME> <NAME>gst_plugin_find_elementfactory</NAME>
@ -1480,7 +1498,7 @@ gchar *name
<ENUM> <ENUM>
<NAME>GstSrcFlags</NAME> <NAME>GstSrcFlags</NAME>
typedef enum { typedef enum {
GST_SRC_ASYNC = 1 << 0, GST_SRC_ASYNC = (1 << 0),
} GstSrcFlags; } GstSrcFlags;
</ENUM> </ENUM>
<MACRO> <MACRO>
@ -1522,11 +1540,6 @@ struct GstSrc {
void void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_src_signal_eos</NAME>
<RETURNS>void </RETURNS>
GstSrc *src
</FUNCTION>
<FUNCTION>
<NAME>gst_src_push</NAME> <NAME>gst_src_push</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstSrc *src GstSrc *src
@ -1534,7 +1547,12 @@ GstSrc *src
<FUNCTION> <FUNCTION>
<NAME>gst_src_push_region</NAME> <NAME>gst_src_push_region</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstSrc *src,gulong offset,gulong size GstSrc *src, gulong offset, gulong size
</FUNCTION>
<FUNCTION>
<NAME>gst_src_signal_eos</NAME>
<RETURNS>void </RETURNS>
GstSrc *src
</FUNCTION> </FUNCTION>
<MACRO> <MACRO>
<NAME>GST_TYPE_TEE</NAME> <NAME>GST_TYPE_TEE</NAME>
@ -1589,15 +1607,15 @@ void
gchar *name gchar *name
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_tee_chain</NAME>
<RETURNS>void </RETURNS>
GstPad *pad,GstBuffer *buf
</FUNCTION>
<FUNCTION>
<NAME>gst_tee_new_pad</NAME> <NAME>gst_tee_new_pad</NAME>
<RETURNS>gchar *</RETURNS> <RETURNS>gchar *</RETURNS>
GstTee *tee GstTee *tee
</FUNCTION> </FUNCTION>
<FUNCTION>
<NAME>gst_tee_chain</NAME>
<RETURNS>void </RETURNS>
GstPad *pad, GstBuffer *buf
</FUNCTION>
<VARIABLE> <VARIABLE>
<NAME>gst_thread_details</NAME> <NAME>gst_thread_details</NAME>
extern GstElementDetails gst_thread_details; extern GstElementDetails gst_thread_details;
@ -1661,11 +1679,6 @@ void
<RETURNS>GstElement *</RETURNS> <RETURNS>GstElement *</RETURNS>
guchar *name guchar *name
</FUNCTION> </FUNCTION>
<FUNCTION>
<NAME>gst_trace_read_tsc</NAME>
<RETURNS>void </RETURNS>
guint64 *dst
</FUNCTION>
<STRUCT> <STRUCT>
<NAME>GstTrace</NAME> <NAME>GstTrace</NAME>
</STRUCT> </STRUCT>
@ -1697,7 +1710,7 @@ struct GstTraceEntry {
<FUNCTION> <FUNCTION>
<NAME>gst_trace_new</NAME> <NAME>gst_trace_new</NAME>
<RETURNS>GstTrace *</RETURNS> <RETURNS>GstTrace *</RETURNS>
guchar *filename,gint size guchar *filename, gint size
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_trace_destroy</NAME> <NAME>gst_trace_destroy</NAME>
@ -1726,6 +1739,11 @@ GstTrace *trace
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstTrace *trace GstTrace *trace
</FUNCTION> </FUNCTION>
<FUNCTION>
<NAME>gst_trace_read_tsc</NAME>
<RETURNS>void </RETURNS>
guint64 *dst
</FUNCTION>
<MACRO> <MACRO>
<NAME>TRACE_ENABLE</NAME> <NAME>TRACE_ENABLE</NAME>
#define TRACE_ENABLE #define TRACE_ENABLE
@ -1796,12 +1814,12 @@ gchar *ext
<FUNCTION> <FUNCTION>
<NAME>gst_type_add_src</NAME> <NAME>gst_type_add_src</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
guint16 id,GstElementFactory *src guint16 id, GstElementFactory *src
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_type_add_sink</NAME> <NAME>gst_type_add_sink</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
guint16 id,GstElementFactory *sink guint16 id, GstElementFactory *sink
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_type_get_srcs</NAME> <NAME>gst_type_get_srcs</NAME>
@ -1826,12 +1844,12 @@ guint16 sinkid, guint16 srcid
<FUNCTION> <FUNCTION>
<NAME>gst_type_get_list</NAME> <NAME>gst_type_get_list</NAME>
<RETURNS>GList *</RETURNS> <RETURNS>GList *</RETURNS>
void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_type_dump</NAME> <NAME>gst_type_dump</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_type_save_thyself</NAME> <NAME>gst_type_save_thyself</NAME>
@ -1856,37 +1874,37 @@ xmlNodePtr parent
<FUNCTION> <FUNCTION>
<NAME>gst_util_get_int_arg</NAME> <NAME>gst_util_get_int_arg</NAME>
<RETURNS>gint </RETURNS> <RETURNS>gint </RETURNS>
GtkObject *object,guchar *argname GtkObject *object, guchar *argname
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_util_get_long_arg</NAME> <NAME>gst_util_get_long_arg</NAME>
<RETURNS>glong </RETURNS> <RETURNS>glong </RETURNS>
GtkObject *object,guchar *argname GtkObject *object, guchar *argname
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_util_get_float_arg</NAME> <NAME>gst_util_get_float_arg</NAME>
<RETURNS>gfloat </RETURNS> <RETURNS>gfloat </RETURNS>
GtkObject *object,guchar *argname GtkObject *object, guchar *argname
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_util_get_double_arg</NAME> <NAME>gst_util_get_double_arg</NAME>
<RETURNS>gdouble </RETURNS> <RETURNS>gdouble </RETURNS>
GtkObject *object,guchar *argname GtkObject *object, guchar *argname
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_util_get_string_arg</NAME> <NAME>gst_util_get_string_arg</NAME>
<RETURNS>guchar *</RETURNS> <RETURNS>guchar *</RETURNS>
GtkObject *object,guchar *argname GtkObject *object, guchar *argname
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_util_get_pointer_arg</NAME> <NAME>gst_util_get_pointer_arg</NAME>
<RETURNS>gpointer </RETURNS> <RETURNS>gpointer </RETURNS>
GtkObject *object,guchar *argname GtkObject *object, guchar *argname
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_util_get_widget_arg</NAME> <NAME>gst_util_get_widget_arg</NAME>
<RETURNS>GtkWidget *</RETURNS> <RETURNS>GtkWidget *</RETURNS>
GtkObject *object,guchar *argname GtkObject *object, guchar *argname
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_util_dump_mem</NAME> <NAME>gst_util_dump_mem</NAME>
@ -1985,7 +2003,7 @@ struct GstBufferPool {
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_pool_new</NAME> <NAME>gst_buffer_pool_new</NAME>
<RETURNS>GstBufferPool *</RETURNS> <RETURNS>GstBufferPool *</RETURNS>
void
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_pool_new_buffer</NAME> <NAME>gst_buffer_pool_new_buffer</NAME>
@ -2000,12 +2018,12 @@ GstBufferPool *pool, GstBuffer *buffer
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_pool_set_create_function</NAME> <NAME>gst_buffer_pool_set_create_function</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstBufferPool *pool, GstBufferPoolCreateFunction create, gpointer user_data GstBufferPool *pool,GstBufferPoolCreateFunction create,gpointer user_data
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_pool_set_destroy_function</NAME> <NAME>gst_buffer_pool_set_destroy_function</NAME>
<RETURNS>void </RETURNS> <RETURNS>void </RETURNS>
GstBufferPool *pool, GstBufferPoolDestroyFunction destroy, gpointer user_data GstBufferPool *pool,GstBufferPoolDestroyFunction destroy,gpointer user_data
</FUNCTION> </FUNCTION>
<FUNCTION> <FUNCTION>
<NAME>gst_buffer_pool_destroy</NAME> <NAME>gst_buffer_pool_destroy</NAME>
@ -2022,7 +2040,7 @@ typedef enum {
<FUNCTION> <FUNCTION>
<NAME>gst_cpu_get_flags</NAME> <NAME>gst_cpu_get_flags</NAME>
<RETURNS>GstCPUFlags </RETURNS> <RETURNS>GstCPUFlags </RETURNS>
void
</FUNCTION> </FUNCTION>
<MACRO> <MACRO>
<NAME>GET_SP</NAME> <NAME>GET_SP</NAME>
@ -2129,6 +2147,7 @@ struct GstAsyncDiskSrc {
/* details for fallback synchronous read */ /* details for fallback synchronous read */
gulong curoffset; /* current offset in file */ gulong curoffset; /* current offset in file */
gulong bytes_per_read; /* bytes per read */ gulong bytes_per_read; /* bytes per read */
gboolean new_seek;
gulong seq; /* buffer sequence number */ gulong seq; /* buffer sequence number */
}; };

3
docs/gst/gstreamer-docs.sgml
View file

@ -23,6 +23,7 @@
<!entity GstType SYSTEM "sgml/gsttype.sgml"> <!entity GstType SYSTEM "sgml/gsttype.sgml">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml"> <!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstXml SYSTEM "sgml/gstxml.sgml"> <!entity GstXml SYSTEM "sgml/gstxml.sgml">
<!entity cothreads SYSTEM "sgml/cothreads.sgml">
<!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml"> <!entity GstFakeSrc SYSTEM "sgml/gstfakesrc.sgml">
<!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml"> <!entity GstFakeSink SYSTEM "sgml/gstfakesink.sgml">
@ -82,6 +83,8 @@ with some more specialized elements.</para>
&GstCpu; &GstCpu;
&GstTrace; &GstTrace;
&GstXml; &GstXml;
&cothreads;
</chapter> </chapter>
<chapter id="element-types"> <chapter id="element-types">

4
docs/gst/gstreamer-sections.txt
View file

@ -15,6 +15,8 @@ cothread_create
cothread_setfunc cothread_setfunc
cothread_switch cothread_switch
cothread_main cothread_main
cothread_set_data
cothread_get_data
<SUBSECTION Standard> <SUBSECTION Standard>
GET_SP GET_SP
JUMP JUMP
@ -272,6 +274,7 @@ GST_PAD_CAN_PULL
GstPad GstPad
GstPadChainFunction GstPadChainFunction
GstPadPullFunction GstPadPullFunction
GstPadPullRegionFunction
GstPadPushFunction GstPadPushFunction
GstPadQoSFunction GstPadQoSFunction
GstPadDirection GstPadDirection
@ -294,6 +297,7 @@ gst_pad_connect
gst_pad_disconnect gst_pad_disconnect
gst_pad_push gst_pad_push
gst_pad_pull gst_pad_pull
gst_pad_pull_region
gst_pad_set_qos_function gst_pad_set_qos_function
gst_pad_handle_qos gst_pad_handle_qos
gst_pad_save_thyself gst_pad_save_thyself