mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-06-18 05:50:41 +00:00
Code Issues 1 Projects Releases Wiki Activity

More docs updates

Browse source 
Original commit message from CVS:
More docs updates
This commit is contained in:
Wim Taymans 2000-10-22 16:30:25 +00:00
parent 894215eb29
commit 268bcbb89d
23 changed files with 398 additions and 93 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/gst/tmpl/audioraw.sgml
View file

@ -19,4 +19,9 @@ Information about audio buffers.
</para>
@meta:
@format:
@channels:
@frequency:
@bps:

13
docs/gst/tmpl/cothreads.sgml
View file

@ -47,12 +47,25 @@ cothreads
</para>
@ctx:
@threadnum:
@func:
@argc:
@argv:
@flags:
@sp:
@top_sp:
@pc:
@jmp:
<!-- ##### STRUCT cothread_context ##### -->
<para>
</para>
@threads:
@nthreads:
@current:
<!-- ##### USER_FUNCTION cothread_func ##### -->
<para>

11
docs/gst/tmpl/gstasyncdisksrc.sgml
View file

@ -29,6 +29,7 @@ the offset.
</para>
@GST_ASYNCDISKSRC_OPEN:
<!-- ##### ARG GstAsyncDiskSrc:location ##### -->
<para>
@ -40,13 +41,13 @@ Specify the location of the file to read.
Specify how many bytes to read at a time.
</para>
<!-- ##### ARG GstAsyncDiskSrc:length ##### -->
<para>
Get the size of the current file.
</para>
<!-- ##### ARG GstAsyncDiskSrc:offset ##### -->
<para>
Specify the current offset in the file.
</para>
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<para>
</para>

1
docs/gst/tmpl/gstaudiosink.sgml
View file

@ -20,6 +20,7 @@ The buffer is sent to the sound card.
</para>
@gstaudiosink: the object which received the signal.
<!-- # Unused Parameters # -->
@arg1: the audiosink.
<!-- ##### ARG GstAudioSink:mute ##### -->

16
docs/gst/tmpl/gstbuffer.sgml
View file

@ -167,12 +167,28 @@ used when data in a stream has been skipped</entry>
</para>
@GST_BUFFER_READONLY:
@GST_BUFFER_EOS:
@GST_BUFFER_ORIGINAL:
@GST_BUFFER_DONTFREE:
@GST_BUFFER_FLUSH:
<!-- ##### STRUCT GstBuffer ##### -->
<para>
</para>
@lock:
@flags:
@data:
@size:
@maxsize:
@offset:
@timestamp:
@maxage:
@metas:
@parent:
@pool:
<!-- ##### FUNCTION gst_buffer_new ##### -->
<para>

25
docs/gst/tmpl/gstbufferpool.sgml
View file

@ -1,12 +1,21 @@
<!-- ##### SECTION Title ##### -->
gstbufferpool
GstBufferPool
<!-- ##### SECTION Short_Description ##### -->
Create buffers from a pool
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -14,19 +23,15 @@ gstbufferpool
</para>
<!-- ##### MACRO GST_BUFFER_POOL ##### -->
<para>
</para>
@buf:
<!-- ##### STRUCT GstBufferPool ##### -->
<para>
</para>
@new_buffer:
@new_user_data:
@destroy_user_data:
@destroy_buffer:
<!-- ##### USER_FUNCTION GstBufferPoolCreateFunction ##### -->
<para>

10
docs/gst/tmpl/gstclock.sgml
View file

@ -40,6 +40,16 @@ gstclock
</para>
@name:
@start_time:
@current_time:
@adjust:
@locking:
@sinkobjects:
@num:
@num_locked:
@sinkmutex:
@lock:
<!-- ##### FUNCTION gst_clock_new ##### -->
<para>

14
docs/gst/tmpl/gstcpu.sgml
View file

@ -18,19 +18,13 @@ features of the CPU.
</para>
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<!-- ##### ENUM GstCPUFlags ##### -->
<para>
A flag indicating that MMX instructions are supported.
</para>
<!-- ##### MACRO GST_CPU_FLAG_SSE ##### -->
<para>
A flag indicating that SSE instructions are supported.
</para>
@GST_CPU_FLAG_MMX:
@GST_CPU_FLAG_SSE:
<!-- ##### FUNCTION gst_cpu_get_flags ##### -->
<para>

1
docs/gst/tmpl/gstdisksrc.sgml
View file

