mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-23 02:01:12 +00:00
Code Issues 1 Projects Releases Wiki Activity

Documentation updates

Browse source 
Original commit message from CVS:
Documentation updates
This commit is contained in:
Wim Taymans 2002-03-31 14:00:33 +00:00
parent cfb228b0f9
commit d30487f9d0
28 changed files with 1264 additions and 518 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -29,6 +29,7 @@
<!entity GstCaps SYSTEM "sgml/gstcaps.sgml">
<!entity GstProps SYSTEM "sgml/gstprops.sgml">
<!entity GstClock SYSTEM "sgml/gstclock.sgml">
<!entity GstSystemClock SYSTEM "sgml/gstsystemclock.sgml">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstXML SYSTEM "sgml/gstxml.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
@ -48,6 +49,7 @@
<!entity GstIdentity SYSTEM "sgml/gstidentity.sgml">
<!entity GstPipefilter SYSTEM "sgml/gstpipefilter.sgml">
<!entity GstStatistics SYSTEM "sgml/gststatistics.sgml">
<!entity GstMD5Sink SYSTEM "sgml/gstmd5sink.sgml">
<!entity GstTee SYSTEM "sgml/gsttee.sgml">
<!entity gstreamer-tree-index SYSTEM "sgml/tree_index.sgml">
@ -91,6 +93,7 @@ with some more specialized elements.</para>
&GstQueue;
&GstScheduler;
&GstSchedulerFactory;
&GstSystemClock;
&GstThread;
&GstTimeCache;
&GstType;
@ -126,6 +129,7 @@ with some more specialized elements.</para>
&GstIdentity;
&GstStatistics;
&GstMD5Sink;
&GstTee;
</chapter>

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

