mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-01-11 01:45:33 +00:00
fix up docs remove props commit automatic moving and removing of documentation
Original commit message from CVS: fix up docs remove props commit automatic moving and removing of documentation
This commit is contained in:
parent
db26705ee3
commit
339012e033
16 changed files with 272 additions and 676 deletions
19
ChangeLog
19
ChangeLog
|
@ -1,3 +1,22 @@
|
|||
2004-01-07 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||
|
||||
* docs/gst/gstreamer-docs.sgml: remove props
|
||||
* docs/gst/gstreamer-sections.txt: remove props
|
||||
* docs/gst/tmpl/gst.sgml:
|
||||
* docs/gst/tmpl/gstbin.sgml:
|
||||
* docs/gst/tmpl/gstbuffer.sgml:
|
||||
* docs/gst/tmpl/gstcaps.sgml:
|
||||
* docs/gst/tmpl/gstclock.sgml:
|
||||
* docs/gst/tmpl/gstelement.sgml:
|
||||
* docs/gst/tmpl/gstindex.sgml:
|
||||
* docs/gst/tmpl/gstobject.sgml:
|
||||
* docs/gst/tmpl/gstpad.sgml:
|
||||
* docs/gst/tmpl/gstpadtemplate.sgml:
|
||||
* docs/gst/tmpl/gstreamer-unused.sgml:
|
||||
* docs/gst/tmpl/gstthread.sgml:
|
||||
* docs/gst/tmpl/gstxml.sgml:
|
||||
sync with code reorganization
|
||||
|
||||
2004-01-07 Jan Schmidt <thaytan@mad.scientist.com>
|
||||
|
||||
* gst/gstelement.c: (gst_element_get_compatible_pad_filtered):
|
||||
|
|
|
@ -31,7 +31,6 @@
|
|||
<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
|
||||
<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
|
||||
<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
|
||||
<!ENTITY GstProps SYSTEM "xml/gstprops.xml">
|
||||
<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
|
||||
<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
|
||||
<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
|
||||
|
@ -102,7 +101,6 @@ with some more specialized elements.</para>
|
|||
&GstPlugin;
|
||||
&GstPluginFeature;
|
||||
&GstProbe;
|
||||
&GstProps;
|
||||
&GstQuery;
|
||||
<!-- no API docs
|
||||
&GstQueue; -->
|
||||
|
|
|
@ -55,9 +55,10 @@ gst_mem_chunk_free
|
|||
<FILE>gst</FILE>
|
||||
<TITLE>Gst</TITLE>
|
||||
gst_init
|
||||
gst_init_get_popt_table
|
||||
gst_init_with_popt_table
|
||||
gst_init_check
|
||||
gst_init_get_popt_table
|
||||
gst_init_check_with_popt_table
|
||||
gst_version
|
||||
gst_main
|
||||
gst_main_quit
|
||||
|
|
|
@ -90,6 +90,14 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
@argv:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_init_get_popt_table ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_init_with_popt_table ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -99,6 +107,7 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
@argv:
|
||||
@popt_options:
|
||||
<!-- # Unused Parameters # -->
|
||||
@Param3:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
@ -112,6 +121,19 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_init_check_with_popt_table ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@argc:
|
||||
@argv:
|
||||
@popt_options:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@Param3:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_version ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -72,34 +72,6 @@ The GstBin object
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstBin::element-added ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@arg1: the element that was added to the bin
|
||||
|
||||
<!-- ##### SIGNAL GstBin::element-removed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@arg1: the element that was removed from the bin
|
||||
|
||||
<!-- ##### SIGNAL GstBin::iterate ##### -->
|
||||
<para>
|
||||
This signal is emitted when a bin iterates, either automatically or
|
||||
due to a #gst_bin_iterate() call. The return value is used to
|
||||
determine if the object method handler processed any data.
|
||||
In most normal cases, a user-provided signal handler should return
|
||||
FALSE.
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@Returns: TRUE if the state of the bin was advanced.
|
||||
|
||||
<!-- ##### USER_FUNCTION GstBinPrePostIterateFunction ##### -->
|
||||
<para>
|
||||
The signature of the callback for the post and pre iterate function as set with
|
||||
|
@ -252,3 +224,31 @@ gst_bin_set_pre_iterate_function() and gst_bin_set_post_iterate_function().
|
|||
@clock:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstBin::element-added ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@arg1: the element that was added to the bin
|
||||
|
||||
<!-- ##### SIGNAL GstBin::element-removed ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@arg1: the element that was removed from the bin
|
||||
|
||||
<!-- ##### SIGNAL GstBin::iterate ##### -->
|
||||
<para>
|
||||
This signal is emitted when a bin iterates, either automatically or
|
||||
due to a #gst_bin_iterate() call. The return value is used to
|
||||
determine if the object method handler processed any data.
|
||||
In most normal cases, a user-provided signal handler should return
|
||||
FALSE.
|
||||
</para>
|
||||
|
||||
@gstbin: the object which received the signal.
|
||||
@Returns: TRUE if the state of the bin was advanced.
|
||||
|
||||
|
|
|
@ -294,17 +294,6 @@ A convenience function to set the data and size on a buffer
|
|||
@size: The size to set on the buffer
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_new_from_pool ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pool:
|
||||
@offset:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_buffer_default_free ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -118,183 +118,14 @@ The GType of the caps boxed type, for use in GValues.
|
|||
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_NEW ##### -->
|
||||
<para>
|
||||
A convenience macro to create a new GstCaps structure.
|
||||
</para>
|
||||
|
||||
@name: the name of the caps structure
|
||||
@type: the mime type of the caps structure
|
||||
@...: the properties of this caps stucture.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_FACTORY ##### -->
|
||||
<para>
|
||||
A convenience macro to create a GstCaps factory.
|
||||
</para>
|
||||
|
||||
@factoryname: the name of the factory
|
||||
@...: the caps to create with this factory, usualy specified
|
||||
with GST_CAPS_NEW()
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_GET ##### -->
|
||||
<para>
|
||||
A convenience macro to get a GstCaps from the given capsfactory.
|
||||
</para>
|
||||
|
||||
@fact: the factory to use.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstCaps ##### -->
|
||||
<para>
|
||||
The gstcaps structure
|
||||
</para>
|
||||
|
||||
@name: the name of the capability, for the application
|
||||
@id: the typeid of the capability
|
||||
@type:
|
||||
@flags:
|
||||
@refcount: a refcounter for this caps structure
|
||||
@properties: the properties of the capability
|
||||
@next: a pointer to the next caps.
|
||||
|
||||
<!-- ##### ENUM GstCapsFlags ##### -->
|
||||
<para>
|
||||
Flags for this caps.
|
||||
</para>
|
||||
|
||||
@GST_CAPS_UNUSED:
|
||||
@GST_CAPS_FLOATING: the caps is not owned by anyone
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_FLAGS ##### -->
|
||||
<para>
|
||||
Get the flags of the caps
|
||||
</para>
|
||||
|
||||
@caps: The caps to get the flags of
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_FLAG_IS_SET ##### -->
|
||||
<para>
|
||||
Test is a flag is set
|
||||
</para>
|
||||
|
||||
@caps: The caps to test
|
||||
@flag: The flag to check
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_FLAG_SET ##### -->
|
||||
<para>
|
||||
Set a flag on the caps
|
||||
</para>
|
||||
|
||||
@caps: The caps to modify
|
||||
@flag: The flag to set
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_FLAG_UNSET ##### -->
|
||||
<para>
|
||||
Unset a flag on the caps
|
||||
</para>
|
||||
|
||||
@caps: The caps to modify
|
||||
@flag: The flag to unset
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_IS_FLOATING ##### -->
|
||||
<para>
|
||||
Test if a caps is floating
|
||||
</para>
|
||||
|
||||
@caps: The caps to test
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_IS_CHAINED ##### -->
|
||||
<para>
|
||||
Check if the GstCaps is chained.
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_IS_FIXED ##### -->
|
||||
<para>
|
||||
Check if the GstCaps has fixed properties, ie. it has no ranges or lists.
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_NEXT ##### -->
|
||||
<para>
|
||||
Get a pointer to the next chained caps
|
||||
</para>
|
||||
|
||||
@caps: The caps to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_PROPERTIES ##### -->
|
||||
<para>
|
||||
Get the properties of the caps
|
||||
</para>
|
||||
|
||||
@caps: The caps to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_REFCOUNT ##### -->
|
||||
<para>
|
||||
Get the refcount of the caps.
|
||||
</para>
|
||||
|
||||
@caps: The caps to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_CAPS_TRACE_NAME ##### -->
|
||||
<para>
|
||||
The name used for tracing
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@mime:
|
||||
@props:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_new_id ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@id:
|
||||
@props:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
@structs:
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_copy ##### -->
|
||||
<para>
|
||||
|
@ -314,133 +145,28 @@ The name used for tracing
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_copy_on_write ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_chain ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_append ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
<!-- # Unused Parameters # -->
|
||||
@caps:
|
||||
@capstoadd:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_prepend ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@capstoadd:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_next ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_replace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@oldcaps:
|
||||
@caps:
|
||||
@newcaps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_replace_sink ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- # Unused Parameters # -->
|
||||
@oldcaps:
|
||||
@newcaps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_sink ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_set_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_get_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_set_mime ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@mime:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_get_mime ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_set_props ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@props:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_get_props ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_is_always_compatible ##### -->
|
||||
|
@ -448,40 +174,12 @@ The name used for tracing
|
|||
|
||||
</para>
|
||||
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@fromcaps:
|
||||
@tocaps:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_has_property ##### -->
|
||||
<para>
|
||||
Check if the GstCaps has a property with the given name
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_has_fixed_property ##### -->
|
||||
<para>
|
||||
Check if the GstCaps has a fixed property with the given name
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_has_property_typed ##### -->
|
||||
<para>
|
||||
Check if the GstCaps has a property with the given type
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_normalize ##### -->
|
||||
|
@ -493,24 +191,6 @@ Check if the GstCaps has a property with the given type
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_set ##### -->
|
||||
<para>
|
||||
Set a property of a caps structure.
|
||||
</para>
|
||||
|
||||
@caps: the caps structure to modify
|
||||
@...: the new value of the property
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_get ##### -->
|
||||
<para>
|
||||
Get key/value pairs from the given GstCaps.
|
||||
</para>
|
||||
|
||||
@caps: the caps to get the values from
|
||||
@...: a pointer to the variable that can hold the result followed by more key/value pairs.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_intersect ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -521,66 +201,6 @@ Get key/value pairs from the given GstCaps.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_get_boolean ##### -->
|
||||
<para>
|
||||
Get the value of the named property as a boolean.
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property to get
|
||||
@res: a pointer to a gboolean to store the result
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_get_by_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_get_fourcc_int ##### -->
|
||||
<para>
|
||||
Get the value of the named property as a fourcc.
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property to get
|
||||
@res: a pointer to a guint32 to store the fourcc value
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_get_int ##### -->
|
||||
<para>
|
||||
Get the value of the named property as an int.
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property to get
|
||||
@res: a pointer to a gint to store the value
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_get_string ##### -->
|
||||
<para>
|
||||
Get the value of the named property as a string.
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property to get
|
||||
@res: a pointer to a gchar* to store the string
|
||||
|
||||
|
||||
<!-- ##### MACRO gst_caps_get_float ##### -->
|
||||
<para>
|
||||
Get the value of the named property as a float.
|
||||
</para>
|
||||
|
||||
@caps: the caps to query
|
||||
@name: the name of the property to get
|
||||
@res: a pointer to a gfloat to store the result
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_save_thyself ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -600,12 +220,13 @@ Get the value of the named property as a float.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_debug ##### -->
|
||||
<!-- ##### FUNCTION gst_caps_union ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@label:
|
||||
@caps1:
|
||||
@caps2:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
@ -235,16 +235,6 @@ The GstClock object
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### ARG GstClock:max-diff ##### -->
|
||||
<para>
|
||||
Maximum allowed diff for clock sync requests against the real time.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstClock:stats ##### -->
|
||||
<para>
|
||||
Boolean property to activate stat generation on the clock.
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_clock_set_speed ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -412,3 +402,13 @@ Boolean property to activate stat generation on the clock.
|
|||
@id:
|
||||
|
||||
|
||||
<!-- ##### ARG GstClock:max-diff ##### -->
|
||||
<para>
|
||||
Maximum allowed diff for clock sync requests against the real time.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GstClock:stats ##### -->
|
||||
<para>
|
||||
Boolean property to activate stat generation on the clock.
|
||||
</para>
|
||||
|
||||
|
|
|
@ -71,58 +71,6 @@ The element object
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstElement::eos ##### -->
|
||||
<para>
|
||||
Signal emited when the element goes to PAUSED due to an end-of-stream
|
||||
condition.
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GstElement::error ##### -->
|
||||
<para>
|
||||
Is triggered whenever an error occured.
|
||||
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1: the error message
|
||||
@arg2:
|
||||
|
||||
<!-- ##### SIGNAL GstElement::found-tag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
|
||||
<!-- ##### SIGNAL GstElement::new-pad ##### -->
|
||||
<para>
|
||||
Is triggered whenever a new pad is added to an element.
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1: the new pad that was added
|
||||
|
||||
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
|
||||
<para>
|
||||
Is triggered whenever a pad has been removed from the element.
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1: The pad that was removed.
|
||||
|
||||
<!-- ##### SIGNAL GstElement::state-change ##### -->
|
||||
<para>
|
||||
Is triggered whenever the state of an element changes.
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1: the new state of the object
|
||||
@arg2:
|
||||
|
||||
<!-- ##### MACRO gst_element_get_name ##### -->
|
||||
<para>
|
||||
Gets the name of the element.
|
||||
|
@ -1015,3 +963,55 @@ Helper macro to create query type functions
|
|||
@...: list of query types.
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstElement::eos ##### -->
|
||||
<para>
|
||||
Signal emited when the element goes to PAUSED due to an end-of-stream
|
||||
condition.
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GstElement::error ##### -->
|
||||
<para>
|
||||
Is triggered whenever an error occured.
|
||||
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1: the error message
|
||||
@arg2:
|
||||
|
||||
<!-- ##### SIGNAL GstElement::found-tag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
|
||||
<!-- ##### SIGNAL GstElement::new-pad ##### -->
|
||||
<para>
|
||||
Is triggered whenever a new pad is added to an element.
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1: the new pad that was added
|
||||
|
||||
<!-- ##### SIGNAL GstElement::pad-removed ##### -->
|
||||
<para>
|
||||
Is triggered whenever a pad has been removed from the element.
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1: The pad that was removed.
|
||||
|
||||
<!-- ##### SIGNAL GstElement::state-change ##### -->
|
||||
<para>
|
||||
Is triggered whenever the state of an element changes.
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1: the new state of the object
|
||||
@arg2:
|
||||
|
||||
|
|
|
@ -209,19 +209,6 @@ The GstIndex object
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstIndex::entry-added ##### -->
|
||||
<para>
|
||||
Is emited when a new entry is added to the index.
|
||||
</para>
|
||||
|
||||
@gstindex: the object which received the signal.
|
||||
@arg1: The entry added to the index.
|
||||
|
||||
<!-- ##### ARG GstIndex:resolver ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_index_new ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -414,3 +401,16 @@ Is emited when a new entry is added to the index.
|
|||
@id:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstIndex::entry-added ##### -->
|
||||
<para>
|
||||
Is emited when a new entry is added to the index.
|
||||
</para>
|
||||
|
||||
@gstindex: the object which received the signal.
|
||||
@arg1: The entry added to the index.
|
||||
|
||||
<!-- ##### ARG GstIndex:resolver ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
|
|
@ -40,47 +40,6 @@ The GstObject
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstObject::deep-notify ##### -->
|
||||
<para>
|
||||
The deep notify signal is used to be notified of property changes.
|
||||
it is typically attached to the toplevel bin to receive notifications
|
||||
from all the elements contained in that bin.
|
||||
</para>
|
||||
|
||||
@gstobject: the object which received the signal.
|
||||
@arg1: the object that originated the signal
|
||||
@arg2: the property that changed
|
||||
|
||||
<!-- ##### SIGNAL GstObject::object-saved ##### -->
|
||||
<para>
|
||||
Is trigered whenever a new object is saved to XML. You can connect to
|
||||
this signal to insert custom XML tags into the core XML.
|
||||
</para>
|
||||
|
||||
@gstobject: the object which received the signal.
|
||||
@arg1: the xmlNodePtr of the parent node
|
||||
|
||||
<!-- ##### SIGNAL GstObject::parent-set ##### -->
|
||||
<para>
|
||||
Is emitted when the parent of an object is set.
|
||||
</para>
|
||||
|
||||
@gstobject: the object which received the signal.
|
||||
@arg1: the new parent
|
||||
|
||||
<!-- ##### SIGNAL GstObject::parent-unset ##### -->
|
||||
<para>
|
||||
Is emitted when the parent of an object is unset.
|
||||
</para>
|
||||
|
||||
@gstobject: the object which received the signal.
|
||||
@arg1: the old parent
|
||||
|
||||
<!-- ##### ARG GstObject:name ##### -->
|
||||
<para>
|
||||
The name of the object
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GST_FLAGS ##### -->
|
||||
<para>
|
||||
This macro returns the entire set of flags for the object.
|
||||
|
@ -331,3 +290,44 @@ Check if the object has been destroyed.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstObject::deep-notify ##### -->
|
||||
<para>
|
||||
The deep notify signal is used to be notified of property changes.
|
||||
it is typically attached to the toplevel bin to receive notifications
|
||||
from all the elements contained in that bin.
|
||||
</para>
|
||||
|
||||
@gstobject: the object which received the signal.
|
||||
@arg1: the object that originated the signal
|
||||
@arg2: the property that changed
|
||||
|
||||
<!-- ##### SIGNAL GstObject::object-saved ##### -->
|
||||
<para>
|
||||
Is trigered whenever a new object is saved to XML. You can connect to
|
||||
this signal to insert custom XML tags into the core XML.
|
||||
</para>
|
||||
|
||||
@gstobject: the object which received the signal.
|
||||
@arg1: the xmlNodePtr of the parent node
|
||||
|
||||
<!-- ##### SIGNAL GstObject::parent-set ##### -->
|
||||
<para>
|
||||
Is emitted when the parent of an object is set.
|
||||
</para>
|
||||
|
||||
@gstobject: the object which received the signal.
|
||||
@arg1: the new parent
|
||||
|
||||
<!-- ##### SIGNAL GstObject::parent-unset ##### -->
|
||||
<para>
|
||||
Is emitted when the parent of an object is unset.
|
||||
</para>
|
||||
|
||||
@gstobject: the object which received the signal.
|
||||
@arg1: the old parent
|
||||
|
||||
<!-- ##### ARG GstObject:name ##### -->
|
||||
<para>
|
||||
The name of the object
|
||||
</para>
|
||||
|
||||
|
|
|
@ -205,16 +205,6 @@ A function that will be called when pulling a buffer.
|
|||
@Returns: the #GstBuffer pulled.
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPadBufferPoolFunction ##### -->
|
||||
<para>
|
||||
A function that will be called when a buffer pool is requested
|
||||
from this pad.
|
||||
</para>
|
||||
|
||||
@pad: the #GstPad to which the buffer pool is associated.
|
||||
@Returns: the #GstBufferPool associated with this pad.
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPadGetCapsFunction ##### -->
|
||||
<para>
|
||||
Returns the capabilities of the specified pad. By default this function
|
||||
|
@ -222,8 +212,9 @@ will return the pad template capabilities, but can optionally be overridden.
|
|||
</para>
|
||||
|
||||
@pad: the #GstPad to get the capabilities of.
|
||||
@caps: the peer's #GstCaps, can be used to filter the capabilities.
|
||||
@Returns: the #GstCaps of the pad.
|
||||
<!-- # Unused Parameters # -->
|
||||
@caps: the peer's #GstCaps, can be used to filter the capabilities.
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
|
||||
|
@ -448,15 +439,6 @@ Flags for the pad.
|
|||
@get:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_set_bufferpool_function ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@bufpool:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_set_link_function ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -696,15 +678,6 @@ Flags for the pad.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_get_bufferpool ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_load_and_link ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -751,15 +724,6 @@ Flags for the pad.
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_recalc_allowed_caps ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_perform_negotiate ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -1072,9 +1036,10 @@ The realpad object
|
|||
|
||||
@pad:
|
||||
@caps:
|
||||
@filter:
|
||||
@appfixatefunc:
|
||||
@appfilter:
|
||||
@getcapsfunc:
|
||||
@fixatefunc:
|
||||
@direction:
|
||||
@linkfunc:
|
||||
@unlinkfunc:
|
||||
|
@ -1093,8 +1058,10 @@ The realpad object
|
|||
@formatsfunc:
|
||||
@querytypefunc:
|
||||
@intlinkfunc:
|
||||
@bufferpoolfunc:
|
||||
@bufferallocfunc:
|
||||
@probedisp:
|
||||
@link:
|
||||
@explicit_caps:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_DIRECTION ##### -->
|
||||
|
@ -1129,14 +1096,6 @@ Get the chain function of the real pad.
|
|||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_FILTER ##### -->
|
||||
<para>
|
||||
Get the filter from the pad
|
||||
</para>
|
||||
|
||||
@pad: the pad to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_APPFILTER ##### -->
|
||||
<para>
|
||||
Get the application filter for this pad
|
||||
|
@ -1153,14 +1112,6 @@ Get get getfunction of the real pad.
|
|||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_BUFFERPOOLFUNC ##### -->
|
||||
<para>
|
||||
Get the bufferpoolfunction from the real pad.
|
||||
</para>
|
||||
|
||||
@pad: the real pad to query.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_RPAD_CHAINHANDLER ##### -->
|
||||
<para>
|
||||
Get the eventhandler function from the real pad.
|
||||
|
|
|
@ -87,15 +87,6 @@ The padtemplate object.
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
|
||||
<para>
|
||||
This signal is fired when an element creates a pad from this
|
||||
template.
|
||||
</para>
|
||||
|
||||
@gstpadtemplate: the object which received the signal.
|
||||
@arg1: The pad that was created.
|
||||
|
||||
<!-- ##### ENUM GstPadTemplateFlags ##### -->
|
||||
<para>
|
||||
Flags for the padtemplate
|
||||
|
@ -136,38 +127,6 @@ Get the presence of the padtemplate.
|
|||
@templ: the template to query
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_TEMPLATE_NEW ##### -->
|
||||
<para>
|
||||
Create a new padtemplate.
|
||||
</para>
|
||||
|
||||
@padname: the nametemplate for the pads that will be created with this template
|
||||
@dir: the direction of the pads.
|
||||
@pres: the presence of the pads.
|
||||
@...: the capabilities of this padtemplate usually created with GST_CAPS_NEW()
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_TEMPLATE_FACTORY ##### -->
|
||||
<para>
|
||||
Create a factory for a padtemplate. This can be used if you only want one instance
|
||||
of the padtemplate. Use GST_PAD_TEMPLATE_GET() to get the unique padtemplate.
|
||||
</para>
|
||||
|
||||
@name: th name of the factory
|
||||
@padname: the nametemplate of the pads
|
||||
@dir: the direction of the pads.
|
||||
@pres: the presence of the pads.
|
||||
@...: the capabilities of this padtemplate, usually created with GST_CAPS_NEW()
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_TEMPLATE_GET ##### -->
|
||||
<para>
|
||||
Get the padtemplate of the factory created with GST_PAD_TEMPLATE_FACTORY()
|
||||
</para>
|
||||
|
||||
@fact: the factory name to get the padtemplate from.
|
||||
|
||||
|
||||
<!-- ##### MACRO GST_PAD_TEMPLATE_IS_FIXED ##### -->
|
||||
<para>
|
||||
Check if the properties of the padtemplate are fixed
|
||||
|
@ -185,8 +144,9 @@ Check if the properties of the padtemplate are fixed
|
|||
@direction:
|
||||
@presence:
|
||||
@caps:
|
||||
@Varargs:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_pad_template_get_caps ##### -->
|
||||
|
@ -208,3 +168,12 @@ Check if the properties of the padtemplate are fixed
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
|
||||
<para>
|
||||
This signal is fired when an element creates a pad from this
|
||||
template.
|
||||
</para>
|
||||
|
||||
@gstpadtemplate: the object which received the signal.
|
||||
@arg1: The pad that was created.
|
||||
|
||||
|
|
|
@ -2119,7 +2119,7 @@ candidate.
|
|||
|
||||
</para>
|
||||
|
||||
@klass:
|
||||
@klass:
|
||||
|
||||
<!-- ##### MACRO GST_EVENT_DISCONT_FLUSH ##### -->
|
||||
<para>
|
||||
|
@ -4286,6 +4286,7 @@ A type that can be used to indicate a filename.
|
|||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ARG GstAggregator:sched ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -4759,6 +4760,16 @@ Get the size of the file.
|
|||
@arg1:
|
||||
@arg2:
|
||||
|
||||
<!-- ##### SIGNAL GstElement::error-2 ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstelement: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
@arg3:
|
||||
|
||||
<!-- ##### SIGNAL GstElement::event ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -5952,15 +5963,6 @@ Query the element for the current mime type
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstxml: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstXMLRegistryAddPathList ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -8012,6 +8014,15 @@ safely be modified.
|
|||
@resolver:
|
||||
@user_data:
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_debug ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@caps:
|
||||
@string:
|
||||
@label:
|
||||
|
||||
<!-- ##### FUNCTION gst_caps_destroy ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -8907,13 +8918,6 @@ of an element he doesn't need anymore.
|
|||
@format:
|
||||
@args...:
|
||||
|
||||
<!-- ##### FUNCTION gst_init_get_popt_table ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
<!-- ##### FUNCTION gst_link_get_type ##### -->
|
||||
<para>
|
||||
|
||||
|
|
|
@ -34,6 +34,15 @@ The GstThread object
|
|||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_thread_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstThread::shutdown ##### -->
|
||||
<para>
|
||||
|
||||
|
@ -46,12 +55,3 @@ The GstThread object
|
|||
The thread priority
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gst_thread_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
|
@ -105,3 +105,25 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
|
|||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@:
|
||||
@:
|
||||
@:
|
||||
|
||||
@gstxml: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
|
||||
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@gstxml: the object which received the signal.
|
||||
@arg1:
|
||||
@arg2:
|
||||
|
||||
|
|
Loading…
Reference in a new issue