mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-06-20 23:10:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

API docs updates.

Browse source 
Original commit message from CVS:
API docs updates.
This commit is contained in:
Wim Taymans 2001-05-27 14:33:30 +00:00
parent eb6a6267bd
commit 1523fcb150
15 changed files with 806 additions and 295 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -17,6 +17,7 @@
<!entity GstParse SYSTEM "sgml/gstparse.sgml">
<!entity GstPlugin SYSTEM "sgml/gstplugin.sgml">
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
<!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
<!entity GstType SYSTEM "sgml/gsttype.sgml">
<!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
@ -77,6 +78,7 @@ with some more specialized elements.</para>
&GstProps;
&GstQueue;
&GstThread;
&GstScheduler;
&GstTrace;
&GstType;
&GstTypeFind;

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

@ -15,6 +15,10 @@ cothread_getcurrent
cothread_main
cothread_set_data
cothread_get_data
cothread_unlock
cothread_current_main
cothread_lock
cothread_trylock
<SUBSECTION Standard>
</SECTION>
@ -46,23 +50,22 @@ gst_debug_get_categories
gst_debug_set_categories
gst_debug_enable_category
gst_debug_disable_category
GST_DEBUG_SET_STRING
GST_DEBUG_ENTER
GST_DEBUG_ENTER_STRING
GST_DEBUG_LEAVE
GST_DEBUG_LEAVE_STRING
GST_DEBUG_NOPREFIX
GST_DEBUG
GST_DEBUG_ENABLE_CATEGORIES
GST_DEBUG_FUNCPTR
GST_DEBUG_PREFIX
GST_DEBUG_ENABLED
GST_DEBUG_FUNCPTR_NAME
GST_DEBUG_PAD_NAME
GST_DEBUG_THREAD_ARGS
GST_DEBUG_THREAD_FORMAT
GST_DEBUG_ELEMENT
GST_DEBUG_CHAR_MODE
GST_ERROR
GST_ERROR_OBJECT
GST_DEBUG_CHAR_MODE
GstDebugHandler
gst_default_debug_handler
gst_default_error_handler
GstInfoHandler
GstErrorHandler
@ -78,8 +81,36 @@ gst_extra_get_filename_type
<SECTION>
<FILE>gstscheduler</FILE>
<TITLE>GstScheduler</TITLE>
gst_bin_schedule_func
<TITLE>GstSchedule</TITLE>
GST_SCHED_PARENT
GstScheduleChain
GST_SCHEDULE_SAFETY
GST_SCHEDULE_ADD_ELEMENT
GST_SCHEDULE_REMOVE_ELEMENT
GST_SCHEDULE_ENABLE_ELEMENT
GST_SCHEDULE_DISABLE_ELEMENT
GST_SCHEDULE_LOCK_ELEMENT
GST_SCHEDULE_UNLOCK_ELEMENT
GST_SCHEDULE_PAD_CONNECT
GST_SCHEDULE_PAD_DISCONNECT
GST_SCHEDULE_ITERATE
gst_schedule_new
gst_schedule_add_element
gst_schedule_remove_element
gst_schedule_enable_element
gst_schedule_disable_element
gst_schedule_pad_connect
gst_schedule_pad_disconnect
gst_schedule_iterate
gst_schedule_show
<SUBSECTION Standard>
GstSchedule
GST_SCHEDULE
GST_IS_SCHEDULE
GST_TYPE_SCHEDULE
gst_schedule_get_type
GST_SCHEDULE_CLASS
GST_IS_SCHEDULE_CLASS
</SECTION>
<SECTION>
@ -96,8 +127,6 @@ gst_bin_get_by_name_recurse_up
gst_bin_get_list
gst_bin_set_state_type
gst_bin_iterate
gst_bin_create_plan
gst_bin_schedule
<SUBSECTION Standard>
GstBinClass
gst_bin_get_type
@ -107,7 +136,6 @@ GST_BIN_CLASS
GST_IS_BIN
GST_IS_BIN_CLASS
gst_bin_details
gst_bin_use_cothreads
_GstBinChain
</SECTION>
@ -187,10 +215,10 @@ GST_STATE
GST_STATE_PENDING
GST_STATE_TRANSITION
GST_STATE_NULL_TO_READY
GST_STATE_READY_TO_PLAYING
GST_STATE_READY_TO_PAUSED
GST_STATE_PAUSED_TO_READY
GST_STATE_PLAYING_TO_PAUSED
GST_STATE_PAUSED_TO_PLAYING
GST_STATE_PLAYING_TO_READY
GST_STATE_READY_TO_NULL
GstElementFlags
GST_ELEMENT_IS_THREAD_SUGGESTED
@ -199,6 +227,8 @@ GST_ELEMENT_IS_EOS
GST_ELEMENT_PARENT
GST_ELEMENT_NAME
GST_ELEMENT_PADS
GST_ELEMENT_SCHED
GST_ELEMENT_MANAGER
GstElement
GstElementDetails
GstElementFactory
@ -208,11 +238,12 @@ gst_element_destroy
gst_element_set_loop_function
gst_element_set_name
gst_element_get_name
gst_element_set_manager
gst_element_get_manager
gst_element_get_sched
gst_element_set_sched
gst_element_set_parent
gst_element_get_parent
gst_element_add_pad
gst_element_remove_pad
gst_element_get_pad
gst_element_get_pad_list
gst_element_get_padtemplate_list
@ -224,10 +255,11 @@ gst_element_request_pad_by_name
gst_element_connect
gst_element_disconnect
gst_element_set_state
gst_element_statename
gst_element_error
gst_element_get_factory
gst_element_signal_eos
gst_element_load_thyself
gst_element_restore_thyself
gst_elementfactory_new
gst_elementfactory_destroy
gst_elementfactory_add_padtemplate
@ -249,6 +281,7 @@ GST_IS_ELEMENT_CLASS
gst_element_get_type
</SECTION>
<SECTION>
<FILE>gstautoplug</FILE>
<TITLE>GstAutoplug</TITLE>
@ -316,7 +349,7 @@ GST_META
<SECTION>
<FILE>gstobject</FILE>
<TITLE>GstObject</TITLE>
GST_OBJECT_FLAG_LAST
GstObjectFlags
GstObject
GST_FLAGS
GST_FLAG_IS_SET
@ -328,7 +361,10 @@ GST_UNLOCK
GST_GET_LOCK
GST_OBJECT_PARENT
GST_OBJECT_NAME
GST_OBJECT_FLOATING
GST_OBJECT_DESTROYED
gst_object_new
gst_object_check_uniqueness
gst_object_set_parent
gst_object_get_parent
gst_object_set_name
@ -406,6 +442,8 @@ gst_pad_set_element_private
gst_pad_get_element_private
gst_pad_set_parent
gst_pad_get_parent
gst_pad_get_sched
gst_pad_set_sched
gst_pad_get_real_parent
gst_pad_add_ghost_pad
gst_pad_remove_ghost_pad
@ -425,13 +463,14 @@ gst_pad_negotiate_proxy
gst_pad_renegotiate
gst_pad_get_padtemplate
gst_pad_get_padtemplate_caps
gst_pad_eos_func
GST_RPAD_LEN
GST_RPAD_OFFSET
GST_RPAD_REGIONTYPE
GstRealPad
GST_RPAD_LEN
GST_RPAD_OFFSET
GST_RPAD_SCHED
GST_RPAD_REGIONTYPE
GST_RPAD_DIRECTION
GST_RPAD_CAPS
GST_RPAD_PEER

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

@ -21,27 +21,6 @@ of data out of their src element.
</para>
<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
<para>
The default stack size of a cothread.
</para>
<!-- ##### MACRO COTHREAD_MAXTHREADS ##### -->
<para>
The maximum number of cothreads we are going to support.
</para>
<!-- ##### MACRO STACK_SIZE ##### -->
<para>
</para>
<!-- ##### MACRO CURRENT_STACK_FRAME ##### -->
<para>
@ -70,10 +49,6 @@ The maximum number of cothreads we are going to support.
</para>
@threads:
@nthreads:
@current:
@data:
<!-- ##### USER_FUNCTION cothread_func ##### -->
<para>
@ -166,3 +141,36 @@ Indicates the cothread is started.
@Returns:
<!-- ##### FUNCTION cothread_unlock ##### -->
<para>
</para>
@thread:
<!-- ##### FUNCTION cothread_current_main ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION cothread_lock ##### -->
<para>
</para>
@thread:
<!-- ##### FUNCTION cothread_trylock ##### -->
<para>
</para>
@thread:
@Returns:

17
docs/gst/tmpl/gstbin.sgml
View file

@ -49,6 +49,7 @@ Flags for a bin.
</para>
@GST_BIN_FLAG_MANAGER:
@GST_BIN_SELF_SCHEDULABLE:
@GST_BIN_FLAG_PREFER_COTHREADS:
@GST_BIN_FLAG_LAST:
@ -142,22 +143,6 @@ Free the memory allocated by this bin
@Returns:
<!-- ##### FUNCTION gst_bin_create_plan ##### -->
<para>
</para>
@bin:
<!-- ##### FUNCTION gst_bin_schedule ##### -->
<para>
</para>
@bin:
<!-- ##### SIGNAL GstBin::object-added ##### -->
<para>
is signaled whenever a new <classname>GstElement</classname> is added to the <classname>GstBin</classname>

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

@ -39,8 +39,8 @@ use gst_element_set_state() to change the state of an element.
@GST_STATE_NULL: Reset the state of an element.
@GST_STATE_READY: will make the element ready to start processing data. some
elements might have a non trivial way to initialize themselves.
@GST_STATE_PLAYING: means there really is data flowing through the graph.
@GST_STATE_PAUSED: means there really is data flowing temporary stops the data flow.
@GST_STATE_PLAYING: means there really is data flowing through the graph.
<!-- ##### ENUM GstElementStateReturn ##### -->
<para>
@ -84,9 +84,16 @@ The Element is going from the NULL state to the READY state.
<!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### -->
<!-- ##### MACRO GST_STATE_READY_TO_PAUSED ##### -->
<para>
The Element is going from the READY state to the PLAYING state.
</para>
<!-- ##### MACRO GST_STATE_PAUSED_TO_READY ##### -->
<para>
</para>
@ -105,13 +112,6 @@ The Element is going from the PAUSED state to the PLAYING state.
<!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### -->
<para>
The Element is going from the PLAYING state to the READY state.
</para>
<!-- ##### MACRO GST_STATE_READY_TO_NULL ##### -->
<para>
The Element is going from the READY state to the NULL state.
@ -128,6 +128,7 @@ This enum defines the standard flags that an element may have.
@GST_ELEMENT_DECOUPLED:
@GST_ELEMENT_THREAD_SUGGESTED:
@GST_ELEMENT_NO_SEEK:
@GST_ELEMENT_NO_ENTRY:
@GST_ELEMENT_NEW_LOOPFUNC:
@GST_ELEMENT_COTHREAD_STOPPING:
@GST_ELEMENT_USE_COTHREAD:
@ -182,6 +183,22 @@ Get the pads of this elements.
@obj: The element to query
<!-- ##### MACRO GST_ELEMENT_SCHED ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_ELEMENT_MANAGER ##### -->
<para>
</para>
@obj:
<!-- ##### STRUCT GstElement ##### -->
<para>
@ -267,6 +284,24 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_element_get_sched ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_set_sched ##### -->
<para>
</para>
@element:
@sched:
<!-- ##### FUNCTION gst_element_set_parent ##### -->
<para>
@ -294,6 +329,15 @@ circumstances.
@pad:
<!-- ##### FUNCTION gst_element_remove_pad ##### -->
<para>
</para>
@element:
@pad:
<!-- ##### FUNCTION gst_element_get_pad ##### -->
<para>
@ -403,6 +447,15 @@ circumstances.
@Returns:
<!-- ##### FUNCTION gst_element_statename ##### -->
<para>
</para>
@state:
@Returns:
<!-- ##### FUNCTION gst_element_error ##### -->
<para>
@ -429,7 +482,7 @@ circumstances.
@element:
<!-- ##### FUNCTION gst_element_load_thyself ##### -->
<!-- ##### FUNCTION gst_element_restore_thyself ##### -->
<para>
</para>
@ -437,8 +490,6 @@ circumstances.
@self:
@parent:
@Returns:
<!-- # Unused Parameters # -->
@elements:
<!-- ##### FUNCTION gst_elementfactory_new ##### -->
@ -564,6 +615,14 @@ Is trigered whenever a new pad is added to an element
@gstelement: the object which received the signal.
@arg1: the new pad that was added
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::new-ghost-pad ##### -->
<para>
@ -573,6 +632,14 @@ Is trigered whenever a new ghost pad is added to an element
@gstelement: the object which received the signal.
@arg1: the new ghost pad that was added
<!-- ##### SIGNAL GstElement::ghost-pad-removed ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::error ##### -->
<para>
Is trigered whenever an error occured

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

@ -22,6 +22,7 @@ with the buffer. (fakesink)
</para>
@gstfakesink: the object which received the signal.
@arg1:
<!-- ##### ARG GstFakeSink:num_sources ##### -->
<para>

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

@ -20,6 +20,7 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>
@gstfakesrc: the object which received the signal.
@arg1:
<!-- ##### ARG GstFakeSrc:num_sources ##### -->
<para>
@ -51,3 +52,8 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>
<!-- ##### ARG GstFakeSrc:silent ##### -->
<para>
</para>

104
docs/gst/tmpl/gstinfo.sgml
View file

@ -78,6 +78,7 @@ before aborting the application.
</para>
@category:
@incore:
@file:
@function:
@line:
@ -146,16 +147,6 @@ Print out information like #GST_INFO, but with an element pointer to clarify thi
@category:
<!-- ##### MACRO GST_DEBUG_SET_STRING ##### -->
<para>
Set the debug string for the current function, typically containing the arguments
to the current function, i.e. "('element')"
</para>
@format: printf-style format string
@args...: printf arguments
<!-- ##### MACRO GST_DEBUG_ENTER ##### -->
<para>
Called at the beginning of a function, it simply prints out a DEBUG string of "entering"
@ -166,13 +157,6 @@ in addition to the given string.
@args...: printf arguments
<!-- ##### MACRO GST_DEBUG_ENTER_STRING ##### -->
<para>
Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING.
</para>
<!-- ##### MACRO GST_DEBUG_LEAVE ##### -->
<para>
@ -182,23 +166,6 @@ Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING.
@args...:
<!-- ##### MACRO GST_DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_NOPREFIX ##### -->
<para>
</para>
@cat:
@format:
@args...:
<!-- ##### MACRO GST_DEBUG ##### -->
<para>
Print out debugging information.
@ -224,16 +191,6 @@ Print out debugging information.
@ptr:
<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
<para>
</para>
@cat:
@format:
@args...:
<!-- ##### MACRO GST_DEBUG_ENABLED ##### -->
<para>
@ -257,6 +214,39 @@ Print out debugging information.
@pad:
<!-- ##### MACRO GST_DEBUG_THREAD_ARGS ##### -->
<para>
</para>
@id:
<!-- ##### MACRO GST_DEBUG_THREAD_FORMAT ##### -->
<para>
</para>
<!-- ##### MACRO GST_DEBUG_ELEMENT ##### -->
<para>
</para>
@cat:
@element:
@format:
@args...:
<!-- ##### MACRO GST_DEBUG_CHAR_MODE ##### -->
<para>
</para>
<!-- ##### MACRO GST_ERROR ##### -->
<para>
Print out an error condition and abort the application.
@ -278,11 +268,34 @@ Print out an error condition and abort the application.
@args...: printf arguments
<!-- ##### MACRO GST_DEBUG_CHAR_MODE ##### -->
<!-- ##### USER_FUNCTION GstDebugHandler ##### -->
<para>
</para>
@category:
@core:
@file:
@function:
@line:
@debug_string:
@element:
@string:
<!-- ##### FUNCTION gst_default_debug_handler ##### -->
<para>
</para>
@category:
@incore:
@file:
@function:
@line:
@debug_string:
@element:
@string:
<!-- ##### FUNCTION gst_default_error_handler ##### -->
@ -305,6 +318,7 @@ Print out an error condition and abort the application.
</para>
@category:
@incore:
@file:
@function:
@line:

57
docs/gst/tmpl/gstobject.sgml
View file

@ -25,12 +25,14 @@ down <classname>GtkObject</classname> to re-parent the hierarchy.
</para>
<!-- ##### MACRO GST_OBJECT_FLAG_LAST ##### -->
<!-- ##### ENUM GstObjectFlags ##### -->
<para>
subclasses can use this value to start the enumeration of their flags
</para>
@GST_DESTROYED:
@GST_FLOATING:
@GST_OBJECT_FLAG_LAST:
<!-- ##### STRUCT GstObject ##### -->
<para>
@ -123,6 +125,22 @@ Get the name of this object
@obj: Object to get the name of.
<!-- ##### MACRO GST_OBJECT_FLOATING ##### -->
<para>
Check if the object is floating.
</para>
@obj: The Object to check
<!-- ##### MACRO GST_OBJECT_DESTROYED ##### -->
<para>
Check if the object has been destroyed.
</para>
@obj: The Object to check
<!-- ##### FUNCTION gst_object_new ##### -->
<para>
@ -131,6 +149,16 @@ Get the name of this object
@Returns:
<!-- ##### FUNCTION gst_object_check_uniqueness ##### -->
<para>
</para>
@list:
@name:
@Returns:
<!-- ##### FUNCTION gst_object_set_parent ##### -->
<para>
@ -175,7 +203,16 @@ Get the name of this object
@object:
<!-- ##### MACRO gst_object_ref ##### -->
<!-- ##### FUNCTION gst_object_ref ##### -->
<para>
</para>
@object: the object
@Returns:
<!-- ##### FUNCTION gst_object_unref ##### -->
<para>
</para>
@ -183,7 +220,7 @@ Get the name of this object
@object: the object
<!-- ##### MACRO gst_object_unref ##### -->
<!-- ##### FUNCTION gst_object_sink ##### -->
<para>
</para>
@ -191,15 +228,7 @@ Get the name of this object
@object: the object
<!-- ##### MACRO gst_object_sink ##### -->
<para>
</para>
@object: the object
<!-- ##### MACRO gst_object_destroy ##### -->
<!-- ##### FUNCTION gst_object_destroy ##### -->
<para>
</para>

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

@ -502,6 +502,24 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_get_sched ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_pad_set_sched ##### -->
<para>
</para>
@pad:
@sched:
<!-- ##### FUNCTION gst_pad_get_real_parent ##### -->
<para>
@ -688,28 +706,13 @@ Call the EOS function of the pad
@Returns:
<!-- ##### MACRO GST_RPAD_LEN ##### -->
<!-- ##### FUNCTION gst_pad_eos_func ##### -->
<para>
Get the length of the region that is being pulled.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_OFFSET ##### -->
<para>
Get the offset of the region that is being pulled.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
<para>
Get the type of the region that is being pulled.
</para>
@pad: the real pad to query.
@pad:
@Returns:
<!-- ##### STRUCT GstRealPad ##### -->
@ -726,6 +729,7 @@ Get the type of the region that is being pulled.
@regiontype:
@offset:
@len:
@sched:
@chainfunc:
@getfunc:
@getregionfunc:
@ -739,6 +743,38 @@ Get the type of the region that is being pulled.
@bufferpoolfunc:
@ghostpads:
<!-- ##### MACRO GST_RPAD_LEN ##### -->
<para>
Get the length of the region that is being pulled.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_OFFSET ##### -->
<para>
Get the offset of the region that is being pulled.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_SCHED ##### -->
<para>
</para>
@pad:
<!-- ##### MACRO GST_RPAD_REGIONTYPE ##### -->
<para>
Get the type of the region that is being pulled.
</para>
@pad: the real pad to query.
<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
<para>
Get the direction of the real pad.

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

@ -28,18 +28,20 @@ objects factories:
</itemizedlist>
</para>
<para>
A new plugin is created with gst_plugin_new(). this function will return a handle
A plugin should export a symbol plugin_desc that is a struct of type #GstPluginDesc.
the plugin loader will check the version of the core library the plugin was linked against
and will create a new #GstPlugin. It will then call the #GstPluginInitFunc function
that was provided in the plugin_desc.
</para>
<para>
Optionally a new plugin is created with gst_plugin_new(). this function will return a handle
to the GstPlugin or NULL if the plugin could not be created.
</para>
<para>
Once a GstPlugin element has been created, you can add the different types of factories
Once you have a handle to a #GstPlugin, you can add the different types of factories
to it with gst_plugin_add_factory(), gst_plugin_add_type(), gst_plugin_add_autoplugger().
</para>
<para>
<application>Gstreamer</application> plugins should have a method plugin_init that is called
by the loader.
</para>
<para>
use gst_plugin_find(), gst_plugin_get_list(), gst_plugin_get_factory_list(), gst_plugin_get_type_list() and
gst_plugin_get_autoplug_list() to query the plugin repository.
</para>
@ -71,24 +73,25 @@ to bring it into memory.
<!-- ##### USER_FUNCTION GstPluginInitFunc ##### -->
<para>
A plugin should implement this function called plugin_init. It will be called
by the loader at statup.
A plugin should provide a pointer to a function of this type in the plugin_desc struct.
It will be called by the loader at statup.
</para>
@module: The <classname>GModule</classname> it was loaded from
@plugin:
@Returns: The plugin or NULL is an error was detected.
@plugin: The plugin object that can be used to register stuff for this plugin.
@Returns: A boolean indicating success or failure.
<!-- ##### STRUCT GstPluginDesc ##### -->
<para>
A plugins should export a variable of this type called plugin_desc. This plugin
loaded will use this variable to initialize the plugin.
</para>
@major_version:
@minor_version:
@name:
@plugin_init:
@major_version: The minor version of the gstreamer library this plugin was created with
@minor_version: The minor version of the gstreamer library this plugin was created with
@name: The name of the plugin
@plugin_init: The init function of this plugin.
<!-- ##### FUNCTION gst_plugin_new ##### -->
<para>

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

@ -25,6 +25,11 @@ The queue blocks by default.
</para>
<!-- ##### ARG GstQueue:leaky ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:level ##### -->
<para>
Get the number of buffers in the queue.
@ -36,8 +41,3 @@ Specify the maximum number of buffers in the queue before the queue
blocks.
</para>
<!-- ##### ARG GstQueue:block ##### -->
<para>
Specify wether the queue blocks or not.
</para>

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

@ -67,14 +67,6 @@ Query the element for the current mime type
</para>
<!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### FUNCTION gst_pad_remove_ghost_parent ##### -->
<para>
@ -83,7 +75,7 @@ Query the element for the current mime type
@pad:
@parent:
<!-- ##### FUNCTION gst_identity_chain ##### -->
<!-- ##### FUNCTION gst_fdsink_chain ##### -->
<para>
</para>
@ -91,7 +83,7 @@ Query the element for the current mime type
@pad:
@buf:
<!-- ##### FUNCTION gst_audiosink_chain ##### -->
<!-- ##### FUNCTION gst_identity_chain ##### -->
<para>
</para>
@ -106,6 +98,14 @@ Query the element for the current mime type
@Returns:
<!-- ##### FUNCTION gst_audiosink_chain ##### -->
<para>
</para>
@pad:
@buf:
<!-- ##### MACRO GST_PIPELINE_CLASS ##### -->
<para>
@ -200,6 +200,12 @@ the stream.
@gstsrc: the object which received the signal.
@arg1: the object which received the signal
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_disksrc_get_type ##### -->
<para>
@ -207,12 +213,6 @@ the stream.
@Returns:
<!-- ##### TYPEDEF GstCapsFactoryEntry ##### -->
<para>
</para>
<!-- ##### MACRO GST_IS_DISKSRC_CLASS ##### -->
<para>
@ -372,16 +372,16 @@ subclass use this to start their flag enumeration
@audiosink:
@channels:
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstSinkClass ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gstconnection.sgml:Short_Description ##### -->
Generic connection between elements.
<!-- ##### STRUCT GstFilterClass ##### -->
<para>
@ -395,6 +395,13 @@ Generic connection between elements.
@obj:
<!-- ##### FUNCTION gst_bin_schedule ##### -->
<para>
</para>
@bin:
<!-- ##### MACRO ERROR ##### -->
<para>
@ -430,6 +437,12 @@ Generic connection between elements.
@obj:
<!-- ##### MACRO GST_DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_esdsink_set_channels ##### -->
<para>
@ -458,6 +471,12 @@ Generic connection between elements.
@obj:
<!-- ##### ARG GstQueue:block ##### -->
<para>
Specify wether the queue blocks or not.
</para>
<!-- ##### FUNCTION gst_pad_pull_region ##### -->
<para>
@ -598,6 +617,12 @@ Specify the current offset in the file.
</para>
<!-- ##### MACRO STACK_SIZE ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_AUDIOSINK ##### -->
<para>
@ -661,13 +686,13 @@ Specify the current offset in the file.
@sheight:
@bytes_per_line:
<!-- ##### ARG GstAudioSink:format ##### -->
<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/GstElement.sgml:Long_Description ##### -->
<!-- ##### ARG GstAudioSink:format ##### -->
<para>
</para>
@ -701,17 +726,24 @@ Specify the current offset in the file.
@name:
@Returns:
<!-- ##### STRUCT GstConnection ##### -->
<para>
</para>
<!-- ##### STRUCT GstQueueClass ##### -->
<para>
</para>
<!-- ##### STRUCT GstConnection ##### -->
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para>
</para>
@src:
<!-- ##### FUNCTION gst_type_add_sink ##### -->
<para>
@ -721,13 +753,6 @@ Specify the current offset in the file.
@id:
@sink:
<!-- ##### FUNCTION gst_fakesrc_push ##### -->
<para>
</para>
@src:
<!-- ##### MACRO GST_IS_IDENTITY_CLASS ##### -->
<para>
@ -842,6 +867,15 @@ audioraw
@obj:
<!-- ##### MACRO GST_DEBUG_NOPREFIX ##### -->
<para>
</para>
@cat:
@format:
@args...:
<!-- ##### MACRO GST_IDENTITY ##### -->
<para>
@ -881,6 +915,13 @@ GstAsyncDiskSrc
@elementfactory:
@id:
<!-- ##### FUNCTION gst_bin_schedule_func ##### -->
<para>
</para>
@bin:
<!-- ##### MACRO GST_IS_OBJECT ##### -->
<para>
@ -964,14 +1005,6 @@ The buffer is sent to the sound card.
@pad:
@buf:
<!-- ##### FUNCTION gst_pad_eos_func ##### -->
<para>
</para>
@pad:
@Returns:
<!-- ##### FUNCTION gst_buffer_add_meta ##### -->
<para>
@ -1125,6 +1158,13 @@ The buffer is sent to the sound card.
@connection:
<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
<para>
Is emited after the buffer has been written to the disk.
</para>
@gstdisksink: the object which received the signal.
<!-- ##### FUNCTION gst_audiosink_new ##### -->
<para>
@ -1133,12 +1173,13 @@ The buffer is sent to the sound card.
@name:
@Returns:
<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
<!-- ##### FUNCTION gst_bin_set_element_manager ##### -->
<para>
Is emited after the buffer has been written to the disk.
</para>
@gstdisksink: the object which received the signal.
@element:
@manager:
<!-- ##### MACRO GST_ESDSINK ##### -->
<para>
@ -1164,13 +1205,6 @@ GstFilter
@obj:
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_QUEUE_CLASS ##### -->
<para>
@ -1178,6 +1212,13 @@ GstFilter
@obj:
<!-- ##### FUNCTION gst_fdsrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_pad_get_type_id ##### -->
<para>
@ -1186,6 +1227,13 @@ GstFilter
@pad:
@Returns:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### STRUCT OverlayClip ##### -->
<para>
@ -1196,13 +1244,6 @@ GstFilter
@y1:
@y2:
<!-- ##### FUNCTION gst_thread_iterate ##### -->
<para>
</para>
@thread:
<!-- ##### ENUM GstSrcFlags ##### -->
<para>
Flags for the GstSrc element
@ -1278,12 +1319,11 @@ Defines an entry for a padfactory.
@obj:
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<!-- ##### MACRO GST_OBJECT_FLAG_LAST ##### -->
<para>
subclasses can use this value to start the enumeration of their flags
</para>
@klass:
<!-- ##### FUNCTION gst_asyncdisksrc_get_type ##### -->
<para>
@ -1292,6 +1332,13 @@ Defines an entry for a padfactory.
@Returns:
<!-- ##### MACRO GST_AUDIOSINK_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_PAD_FACTORY_SINK ##### -->
<para>
Indicates a sinkpad for the padfactory.
@ -1327,6 +1374,12 @@ Indicates a sinkpad for the padfactory.
@pad:
@Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_esdsink_new ##### -->
<para>
@ -1335,12 +1388,6 @@ Indicates a sinkpad for the padfactory.
@name:
@Returns:
<!-- ##### MACRO GST_PROPS_FOURCC_ID ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_element_request_pad ##### -->
<para>
@ -1457,12 +1504,6 @@ Retrieves the type id of the data in the buffer.
@buf: GstBuffer
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### MACRO GST_PROPS_FLOAT_STRING ##### -->
<para>
@ -1470,6 +1511,12 @@ Retrieves the type id of the data in the buffer.
@a:
<!-- ##### MACRO DEBUG_LEAVE_STRING ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_filter_get_type ##### -->
<para>
@ -1491,16 +1538,16 @@ Retrieves the type id of the data in the buffer.
</para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### MACRO GST_CPU_FLAG_MMX ##### -->
<para>
A flag indicating that MMX instructions are supported.
</para>
<!-- ##### SECTION ./tmpl/gstsink.sgml:Title ##### -->
GstSink
<!-- ##### FUNCTION gst_object_get_type ##### -->
<para>
@ -1619,6 +1666,15 @@ Indicates a srcpad for the padfactory.
@esdsink:
@format:
<!-- ##### MACRO GST_DEBUG_PREFIX ##### -->
<para>
</para>
@cat:
@format:
@args...:
<!-- ##### SECTION ./tmpl/gstcolorspace.sgml:See_Also ##### -->
<para>
@ -1659,6 +1715,12 @@ Indicates a srcpad for the padfactory.
@obj:
<!-- ##### MACRO COTHREAD_MAXTHREADS ##### -->
<para>
The maximum number of cothreads we are going to support.
</para>
<!-- ##### FUNCTION gst_fakesink_new ##### -->
<para>
@ -1704,6 +1766,12 @@ GstSrc
@props:
@Returns:
<!-- ##### MACRO GST_STATE_READY_TO_PLAYING ##### -->
<para>
The Element is going from the READY state to the PLAYING state.
</para>
<!-- ##### MACRO GST_TYPE_AUDIOSRC ##### -->
<para>
@ -1895,6 +1963,16 @@ Query whether this object has multiple input pads.
</para>
<!-- ##### FUNCTION gst_element_load_thyself ##### -->
<para>
</para>
@self:
@parent:
@Returns:
@elements:
<!-- ##### FUNCTION gst_src_signal_eos ##### -->
<para>
@ -1920,6 +1998,14 @@ Information about video buffers.
</para>
<!-- ##### FUNCTION gst_bin_add_managed_element ##### -->
<para>
</para>
@bin:
@element:
<!-- ##### FUNCTION gst_queue_new ##### -->
<para>
@ -2037,6 +2123,12 @@ on its own.
@obj:
<!-- ##### MACRO GST_STATE_PLAYING_TO_READY ##### -->
<para>
The Element is going from the PLAYING state to the READY state.
</para>
<!-- ##### MACRO GST_IS_FDSINK ##### -->
<para>
@ -2044,6 +2136,12 @@ on its own.
@obj:
<!-- ##### MACRO GST_DEBUG_ENTER_STRING ##### -->
<para>
Combine #GST_DEBUG_ENTER and #GST_DEBUG_SET_STRING.
</para>
<!-- ##### MACRO GST_IS_DISKSRC ##### -->
<para>
@ -2196,6 +2294,13 @@ The start point of a filter graph
@src:
<!-- ##### FUNCTION gst_bin_create_plan ##### -->
<para>
</para>
@bin:
<!-- ##### FUNCTION gst_props_register_count ##### -->
<para>
@ -2226,6 +2331,12 @@ The start point of a filter graph
</para>
<!-- ##### MACRO COTHREAD_STACKSIZE ##### -->
<para>
The default stack size of a cothread.
</para>
<!-- ##### SECTION ./tmpl/gstesdsink.sgml:Long_Description ##### -->
<para>
@ -2286,6 +2397,13 @@ this in the factory definition.
@audiosink:
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_STATE_UNSET ##### -->
<para>
This macro unsets the given state on the element.
@ -2294,13 +2412,6 @@ This macro unsets the given state on the element.
@obj: Element to unset state of.
@flag: State to unset, can be any number of bits in guint32.
<!-- ##### MACRO GST_IS_FAKESINK ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_QUEUE_CLASS ##### -->
<para>
@ -2373,13 +2484,6 @@ The number of bytes per read.
@obj:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO ERROR_OBJECT ##### -->
<para>
@ -2390,6 +2494,13 @@ The number of bytes per read.
@format:
@args...:
<!-- ##### FUNCTION gst_sinesrc_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### MACRO GST_IS_IDENTITY ##### -->
<para>
@ -2494,14 +2605,9 @@ This macro sets the given state on the element.
@obj:
<!-- ##### FUNCTION gst_src_push_region ##### -->
<para>
<!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
Information about video buffers.
</para>
@src:
@offset:
@size:
<!-- ##### FUNCTION gst_fdsink_get_type ##### -->
<para>
@ -2510,9 +2616,14 @@ This macro sets the given state on the element.
@Returns:
<!-- ##### SECTION ./tmpl/videoraw.sgml:Short_Description ##### -->
Information about video buffers.
<!-- ##### FUNCTION gst_src_push_region ##### -->
<para>
</para>
@src:
@offset:
@size:
<!-- ##### STRUCT GstPipelineClass ##### -->
<para>
@ -2585,13 +2696,13 @@ This macro checks to see if the GST_SRC_ASYNC flag is set.
@obj: GstSrc to check for flag in.
<!-- ##### MACRO GST_TYPE_SINESRC ##### -->
<!-- ##### STRUCT GstPluginElement ##### -->
<para>
</para>
<!-- ##### STRUCT GstPluginElement ##### -->
<!-- ##### MACRO GST_TYPE_SINESRC ##### -->
<para>
</para>
@ -2622,17 +2733,26 @@ A flag indicating that SSE instructions are supported.
@obj:
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<para>
</para>
<!-- ##### STRUCT GstDiskSrcClass ##### -->
<para>
</para>
<!-- ##### ARG GstAsyncDiskSrc:size ##### -->
<!-- ##### MACRO GST_DEBUG_SET_STRING ##### -->
<para>
Set the debug string for the current function, typically containing the arguments
to the current function, i.e. "('element')"
</para>
@format: printf-style format string
@args...: printf arguments
<!-- ##### FUNCTION gst_element_get_type ##### -->
<para>
@ -2641,6 +2761,14 @@ A flag indicating that SSE instructions are supported.
@Returns:
<!-- ##### FUNCTION gst_bin_remove_managed_element ##### -->
<para>
</para>
@bin:
@element:
<!-- ##### STRUCT GstElementClass ##### -->
<para>
@ -2709,6 +2837,12 @@ Information about audio buffers.
</para>
<!-- ##### FUNCTION plugin_initialize ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_caps_register ##### -->
<para>
@ -2717,12 +2851,6 @@ Information about audio buffers.
@factory:
@Returns:
<!-- ##### FUNCTION plugin_initialize ##### -->
<para>
</para>
<!-- ##### ARG GstAsyncDiskSrc:location ##### -->
<para>
Specify the location of the file to read.
@ -2786,12 +2914,12 @@ the offset.
</para>
<!-- ##### FUNCTION gst_buffer_get_metas ##### -->
<!-- ##### FUNCTION gst_sinesrc_new ##### -->
<para>
</para>
@buffer:
@name:
@Returns:
<!-- ##### MACRO GST_IS_ASYNCDISKSRC_CLASS ##### -->
@ -2801,12 +2929,12 @@ the offset.
@obj:
<!-- ##### FUNCTION gst_sinesrc_new ##### -->
<!-- ##### FUNCTION gst_buffer_get_metas ##### -->
<para>
</para>
@name:
@buffer:
@Returns:
<!-- ##### ARG GstAudioSrc:curoffset ##### -->
@ -2857,13 +2985,6 @@ plugin
@klass:
<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_HTTPSRC_CLASS ##### -->
<para>
@ -2871,6 +2992,13 @@ plugin
@klass:
<!-- ##### MACRO GST_ASYNCDISKSRC ##### -->
<para>
</para>
@obj:
<!-- ##### ARG GstPad:active ##### -->
<para>
Indicates this pad is active

191
docs/gst/tmpl/gstscheduler.sgml
View file

@ -2,7 +2,7 @@
GstScheduler
<!-- ##### SECTION Short_Description ##### -->
An abstract class for plugable schedulers.
<!-- ##### SECTION Long_Description ##### -->
<para>
@ -14,11 +14,196 @@ GstScheduler
</para>
<!-- ##### FUNCTION gst_bin_schedule_func ##### -->
<!-- ##### MACRO GST_SCHED_PARENT ##### -->
<para>
</para>
@bin:
@sched:
<!-- ##### STRUCT GstScheduleChain ##### -->
<para>
</para>
@sched:
@disabled:
@elements:
@num_elements:
@entry:
@cothreaded_elements:
@schedule:
<!-- ##### MACRO GST_SCHEDULE_SAFETY ##### -->
<para>
</para>
@sched:
<!-- ##### MACRO GST_SCHEDULE_ADD_ELEMENT ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### MACRO GST_SCHEDULE_REMOVE_ELEMENT ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### MACRO GST_SCHEDULE_ENABLE_ELEMENT ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### MACRO GST_SCHEDULE_DISABLE_ELEMENT ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### MACRO GST_SCHEDULE_LOCK_ELEMENT ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### MACRO GST_SCHEDULE_UNLOCK_ELEMENT ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### MACRO GST_SCHEDULE_PAD_CONNECT ##### -->
<para>
</para>
@sched:
@srcpad:
@sinkpad:
<!-- ##### MACRO GST_SCHEDULE_PAD_DISCONNECT ##### -->
<para>
</para>
@sched:
@srcpad:
@sinkpad:
<!-- ##### MACRO GST_SCHEDULE_ITERATE ##### -->
<para>
</para>
@sched:
<!-- ##### FUNCTION gst_schedule_new ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_schedule_add_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_schedule_remove_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_schedule_enable_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_schedule_disable_element ##### -->
<para>
</para>
@sched:
@element:
<!-- ##### FUNCTION gst_schedule_pad_connect ##### -->
<para>
</para>
@sched:
@srcpad:
@sinkpad:
<!-- ##### FUNCTION gst_schedule_pad_disconnect ##### -->
<para>
</para>
@sched:
@srcpad:
@sinkpad:
<!-- ##### FUNCTION gst_schedule_iterate ##### -->
<para>
</para>
@sched:
@Returns:
<!-- ##### FUNCTION gst_schedule_show ##### -->
<para>
</para>
@sched:

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

@ -69,6 +69,14 @@ Tracing functionality
@trace:
<!-- ##### FUNCTION gst_trace_text_flush ##### -->
<para>
</para>
@trace:
<!-- ##### MACRO gst_trace_get_size ##### -->
<para>