@ -1,211 +1,5 @@
<INCLUDE>gst/gst.h</INCLUDE>
<SECTION>
<FILE>gobject2gtk</FILE>
<TITLE>GObject</TITLE>
<SUBSECTION Standard>
g_object_get_type
GObject
G_MAXUINT
G_MAXULONG
G_MAXINT64
g_object_ref
g_object_unref
G_TYPE_CHECK_INSTANCE_CAST
G_TYPE_CHECK_INSTANCE_TYPE
G_TYPE_CHECK_CLASS_CAST
G_TYPE_CHECK_CLASS_TYPE
G_TYPE_FROM_CLASS
G_OBJECT_TYPE
G_OBJECT_CLASS_TYPE
G_TYPE_NONE
G_TYPE_CHAR
G_TYPE_UCHAR
G_TYPE_BOOLEAN
G_TYPE_INT
G_TYPE_UINT
G_TYPE_INT64
G_TYPE_LONG
G_TYPE_ULONG
G_TYPE_ENUM
G_TYPE_FLAGS
G_TYPE_FLOAT
G_TYPE_DOUBLE
G_TYPE_STRING
G_TYPE_POINTER
G_TYPE_BOXED
G_TYPE_PARAM
G_CSET_A_2_Z
G_CSET_DIGITS
G_CSET_a_2_z
G_BEGIN_DECLS
G_E
G_END_DECLS
G_LN10
G_LN2
G_PI
G_PI_2
G_PI_4
G_SIGNAL_NO_HOOKS
G_SIGNAL_NO_RECURSE
G_SIGNAL_RUN_CLEANUP
G_SQRT2
G_TYPE_INSTANCE_GET_CLASS
G_VALUE_HOLDS_BOOLEAN
G_VALUE_HOLDS_CHAR
G_VALUE_HOLDS_DOUBLE
G_VALUE_HOLDS_FLOAT
G_VALUE_HOLDS_INT
G_VALUE_HOLDS_LONG
G_VALUE_HOLDS_POINTER
G_VALUE_HOLDS_STRING
G_VALUE_HOLDS_UCHAR
G_VALUE_HOLDS_UINT
G_VALUE_HOLDS_ULONG
g_cclosure_marshal_VOID__VOID
g_cclosure_marshal_VOID__BOOLEAN
g_cclosure_marshal_VOID__CHAR
g_cclosure_marshal_VOID__UCHAR
g_cclosure_marshal_VOID__INT
g_cclosure_marshal_VOID__UINT
g_cclosure_marshal_VOID__LONG
g_cclosure_marshal_VOID__ULONG
g_cclosure_marshal_VOID__ENUM
g_cclosure_marshal_VOID__FLAGS
g_cclosure_marshal_VOID__FLOAT
g_cclosure_marshal_VOID__DOUBLE
g_cclosure_marshal_VOID__STRING
g_cclosure_marshal_VOID__PARAM
g_cclosure_marshal_VOID__BOXED
g_cclosure_marshal_VOID__POINTER
g_cclosure_marshal_STRING__OBJECT_POINTER
g_cclosure_marshal_VOID__UINT_POINTER
gst_marshal_VOID__OBJECT_POINTER
gst_marshal_VOID__INT_INT
gst_marshal_VOID__POINTER
gst_marshal_VOID__VOID
gst_marshal_VOID__INT
gst_marshal_VOID__STRING
gst_marshal_VOID__OBJECT
gst_marshal_VOID__BOOLEAN
g2g_object_run_dispose
g_list_delete_link
g_log_domain_gstreamer
g_object_run_dispose
g_signal_handlers_destroy
g_signal_list_ids
g_slist_delete_link
g_string_printf
g_string_printfa
g_type_class_peek_parent
g_type_init
g_type_is_a
g_type_parent
g_value_copy
g_value_get_char
g_value_get_uchar
g_value_set_char
g_value_set_uchar
g_value_unset
g_value_get_int64
g_object_get_property
g_object_set
GType
GTypeFlags
GClassInitFunc
GBaseInitFunc
GInstanceInitFunc
g_type_class_ref
g_type_class_unref
g_type_name
g_type_from_name
GEnumValue
g_enum_register_static
GTypeInfo
G_TYPE_FLAG_ABSTRACT
g_type_register_static
g2g_type_register_static
g_object_new
g2g_object_new
G_SIGNAL_RUN_LAST
G_SIGNAL_RUN_FIRST
GCallback
G_CALLBACK
g_signal_new
g2g_signal_new
g_signal_lookup
g_signal_handler_block
g_signal_handler_unblock
GValue
GParamFlags
G_VALUE_TYPE
G_PARAM_READWRITE
G_PARAM_READABLE
G_PARAM_WRITABLE
G_OBJECT_WARN_INVALID_PROPERTY_ID
GParamSpec
g_value_init
g_object_class_install_property
g2g_object_class_install_property
g_object_class_find_property
g2g_object_class_find_property
g_object_class_list_properties
g2g_object_class_list_properties
G_IS_PARAM_SPEC_ENUM
g_param_spec_boolean
g2g_param_spec_boolean
g_param_spec_int
g2g_param_spec_int
g_param_spec_uint
g2g_param_spec_uint
g_param_spec_long
g2g_param_spec_long
g_param_spec_ulong
g2g_param_spec_ulong
g_param_spec_float
g2g_param_spec_float
g_param_spec_double
g2g_param_spec_double
g_param_spec_enum
g2g_param_spec_enum
g_param_spec_pointer
g2g_param_spec_pointer
g_param_spec_string
g2g_param_spec_string
g_param_spec_int64
g_value_set_int64
g_value_get_boolean
g_value_set_boolean
g_value_get_enum
g_value_set_enum
g_value_get_int
g_value_set_int
g_value_get_uint
g_value_set_uint
g_value_get_long
g_value_set_long
g_value_get_ulong
g_value_set_ulong
g_value_get_float
g_value_set_float
g_value_get_double
g_value_set_double
g_value_get_string
g_value_set_string
g_value_get_pointer
g_value_set_pointer
g_strcanon
g_string_append_printf
G_OBJECT
g_cclosure_marshal_VOID__OBJECT
G_IS_OBJECT
G_TYPE_OBJECT
g2g_object_get_type
G_OBJECT_CLASS
G_IS_OBJECT_CLASS
G_OBJECT_GET_CLASS
</SECTION>
<SECTION>
<FILE>cothreads</FILE>
CURRENT_STACK_FRAME
@ -216,19 +10,22 @@ COTHREAD_STARTED
COTHREAD_DESTROYED
cothread_context_init
cothread_context_free
cothread_get_private
cothread_set_private
cothread_create
cothread_free
cothread_setfunc
cothread_stop
cothread_switch
cothread_set_data
cothread_get_data
cothread_context_get_data
cothread_context_set_data
cothread_lock
cothread_trylock
cothread_unlock
cothread_main
cothread_current_main
cothread_current
<SUBSECTION Standard>
</SECTION>
@ -236,13 +33,25 @@ cothread_current
<FILE>gst</FILE>
<TITLE>Gst</TITLE>
gst_init
gst_init_with_popt_table
gst_version
gst_main
gst_main_quit
g_log_domain_gstreamer
GST_VERSION_MAJOR
GST_VERSION_MINOR
GST_VERSION_MICRO
<SUBSECTION Standard>
gst_marshal_VOID__BOOLEAN
gst_marshal_VOID__INT
gst_marshal_VOID__INT_INT
gst_marshal_VOID__OBJECT
gst_marshal_VOID__OBJECT_PARAM
gst_marshal_VOID__OBJECT_POINTER
gst_marshal_VOID__OBJECT_STRING
gst_marshal_VOID__POINTER
gst_marshal_VOID__STRING
gst_marshal_VOID__VOID
</SECTION>
<SECTION>
@ -299,6 +108,7 @@ GST_DISABLE_LOADSAVE_REGISTRY
GST_SCHEDULER_PARENT
GST_SCHEDULER_STATE
GstSchedulerState
GstSchedulerFlags
gst_scheduler_destroy
gst_scheduler_setup
gst_scheduler_reset
@ -313,6 +123,13 @@ gst_scheduler_error
gst_scheduler_pad_connect
gst_scheduler_pad_disconnect
gst_scheduler_pad_select
gst_scheduler_add_scheduler
gst_scheduler_remove_scheduler
gst_scheduler_auto_clock
gst_scheduler_get_clock
gst_scheduler_set_clock
gst_scheduler_use_clock
gst_scheduler_clock_wait
gst_scheduler_iterate
gst_scheduler_show
<SUBSECTION Standard>
@ -357,6 +174,7 @@ GstBin
gst_bin_new
gst_bin_destroy
gst_bin_add
gst_bin_add_many
gst_bin_remove
gst_bin_get_by_name
gst_bin_get_by_name_recurse_up
@ -365,6 +183,9 @@ gst_bin_set_state_type
gst_bin_iterate
gst_bin_child_state_change
gst_bin_child_error
gst_bin_auto_clock
gst_bin_get_clock
gst_bin_use_clock
<SUBSECTION Standard>
GstBinClass
gst_bin_get_type
@ -486,6 +307,7 @@ GST_EVENT_INFO_PROPS
GstEvent
gst_event_new
gst_event_free
gst_event_copy
gst_event_new_seek
gst_event_new_flush
gst_event_new_info
@ -520,8 +342,11 @@ GST_ELEMENT_NAME
GST_ELEMENT_PADS
GST_ELEMENT_SCHED
GST_ELEMENT_MANAGER
GST_ELEMENT_CLOCK
GstElement
GstElementLoopFunction
GstElementGetClockFunction
GstElementSetClockFunction
gst_element_class_add_padtemplate
gst_element_destroy
gst_element_set_loop_function
@ -531,6 +356,7 @@ gst_element_get_sched
gst_element_set_sched
gst_element_set_parent
gst_element_get_parent
gst_element_get_managing_bin
gst_element_add_pad
gst_element_remove_pad
gst_element_get_pad
@ -541,21 +367,27 @@ gst_element_add_ghost_pad
gst_element_remove_ghost_pad
gst_element_request_compatible_pad
gst_element_request_pad_by_name
gst_element_get_compatible_pad
gst_element_get_compatible_pad_filtered
gst_element_connect
gst_element_connect_filtered
gst_element_connect_elements
gst_element_connect_elements_filtered
gst_element_connect_elements_many
gst_element_disconnect
gst_element_disconnect_elements
gst_element_set_state
gst_element_get_state
gst_element_wait_state_change
gst_element_statename
gst_element_info
gst_element_error
gst_element_get_factory
gst_element_set_eos
gst_element_install_std_props
gst_element_send_event
gst_element_interrupt
gst_element_yield
gst_element_clock_wait
gst_element_get_clock
gst_element_set_clock
<SUBSECTION Standard>
GstElementClass
GST_TYPE_ELEMENT
@ -566,6 +398,7 @@ GST_ELEMENT_CLASS_CAST
GST_IS_ELEMENT
GST_IS_ELEMENT_CLASS
gst_element_get_type
gst_element_class_install_std_props
</SECTION>
<SECTION>
@ -633,17 +466,55 @@ GST_IS_AUTOPLUGFACTORY_CLASS
<TITLE>GstClock</TITLE>
GstClockTime
GstClockTimeDiff
GstClockCallback
GstClockID
GstClockReturn
GST_CLOCK_DIFF
GST_TIMEVAL_TO_TIME
GstClock
gst_clock_new
gst_clock_get_system
gst_clock_register
gst_clock_set
gst_clock_activate
gst_clock_is_active
gst_clock_async_supported
gst_clock_wait_async
gst_clock_cancel_wait_async
gst_clock_notify_async
gst_clock_remove_notify_async
gst_clock_unlock_id
gst_clock_wait_id
gst_clock_get_next_id
gst_clock_get_time
gst_clock_id_get_time
gst_clock_get_resolution
gst_clock_set_resolution
gst_clock_set_speed
gst_clock_get_speed
gst_clock_reset
gst_clock_wait
gst_clock_current_diff
<SUBSECTION Standard>
gst_clock_get_type
GST_TYPE_CLOCK
GST_CLOCK
GST_CLOCK_CLASS
GST_IS_CLOCK
GST_IS_CLOCK_CLASS
</SECTION>
<SECTION>
<FILE>gstsystemclock</FILE>
<TITLE>GstSystemClock</TITLE>
GstSystemClock
gst_system_clock_obtain
<SUBSECTION Standard>
gst_system_clock_get_type
GstSystemClockClass
GST_TYPE_SYSTEM_CLOCK
GST_SYSTEM_CLOCK
GST_SYSTEM_CLOCK_CLASS
GST_IS_SYSTEM_CLOCK
GST_IS_SYSTEM_CLOCK_CLASS
</SECTION>
<SECTION>
<FILE>gstlog</FILE>
<SUBSECTION Standard>
@ -748,6 +619,7 @@ gst_pad_set_parent
gst_pad_get_parent
gst_pad_get_sched
gst_pad_set_sched
gst_pad_unset_sched
gst_pad_get_real_parent
gst_pad_add_ghost_pad
gst_pad_remove_ghost_pad
@ -758,6 +630,8 @@ gst_pad_connect_filtered
gst_pad_reconnect_filtered
gst_pad_try_reconnect_filtered
gst_pad_disconnect
gst_pad_can_connect
gst_pad_can_connect_filtered
gst_pad_push
gst_pad_pull
gst_pad_pullregion
@ -768,6 +642,7 @@ gst_pad_get_padtemplate
gst_pad_get_padtemplate_caps
gst_pad_get_allowed_caps
gst_pad_recalc_allowed_caps
gst_pad_perform_negotiate
gst_pad_ghost_save_thyself
gst_pad_peek
gst_pad_select
@ -776,7 +651,6 @@ gst_pad_send_event
gst_pad_event_default
gst_pad_set_event_function
GstRealPad
GST_RPAD_LEN
GST_RPAD_OFFSET
@ -1017,9 +891,7 @@ GST_IS_TYPEFACTORY_CLASS
<SECTION>
<FILE>gstcaps</FILE>
<TITLE>GstCaps</TITLE>
GST_CAPS_LOCK
GST_CAPS_TRYLOCK
GST_CAPS_UNLOCK
GST_TYPE_CAPS
GST_CAPS_NEW
GST_CAPS_FACTORY
GST_CAPS_GET
@ -1032,6 +904,7 @@ gst_caps_destroy
gst_caps_ref
gst_caps_unref
gst_caps_copy
gst_caps_copy_1
gst_caps_copy_on_write
gst_caps_chain
gst_caps_append
@ -1046,9 +919,11 @@ gst_caps_set_props
gst_caps_get_props
gst_caps_check_compatibility
gst_caps_has_property
gst_caps_has_fixed_property
gst_caps_has_property_typed
gst_caps_normalize
gst_caps_set
gst_caps_get
gst_caps_intersect
gst_caps_get_boolean
gst_caps_get_by_name
@ -1057,7 +932,6 @@ gst_caps_get_int
gst_caps_get_string
gst_caps_get_float
gst_caps_save_thyself
gst_caps_load_thyself
gst_caps_debug
@ -1069,6 +943,9 @@ GST_CAPS
<FILE>gstprops</FILE>
<TITLE>GstProps</TITLE>
GstProps
GstPropsEntry
GstPropsType
GST_TYPE_PROPS
GST_MAKE_FOURCC
GST_STR_FOURCC
GST_PROPS_LIST
@ -1082,7 +959,6 @@ GST_PROPS_STRING
GST_PROPS_FLOAT
GST_PROPS_FLOAT_RANGE
GST_PROPS_INT_POSITIVE
GST_PROPS_ENTRY_IS_VARIABLE
gst_props_new
gst_props_newv
gst_props_merge
@ -1095,24 +971,35 @@ gst_props_check_compatibility
gst_props_has_property
gst_props_normalize
gst_props_set
gst_props_get_boolean
gst_props_get_fourcc_int
gst_props_get_int
gst_props_get_string
gst_props_get_float
gst_props_get
gst_props_has_fixed_property
gst_props_has_property_typed
gst_props_intersect
gst_props_debug
gst_props_save_thyself
gst_props_load_thyself
gst_props_get_entry
gst_props_entry_get
gst_props_entry_get_boolean
gst_props_entry_get_float
gst_props_entry_get_float_range
gst_props_entry_get_fourcc_int
gst_props_entry_get_int
gst_props_entry_get_int_range
gst_props_entry_get_list
gst_props_entry_get_name
gst_props_entry_get_string
gst_props_entry_get_type
gst_props_entry_is_fixed
<SUBSECTION Standard>
GstPropsEntry
GstPropsId
</SECTION>
<SECTION>
<FILE>gstutils</FILE>
<TITLE>GstUtils</TITLE>
gst_util_set_object_arg
gst_util_set_value_from_string
gst_util_get_int_arg
gst_util_get_bool_arg
gst_util_get_long_arg
@ -1131,7 +1018,6 @@ gst_print_pad_caps
<SECTION>
<FILE>gstxml</FILE>
<TITLE>GstXML</TITLE>
GstXML
gst_xml_new
gst_xml_parse_doc
gst_xml_parse_memory
@ -1140,6 +1026,8 @@ gst_xml_write
gst_xml_write_file
gst_xml_get_element
gst_xml_get_topelements
gst_xml_make_element
<SUBSECTION Standard>
gst_xml_get_type
GST_XML
@ -1147,9 +1035,8 @@ GST_IS_XML
GST_IS_XML_CLASS
GST_TYPE_XML
GST_XML_CLASS
GstXML
GstXMLClass
xmlChildrenNode
xmlRootNode
</SECTION>
<SECTION>
@ -1379,9 +1266,9 @@ GST_IS_TYPEFIND_CLASS
<SECTION>
<FILE>gstdisksink</FILE>
<TITLE>GstDiskSink</TITLE>
GstDiskSinkFlags
<SUBSECTION Standard>
GstDiskSink
GstDiskSinkFlags
GST_DISKSINK
GST_IS_DISKSINK
GST_TYPE_DISKSINK
@ -1404,3 +1291,16 @@ GST_MULTIDISKSRC_CLASS
GST_IS_MULTIDISKSRC_CLASS
</SECTION>
<SECTION>
<FILE>gstmd5sink</FILE>
<TITLE>GstMD5Sink</TITLE>
<SUBSECTION Standard>
GST_MD5SINK
GST_IS_MD5SINK
GST_TYPE_MD5SINK
gst_md5sink_get_type
GST_MD5SINK_CLASS
GST_IS_MD5SINK_CLASS
gst_md5sink_factory_init
</SECTION>