@ -30,6 +30,7 @@ with seeking capabilities use a <classname>GstAsynDiskSrc</classname> instead.
</para>
@GST_DISKSRC_OPEN:
<!-- ##### ARG GstDiskSrc:location ##### -->
<para>

39
docs/gst/tmpl/gstelement.sgml
View file

@ -69,6 +69,11 @@ temporary stops the data flow.
</tbody></tgroup></informaltable>
</para>
@GST_STATE_NONE_PENDING:
@GST_STATE_NULL:
@GST_STATE_READY:
@GST_STATE_PLAYING:
@GST_STATE_PAUSED:
<!-- ##### ENUM GstElementStateReturn ##### -->
<para>
@ -98,6 +103,9 @@ can return after a state change.
</para>
@GST_STATE_FAILURE:
@GST_STATE_SUCCESS:
@GST_STATE_ASYNC:
<!-- ##### MACRO GST_STATE ##### -->
<para>
@ -132,6 +140,8 @@ may have.
</para>
@GST_ELEMENT_MULTI_IN:
@GST_ELEMENT_THREAD_SUGGESTED:
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
<para>
@ -142,6 +152,14 @@ Query whether this object has multiple input pads.
@obj: Element to query for multiple input pads.
<!-- ##### MACRO GST_ELEMENT_IS_THREAD_SUGGESTED ##### -->
<para>
</para>
@obj:
<!-- ##### STRUCT GstElement ##### -->
<para>
@ -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.
</para>
@longname:
@class:
@description:
@version:
@author:
@copyright:
<!-- ##### STRUCT GstElementFactory ##### -->
<para>
@ -162,6 +186,11 @@ of the element, the GtkType value for it, as well as a pointer to the
GstElementDetails struct for the element.
</para>
@name:
@type:
@details:
@src_types:
@sink_types:
<!-- ##### USER_FUNCTION GstElementLoopFunction ##### -->
<para>
@ -320,6 +349,16 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_element_load_thyself ##### -->
<para>
</para>
@parent:
@elements:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_new ##### -->
<para>

31
docs/gst/tmpl/gstextratypes.sgml Normal file
View file

@ -0,0 +1,31 @@
<!-- ##### SECTION Title ##### -->
GstExtraTypes
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_FILENAME ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_extra_get_filename_type ##### -->
<para>
</para>
@Returns:

7
docs/gst/tmpl/gstmeta.sgml
View file

@ -112,6 +112,8 @@ it, is there?
</para>
@meta:
<!-- # Unused Parameters # -->
@buf:
@ -147,12 +149,17 @@ it, is there?
</para>
@GST_META_FREEABLE:
<!-- ##### STRUCT GstMeta ##### -->
<para>
</para>
@lock:
@flags:
@data:
@size:
<!-- ##### FUNCTION gst_meta_new_size ##### -->
<para>

13
docs/gst/tmpl/gstpad.sgml
View file

@ -78,6 +78,9 @@ the function that will be called when a QoS message is sent.
</para>
@GST_PAD_UNKNOWN:
@GST_PAD_SRC:
@GST_PAD_SINK:
<!-- ##### FUNCTION gst_pad_new ##### -->
<para>
@ -278,3 +281,13 @@ the function that will be called when a QoS message is sent.
@Returns:
<!-- ##### FUNCTION gst_pad_load_and_connect ##### -->
<para>
</para>
@parent:
@element:
@elements:

6
docs/gst/tmpl/gstplugin.sgml
View file

@ -20,6 +20,12 @@ GStreamer is extensible so <classname>GstElements</classname> can be loaded at r
</para>
@name:
@longname:
@filename:
@types:
@elements:
@loaded:
<!-- ##### STRUCT GstPluginElement ##### -->
<para>

183
docs/gst/tmpl/gstreamer-unused.sgml
View file

@ -17,13 +17,6 @@
</para>
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para>
</para>
@src:
<!-- ##### FUNCTION gst_tee_get_type ##### -->
<para>
@ -31,6 +24,13 @@
@Returns:
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para>
</para>
@src:
<!-- ##### MACRO GST_FAKESRC ##### -->
<para>
@ -45,6 +45,12 @@
@obj:
<!-- ##### STRUCT GstAsyncDiskSrcClass ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_fdsink_new ##### -->
<para>
@ -53,12 +59,6 @@
@name:
@Returns:
<!-- ##### STRUCT GstAsyncDiskSrcClass ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_FILTER_CLASS ##### -->
<para>
@ -133,6 +133,10 @@
</para>
<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Short_Description ##### -->
<!-- ##### MACRO GST_PAD_CLASS ##### -->
<para>
@ -167,13 +171,6 @@
@Returns:
<!-- ##### FUNCTION gst_object_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_SINESRC ##### -->
<para>
@ -181,19 +178,19 @@
@obj:
<!-- ##### SECTION ./tmpl/plugin.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_audiosrc_get_type ##### -->
<!-- ##### FUNCTION gst_object_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION ./tmpl/plugin.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### MACRO GST_QUEUE_CLASS ##### -->
<para>
@ -201,6 +198,13 @@
@klass:
<!-- ##### FUNCTION gst_audiosrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_QUEUE ##### -->
<para>
@ -237,6 +241,12 @@
@name:
@Returns:
<!-- ##### SECTION ./tmpl/gstgetbits.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_SRC ##### -->
<para>
@ -264,6 +274,13 @@
@klass:
<!-- ##### FUNCTION gst_thread_main_loop ##### -->
<para>
</para>
@arg:
<!-- ##### MACRO GST_TYPE_BIN ##### -->
<para>
@ -339,12 +356,6 @@
</para>
<!-- ##### STRUCT GstFakeSink ##### -->
<para>
</para>
<!-- ##### MACRO GST_THREAD_CLASS ##### -->
<para>
@ -352,6 +363,12 @@
@klass:
<!-- ##### STRUCT GstFakeSink ##### -->
<para>
</para>
<!-- ##### MACRO GST_BIN_CLASS ##### -->
<para>
@ -392,6 +409,10 @@
</para>
<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Title ##### -->
GstColorSpace
<!-- ##### MACRO GST_PAD ##### -->
<para>
@ -422,6 +443,12 @@
@name:
@Returns:
<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_audiosrc_new ##### -->
<para>
@ -457,6 +484,10 @@
@obj:
<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Title ##### -->
GstGetbits
<!-- ##### MACRO GST_FILTER_CLASS ##### -->
<para>
@ -668,14 +699,18 @@ This macro unsets the given state on the element.
</para>
<!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### -->
<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:Short_Description ##### -->
<!-- ##### MACRO GST_ESDSINK_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_ESDSINK_CLASS ##### -->
<!-- ##### MACRO GST_ASYNCDISKSRC_CLASS ##### -->
<para>
</para>
@ -715,6 +750,12 @@ This macro unsets the given state on the element.
</para>
<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstHttpSrc ##### -->
<para>
@ -891,6 +932,12 @@ plugin
@obj:
<!-- ##### MACRO GST_CPU_FLAG_SSE ##### -->
<para>
A flag indicating that SSE instructions are supported.
</para>
<!-- ##### STRUCT GstAudioSrcClass ##### -->
<para>
@ -1087,6 +1134,12 @@ This macro checks to see if the given state is set.
<!-- ##### SECTION ./tmpl/gstgetbits.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_fakesink_get_type ##### -->
<para>
@ -1143,6 +1196,12 @@ This macro checks to see if the given state is set.
@esdsink:
@frequency:
<!-- ##### ARG GstAsyncDiskSrc:length ##### -->
<para>
Get the size of the current file.
</para>
<!-- ##### MACRO GST_TYPE_PIPELINE ##### -->
<para>
@ -1177,6 +1236,13 @@ This macro checks to see if the given state is set.
</para>
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### MACRO GST_AUDIOSINK ##### -->
<para>
@ -1300,13 +1366,6 @@ This macro checks to see if the given state is set.
</para>
<!-- ##### MACRO GST_META ##### -->
<para>
</para>
@meta:
<!-- ##### FUNCTION gst_audiosink_get_type ##### -->
<para>
@ -1314,6 +1373,13 @@ This macro checks to see if the given state is set.
@Returns:
<!-- ##### MACRO GST_META ##### -->
<para>
</para>
@meta:
<!-- ##### FUNCTION gst_httpsrc_get_type ##### -->
<para>
@ -1355,6 +1421,12 @@ This macro checks to see if the given state is set.
</para>
<!-- ##### MACRO GST_TYPE_FILTER ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_SINESRC_CLASS ##### -->
<para>
@ -1362,12 +1434,6 @@ This macro checks to see if the given state is set.
@obj:
<!-- ##### MACRO GST_TYPE_FILTER ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_AUDIOSRC_CLASS ##### -->
<para>
@ -1445,6 +1511,10 @@ GstElement
@obj:
<!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### -->
<!-- ##### FUNCTION gst_audiosrc_push ##### -->
<para>
@ -1452,10 +1522,6 @@ GstElement
@src:
<!-- ##### SECTION ./tmpl/plugin.sgml:Short_Description ##### -->
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
<para>
@ -1506,6 +1572,13 @@ GstElement
@fd:
@Returns:
<!-- ##### MACRO GST_BUFFER_POOL ##### -->
<para>
</para>
@buf:
<!-- ##### FUNCTION gst_audiosink_set_format ##### -->
<para>
@ -1570,3 +1643,9 @@ GstElement
</para>
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<para>
A flag indicating that MMX instructions are supported.
</para>

1
docs/gst/tmpl/gstsrc.sgml
View file

@ -30,6 +30,7 @@ audio source. It provides data for the next element in the graph.
</tbody></tgroup></informaltable>
</para>
@GST_SRC_ASYNC:
<!-- ##### MACRO GST_SRC_FLAGS ##### -->
<para>

19
docs/gst/tmpl/gstthread.sgml
View file

@ -43,6 +43,9 @@ to be dealt with in the separate thread.
</para>
@GST_THREAD_CREATE:
@GST_THREAD_STATE_SPINNING:
@GST_THREAD_STATE_REAPING:
<!-- ##### STRUCT GstThread ##### -->
<para>
@ -59,22 +62,6 @@ to be dealt with in the separate thread.
@Returns:
<!-- ##### FUNCTION gst_thread_main_loop ##### -->
<para>
</para>
@arg:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### ARG GstThread:create_thread ##### -->
<para>
TRUE if the thread should be created.

9
docs/gst/tmpl/gsttrace.sgml
View file

@ -27,12 +27,21 @@ Tracing functionality
</para>
@filename:
@fd:
@buf:
@bufsize:
@bufoffset:
<!-- ##### STRUCT GstTraceEntry ##### -->
<para>
</para>
@timestamp:
@sequence:
@data:
@message:
<!-- ##### FUNCTION gst_trace_new ##### -->
<para>

10
docs/gst/tmpl/gsttype.sgml
View file

@ -69,12 +69,22 @@ valid mp3 decoder, and thus the whole point of the type system.
</para>
@id:
@mime:
@exts:
@typefindfunc:
@srcs:
@sinks:
@converters:
<!-- ##### STRUCT GstTypeFactory ##### -->
<para>
</para>
@mime:
@exts:
@typefindfunc:
<!-- ##### FUNCTION gst_type_register ##### -->
<para>

30
docs/gst/tmpl/gsttypefind.sgml Normal file
View file

@ -0,0 +1,30 @@
<!-- ##### SECTION Title ##### -->
GstTypeFind
<!-- ##### SECTION Short_Description ##### -->
Detect the mime type of a media stream
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SIGNAL GstTypeFind::have-type ##### -->
<para>
The signal to indicate the mime type was detected.
</para>
@gsttypefind: the object which received the signal.
@arg1: The mime type that was detected
<!-- ##### ARG GstTypeFind:type ##### -->
<para>
Query the element for the current mime type
</para>

28
docs/gst/tmpl/gstxml.sgml
View file

@ -15,6 +15,24 @@ All GstElements can be serialized to an XML presentation
</para>
<!-- ##### STRUCT GstXML ##### -->
<para>
</para>
@object:
@elements:
<!-- ##### FUNCTION gst_xml_new ##### -->
<para>
</para>
@fname:
@root:
@Returns:
<!-- ##### FUNCTION gst_xml_write ##### -->
<para>
@ -24,3 +42,13 @@ All GstElements can be serialized to an XML presentation
@Returns:
<!-- ##### FUNCTION gst_xml_get_element ##### -->
<para>
</para>
@xml:
@name:
@Returns:

7
docs/gst/tmpl/spectrum.sgml
View file

@ -20,4 +20,11 @@ Frequencies of a spectrum analysis.
</para>
@meta:
@bands:
@channels:
@interleaved:
@lowfreq:
@highfreq:
@steps:

12
docs/gst/tmpl/videoraw.sgml
View file

@ -19,6 +19,10 @@ Information about video buffers.
</para>
@meta:
@format:
@visual:
@height:
<!-- ##### STRUCT MetaDGA ##### -->
<para>
@ -31,10 +35,18 @@ Information about video buffers.
</para>
@width:
@height:
@did_overlay:
@fully_obscured:
<!-- ##### STRUCT OverlayClip ##### -->
<para>
</para>
@x1:
@x2:
@y1:
@y2: