Updated docs

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

View file

@ -10,7 +10,7 @@ DOC_MAIN_SGML_FILE=gstreamer-docs.sgml
DOC_SOURCE_DIR=$(top_srcdir)/gst
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
@ -89,7 +89,7 @@ gstreamer-decl.txt:
$(MAKE) scan
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)

View file

@ -43,7 +43,7 @@ struct cothread_state {
int *sp;
int *top_sp;
int *pc;
sigjmp_buf jmp;
jmp_buf jmp;
};
</STRUCT>
<STRUCT>
@ -52,6 +52,7 @@ struct cothread_context {
cothread_state *threads[COTHREAD_MAXTHREADS];
int nthreads;
int current;
GHashTable *data;
};
</STRUCT>
<FUNCTION>
@ -75,6 +76,16 @@ cothread_state *thread,cothread_func func,int argc,char **argv
cothread_state *thread
</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>
<RETURNS>cothread_state *</RETURNS>
cothread_context *ctx
@ -87,12 +98,12 @@ int *argc,char **argv[]
<FUNCTION>
<NAME>gst_main</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gst_main_quit</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<MACRO>
<NAME>DEBUG</NAME>
@ -190,6 +201,11 @@ GstBin *bin,gchar *name
GstBin *bin
</FUNCTION>
<FUNCTION>
<NAME>gst_bin_create_plan</NAME>
<RETURNS>void </RETURNS>
GstBin *bin
</FUNCTION>
<FUNCTION>
<NAME>gst_bin_set_state_type</NAME>
<RETURNS>gboolean </RETURNS>
GstBin *bin,GstElementState state,GtkType type
@ -200,11 +216,6 @@ GstBin *bin,GstElementState state,GtkType type
GstBin *bin
</FUNCTION>
<FUNCTION>
<NAME>gst_bin_create_plan</NAME>
<RETURNS>void </RETURNS>
GstBin *bin
</FUNCTION>
<FUNCTION>
<NAME>gst_bin_use_cothreads</NAME>
<RETURNS>void </RETURNS>
GstBin *bin, gboolean enabled
@ -327,7 +338,7 @@ struct GstBuffer {
<FUNCTION>
<NAME>gst_buffer_new</NAME>
<RETURNS>GstBuffer *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gst_buffer_new_from_pool</NAME>
@ -370,6 +381,11 @@ GstBuffer *buffer
GstBuffer *buffer, GstMeta *meta
</FUNCTION>
<FUNCTION>
<NAME>gst_buffer_remove_meta</NAME>
<RETURNS>void </RETURNS>
GstBuffer *buffer, GstMeta *meta
</FUNCTION>
<FUNCTION>
<NAME>gst_buffer_get_first_meta</NAME>
<RETURNS>GstMeta *</RETURNS>
GstBuffer *buffer
@ -379,11 +395,6 @@ GstBuffer *buffer
<RETURNS>GSList *</RETURNS>
GstBuffer *buffer
</FUNCTION>
<FUNCTION>
<NAME>gst_buffer_remove_meta</NAME>
<RETURNS>void </RETURNS>
GstBuffer *buffer,GstMeta *meta
</FUNCTION>
<TYPEDEF>
<NAME>GstClockTime</NAME>
typedef guint64 GstClockTime;
@ -548,7 +559,7 @@ typedef enum {
</MACRO>
<MACRO>
<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))
</MACRO>
<ENUM>
@ -556,6 +567,7 @@ typedef enum {
typedef enum {
GST_ELEMENT_MULTI_IN = (1 << 4),
GST_ELEMENT_THREAD_SUGGESTED = (1 << 5),
GST_ELEMENT_NO_SEEK = (1 << 6),
} GstElementFlags;
</ENUM>
<MACRO>
@ -635,6 +647,10 @@ void
<RETURNS>GstElement *</RETURNS>
void
</FUNCTION>
<MACRO>
<NAME>gst_element_destroy</NAME>
#define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
</MACRO>
<FUNCTION>
<NAME>gst_element_set_loop_function</NAME>
<RETURNS>void </RETURNS>
@ -647,7 +663,7 @@ GstElement *element,gchar *name
</FUNCTION>
<FUNCTION>
<NAME>gst_element_get_name</NAME>
<RETURNS>gchar *</RETURNS>
<RETURNS>const gchar *</RETURNS>
GstElement *element
</FUNCTION>
<FUNCTION>
@ -666,11 +682,6 @@ GstElement *element
GstElement *element, GstPad *pad
</FUNCTION>
<FUNCTION>
<NAME>gst_element_add_ghost_pad</NAME>
<RETURNS>void </RETURNS>
GstElement *element,GstPad *pad
</FUNCTION>
<FUNCTION>
<NAME>gst_element_get_pad</NAME>
<RETURNS>GstPad *</RETURNS>
GstElement *element, gchar *name
@ -681,6 +692,11 @@ GstElement *element,gchar *name
GstElement *element
</FUNCTION>
<FUNCTION>
<NAME>gst_element_add_ghost_pad</NAME>
<RETURNS>void </RETURNS>
GstElement *element, GstPad *pad
</FUNCTION>
<FUNCTION>
<NAME>gst_element_connect</NAME>
<RETURNS>void </RETURNS>
GstElement *src, gchar *srcpadname,GstElement *dest, gchar *destpadname
@ -700,10 +716,11 @@ GstElement *element,gchar *error
<RETURNS>GstElementFactory *</RETURNS>
GstElement *element
</FUNCTION>
<MACRO>
<NAME>gst_element_destroy</NAME>
#define gst_element_destroy(element) gst_object_destroy(GST_OBJECT(element))
</MACRO>
<FUNCTION>
<NAME>gst_element_loopfunc_wrapper</NAME>
<RETURNS>int </RETURNS>
int argc,char **argv
</FUNCTION>
<FUNCTION>
<NAME>gst_element_save_thyself</NAME>
<RETURNS>xmlNodePtr </RETURNS>
@ -742,7 +759,7 @@ gchar *name
<FUNCTION>
<NAME>gst_elementfactory_get_list</NAME>
<RETURNS>GList *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gst_elementfactory_create</NAME>
@ -764,11 +781,6 @@ GstElementFactory *factory, xmlNodePtr parent
<RETURNS>GstElementFactory *</RETURNS>
xmlNodePtr parent
</FUNCTION>
<FUNCTION>
<NAME>gst_element_loopfunc_wrapper</NAME>
<RETURNS>int </RETURNS>
int argc,char **argv
</FUNCTION>
<MACRO>
<NAME>GST_TYPE_FILTER</NAME>
#define GST_TYPE_FILTER \
@ -1064,6 +1076,11 @@ GstPad *pad,GstBuffer *buf
GstPad *pad
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GstPadPullRegionFunction</NAME>
<RETURNS>void </RETURNS>
GstPad *pad, gulong offset, gulong size
</USER_FUNCTION>
<USER_FUNCTION>
<NAME>GstPadPushFunction</NAME>
<RETURNS>void </RETURNS>
GstPad *pad
@ -1097,6 +1114,7 @@ struct GstPad {
GstPadChainFunction chainfunc;
GstPadPullFunction pullfunc;
GstPadPullRegionFunction pullregionfunc;
GstPadPushFunction pushfunc;
GstPadQoSFunction qosfunc;
@ -1114,11 +1132,10 @@ void
<RETURNS>GstPad *</RETURNS>
gchar *name, GstPadDirection direction
</FUNCTION>
<FUNCTION>
<MACRO>
<NAME>gst_pad_destroy</NAME>
<RETURNS>void </RETURNS>
GstPad *pad
</FUNCTION>
#define gst_pad_destroy(pad) gst_object_destroy (GST_OBJECT (pad))
</MACRO>
<FUNCTION>
<NAME>gst_pad_get_direction</NAME>
<RETURNS>GstPadDirection </RETURNS>
@ -1152,23 +1169,24 @@ GstPad *pad,guint16 id
<FUNCTION>
<NAME>gst_pad_set_name</NAME>
<RETURNS>void </RETURNS>
GstPad *pad,gchar *name
GstPad *pad, const gchar *name
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_get_name</NAME>
<RETURNS>gchar *</RETURNS>
<RETURNS>const gchar *</RETURNS>
GstPad *pad
</FUNCTION>
<MACRO>
<NAME>gst_pad_destroy</NAME>
#define gst_pad_destroy(pad) gst_object_destroy(GST_OBJECT(pad))
</MACRO>
<FUNCTION>
<NAME>gst_pad_set_parent</NAME>
<RETURNS>void </RETURNS>
GstPad *pad, GstObject *parent
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_get_parent</NAME>
<RETURNS>GstObject *</RETURNS>
GstPad *pad
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_add_ghost_parent</NAME>
<RETURNS>void </RETURNS>
GstPad *pad, GstObject *parent
@ -1179,11 +1197,6 @@ GstPad *pad,GstObject *parent
GstPad *pad, GstObject *parent
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_get_parent</NAME>
<RETURNS>GstObject *</RETURNS>
GstPad *pad
</FUNCTION>
<FUNCTION>
<NAME>gst_pad_get_ghost_parents</NAME>
<RETURNS>GList *</RETURNS>
GstPad *pad
@ -1214,6 +1227,11 @@ GstPad *pad,GstBuffer *buffer
GstPad *pad
</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>
<RETURNS>void </RETURNS>
GstPad *pad, glong qos_message
@ -1287,11 +1305,6 @@ guchar *name
#define gst_pipeline_destroy(pipeline) gst_object_destroy(GST_OBJECT(pipeline))
</MACRO>
<FUNCTION>
<NAME>gst_pipeline_autoplug</NAME>
<RETURNS>gboolean </RETURNS>
GstPipeline *pipeline
</FUNCTION>
<FUNCTION>
<NAME>gst_pipeline_add_src</NAME>
<RETURNS>void </RETURNS>
GstPipeline *pipeline, GstElement *src
@ -1302,6 +1315,11 @@ GstPipeline *pipeline, GstElement *src
GstPipeline *pipeline, GstElement *sink
</FUNCTION>
<FUNCTION>
<NAME>gst_pipeline_autoplug</NAME>
<RETURNS>gboolean </RETURNS>
GstPipeline *pipeline
</FUNCTION>
<FUNCTION>
<NAME>gst_pipeline_iterate</NAME>
<RETURNS>void </RETURNS>
GstPipeline *pipeline
@ -1336,14 +1354,9 @@ GModule *module
gchar *name
</FUNCTION>
<FUNCTION>
<NAME>gst_plugin_set_longname</NAME>
<RETURNS>void </RETURNS>
GstPlugin *plugin,gchar *longname
</FUNCTION>
<FUNCTION>
<NAME>gst_plugin_load_all</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gst_plugin_load</NAME>
@ -1361,6 +1374,11 @@ gchar *name
gchar *name
</FUNCTION>
<FUNCTION>
<NAME>gst_plugin_set_longname</NAME>
<RETURNS>void </RETURNS>
GstPlugin *plugin, gchar *longname
</FUNCTION>
<FUNCTION>
<NAME>gst_plugin_add_factory</NAME>
<RETURNS>void </RETURNS>
GstPlugin *plugin, GstElementFactory *factory
@ -1378,7 +1396,7 @@ const gchar *name
<FUNCTION>
<NAME>gst_plugin_get_list</NAME>
<RETURNS>GList *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gst_plugin_find_elementfactory</NAME>
@ -1480,7 +1498,7 @@ gchar *name
<ENUM>
<NAME>GstSrcFlags</NAME>
typedef enum {
GST_SRC_ASYNC = 1 << 0,
GST_SRC_ASYNC = (1 << 0),
} GstSrcFlags;
</ENUM>
<MACRO>
@ -1522,11 +1540,6 @@ struct GstSrc {
void
</FUNCTION>
<FUNCTION>
<NAME>gst_src_signal_eos</NAME>
<RETURNS>void </RETURNS>
GstSrc *src
</FUNCTION>
<FUNCTION>
<NAME>gst_src_push</NAME>
<RETURNS>void </RETURNS>
GstSrc *src
@ -1536,6 +1549,11 @@ GstSrc *src
<RETURNS>void </RETURNS>
GstSrc *src, gulong offset, gulong size
</FUNCTION>
<FUNCTION>
<NAME>gst_src_signal_eos</NAME>
<RETURNS>void </RETURNS>
GstSrc *src
</FUNCTION>
<MACRO>
<NAME>GST_TYPE_TEE</NAME>
#define GST_TYPE_TEE \
@ -1589,15 +1607,15 @@ void
gchar *name
</FUNCTION>
<FUNCTION>
<NAME>gst_tee_chain</NAME>
<RETURNS>void </RETURNS>
GstPad *pad,GstBuffer *buf
</FUNCTION>
<FUNCTION>
<NAME>gst_tee_new_pad</NAME>
<RETURNS>gchar *</RETURNS>
GstTee *tee
</FUNCTION>
<FUNCTION>
<NAME>gst_tee_chain</NAME>
<RETURNS>void </RETURNS>
GstPad *pad, GstBuffer *buf
</FUNCTION>
<VARIABLE>
<NAME>gst_thread_details</NAME>
extern GstElementDetails gst_thread_details;
@ -1661,11 +1679,6 @@ void
<RETURNS>GstElement *</RETURNS>
guchar *name
</FUNCTION>
<FUNCTION>
<NAME>gst_trace_read_tsc</NAME>
<RETURNS>void </RETURNS>
guint64 *dst
</FUNCTION>
<STRUCT>
<NAME>GstTrace</NAME>
</STRUCT>
@ -1726,6 +1739,11 @@ GstTrace *trace
<RETURNS>void </RETURNS>
GstTrace *trace
</FUNCTION>
<FUNCTION>
<NAME>gst_trace_read_tsc</NAME>
<RETURNS>void </RETURNS>
guint64 *dst
</FUNCTION>
<MACRO>
<NAME>TRACE_ENABLE</NAME>
#define TRACE_ENABLE
@ -1826,12 +1844,12 @@ guint16 sinkid, guint16 srcid
<FUNCTION>
<NAME>gst_type_get_list</NAME>
<RETURNS>GList *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gst_type_dump</NAME>
<RETURNS>void </RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gst_type_save_thyself</NAME>
@ -1985,7 +2003,7 @@ struct GstBufferPool {
<FUNCTION>
<NAME>gst_buffer_pool_new</NAME>
<RETURNS>GstBufferPool *</RETURNS>
void
</FUNCTION>
<FUNCTION>
<NAME>gst_buffer_pool_new_buffer</NAME>
@ -2022,7 +2040,7 @@ typedef enum {
<FUNCTION>
<NAME>gst_cpu_get_flags</NAME>
<RETURNS>GstCPUFlags </RETURNS>
void
</FUNCTION>
<MACRO>
<NAME>GET_SP</NAME>
@ -2129,6 +2147,7 @@ struct GstAsyncDiskSrc {
/* details for fallback synchronous read */
gulong curoffset; /* current offset in file */
gulong bytes_per_read; /* bytes per read */
gboolean new_seek;
gulong seq; /* buffer sequence number */
};

View file

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

View file

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