9
docs/gst/gstreamer.types.in
View file

@ -4,15 +4,22 @@ gst_object_get_type
gst_xml_get_type
gst_element_get_type
gst_bin_get_type
gst_clock_get_type
gst_pipeline_get_type
gst_pad_get_type
gst_padtemplate_get_type
gst_ghost_pad_get_type
gst_thread_get_type
gst_tee_get_type
gst_plugin_feature_get_type
gst_autoplug_get_type
gst_autoplugfactory_get_type
gst_typefactory_get_type
gst_elementfactory_get_type
gst_schedulerfactory_get_type
gst_scheduler_get_type
gst_system_clock_get_type
gst_timecache_get_type
gst_xml_get_type
gst_aggregator_get_type
@ -23,11 +30,13 @@ gst_filesrc_get_type
gst_fdsrc_get_type
gst_fdsink_get_type
gst_disksink_get_type
gst_pipefilter_get_type
gst_identity_get_type
gst_queue_get_type
gst_statistics_get_type
gst_md5sink_get_type
gst_typefind_get_type

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

@ -35,6 +35,7 @@ Get the current stack frame.
@ctx:
@threadnum:
@priv:
@func:
@argc:
@argv:
@ -92,6 +93,24 @@ Indicates the cothread is destroyed.
@ctx:
<!-- ##### FUNCTION cothread_get_private ##### -->
<para>
</para>
@thread:
@Returns:
<!-- ##### FUNCTION cothread_set_private ##### -->
<para>
</para>
@thread:
@data:
<!-- ##### FUNCTION cothread_create ##### -->
<para>
@ -136,17 +155,7 @@ Indicates the cothread is destroyed.
@thread:
<!-- ##### FUNCTION cothread_set_data ##### -->
<para>
</para>
@thread:
@key:
@data:
<!-- ##### FUNCTION cothread_get_data ##### -->
<!-- ##### FUNCTION cothread_context_get_data ##### -->
<para>
</para>
@ -156,6 +165,16 @@ Indicates the cothread is destroyed.
@Returns:
<!-- ##### FUNCTION cothread_context_set_data ##### -->
<para>
</para>
@thread:
@key:
@data:
<!-- ##### FUNCTION cothread_lock ##### -->
<para>

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

@ -62,6 +62,16 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
@argv:
<!-- ##### FUNCTION gst_init_with_popt_table ##### -->
<para>
</para>
@argc:
@argv:
@popt_options:
<!-- ##### FUNCTION gst_version ##### -->
<para>
@ -86,6 +96,12 @@ pipeline</ulink> and Microsoft's DirectShow for some background.
<!-- ##### VARIABLE g_log_domain_gstreamer ##### -->
<para>
</para>
<!-- ##### MACRO GST_VERSION_MAJOR ##### -->
<para>
The major version of GStreamer at compile time

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

@ -40,3 +40,8 @@ methods to request buffers from its pads.
</para>
<!-- ##### ARG GstAggregator:last-message ##### -->
<para>
</para>

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

@ -98,7 +98,6 @@ Use the regular gst_object_destroy() call to destroy the autoplugger.
</para>
@object:
<!-- ##### ENUM GstAutoplugFlags ##### -->
<para>
@ -142,3 +141,11 @@ The type of the autoplugger.
@Returns:
<!-- ##### SIGNAL GstAutoplug::new-object ##### -->
<para>
</para>
@gstautoplug: the object which received the signal.
@arg1:

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

@ -53,6 +53,8 @@ Flags for a bin.
@GST_BIN_FLAG_MANAGER:
@GST_BIN_SELF_SCHEDULABLE:
@GST_BIN_FLAG_PREFER_COTHREADS:
@GST_BIN_FLAG_FIXED_CLOCK:
@GST_BIN_SELF_ITERATING:
@GST_BIN_FLAG_LAST:
<!-- ##### STRUCT GstBin ##### -->
@ -87,6 +89,16 @@ Free the memory allocated by this bin
@element:
<!-- ##### FUNCTION gst_bin_add_many ##### -->
<para>
</para>
@bin:
@element_1:
@Varargs:
<!-- ##### FUNCTION gst_bin_remove ##### -->
<para>
@ -156,13 +168,30 @@ Free the memory allocated by this bin
@child:
<!-- ##### FUNCTION gst_bin_child_error ##### -->
<!-- ##### FUNCTION gst_bin_auto_clock ##### -->
<para>
</para>
@bin:
@child:
<!-- ##### FUNCTION gst_bin_get_clock ##### -->
<para>
</para>
@bin:
@Returns:
<!-- ##### FUNCTION gst_bin_use_clock ##### -->
<para>
</para>
@bin:
@clock:
<!-- ##### SIGNAL GstBin::object-added ##### -->

84
docs/gst/tmpl/gstcaps.sgml
View file

@ -103,28 +103,11 @@ GST_CAPS_FACTORY() macro as shown below.
#GstProps, #GstPad
</para>
<!-- ##### MACRO GST_CAPS_LOCK ##### -->
<!-- ##### MACRO GST_TYPE_CAPS ##### -->
<para>
Lock the caps structure
The GType of the caps boxed type, for use in GValues.
</para>
@caps: The caps structure to lock
<!-- ##### MACRO GST_CAPS_TRYLOCK ##### -->
<para>
Try to lock the caps structure
</para>
@caps: The caps structure to try to lock
<!-- ##### MACRO GST_CAPS_UNLOCK ##### -->
<para>
Unlock the caps structure
</para>
@caps: The caps structure to unlock
<!-- ##### MACRO GST_CAPS_NEW ##### -->
@ -157,18 +140,18 @@ A convenience macro to get a GstCaps from the given capsfactory.
<!-- ##### MACRO GST_CAPS_IS_CHAINED ##### -->
<para>
Check if the GstCaps is chained.
</para>
@caps:
@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:
@caps: the caps to query
<!-- ##### STRUCT GstCaps ##### -->
@ -179,8 +162,7 @@ A convenience macro to get a GstCaps from the given capsfactory.
@name: the name of the capability, for the application
@id: the typeid of the capability
@refcount: a refcounter for this caps structure
@lock: the lock for this caps structure
@fixed:
@fixed: a boolean indicating that this caps structure is fixed
@properties: the properties of the capability
@next: a pointer to the next caps.
@ -241,6 +223,15 @@ A convenience macro to get a GstCaps from the given capsfactory.
@Returns:
<!-- ##### FUNCTION gst_caps_copy_1 ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_copy_on_write ##### -->
<para>
@ -305,9 +296,6 @@ A convenience macro to get a GstCaps from the given capsfactory.
@caps:
@type_id:
<!-- # Unused Parameters # -->
@Param2:
@typeid:
<!-- ##### FUNCTION gst_caps_get_type_id ##### -->
@ -368,11 +356,29 @@ A convenience macro to get a GstCaps from the given capsfactory.
<!-- ##### MACRO gst_caps_has_property ##### -->
<para>
Check if the GstCaps has a property with the given name
</para>
@caps:
@name:
@caps: the caps to query
@name: the name of the property
<!-- ##### MACRO 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
<!-- ##### MACRO 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
<!-- ##### FUNCTION gst_caps_normalize ##### -->
@ -394,6 +400,16 @@ Set a property of a caps structure.
@args...: 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
@name: the name of the first key
@args...: a pointer to the variable that can hold the result followed by more key/value pairs.
<!-- ##### FUNCTION gst_caps_intersect ##### -->
<para>
@ -411,6 +427,7 @@ Get the value of the named property as a boolean.
@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 ##### -->
@ -430,6 +447,7 @@ Get the value of the named property as a fourcc.
@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 ##### -->
@ -439,6 +457,7 @@ Get the value of the named property as an int.
@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 ##### -->
@ -448,6 +467,7 @@ Get the value of the named property as a string.
@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 ##### -->
@ -457,6 +477,7 @@ Get the value of the named property as a float.
@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 ##### -->
@ -484,5 +505,6 @@ Get the value of the named property as a float.
</para>
@caps:
@label:

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

@ -2,90 +2,231 @@
GstClock
<!-- ##### SECTION Short_Description ##### -->
Clocking and synchronisation.
Abstract class for global clocks
<!-- ##### SECTION Long_Description ##### -->
<para>
GstClock provides an easy way to synchonize against a global clock.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GstSystemClock
</para>
<!-- ##### TYPEDEF GstClockTime ##### -->
<para>
A datatype to hold a time, measured in microseconds.
</para>
<!-- ##### TYPEDEF GstClockTimeDiff ##### -->
<para>
A datatype to hold a timedifference, measured in microseconds.
</para>
<!-- ##### USER_FUNCTION GstClockCallback ##### -->
<para>
The function prototype of the callback.
</para>
@clock: The clock that triggered the callback
@time: The time it was triggered
@id: The id that expired
@user_data: user data passed in the async_wait call
<!-- ##### TYPEDEF GstClockID ##### -->
<para>
A detatype to hold the handle to an outstanding async clock callback
</para>
<!-- ##### ENUM GstClockReturn ##### -->
<para>
The return value of a clock operation.
</para>
@GST_CLOCK_STOPPED: The clock is stopped.
@GST_CLOCK_TIMEOUT: The operation timed out.
@GST_CLOCK_EARLY: The operation was scheduled too late.
@GST_CLOCK_ERROR: An error occured
<!-- ##### MACRO GST_CLOCK_DIFF ##### -->
<para>
Calculate the difference between to timestamps. This does not create
and absolute difference so the result might be negative if the first
timestamp is less than the second timestamp.
Calculate a difference between to clock times.
</para>
@s: first timestamp
@e: second timestamp
@s: the first time
@e: the second time
<!-- ##### MACRO GST_TIMEVAL_TO_TIME ##### -->
<para>
Convert a GTimeVal to a GstClockTime
</para>
@tv: the timeval to convert
<!-- ##### STRUCT GstClock ##### -->
<para>
The opaque data structure of the clock.
</para>
@name:
@start_time:
@current_time:
@adjust:
@locking:
@sinkobjects:
@num:
@num_locked:
@sinkmutex:
@lock:
<!-- ##### FUNCTION gst_clock_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_clock_get_system ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_clock_register ##### -->
<!-- ##### FUNCTION gst_clock_activate ##### -->
<para>
</para>
@clock:
@obj:
@active:
<!-- ##### FUNCTION gst_clock_set ##### -->
<!-- ##### FUNCTION gst_clock_is_active ##### -->
<para>
</para>
@clock:
@Returns:
<!-- ##### FUNCTION gst_clock_async_supported ##### -->
<para>
</para>
@clock:
@Returns:
<!-- ##### FUNCTION gst_clock_wait_async ##### -->
<para>
</para>
@clock:
@time:
@func:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_clock_cancel_wait_async ##### -->
<para>
</para>
@clock:
@id:
<!-- ##### FUNCTION gst_clock_notify_async ##### -->
<para>
</para>
@clock:
@interval:
@func:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_clock_remove_notify_async ##### -->
<para>
</para>
@clock:
@id:
<!-- ##### FUNCTION gst_clock_unlock_id ##### -->
<para>
</para>
@clock:
@id:
<!-- ##### FUNCTION gst_clock_wait_id ##### -->
<para>
</para>
@clock:
@id:
@Returns:
<!-- ##### FUNCTION gst_clock_get_next_id ##### -->
<para>
</para>
@clock:
@Returns:
<!-- ##### FUNCTION gst_clock_get_time ##### -->
<para>
</para>
@clock:
@Returns:
<!-- ##### FUNCTION gst_clock_id_get_time ##### -->
<para>
</para>
@id:
@Returns:
<!-- ##### FUNCTION gst_clock_get_resolution ##### -->
<para>
</para>
@clock:
@Returns:
<!-- ##### FUNCTION gst_clock_set_resolution ##### -->
<para>
</para>
@clock:
@resolution:
<!-- ##### FUNCTION gst_clock_set_speed ##### -->
<para>
</para>
@clock:
@speed:
<!-- ##### FUNCTION gst_clock_get_speed ##### -->
<para>
</para>
@clock:
@Returns:
<!-- # Unused Parameters # -->
@speed:
<!-- ##### FUNCTION gst_clock_reset ##### -->
@ -101,16 +242,6 @@ timestamp is less than the second timestamp.
</para>
@clock:
@time:
@obj:
<!-- ##### FUNCTION gst_clock_current_diff ##### -->
<para>
</para>
@clock:
@time:
@Returns:

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

@ -14,11 +14,20 @@ The disksink write to a file. The filename can be given as an argument.
#GstFdSink
</para>
<!-- ##### ENUM GstDiskSinkFlags ##### -->
<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
<para>
Is emited after the buffer has been written to the disk.
</para>
@gstdisksink: the object which received the signal.
<!-- ##### ARG GstDiskSink:location ##### -->
<para>
The filename to write to.
</para>
<!-- ##### ARG GstDiskSink:maxfilesize ##### -->
<para>
</para>
@GST_DISKSINK_OPEN:
@GST_DISKSINK_FLAG_LAST:

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

@ -214,6 +214,14 @@ Get the manager of this element.
@obj: The element to query
<!-- ##### MACRO GST_ELEMENT_CLOCK ##### -->
<para>
Get the clock of this element
</para>
@obj: the Element to query
<!-- ##### STRUCT GstElement ##### -->
<para>
@ -230,6 +238,24 @@ circumstances.
@element: The element in question.
<!-- ##### USER_FUNCTION GstElementGetClockFunction ##### -->
<para>
The function to get the clock from a clock providing element
</para>
@element: The element to get the clock of
@Returns: The clock provided by the element
<!-- ##### USER_FUNCTION GstElementSetClockFunction ##### -->
<para>
The function to set the clock on a clock receiving element.
</para>
@element: The element to set the clock on
@clock: The clock to set on the element
<!-- ##### FUNCTION gst_element_class_add_padtemplate ##### -->
<para>
@ -313,6 +339,15 @@ instead.
@Returns:
<!-- ##### FUNCTION gst_element_get_managing_bin ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_add_pad ##### -->
<para>
@ -377,6 +412,7 @@ instead.
@element:
@pad:
@name:
@Returns:
<!-- ##### FUNCTION gst_element_remove_ghost_pad ##### -->
@ -408,6 +444,27 @@ instead.
@Returns:
<!-- ##### FUNCTION gst_element_get_compatible_pad ##### -->
<para>
</para>
@element:
@pad:
@Returns:
<!-- ##### FUNCTION gst_element_get_compatible_pad_filtered ##### -->
<para>
</para>
@element:
@pad:
@filtercaps:
@Returns:
<!-- ##### FUNCTION gst_element_connect ##### -->
<para>
@ -433,6 +490,38 @@ instead.
@Returns:
<!-- ##### FUNCTION gst_element_connect_elements ##### -->
<para>
</para>
@src:
@dest:
@Returns:
<!-- ##### FUNCTION gst_element_connect_elements_filtered ##### -->
<para>
</para>
@src:
@dest:
@filtercaps:
@Returns:
<!-- ##### FUNCTION gst_element_connect_elements_many ##### -->
<para>
</para>
@element_1:
@element_2:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_element_disconnect ##### -->
<para>
@ -444,6 +533,15 @@ instead.
@destpadname:
<!-- ##### FUNCTION gst_element_disconnect_elements ##### -->
<para>
</para>
@src:
@dest:
<!-- ##### FUNCTION gst_element_set_state ##### -->
<para>
@ -482,16 +580,6 @@ instead.
@Returns:
<!-- ##### FUNCTION gst_element_info ##### -->
<para>
</para>
@element:
@info:
@Varargs:
<!-- ##### FUNCTION gst_element_error ##### -->
<para>
@ -519,25 +607,6 @@ instead.
@element:
<!-- ##### FUNCTION gst_element_install_std_props ##### -->
<para>
</para>
@klass:
@first_name:
@Varargs:
<!-- ##### FUNCTION gst_element_send_event ##### -->
<para>
</para>
@element:
@event:
<!-- ##### FUNCTION gst_element_interrupt ##### -->
<para>
@ -555,6 +624,35 @@ instead.
@element:
<!-- ##### FUNCTION gst_element_clock_wait ##### -->
<para>
</para>
@element:
@clock:
@time:
@Returns:
<!-- ##### FUNCTION gst_element_get_clock ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_set_clock ##### -->
<para>
</para>
@element:
@clock:
<!-- ##### SIGNAL GstElement::eos ##### -->
<para>
@ -570,14 +668,7 @@ Is trigered whenever an error occured
@gstelement: the object which received the signal.
@arg1: the error message
<!-- ##### SIGNAL GstElement::event ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GstElement::new-pad ##### -->
<para>

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

@ -38,6 +38,7 @@ The different major types of events.
@GST_EVENT_EMPTY: an empty event.
@GST_EVENT_SEEK: a seek event.
@GST_EVENT_DISCONTINUOUS: a discontinuous event to indicate the stream has a discontinuity.
@GST_EVENT_NEW_MEDIA:
@GST_EVENT_INFO: an informational event
@GST_EVENT_ERROR: an error event
@ -71,8 +72,10 @@ The different types of seek events.
</para>
@GST_SEEK_ANY: the seek is performed anyway.
@GST_SEEK_TIMEOFFSET: this is a seek to specific timeoffset
@GST_SEEK_BYTEOFFSET: this is a seek to specific byteoffset
@GST_SEEK_TIMEOFFSET_SET:
@GST_SEEK_BYTEOFFSET_SET:
@GST_SEEK_BYTEOFFSET_CUR:
@GST_SEEK_BYTEOFFSET_END:
<!-- ##### MACRO GST_EVENT_SEEK_TYPE ##### -->
<para>
@ -133,6 +136,15 @@ The event data structure.
@event:
<!-- ##### FUNCTION gst_event_copy ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION gst_event_new_seek ##### -->
<para>

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

@ -18,24 +18,34 @@ with the buffer. (fakesink)
<!-- ##### SIGNAL GstFakeSink::handoff ##### -->
<para>
This signal is emmitted when a buffer is handled.
</para>
@gstfakesink: the object which received the signal.
@arg1:
@arg1: The buffer that is received.
<!-- ##### ARG GstFakeSink:num-sinks ##### -->
<para>
The number of sink pads.
</para>
<!-- ##### ARG GstFakeSink:silent ##### -->
<para>
Indicates the plugin should not emit messages.
</para>
<!-- ##### ARG GstFakeSink:dump ##### -->
<para>
Dump the contents of the buffer
</para>
<!-- ##### ARG GstFakeSink:sync ##### -->
<para>
Sync on the clock
</para>
<!-- ##### ARG GstFakeSink:last-message ##### -->
<para>
The last message this plugin emmited.
</para>

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

@ -92,3 +92,8 @@ The <classname>GstFakeSrc</classname> generates empty buffers. (fakesrc)
</para>
<!-- ##### ARG GstFakeSrc:last-message ##### -->
<para>
</para>

27
docs/gst/tmpl/gstfilesrc.sgml
View file

@ -2,11 +2,12 @@
GstFileSrc
<!-- ##### SECTION Short_Description ##### -->
Read data from a file
<!-- ##### SECTION Long_Description ##### -->
<para>
FileSrc is used to read buffers from a file. It efficiently uses mmap
and subbuffers.
</para>
<!-- ##### SECTION See_Also ##### -->
@ -14,38 +15,38 @@ GstFileSrc
</para>
<!-- ##### ARG GstFileSrc:offset ##### -->
<para>
The offset in the file that is currently being read.
</para>
<!-- ##### ARG GstFileSrc:location ##### -->
<para>
The filename
</para>
<!-- ##### ARG GstFileSrc:filesize ##### -->
<para>
The filesize.
</para>
<!-- ##### ARG GstFileSrc:fd ##### -->
<para>
The file descriptor.
</para>
<!-- ##### ARG GstFileSrc:blocksize ##### -->
<para>
</para>
<!-- ##### ARG GstFileSrc:offset ##### -->
<para>
The size of the buffers to pass to the peer element.
</para>
<!-- ##### ARG GstFileSrc:mmapsize ##### -->
<para>
The size of the mmapped area.
</para>
<!-- ##### ARG GstFileSrc:touch ##### -->
<para>
Indicates the mmapped area should be touched to bring it into memory.
</para>

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

@ -52,3 +52,13 @@ Pass data without modification.
</para>
<!-- ##### ARG GstIdentity:last-message ##### -->
<para>
</para>
<!-- ##### ARG GstIdentity:dump ##### -->
<para>
</para>

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

@ -245,6 +245,8 @@ Check if the object has been destroyed.
</para>
@object:
@self:
<!-- # Unused Parameters # -->
@parent:
@ -279,6 +281,15 @@ Check if the object has been destroyed.
@Returns:
<!-- ##### SIGNAL GstObject::deep-notify ##### -->
<para>
</para>
@gstobject: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GstObject::object-saved ##### -->
<para>
Is trigered whenever a new object is saved to XML. You can connect to

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

@ -121,26 +121,26 @@ Can this pad be used to pull a buffer.
<!-- ##### MACRO GST_PAD_IS_SINK ##### -->
<para>
Check if the pad is a sinkpad.
</para>
@pad:
@pad: the pad to query
<!-- ##### MACRO GST_PAD_IS_SRC ##### -->
<para>
Check if the pad is a srcpad.
</para>
@pad:
@pad: the pad to query
<!-- ##### MACRO GST_PAD_IS_CONNECTED ##### -->
<para>
Checks if the pad is connected
</para>
@pad:
@pad: the pad to query
<!-- ##### STRUCT GstPad ##### -->
@ -193,12 +193,13 @@ from this pad.
<!-- ##### USER_FUNCTION GstPadGetCapsFunction ##### -->
<para>
Return the caps of the specified pad. By default this function
will return the pad template caps but can optionally be overridden.
</para>
@pad:
@caps:
@Returns:
@pad: The pad to get the caps of
@caps: The peer caps, can be used to filter the caps.
@Returns: The caps of the pad.
<!-- ##### ENUM GstRegionType ##### -->
@ -226,22 +227,22 @@ a start/stop timecode pair.
<!-- ##### USER_FUNCTION GstPadEventFunction ##### -->
<para>
Function signature to handle an event for the pad.
</para>
@pad:
@event:
@Returns:
@pad: The pad to handle the event
@event: The event to handle
@Returns: TRUE if the pad could handle the event.
<!-- ##### USER_FUNCTION GstPadConnectFunction ##### -->
<para>
Function signature to handle a new connection on the pad.
</para>
@pad:
@caps:
@Returns:
@pad: The pad that is connected.
@caps: The peer caps.
@Returns: the result of the connection with the specified caps.
<!-- ##### ENUM GstPadConnectReturn ##### -->
@ -250,9 +251,9 @@ a start/stop timecode pair.
</para>
@GST_PAD_CONNECT_REFUSED:
@GST_PAD_CONNECT_DELAYED:
@GST_PAD_CONNECT_OK:
@GST_PAD_CONNECT_DONE:
@GST_PAD_CONNECT_DELAYED:
<!-- ##### ENUM GstPadDirection ##### -->
<para>
@ -466,6 +467,14 @@ Destroy the pad.
@sched:
<!-- ##### FUNCTION gst_pad_unset_sched ##### -->
<para>
</para>
@pad:
<!-- ##### FUNCTION gst_pad_get_real_parent ##### -->
<para>
@ -537,9 +546,12 @@ Destroy the pad.
</para>
@pad:
@srcpad:
@sinkpad:
@filtercaps:
@Returns:
<!-- # Unused Parameters # -->
@pad:
<!-- ##### FUNCTION gst_pad_try_reconnect_filtered ##### -->
@ -547,9 +559,12 @@ Destroy the pad.
</para>
@pad:
@srcpad:
@sinkpad:
@filtercaps:
@Returns:
<!-- # Unused Parameters # -->
@pad:
<!-- ##### FUNCTION gst_pad_disconnect ##### -->
@ -561,6 +576,27 @@ Destroy the pad.
@sinkpad:
<!-- ##### FUNCTION gst_pad_can_connect ##### -->
<para>
</para>
@srcpad:
@sinkpad:
@Returns:
<!-- ##### FUNCTION gst_pad_can_connect_filtered ##### -->
<para>
</para>
@srcpad:
@sinkpad:
@filtercaps:
@Returns:
<!-- ##### FUNCTION gst_pad_push ##### -->
<para>
@ -662,6 +698,16 @@ Destroy the pad.
@Returns:
<!-- ##### FUNCTION gst_pad_perform_negotiate ##### -->
<para>
</para>
@srcpad:
@sinkpad:
@Returns:
<!-- ##### FUNCTION gst_pad_ghost_save_thyself ##### -->
<para>
@ -833,18 +879,18 @@ Get the chain function of the real pad.
<!-- ##### MACRO GST_RPAD_FILTER ##### -->
<para>
Get the filter from the pad
</para>
@pad:
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_APPFILTER ##### -->
<para>
Get the application filter for this pad
</para>
@pad:
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_GETFUNC ##### -->
@ -913,18 +959,18 @@ Get the gethandler function of this real pad.
<!-- ##### MACRO GST_RPAD_CONNECTFUNC ##### -->
<para>
Get the connect function of the pad
</para>
@pad:
@pad: the pad to query
<!-- ##### MACRO GST_RPAD_GETCAPSFUNC ##### -->
<para>
Get the getcaps function of this pad
</para>
@pad:
@pad: the pad to query
<!-- ##### MACRO GST_GPAD_REALPAD ##### -->
@ -940,8 +986,6 @@ Get the real pad of this ghost pad.
</para>
@pad:
@realpad:
<!-- ##### FUNCTION gst_ghost_pad_new ##### -->
<para>

22
docs/gst/tmpl/gstpadtemplate.sgml
View file

@ -86,12 +86,6 @@ gst_element_request_pad_by_name() or gst_element_request_compatible_pad().
</para>
@object:
@name_template:
@direction:
@presence:
@caps:
@fixed:
<!-- ##### MACRO GST_PADTEMPLATE_CAPS ##### -->
<para>
@ -159,18 +153,18 @@ Get the padtemplate of the factory created with GST_PADTEMPLATE_FACTORY()
<!-- ##### MACRO GST_PADTEMPLATE_FIXED ##### -->
<para>
Get the flag indicating the properties are fixed from the template.
</para>
@templ:
@templ: the template to query
<!-- ##### MACRO GST_PADTEMPLATE_IS_FIXED ##### -->
<para>
Check if the properties of the padtemplate are fixed
</para>
@templ:
@templ: the template to query
<!-- ##### FUNCTION gst_padtemplate_new ##### -->
@ -224,3 +218,11 @@ Get the padtemplate of the factory created with GST_PADTEMPLATE_FACTORY()
@Returns:
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
<para>
</para>
@gstpadtemplate: the object which received the signal.
@arg1:

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

@ -53,6 +53,7 @@ can be made with <option>{}</option>.
@GST_PARSE_ERROR_CREATING_ELEMENT:
@GST_PARSE_ERROR_NOSUCH_ELEMENT:
@GST_PARSE_ERROR_INTERNAL:
@GST_PARSE_ERROR_CONNECT:
<!-- ##### FUNCTION gst_parse_launch ##### -->
<para>

227
docs/gst/tmpl/gstprops.sgml
View file

@ -20,11 +20,41 @@ are usually used in conjunction with GstCaps.
</para>
@refcount:
@lock:
@fixed:
@refcount: a refcount for this struct
@fixed: indicates that this props has no lists or ranges
@properties: the properties
<!-- ##### STRUCT GstPropsEntry ##### -->
<para>
</para>
<!-- ##### ENUM GstPropsType ##### -->
<para>
</para>
@GST_PROPS_END_TYPE:
@GST_PROPS_INVALID_TYPE:
@GST_PROPS_INT_TYPE:
@GST_PROPS_FLOAT_TYPE:
@GST_PROPS_FOURCC_TYPE:
@GST_PROPS_BOOL_TYPE:
@GST_PROPS_STRING_TYPE:
@GST_PROPS_VAR_TYPE:
@GST_PROPS_LIST_TYPE:
@GST_PROPS_FLOAT_RANGE_TYPE:
@GST_PROPS_INT_RANGE_TYPE:
@GST_PROPS_LAST_TYPE:
<!-- ##### MACRO GST_TYPE_PROPS ##### -->
<para>
The GType of the props boxed type, for use in GValues.
</para>
<!-- ##### MACRO GST_MAKE_FOURCC ##### -->
<para>
Create a FOURCC value that can easily be used to construct
@ -73,7 +103,7 @@ Create an integer property.
<!-- ##### MACRO GST_PROPS_INT_ANY ##### -->
<para>
Create an integer property that can hold any int.
</para>
@ -89,7 +119,7 @@ Create an integer range property.
<!-- ##### MACRO GST_PROPS_INT_NEGATIVE ##### -->
<para>
Create an integer property that can hold negative ints.
</para>
@ -137,19 +167,11 @@ Create a float range value.
<!-- ##### MACRO GST_PROPS_INT_POSITIVE ##### -->
<para>
Create an integer property that can hold positive ints.
</para>
<!-- ##### MACRO GST_PROPS_ENTRY_IS_VARIABLE ##### -->
<para>
</para>
@a:
<!-- ##### FUNCTION gst_props_new ##### -->
<para>
@ -268,7 +290,18 @@ Create a float range value.
@value:
<!-- ##### FUNCTION gst_props_get_boolean ##### -->
<!-- ##### FUNCTION gst_props_get ##### -->
<para>
</para>
@props:
@first_name:
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_props_has_fixed_property ##### -->
<para>
</para>
@ -278,43 +311,14 @@ Create a float range value.
@Returns:
<!-- ##### FUNCTION gst_props_get_fourcc_int ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_int ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_string ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_float ##### -->
<!-- ##### FUNCTION gst_props_has_property_typed ##### -->
<para>
</para>
@props:
@name:
@type:
@Returns:
@ -355,3 +359,134 @@ Create a float range value.
@Returns:
<!-- ##### FUNCTION gst_props_get_entry ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get ##### -->
<para>
</para>
@entry:
@Varargs:
@Returns:
<!-- # Unused Parameters # -->
@props:
<!-- ##### FUNCTION gst_props_entry_get_boolean ##### -->
<para>
</para>
@entry:
@val:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_float ##### -->
<para>
</para>
@entry:
@val:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_float_range ##### -->
<para>
</para>
@entry:
@min:
@max:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_fourcc_int ##### -->
<para>
</para>
@entry:
@val:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_int ##### -->
<para>
</para>
@entry:
@val:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_int_range ##### -->
<para>
</para>
@entry:
@min:
@max:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_list ##### -->
<para>
</para>
@entry:
@val:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_name ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_string ##### -->
<para>
</para>
@entry:
@val:
@Returns:
<!-- ##### FUNCTION gst_props_entry_get_type ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gst_props_entry_is_fixed ##### -->
<para>
</para>
@entry:
@Returns:

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

@ -38,6 +38,26 @@ Information about audio buffers.
audioraw
<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:See_Also ##### -->
<para>
</para>
<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Short_Description ##### -->
<!-- ##### SECTION ./tmpl/gobject2gtk.sgml:Title ##### -->
GObject
<!-- ##### SECTION ./tmpl/gstasyncdisksrc.sgml:Long_Description ##### -->
<para>
Reads data from a file. You can seek to a specific location by setting
@ -686,6 +706,27 @@ Retrieves the type id of the data in the buffer.
@buf: GstBuffer
<!-- ##### MACRO GST_CAPS_LOCK ##### -->
<para>
Lock the caps structure
</para>
@caps: The caps structure to lock
<!-- ##### MACRO GST_CAPS_TRYLOCK ##### -->
<para>
Try to lock the caps structure
</para>
@caps: The caps structure to try to lock
<!-- ##### MACRO GST_CAPS_UNLOCK ##### -->
<para>
Unlock the caps structure
</para>
@caps: The caps structure to unlock
<!-- ##### MACRO GST_CONNECTION ##### -->
<para>
@ -1420,6 +1461,13 @@ Indicates a srcpad for the padfactory.
</para>
<!-- ##### MACRO GST_PROPS_ENTRY_IS_VARIABLE ##### -->
<para>
</para>
@a:
<!-- ##### MACRO GST_PROPS_FLOAT_RANGE_STRING ##### -->
<para>
@ -2538,24 +2586,19 @@ the pool.
</para>
<!-- ##### SIGNAL GstDiskSink::handoff ##### -->
<para>
Is emited after the buffer has been written to the disk.
</para>
@gstdisksink: the object which received the signal.
<!-- ##### ARG GstDiskSink:closed ##### -->
<para>
</para>
<!-- ##### ARG GstDiskSink:location ##### -->
<!-- ##### ENUM GstDiskSinkFlags ##### -->
<para>
The filename to write to.
</para>
@GST_DISKSINK_OPEN:
@GST_DISKSINK_FLAG_LAST:
<!-- ##### STRUCT GstDiskSrc ##### -->
<para>
@ -2616,6 +2659,14 @@ Get the size of the file.
@GST_DISKSRC_OPEN:
@GST_DISKSRC_FLAG_LAST:
<!-- ##### SIGNAL GstElement::event ##### -->
<para>
</para>
@gstelement: the object which received the signal.
@arg1:
<!-- ##### SIGNAL GstElement::ghost-pad-removed ##### -->
<para>
@ -2885,14 +2936,6 @@ The function that will be called when a QoS message is sent.
@pad: the pad that sent the QoS message
@qos_message: the message
<!-- ##### SIGNAL GstPadTemplate::pad-created ##### -->
<para>
</para>
@gstpadtemplate: the object which received the signal.
@arg1:
<!-- ##### STRUCT GstPipelineClass ##### -->
<para>
@ -3126,13 +3169,20 @@ Query the element for the current mime type
</para>
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
<!-- ##### STRUCT GstXML ##### -->
<para>
Is trigered whenever the state of an element changes
</para>
@gstelement: the object which received the signal.
@arg1: the new state of the object
<!-- ##### SIGNAL GstXml::object-loaded ##### -->
<para>
</para>
@gstxml: the object which received the signal.
@arg1:
@arg2:
<!-- ##### MACRO INFO ##### -->
<para>
@ -3237,6 +3287,15 @@ must be defined to activate the tracing functionality.
</para>
<!-- ##### FUNCTION cothread_get_data ##### -->
<para>
</para>
@thread:
@key:
@Returns:
<!-- ##### FUNCTION cothread_getcurrent ##### -->
<para>
@ -3250,6 +3309,15 @@ must be defined to activate the tracing functionality.
@Returns:
<!-- ##### FUNCTION cothread_set_data ##### -->
<para>
</para>
@thread:
@key:
@data:
<!-- ##### FUNCTION g2g_object_class_find_property ##### -->
<para>
@ -3571,12 +3639,6 @@ must be defined to activate the tracing functionality.
@llink:
@Returns:
<!-- ##### VARIABLE g_log_domain_gstreamer ##### -->
<para>
</para>
<!-- ##### MACRO g_object_class_find_property ##### -->
<para>
@ -4159,6 +4221,14 @@ must be defined to activate the tracing functionality.
@bin:
@element:
<!-- ##### FUNCTION gst_bin_child_error ##### -->
<para>
</para>
@bin:
@child:
<!-- ##### FUNCTION gst_bin_create_plan ##### -->
<para>
@ -4306,6 +4376,46 @@ must be defined to activate the tracing functionality.
@Returns:
@count:
<!-- ##### FUNCTION gst_clock_current_diff ##### -->
<para>
</para>
@clock:
@time:
@Returns:
<!-- ##### FUNCTION gst_clock_get_system ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_clock_new ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_clock_register ##### -->
<para>
</para>
@clock:
@obj:
<!-- ##### FUNCTION gst_clock_set ##### -->
<para>
</para>
@clock:
@time:
<!-- ##### FUNCTION gst_connection_get_type ##### -->
<para>
@ -4357,6 +4467,24 @@ must be defined to activate the tracing functionality.
@Returns:
<!-- ##### FUNCTION gst_element_info ##### -->
<para>
</para>
@element:
@info:
@Varargs:
<!-- ##### FUNCTION gst_element_install_std_props ##### -->
<para>
</para>
@klass:
@first_name:
@Varargs:
<!-- ##### FUNCTION gst_element_load_thyself ##### -->
<para>
@ -4410,6 +4538,14 @@ must be defined to activate the tracing functionality.
@parent:
@Returns:
<!-- ##### FUNCTION gst_element_send_event ##### -->
<para>
</para>
@element:
@event:
<!-- ##### FUNCTION gst_element_signal_eos ##### -->
<para>
@ -5109,6 +5245,51 @@ Call the EOS function of the pad
@minor:
@Returns:
<!-- ##### FUNCTION gst_props_get_boolean ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_float ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_fourcc_int ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_int ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_get_string ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_register ##### -->
<para>

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

@ -40,6 +40,14 @@ Get the state of the scheduler.
@GST_SCHEDULER_STATE_STOPPED:
@GST_SCHEDULER_STATE_ERROR:
<!-- ##### ENUM GstSchedulerFlags ##### -->
<para>
</para>
@GST_SCHEDULER_FLAG_FIXED_CLOCK:
@GST_SCHEDULER_FLAG_LAST:
<!-- ##### MACRO gst_scheduler_destroy ##### -->
<para>
Destroy the scheduler
@ -169,6 +177,71 @@ Destroy the scheduler
@Returns:
<!-- ##### FUNCTION gst_scheduler_add_scheduler ##### -->
<para>
</para>
@sched:
@sched2:
<!-- ##### FUNCTION gst_scheduler_remove_scheduler ##### -->
<para>
</para>
@sched:
@sched2:
<!-- ##### FUNCTION gst_scheduler_auto_clock ##### -->
<para>
</para>
@sched:
<!-- ##### FUNCTION gst_scheduler_get_clock ##### -->
<para>
</para>
@sched:
@Returns:
<!-- ##### FUNCTION gst_scheduler_set_clock ##### -->
<para>
</para>
@sched:
@clock:
<!-- ##### FUNCTION gst_scheduler_use_clock ##### -->
<para>
</para>
@sched:
@clock:
<!-- ##### FUNCTION gst_scheduler_clock_wait ##### -->
<para>
</para>
@sched:
@element:
@clock:
@time:
@Returns:
<!-- ##### FUNCTION gst_scheduler_iterate ##### -->
<para>

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

@ -24,3 +24,8 @@ A tee can be used to split out the filter graph.
</para>
<!-- ##### ARG GstTee:last-message ##### -->
<para>
</para>

2
docs/gst/tmpl/gsttimecache.sgml
View file

@ -6,7 +6,7 @@ Cache time and byteoffsets.
<!-- ##### SECTION Long_Description ##### -->
<para>
This clas is used by plugins to manage time vs byte offsets. It is mainly
This class is used by plugins to manage time vs byte offsets. It is mainly
used for efficient seeking.
</para>

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

@ -24,6 +24,15 @@ Some convenience functions
@value:
<!-- ##### FUNCTION gst_util_set_value_from_string ##### -->
<para>
</para>
@value:
@value_str:
<!-- ##### FUNCTION gst_util_get_int_arg ##### -->
<para>

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

@ -1,5 +1,5 @@
<!-- ##### SECTION Title ##### -->
GstXml
GstXML
<!-- ##### SECTION Short_Description ##### -->
Convert Elements into an XML presentation.
@ -15,15 +15,6 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
</para>
<!-- ##### STRUCT GstXML ##### -->
<para>
</para>
@object:
@topelements:
@ns:
<!-- ##### FUNCTION gst_xml_new ##### -->
<para>
@ -104,7 +95,17 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
@Returns:
<!-- ##### SIGNAL GstXml::object-loaded ##### -->
<!-- ##### FUNCTION gst_xml_make_element ##### -->
<para>
</para>
@cur:
@parent:
@Returns:
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
<para>
</para>
@ -112,8 +113,10 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
@gstxml: the object which received the signal.
@arg1:
@arg2:
<!-- # Unused Parameters # -->
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstXml::object-loaded ##### -->
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
<para>
</para>
@ -121,4 +124,6 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
@gstxml: the object which received the signal.
@arg1:
@arg2:
<!-- # Unused Parameters # -->
@gstelement: the object which received the signal.