diff --git a/docs/gst/tmpl/audioraw.sgml b/docs/gst/tmpl/audioraw.sgml index d3ef062716..df16e49c92 100644 --- a/docs/gst/tmpl/audioraw.sgml +++ b/docs/gst/tmpl/audioraw.sgml @@ -19,4 +19,9 @@ Information about audio buffers. +@meta: +@format: +@channels: +@frequency: +@bps: diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index 8c1326fd23..fee77b9b35 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -47,12 +47,25 @@ cothreads +@ctx: +@threadnum: +@func: +@argc: +@argv: +@flags: +@sp: +@top_sp: +@pc: +@jmp: +@threads: +@nthreads: +@current: diff --git a/docs/gst/tmpl/gstasyncdisksrc.sgml b/docs/gst/tmpl/gstasyncdisksrc.sgml index 1e3fea6fd8..1179a56213 100644 --- a/docs/gst/tmpl/gstasyncdisksrc.sgml +++ b/docs/gst/tmpl/gstasyncdisksrc.sgml @@ -29,6 +29,7 @@ the offset. +@GST_ASYNCDISKSRC_OPEN: @@ -40,13 +41,13 @@ Specify the location of the file to read. Specify how many bytes to read at a time. - - -Get the size of the current file. - - Specify the current offset in the file. + + + + + diff --git a/docs/gst/tmpl/gstaudiosink.sgml b/docs/gst/tmpl/gstaudiosink.sgml index e96a50dcd3..87e51aa4d3 100644 --- a/docs/gst/tmpl/gstaudiosink.sgml +++ b/docs/gst/tmpl/gstaudiosink.sgml @@ -20,6 +20,7 @@ The buffer is sent to the sound card. @gstaudiosink: the object which received the signal. + @arg1: the audiosink. diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index cc4dbdf356..3360012670 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -167,12 +167,28 @@ used when data in a stream has been skipped +@GST_BUFFER_READONLY: +@GST_BUFFER_EOS: +@GST_BUFFER_ORIGINAL: +@GST_BUFFER_DONTFREE: +@GST_BUFFER_FLUSH: +@lock: +@flags: +@data: +@size: +@maxsize: +@offset: +@timestamp: +@maxage: +@metas: +@parent: +@pool: diff --git a/docs/gst/tmpl/gstbufferpool.sgml b/docs/gst/tmpl/gstbufferpool.sgml index 0b09f7638a..91ea231866 100644 --- a/docs/gst/tmpl/gstbufferpool.sgml +++ b/docs/gst/tmpl/gstbufferpool.sgml @@ -1,12 +1,21 @@ -gstbufferpool +GstBufferPool - +Create buffers from a pool +A bufferpool is used to create buffers in an efficient way. En element +can maintain a bufferpool with a fixed number of buffers. This will reduce +the g_malloc and g_free overhead. + + +A bufferpool can also be used to implement direct access. A bufferpool can be +sent from one element to another so that the latter can directly write into +the memory of the element that maintains the bufferpool. This can greatly reduce +the number of memcpy operations. @@ -14,19 +23,15 @@ gstbufferpool - - - - - -@buf: - - +@new_buffer: +@new_user_data: +@destroy_user_data: +@destroy_buffer: diff --git a/docs/gst/tmpl/gstclock.sgml b/docs/gst/tmpl/gstclock.sgml index 37e640cd45..888a957daa 100644 --- a/docs/gst/tmpl/gstclock.sgml +++ b/docs/gst/tmpl/gstclock.sgml @@ -40,6 +40,16 @@ gstclock +@name: +@start_time: +@current_time: +@adjust: +@locking: +@sinkobjects: +@num: +@num_locked: +@sinkmutex: +@lock: diff --git a/docs/gst/tmpl/gstcpu.sgml b/docs/gst/tmpl/gstcpu.sgml index f1c65a621b..265ecbb5bb 100644 --- a/docs/gst/tmpl/gstcpu.sgml +++ b/docs/gst/tmpl/gstcpu.sgml @@ -18,19 +18,13 @@ features of the CPU. - + -A flag indicating that MMX instructions are supported. + - - - - -A flag indicating that SSE instructions are supported. - - - +@GST_CPU_FLAG_MMX: +@GST_CPU_FLAG_SSE: diff --git a/docs/gst/tmpl/gstdisksrc.sgml b/docs/gst/tmpl/gstdisksrc.sgml index 89d7e63eb9..63bc83a0f8 100644 --- a/docs/gst/tmpl/gstdisksrc.sgml +++ b/docs/gst/tmpl/gstdisksrc.sgml @@ -30,6 +30,7 @@ with seeking capabilities use a GstAsynDiskSrc instead. +@GST_DISKSRC_OPEN: diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 00096e0073..7ec802185d 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -69,6 +69,11 @@ temporary stops the data flow. +@GST_STATE_NONE_PENDING: +@GST_STATE_NULL: +@GST_STATE_READY: +@GST_STATE_PLAYING: +@GST_STATE_PAUSED: @@ -98,6 +103,9 @@ can return after a state change. +@GST_STATE_FAILURE: +@GST_STATE_SUCCESS: +@GST_STATE_ASYNC: @@ -132,6 +140,8 @@ may have. +@GST_ELEMENT_MULTI_IN: +@GST_ELEMENT_THREAD_SUGGESTED: @@ -142,6 +152,14 @@ Query whether this object has multiple input pads. @obj: Element to query for multiple input pads. + + + + + +@obj: + + @@ -154,6 +172,12 @@ This struct is used to define public information about the element. It describes the element, mostly for the benefit of editors. +@longname: +@class: +@description: +@version: +@author: +@copyright: @@ -162,6 +186,11 @@ of the element, the GtkType value for it, as well as a pointer to the GstElementDetails struct for the element. +@name: +@type: +@details: +@src_types: +@sink_types: @@ -320,6 +349,16 @@ circumstances. @Returns: + + + + + +@parent: +@elements: +@Returns: + + diff --git a/docs/gst/tmpl/gstextratypes.sgml b/docs/gst/tmpl/gstextratypes.sgml new file mode 100644 index 0000000000..af34d4b41a --- /dev/null +++ b/docs/gst/tmpl/gstextratypes.sgml @@ -0,0 +1,31 @@ + +GstExtraTypes + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + diff --git a/docs/gst/tmpl/gstmeta.sgml b/docs/gst/tmpl/gstmeta.sgml index 184eebc49b..70a5fe4122 100644 --- a/docs/gst/tmpl/gstmeta.sgml +++ b/docs/gst/tmpl/gstmeta.sgml @@ -112,6 +112,8 @@ it, is there? +@meta: + @buf: @@ -147,12 +149,17 @@ it, is there? +@GST_META_FREEABLE: +@lock: +@flags: +@data: +@size: diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 843124012a..ab7d4af19e 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -78,6 +78,9 @@ the function that will be called when a QoS message is sent. +@GST_PAD_UNKNOWN: +@GST_PAD_SRC: +@GST_PAD_SINK: @@ -278,3 +281,13 @@ the function that will be called when a QoS message is sent. @Returns: + + + + + +@parent: +@element: +@elements: + + diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index acf6798acf..724d9838dc 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -20,6 +20,12 @@ GStreamer is extensible so GstElements can be loaded at r +@name: +@longname: +@filename: +@types: +@elements: +@loaded: diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 7639eba647..2243adc417 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -17,13 +17,6 @@ - - - - - -@src: - @@ -31,6 +24,13 @@ @Returns: + + + + + +@src: + @@ -45,6 +45,12 @@ @obj: + + + + + + @@ -53,12 +59,6 @@ @name: @Returns: - - - - - - @@ -133,6 +133,10 @@ + + + + @@ -167,13 +171,6 @@ @Returns: - - - - - -@Returns: - @@ -181,19 +178,19 @@ @obj: - - - - - - - + @Returns: + + + + + + @@ -201,6 +198,13 @@ @klass: + + + + + +@Returns: + @@ -237,6 +241,12 @@ @name: @Returns: + + + + + + @@ -264,6 +274,13 @@ @klass: + + + + + +@arg: + @@ -339,12 +356,6 @@ - - - - - - @@ -352,6 +363,12 @@ @klass: + + + + + + @@ -392,6 +409,10 @@ + +GstColorSpace + + @@ -422,6 +443,12 @@ @name: @Returns: + + + + + + @@ -457,6 +484,10 @@ @obj: + +GstGetbits + + @@ -668,14 +699,18 @@ This macro unsets the given state on the element. - + + + + + @klass: - + @@ -715,6 +750,12 @@ This macro unsets the given state on the element. + + + + + + @@ -891,6 +932,12 @@ plugin @obj: + + +A flag indicating that SSE instructions are supported. + + + @@ -1087,6 +1134,12 @@ This macro checks to see if the given state is set. + + + + + + @@ -1143,6 +1196,12 @@ This macro checks to see if the given state is set. @esdsink: @frequency: + + +Get the size of the current file. + + + @@ -1177,6 +1236,13 @@ This macro checks to see if the given state is set. + + + + + +@thread: + @@ -1300,13 +1366,6 @@ This macro checks to see if the given state is set. - - - - - -@meta: - @@ -1314,6 +1373,13 @@ This macro checks to see if the given state is set. @Returns: + + + + + +@meta: + @@ -1355,6 +1421,12 @@ This macro checks to see if the given state is set. + + + + + + @@ -1362,12 +1434,6 @@ This macro checks to see if the given state is set. @obj: - - - - - - @@ -1445,6 +1511,10 @@ GstElement @obj: + + + + @@ -1452,10 +1522,6 @@ GstElement @src: - - - - @@ -1506,6 +1572,13 @@ GstElement @fd: @Returns: + + + + + +@buf: + @@ -1570,3 +1643,9 @@ GstElement + + +A flag indicating that MMX instructions are supported. + + + diff --git a/docs/gst/tmpl/gstsrc.sgml b/docs/gst/tmpl/gstsrc.sgml index 7cd79db422..cf087070ac 100644 --- a/docs/gst/tmpl/gstsrc.sgml +++ b/docs/gst/tmpl/gstsrc.sgml @@ -30,6 +30,7 @@ audio source. It provides data for the next element in the graph. +@GST_SRC_ASYNC: diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 85226c9fd0..68d88530e6 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -43,6 +43,9 @@ to be dealt with in the separate thread. +@GST_THREAD_CREATE: +@GST_THREAD_STATE_SPINNING: +@GST_THREAD_STATE_REAPING: @@ -59,22 +62,6 @@ to be dealt with in the separate thread. @Returns: - - - - - -@arg: - - - - - - - -@thread: - - TRUE if the thread should be created. diff --git a/docs/gst/tmpl/gsttrace.sgml b/docs/gst/tmpl/gsttrace.sgml index e93cd039f2..cb36b95380 100644 --- a/docs/gst/tmpl/gsttrace.sgml +++ b/docs/gst/tmpl/gsttrace.sgml @@ -27,12 +27,21 @@ Tracing functionality +@filename: +@fd: +@buf: +@bufsize: +@bufoffset: +@timestamp: +@sequence: +@data: +@message: diff --git a/docs/gst/tmpl/gsttype.sgml b/docs/gst/tmpl/gsttype.sgml index 6e4c742861..a1428b1267 100644 --- a/docs/gst/tmpl/gsttype.sgml +++ b/docs/gst/tmpl/gsttype.sgml @@ -69,12 +69,22 @@ valid mp3 decoder, and thus the whole point of the type system. +@id: +@mime: +@exts: +@typefindfunc: +@srcs: +@sinks: +@converters: +@mime: +@exts: +@typefindfunc: diff --git a/docs/gst/tmpl/gsttypefind.sgml b/docs/gst/tmpl/gsttypefind.sgml new file mode 100644 index 0000000000..b02705b11c --- /dev/null +++ b/docs/gst/tmpl/gsttypefind.sgml @@ -0,0 +1,30 @@ + +GstTypeFind + + +Detect the mime type of a media stream + + + +This element can be added to the pipeline and will notify the listener of +the detected mime type of the stream. It is used in autoplugging. + + + + + + + + + +The signal to indicate the mime type was detected. + + +@gsttypefind: the object which received the signal. +@arg1: The mime type that was detected + + + +Query the element for the current mime type + + diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index ee985b4c54..c543a8d283 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -15,6 +15,24 @@ All GstElements can be serialized to an XML presentation + + + + + +@object: +@elements: + + + + + + +@fname: +@root: +@Returns: + + @@ -24,3 +42,13 @@ All GstElements can be serialized to an XML presentation @Returns: + + + + + +@xml: +@name: +@Returns: + + diff --git a/docs/gst/tmpl/spectrum.sgml b/docs/gst/tmpl/spectrum.sgml index 9835398bab..556d71bd39 100644 --- a/docs/gst/tmpl/spectrum.sgml +++ b/docs/gst/tmpl/spectrum.sgml @@ -20,4 +20,11 @@ Frequencies of a spectrum analysis. +@meta: +@bands: +@channels: +@interleaved: +@lowfreq: +@highfreq: +@steps: diff --git a/docs/gst/tmpl/videoraw.sgml b/docs/gst/tmpl/videoraw.sgml index 080d0fce29..d2518506fc 100644 --- a/docs/gst/tmpl/videoraw.sgml +++ b/docs/gst/tmpl/videoraw.sgml @@ -19,6 +19,10 @@ Information about video buffers. +@meta: +@format: +@visual: +@height: @@ -31,10 +35,18 @@ Information about video buffers. +@width: +@height: +@did_overlay: +@fully_obscured: +@x1: +@x2: +@y1: +@y2: