Bring the low level API docs up to date.

Original commit message from CVS:
Bring the low level API docs up to date.
This commit is contained in:
Wim Taymans 2000-09-13 19:04:55 +00:00
parent 8d2a4dfbec
commit 56e7d38238
23 changed files with 1390 additions and 152 deletions

File diff suppressed because it is too large Load diff

View file

@ -5,6 +5,7 @@
<!entity GstBin SYSTEM "sgml/gstbin.sgml"> <!entity GstBin SYSTEM "sgml/gstbin.sgml">
<!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml"> <!entity GstBuffer SYSTEM "sgml/gstbuffer.sgml">
<!entity GstConnection SYSTEM "sgml/gstconnection.sgml"> <!entity GstConnection SYSTEM "sgml/gstconnection.sgml">
<!entity GstCpu SYSTEM "sgml/gstcpu.sgml">
<!entity GstElement SYSTEM "sgml/gstelement.sgml"> <!entity GstElement SYSTEM "sgml/gstelement.sgml">
<!entity GstFilter SYSTEM "sgml/gstfilter.sgml"> <!entity GstFilter SYSTEM "sgml/gstfilter.sgml">
<!entity GstLog SYSTEM "sgml/gstlog.sgml"> <!entity GstLog SYSTEM "sgml/gstlog.sgml">
@ -37,6 +38,7 @@
<!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml"> <!entity GstFdSink SYSTEM "sgml/gstfdsink.sgml">
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml"> <!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml"> <!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity audioraw SYSTEM "sgml/audioraw.sgml"> <!entity audioraw SYSTEM "sgml/audioraw.sgml">
@ -77,6 +79,7 @@ with some more specialized elements.</para>
&GstType; &GstType;
&GstMeta; &GstMeta;
&GstUtils; &GstUtils;
&GstCpu;
&GstTrace; &GstTrace;
&GstXml; &GstXml;
</chapter> </chapter>
@ -127,6 +130,7 @@ with some more specialized elements.</para>
&GstAudioSink; &GstAudioSink;
&GstFdSink; &GstFdSink;
&GstPipefilter;
&GstIdentity; &GstIdentity;
&GstQueue; &GstQueue;
</chapter> </chapter>

View file

@ -22,6 +22,8 @@ cothread_main
<FILE>gst</FILE> <FILE>gst</FILE>
<TITLE>Gst</TITLE> <TITLE>Gst</TITLE>
gst_init gst_init
gst_main
gst_main_quit
DEBUG DEBUG
<SUBSECTION Standard> <SUBSECTION Standard>
</SECTION> </SECTION>
@ -46,6 +48,9 @@ GST_BIN
GST_BIN_CLASS GST_BIN_CLASS
GST_IS_BIN GST_IS_BIN
GST_IS_BIN_CLASS GST_IS_BIN_CLASS
gst_bin_details
gst_bin_destroy
gst_bin_use_cothreads
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -67,7 +72,9 @@ GST_BUFFER_UNLOCK
GstBufferFlags GstBufferFlags
GstBuffer GstBuffer
gst_buffer_new gst_buffer_new
gst_buffer_new_from_pool
gst_buffer_create_sub gst_buffer_create_sub
gst_buffer_append
gst_buffer_ref gst_buffer_ref
gst_buffer_ref_by_count gst_buffer_ref_by_count
gst_buffer_unref gst_buffer_unref
@ -80,6 +87,20 @@ gst_buffer_remove_meta
GST_BUFFER GST_BUFFER
</SECTION> </SECTION>
<SECTION>
<FILE>gstbufferpool</FILE>
GST_BUFFER_POOL
GstBufferPool
GstBufferPoolCreateFunction
GstBufferPoolDestroyFunction
gst_buffer_pool_new
gst_buffer_pool_new_buffer
gst_buffer_pool_destroy_buffer
gst_buffer_pool_set_create_function
gst_buffer_pool_set_destroy_function
gst_buffer_pool_destroy
</SECTION>
<SECTION> <SECTION>
<FILE>gstconnection</FILE> <FILE>gstconnection</FILE>
<TITLE>GstConnection</TITLE> <TITLE>GstConnection</TITLE>
@ -100,10 +121,11 @@ GstConnectionClass
<FILE>gstelement</FILE> <FILE>gstelement</FILE>
<TITLE>GstElement</TITLE> <TITLE>GstElement</TITLE>
GstElementState GstElementState
GstElementStateReturn
GST_STATE GST_STATE
GST_STATE_IS_SET GST_STATE_PENDING
GST_STATE_SET GstElementFlags
GST_STATE_UNSET GST_ELEMENT_IS_MULTI_IN
GstElement GstElement
GstElementDetails GstElementDetails
GstElementFactory GstElementFactory
@ -121,15 +143,19 @@ gst_element_get_pad_list
gst_element_connect gst_element_connect
gst_element_set_state gst_element_set_state
gst_element_error gst_element_error
gst_element_change_state gst_element_get_factory
gst_element_destroy gst_element_destroy
gst_element_save_thyself gst_element_save_thyself
gst_elementfactory_new gst_elementfactory_new
gst_elementfactory_register gst_elementfactory_register
gst_elementfactory_add_sink
gst_elementfactory_add_src
gst_elementfactory_find gst_elementfactory_find
gst_elementfactory_get_list gst_elementfactory_get_list
gst_elementfactory_create gst_elementfactory_create
gst_elementfactory_make gst_elementfactory_make
gst_elementfactory_save_thyself
gst_elementfactory_load_thyself
gst_element_loopfunc_wrapper gst_element_loopfunc_wrapper
<SUBSECTION Standard> <SUBSECTION Standard>
GstElementClass GstElementClass
@ -156,6 +182,21 @@ GST_IS_FILTER
GST_IS_FILTER_CLASS GST_IS_FILTER_CLASS
</SECTION> </SECTION>
<SECTION>
<FILE>gstclock</FILE>
GstClockTime
GstClockTimeDiff
GST_CLOCK_DIFF
GstClock
gst_clock_new
gst_clock_get_system
gst_clock_register
gst_clock_set
gst_clock_reset
gst_clock_wait
gst_clock_current_diff
</SECTION>
<SECTION> <SECTION>
<FILE>gstlog</FILE> <FILE>gstlog</FILE>
GST_SHOW_INFO GST_SHOW_INFO
@ -217,6 +258,7 @@ GstPad
GstPadChainFunction GstPadChainFunction
GstPadPullFunction GstPadPullFunction
GstPadPushFunction GstPadPushFunction
GstPadQoSFunction
GstPadDirection GstPadDirection
gst_pad_new gst_pad_new
gst_pad_destroy gst_pad_destroy
@ -234,8 +276,11 @@ gst_pad_get_parent
gst_pad_get_ghost_parents gst_pad_get_ghost_parents
gst_pad_get_peer gst_pad_get_peer
gst_pad_connect gst_pad_connect
gst_pad_disconnect
gst_pad_push gst_pad_push
gst_pad_pull gst_pad_pull
gst_pad_set_qos_function
gst_pad_handle_qos
gst_pad_save_thyself gst_pad_save_thyself
<SUBSECTION Standard> <SUBSECTION Standard>
GstPadClass GstPadClass
@ -252,6 +297,7 @@ gst_pad_get_type
<TITLE>GstPipeline</TITLE> <TITLE>GstPipeline</TITLE>
GstPipeline GstPipeline
gst_pipeline_new gst_pipeline_new
gst_pipeline_autoplug
gst_pipeline_destroy gst_pipeline_destroy
gst_pipeline_iterate gst_pipeline_iterate
<SUBSECTION Standard> <SUBSECTION Standard>
@ -262,6 +308,7 @@ GST_PIPELINE
GST_PIPELINE_CLASS GST_PIPELINE_CLASS
GST_IS_PIPELINE GST_IS_PIPELINE
GST_IS_PIPELINE_CLASS GST_IS_PIPELINE_CLASS
gst_pipeline_details
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -274,12 +321,17 @@ gst_plugin_new
gst_plugin_set_longname gst_plugin_set_longname
gst_plugin_load_all gst_plugin_load_all
gst_plugin_load gst_plugin_load
gst_plugin_add_type
gst_library_load gst_library_load
gst_plugin_load_absolute gst_plugin_load_absolute
gst_plugin_add_factory gst_plugin_add_factory
gst_plugin_find gst_plugin_find
gst_plugin_get_list gst_plugin_get_list
gst_plugin_find_elementfactory gst_plugin_find_elementfactory
gst_plugin_load_elementfactory
gst_plugin_load_typefactory
gst_plugin_load_thyself
gst_plugin_save_thyself
<SUBSECTION Standard> <SUBSECTION Standard>
</SECTION> </SECTION>
@ -353,6 +405,7 @@ GST_THREAD
GST_THREAD_CLASS GST_THREAD_CLASS
GST_IS_THREAD GST_IS_THREAD
GST_IS_THREAD_CLASS GST_IS_THREAD_CLASS
gst_thread_details
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -388,6 +441,12 @@ gst_type_get_srcs
gst_type_get_sinks gst_type_get_sinks
gst_type_find_by_id gst_type_find_by_id
gst_type_get_list gst_type_get_list
gst_type_save_thyself
gst_type_get_sink_to_src
gst_type_dump
gst_type_load_thyself
gst_typefactory_load_thyself
gst_typefactory_save_thyself
<SUBSECTION Standard> <SUBSECTION Standard>
</SECTION> </SECTION>
@ -401,6 +460,7 @@ gst_util_get_double_arg
gst_util_get_string_arg gst_util_get_string_arg
gst_util_get_pointer_arg gst_util_get_pointer_arg
gst_util_get_widget_arg gst_util_get_widget_arg
gst_util_dump_mem
<SUBSECTION Standard> <SUBSECTION Standard>
</SECTION> </SECTION>
@ -410,6 +470,14 @@ gst_util_get_widget_arg
gst_xml_write gst_xml_write
</SECTION> </SECTION>
<SECTION>
<FILE>gstcpu</FILE>
<TITLE>GstCpu</TITLE>
GST_CPU_FLAG_MMX
GST_CPU_FLAG_SSE
gst_cpu_get_flags
</SECTION>
<SECTION> <SECTION>
<FILE>gstasyncdisksrc</FILE> <FILE>gstasyncdisksrc</FILE>
<TITLE>GstAsyncDiskSrc</TITLE> <TITLE>GstAsyncDiskSrc</TITLE>
@ -431,12 +499,14 @@ GST_IS_ASYNCDISKSRC_CLASS
<SUBSECTION Standard> <SUBSECTION Standard>
GstAudioSink GstAudioSink
GstAudioSinkClass GstAudioSinkClass
GstAudioSinkFlags
gst_audiosink_get_type gst_audiosink_get_type
GST_TYPE_AUDIOSINK GST_TYPE_AUDIOSINK
GST_AUDIOSINK GST_AUDIOSINK
GST_AUDIOSINK_CLASS GST_AUDIOSINK_CLASS
GST_IS_AUDIOSINK GST_IS_AUDIOSINK
GST_IS_AUDIOSINK_CLASS GST_IS_AUDIOSINK_CLASS
gst_audiosink_factory_init
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -445,6 +515,7 @@ GST_IS_AUDIOSINK_CLASS
<SUBSECTION Standard> <SUBSECTION Standard>
GstAudioSrc GstAudioSrc
GstAudioSrcClass GstAudioSrcClass
GstAudioSrcFlags
gst_audiosrc_get_type gst_audiosrc_get_type
GST_TYPE_AUDIOSRC GST_TYPE_AUDIOSRC
GST_AUDIOSRC GST_AUDIOSRC
@ -466,6 +537,7 @@ GST_DISKSRC
GST_DISKSRC_CLASS GST_DISKSRC_CLASS
GST_IS_DISKSRC GST_IS_DISKSRC
GST_IS_DISKSRC_CLASS GST_IS_DISKSRC_CLASS
gst_disksrc_details
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -543,6 +615,7 @@ GST_IS_FDSRC_CLASS
<TITLE>GstHttpSrc</TITLE> <TITLE>GstHttpSrc</TITLE>
<SUBSECTION Standard> <SUBSECTION Standard>
GstHttpSrc GstHttpSrc
GstHttpSrcFlags
gst_httpsrc_get_type gst_httpsrc_get_type
GstHttpSrcClass GstHttpSrcClass
GST_TYPE_HTTPSRC GST_TYPE_HTTPSRC
@ -594,6 +667,21 @@ GST_IS_SINESRC
GST_IS_SINESRC_CLASS GST_IS_SINESRC_CLASS
</SECTION> </SECTION>
<SECTION>
<FILE>gstpipefilter</FILE>
<TITLE>GstPipefilter</TITLE>
<SUBSECTION Standard>
GST_TYPE_PIPEFILTER
GST_PIPEFILTER
GST_PIPEFILTER_CLASS
GST_IS_PIPEFILTER
GST_IS_PIPEFILTER_CLASS
GstPipeFilterFlags
GstPipefilter
GstPipefilterClass
gst_pipefilter_get_type
</SECTION>
<SECTION> <SECTION>
<FILE>audioraw</FILE> <FILE>audioraw</FILE>
MetaAudioRaw MetaAudioRaw

View file

@ -9,6 +9,7 @@ GtkObject
GstThread GstThread
GstFilter GstFilter
GstTee GstTee
GstPipefilter
GstIdentity GstIdentity
GstSink GstSink
GstFakeSink GstFakeSink

View file

@ -25,5 +25,6 @@ gst_sinesrc_get_type
gst_audiosink_get_type gst_audiosink_get_type
gst_fdsink_get_type gst_fdsink_get_type
gst_pipefilter_get_type
gst_identity_get_type gst_identity_get_type
gst_queue_get_type gst_queue_get_type

View file

@ -39,6 +39,20 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
@argv: @argv:
<!-- ##### FUNCTION gst_main ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_main_quit ##### -->
<para>
</para>
<!-- ##### MACRO DEBUG ##### --> <!-- ##### MACRO DEBUG ##### -->
<para> <para>
Use this macro to show debugging info. This is only usefull when developing new Use this macro to show debugging info. This is only usefull when developing new

View file

@ -22,3 +22,23 @@ The buffer is sent to the sound card.
@gstaudiosink: the object which received the signal. @gstaudiosink: the object which received the signal.
@arg1: the audiosink. @arg1: the audiosink.
<!-- ##### ARG GstAudioSink:mute ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:format ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:channels ##### -->
<para>
</para>
<!-- ##### ARG GstAudioSink:frequency ##### -->
<para>
</para>

View file

@ -56,7 +56,7 @@ clear a flag in a buffer
<!-- ##### MACRO GST_BUFFER_TYPE ##### --> <!-- ##### MACRO GST_BUFFER_TYPE ##### -->
<para> <para>
Retrieves the type id of the data in the buffer.
</para> </para>
@buf: GstBuffer @buf: GstBuffer
@ -134,6 +134,37 @@ this macro releases a lock on the object.
<!-- ##### ENUM GstBufferFlags ##### --> <!-- ##### ENUM GstBufferFlags ##### -->
<para> <para>
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_BUFFER_READONLY</entry>
<entry>the buffer is read only</entry>
</row>
<row>
<entry>GST_BUFFER_EOS</entry>
<entry>this buffer is the last one in the stream</entry>
</row>
<row>
<entry>GST_BUFFER_ORIGINAL</entry>
<entry>this buffer not a copy</entry>
</row>
<row>
<entry>GST_BUFFER_DONTFREE</entry>
<entry>do not try to free the data when this buffer is unref-ed</entry>
</row>
<row>
<entry>GST_BUFFER_FLUSH</entry>
<entry>this buffer is not related to previous buffers. This flag is mainly
used when data in a stream has been skipped</entry>
</row>
</tbody></tgroup></informaltable>
</para> </para>
@ -151,6 +182,15 @@ this macro releases a lock on the object.
@Returns: @Returns:
<!-- ##### FUNCTION gst_buffer_new_from_pool ##### -->
<para>
</para>
@pool:
@Returns:
<!-- ##### FUNCTION gst_buffer_create_sub ##### --> <!-- ##### FUNCTION gst_buffer_create_sub ##### -->
<para> <para>
@ -162,6 +202,16 @@ this macro releases a lock on the object.
@Returns: @Returns:
<!-- ##### FUNCTION gst_buffer_append ##### -->
<para>
</para>
@buffer:
@append:
@Returns:
<!-- ##### FUNCTION gst_buffer_ref ##### --> <!-- ##### FUNCTION gst_buffer_ref ##### -->
<para> <para>

View file

@ -0,0 +1,104 @@
<!-- ##### SECTION Title ##### -->
gstbufferpool
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_BUFFER_POOL ##### -->
<para>
</para>
@buf:
<!-- ##### STRUCT GstBufferPool ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GstBufferPoolCreateFunction ##### -->
<para>
</para>
@pool:
@user_data:
@Returns:
<!-- ##### USER_FUNCTION GstBufferPoolDestroyFunction ##### -->
<para>
</para>
@pool:
@buffer:
@user_data:
<!-- ##### FUNCTION gst_buffer_pool_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_buffer_pool_new_buffer ##### -->
<para>
</para>
@pool:
@Returns:
<!-- ##### FUNCTION gst_buffer_pool_destroy_buffer ##### -->
<para>
</para>
@pool:
@buffer:
<!-- ##### FUNCTION gst_buffer_pool_set_create_function ##### -->
<para>
</para>
@pool:
@create:
@user_data:
<!-- ##### FUNCTION gst_buffer_pool_set_destroy_function ##### -->
<para>
</para>
@pool:
@destroy:
@user_data:
<!-- ##### FUNCTION gst_buffer_pool_destroy ##### -->
<para>
</para>
@pool:

106
docs/gst/tmpl/gstclock.sgml Normal file
View file

@ -0,0 +1,106 @@
<!-- ##### SECTION Title ##### -->
gstclock
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstClockTime ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstClockTimeDiff ##### -->
<para>
</para>
<!-- ##### MACRO GST_CLOCK_DIFF ##### -->
<para>
</para>
@s:
@e:
<!-- ##### STRUCT GstClock ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_clock_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_clock_get_system ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_clock_register ##### -->
<para>
</para>
@clock:
@obj:
<!-- ##### FUNCTION gst_clock_set ##### -->
<para>
</para>
@clock:
@time:
<!-- ##### FUNCTION gst_clock_reset ##### -->
<para>
</para>
@clock:
<!-- ##### FUNCTION gst_clock_wait ##### -->
<para>
</para>
@clock:
@time:
@obj:
<!-- ##### FUNCTION gst_clock_current_diff ##### -->
<para>
</para>
@clock:
@time:
@Returns:

View file

@ -2,11 +2,12 @@
GstConnection GstConnection
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->
Passes buffers between elements. Generic connection between elements.
<!-- ##### SECTION Long_Description ##### --> <!-- ##### SECTION Long_Description ##### -->
<para> <para>
Passes buffers between elements. A connection is a bas class for a generic connection between
elements. A connection is typically a bas class for queues.
</para> </para>

42
docs/gst/tmpl/gstcpu.sgml Normal file
View file

@ -0,0 +1,42 @@
<!-- ##### SECTION Title ##### -->
GstCpu
<!-- ##### SECTION Short_Description ##### -->
Request the features of the CPU.
<!-- ##### SECTION Long_Description ##### -->
<para>
This module can be used when developing plugins. It is
typically used to enable special optimisations based on the
features of the CPU.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<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>
<!-- ##### FUNCTION gst_cpu_get_flags ##### -->
<para>
Request a set of bits specifiying the features of the CPU.
</para>
@Returns: the features of the CPU

View file

@ -46,3 +46,8 @@ Specify how many bytes to read at a time.
Get the current offset in the file. Get the current offset in the file.
</para> </para>
<!-- ##### ARG GstDiskSrc:size ##### -->
<para>
</para>

View file

@ -30,56 +30,75 @@ simpler to connect pads of two elements together.
<!-- ##### ENUM GstElementState ##### --> <!-- ##### ENUM GstElementState ##### -->
<para> <para>
This enum defines the standard states an element may be in. GST_STATE_MAX This enum defines the standard states an element may be in. You will normally
is the highest bit that can be set, and is used internally. use gst_element_set_state() to change the state of an element.
<informaltable pgwide=1 frame="none" role="enum"> <informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*"> <tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody> <tbody>
<row> <row>
<entry>GST_STATE_COMPLETE</entry> <entry>GST_STATE_NONE_PENDING</entry>
<entry>means all the necesary information is available to run, i.e. the <entry>The element is in the desired state.</entry>
filename for the disksrc, etc. </entry>
</row> </row>
<row> <row>
<entry>GST_STATE_RUNNING</entry> <entry>GST_STATE_NULL</entry>
<entry>means that it's actually doing something, but that's fuzzy. </entry> <entry>Reset the state of an element.</entry>
</row> </row>
<row> <row>
<entry>GST_STATE_DISCOVERY</entry> <entry>GST_STATE_READY</entry>
<entry>is intended for the autoconnect case, in those instances where <entry>will make the element ready to start processing data. some
the only way to determine the input or output type of some pad is for an elements might have a non trivial way to initialize themselves.
element to actually process some data. The idea in that case is that the </entry>
source element would be responsible for sending the data non-destructively
(in the case of a network client, it would have to save it all up, unless
it has seek capabilities over the network), and all downstream elements
process it in such a way as to not hose their own state. Or rather, when
they cease to do discovery, they completely wipe their state as if nothing
ever happened.</entry>
</row>
<row>
<entry>GST_STATE_PREROLL</entry>
<entry>is a local state, used for things like sending the first half of
an MPEG GOP through the decoder in order to start playback at a frame
somewhere in the middle of said GOP. Not sure how that will work,
exactly.</entry>
</row> </row>
<row> <row>
<entry>GST_STATE_PLAYING</entry> <entry>GST_STATE_PLAYING</entry>
<entry>means there really is data flowing through the graph.
</entry>
</row>
<row>
<entry>GST_STATE_PAUSED</entry>
<entry>means there really is data flowing <entry>means there really is data flowing
through the graph, where GST_STATE_PAUSED temporary stops the flow. GST_STATE_PLAYING && temporary stops the data flow.
GST_STATE_PAUSED is the same idea as !GST_STATE_PLAYING, but there are probably going to be </entry>
many cases where there really is a distinction.</entry>
</row> </row>
</tbody></tgroup></informaltable> </tbody></tgroup></informaltable>
</para> </para>
<!-- ##### ENUM GstElementStateReturn ##### -->
<para>
This enum defines the standard return values that an element
can return after a state change.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_STATE_FAILURE</entry>
<entry>the element could not perform the state change</entry>
</row>
<row>
<entry>GST_STATE_SUCCESS</entry>
<entry>the element successfully changed its state</entry>
</row>
<row>
<entry>GST_STATE_ASYNC</entry>
<entry>the element will asynchronously change its state as soon as possible
</entry>
</row>
</tbody></tgroup></informaltable>
</para>
<!-- ##### MACRO GST_STATE ##### --> <!-- ##### MACRO GST_STATE ##### -->
<para> <para>
This macro returns the entire state of the element. This macro returns the entire state of the element.
@ -88,31 +107,39 @@ This macro returns the entire state of the element.
@obj: Element to return state for. @obj: Element to return state for.
<!-- ##### MACRO GST_STATE_IS_SET ##### --> <!-- ##### MACRO GST_STATE_PENDING ##### -->
<para> <para>
This macro checks to see if the given state is set. This macro returns the currently pending state of the element.
</para> </para>
@obj: Element to check for state. @obj: Element to return the pending state for.
@flag: State to check for, must be a single bit in guint32.
<!-- ##### MACRO GST_STATE_SET ##### --> <!-- ##### ENUM GstElementFlags ##### -->
<para> <para>
This macro sets the given state on the element. This enum defines the standard flags that an element
may have.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GST_ELEMENT_MULTI_IN</entry>
<entry>the element has multiple input pads</entry>
</row>
</tbody></tgroup></informaltable>
</para> </para>
@obj: Element to set state of.
@flag: State to set, can be any number of bits in guint32.
<!-- ##### MACRO GST_ELEMENT_IS_MULTI_IN ##### -->
<!-- ##### MACRO GST_STATE_UNSET ##### -->
<para> <para>
This macro unsets the given state on the element. Query whether this object has multiple input pads.
</para> </para>
@obj: Element to unset state of. @obj: Element to query for multiple input pads.
@flag: State to unset, can be any number of bits in guint32.
<!-- ##### STRUCT GstElement ##### --> <!-- ##### STRUCT GstElement ##### -->
@ -245,9 +272,6 @@ circumstances.
@srcpadname: @srcpadname:
@dest: @dest:
@destpadname: @destpadname:
<!-- # Unused Parameters # -->
@srcpad:
@destpad:
<!-- ##### FUNCTION gst_element_set_state ##### --> <!-- ##### FUNCTION gst_element_set_state ##### -->
@ -269,13 +293,12 @@ circumstances.
@error: @error:
<!-- ##### FUNCTION gst_element_change_state ##### --> <!-- ##### FUNCTION gst_element_get_factory ##### -->
<para> <para>
</para> </para>
@element: @element:
@state:
@Returns: @Returns:
@ -316,6 +339,24 @@ circumstances.
@elementfactory: @elementfactory:
<!-- ##### FUNCTION gst_elementfactory_add_sink ##### -->
<para>
</para>
@elementfactory:
@id:
<!-- ##### FUNCTION gst_elementfactory_add_src ##### -->
<para>
</para>
@elementfactory:
@id:
<!-- ##### FUNCTION gst_elementfactory_find ##### --> <!-- ##### FUNCTION gst_elementfactory_find ##### -->
<para> <para>
@ -353,6 +394,25 @@ circumstances.
@Returns: @Returns:
<!-- ##### FUNCTION gst_elementfactory_save_thyself ##### -->
<para>
</para>
@factory:
@parent:
@Returns:
<!-- ##### FUNCTION gst_elementfactory_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### --> <!-- ##### FUNCTION gst_element_loopfunc_wrapper ##### -->
<para> <para>
</para> </para>

View file

@ -40,28 +40,37 @@ can this pad be used to pull a buffer
<!-- ##### USER_FUNCTION GstPadChainFunction ##### --> <!-- ##### USER_FUNCTION GstPadChainFunction ##### -->
<para> <para>
The function that will be called when chaining buffers.
</para> </para>
@pad: @pad: the pad that performed the chain
@buf: @buf: the buffer that is chained
<!-- ##### USER_FUNCTION GstPadPullFunction ##### --> <!-- ##### USER_FUNCTION GstPadPullFunction ##### -->
<para> <para>
The function that will be called when pulling buffers.
</para> </para>
@pad: @pad: the pad to pull
@Returns:
<!-- ##### USER_FUNCTION GstPadPushFunction ##### --> <!-- ##### USER_FUNCTION GstPadPushFunction ##### -->
<para> <para>
The function that will be called when pulling buffers.
</para> </para>
@pad: @pad: the pad to push
<!-- ##### USER_FUNCTION GstPadQoSFunction ##### -->
<para>
the function that will be called when a QoS message is sent.
</para>
@pad: the pad that sent the QoS message
@qos_message: the message
<!-- ##### ENUM GstPadDirection ##### --> <!-- ##### ENUM GstPadDirection ##### -->
@ -214,6 +223,15 @@ can this pad be used to pull a buffer
@sinkpad: @sinkpad:
<!-- ##### FUNCTION gst_pad_disconnect ##### -->
<para>
</para>
@srcpad:
@sinkpad:
<!-- ##### FUNCTION gst_pad_push ##### --> <!-- ##### FUNCTION gst_pad_push ##### -->
<para> <para>
@ -232,6 +250,24 @@ can this pad be used to pull a buffer
@Returns: @Returns:
<!-- ##### FUNCTION gst_pad_set_qos_function ##### -->
<para>
</para>
@pad:
@qos:
<!-- ##### FUNCTION gst_pad_handle_qos ##### -->
<para>
</para>
@pad:
@qos_message:
<!-- ##### FUNCTION gst_pad_save_thyself ##### --> <!-- ##### FUNCTION gst_pad_save_thyself ##### -->
<para> <para>

View file

@ -0,0 +1,22 @@
<!-- ##### SECTION Title ##### -->
GstPipefilter
<!-- ##### SECTION Short_Description ##### -->
A wrapper around every stdin/stdout capable program
<!-- ##### SECTION Long_Description ##### -->
<para>
A GstPipefilter pipes data to an external program and creates
buffers from its output.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ARG GstPipefilter:command ##### -->
<para>
Sets the command to be executed.
</para>

View file

@ -12,7 +12,9 @@ including threading, as well as provide simple interfaces to common
functions, like 'Play'. functions, like 'Play'.
</para> </para>
<para>FIXME: this is entirely blue-sky</para> <para>the pipeline also has the capability to autoplug. This feature
allows you to only define the input/output plugins and let the
pipeline figure out what plugins to use.</para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
@ -34,6 +36,15 @@ functions, like 'Play'.
@Returns: @Returns:
<!-- ##### FUNCTION gst_pipeline_autoplug ##### -->
<para>
</para>
@pipeline:
@Returns:
<!-- ##### MACRO gst_pipeline_destroy ##### --> <!-- ##### MACRO gst_pipeline_destroy ##### -->
<para> <para>
destroys the pipeline destroys the pipeline

View file

@ -71,6 +71,15 @@ by the loader at statup.
@Returns: @Returns:
<!-- ##### FUNCTION gst_plugin_add_type ##### -->
<para>
</para>
@plugin:
@factory:
<!-- ##### FUNCTION gst_library_load ##### --> <!-- ##### FUNCTION gst_library_load ##### -->
<para> <para>
@ -124,3 +133,37 @@ by the loader at statup.
@Returns: @Returns:
<!-- ##### FUNCTION gst_plugin_load_elementfactory ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_plugin_load_typefactory ##### -->
<para>
</para>
@mime:
<!-- ##### FUNCTION gst_plugin_load_thyself ##### -->
<para>
</para>
@parent:
<!-- ##### FUNCTION gst_plugin_save_thyself ##### -->
<para>
</para>
@parent:
@Returns:

View file

@ -595,6 +595,14 @@ The frequency.
@obj: @obj:
<!-- ##### MACRO GST_STATE_UNSET ##### -->
<para>
This macro unsets the given state on the element.
</para>
@obj: Element to unset state of.
@flag: State to unset, can be any number of bits in guint32.
<!-- ##### STRUCT GstDiskSrc ##### --> <!-- ##### STRUCT GstDiskSrc ##### -->
<para> <para>
@ -713,6 +721,14 @@ The frequency.
</para> </para>
<!-- ##### MACRO GST_STATE_SET ##### -->
<para>
This macro sets the given state on the element.
</para>
@obj: Element to set state of.
@flag: State to set, can be any number of bits in guint32.
<!-- ##### MACRO GST_AUDIOSRC_CLASS ##### --> <!-- ##### MACRO GST_AUDIOSRC_CLASS ##### -->
<para> <para>
@ -955,6 +971,14 @@ plugin
@obj: @obj:
<!-- ##### MACRO GST_STATE_IS_SET ##### -->
<para>
This macro checks to see if the given state is set.
</para>
@obj: Element to check for state.
@flag: State to check for, must be a single bit in guint32.
<!-- ##### MACRO GST_IS_SINESRC ##### --> <!-- ##### MACRO GST_IS_SINESRC ##### -->
<para> <para>
@ -1070,6 +1094,15 @@ plugin
@Returns: @Returns:
<!-- ##### FUNCTION gst_element_change_state ##### -->
<para>
</para>
@element:
@state:
@Returns:
<!-- ##### MACRO GST_FAKESRC_CLASS ##### --> <!-- ##### MACRO GST_FAKESRC_CLASS ##### -->
<para> <para>

View file

@ -109,5 +109,6 @@ the stream.
</para> </para>
@gstsrc: the object which received the signal. @gstsrc: the object which received the signal.
<!-- # Unused Parameters # -->
@arg1: the object which received the signal @arg1: the object which received the signal

View file

@ -58,8 +58,10 @@ valid mp3 decoder, and thus the whole point of the type system.
</para> </para>
@buf: @buf:
@private: @priv:
@Returns: @Returns:
<!-- # Unused Parameters # -->
@private:
<!-- ##### STRUCT GstType ##### --> <!-- ##### STRUCT GstType ##### -->
@ -154,3 +156,58 @@ valid mp3 decoder, and thus the whole point of the type system.
@Returns: @Returns:
<!-- ##### FUNCTION gst_type_save_thyself ##### -->
<para>
</para>
@type:
@parent:
@Returns:
<!-- ##### FUNCTION gst_type_get_sink_to_src ##### -->
<para>
</para>
@sinkid:
@srcid:
@Returns:
<!-- ##### FUNCTION gst_type_dump ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_type_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_typefactory_load_thyself ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_typefactory_save_thyself ##### -->
<para>
</para>
@factory:
@parent:
@Returns:

View file

@ -84,3 +84,12 @@ Utility functions
@Returns: @Returns:
<!-- ##### FUNCTION gst_util_dump_mem ##### -->
<para>
</para>
@mem:
@size:

View file

@ -24,6 +24,7 @@
<!ENTITY XML SYSTEM "xml.sgml"> <!ENTITY XML SYSTEM "xml.sgml">
<!ENTITY PLUGINS SYSTEM "plugins.sgml"> <!ENTITY PLUGINS SYSTEM "plugins.sgml">
<!ENTITY PROGRAMS SYSTEM "programs.sgml"> <!ENTITY PROGRAMS SYSTEM "programs.sgml">
<!ENTITY COMPONENTS SYSTEM "components.sgml">
]> ]>
<book id="GStreamer"> <book id="GStreamer">
@ -196,6 +197,8 @@
&PROGRAMS; &PROGRAMS;
&COMPONENTS;
</part> </part>
</book> </book>