Documentation updates

Original commit message from CVS:
Documentation updates
This commit is contained in:
Wim Taymans 2003-02-10 23:01:55 +00:00
parent 612d89da34
commit a6dfa0f792
23 changed files with 1169 additions and 237 deletions

View file

@ -27,6 +27,7 @@
<!entity GstQuery SYSTEM "sgml/gstquery.sgml">
<!entity GstThread SYSTEM "sgml/gstthread.sgml">
<!entity GstRegistry SYSTEM "sgml/gstregistry.sgml">
<!entity GstRegistryPool SYSTEM "sgml/gstregistrypool.sgml">
<!entity GstScheduler SYSTEM "sgml/gstscheduler.sgml">
<!entity GstSchedulerFactory SYSTEM "sgml/gstschedulerfactory.sgml">
<!entity GstTrace SYSTEM "sgml/gsttrace.sgml">
@ -37,6 +38,7 @@
<!entity GstClock SYSTEM "sgml/gstclock.sgml">
<!entity GstSystemClock SYSTEM "sgml/gstsystemclock.sgml">
<!entity GstUtils SYSTEM "sgml/gstutils.sgml">
<!entity GstUri SYSTEM "sgml/gsturi.sgml">
<!entity GstXML SYSTEM "sgml/gstxml.sgml">
<!entity GstQueue SYSTEM "sgml/gstqueue.sgml">
<!entity GstTypeFind SYSTEM "sgml/gsttypefind.sgml">
@ -114,6 +116,7 @@ with some more specialized elements.</para>
&GstQuery;
&GstQueue;
&GstRegistry;
&GstRegistryPool;
&GstScheduler;
&GstSchedulerFactory;
&GstSystemClock;
@ -121,6 +124,7 @@ with some more specialized elements.</para>
&GstType;
&GstTypeFactory;
&GstTypeFind;
&GstUri;
&GstUtils;
&GstXML;

View file

@ -164,6 +164,8 @@ GST_TYPE_SCHEDULER_FLAGS
gst_scheduler_flags_get_type
GST_TYPE_SCHEDULER_STATE
gst_scheduler_state_get_type
GST_SCHEDULER_FACTORY_GET_CLASS
GST_SCHEDULER_GET_CLASS
</SECTION>
<SECTION>
@ -234,6 +236,7 @@ GST_BIN
GST_BIN_CLASS
GST_BIN_CAST
GST_BIN_CLASS_CAST
GST_BIN_GET_CLASS
GST_IS_BIN
GST_IS_BIN_CLASS
gst_bin_details
@ -301,6 +304,7 @@ gst_data_flags_get_type
<SECTION>
<FILE>gstbuffer</FILE>
<TITLE>GstBuffer</TITLE>
GST_BUFFER_TRACE_NAME
GST_BUFFER
GST_IS_BUFFER
GST_BUFFER_REFCOUNT
@ -339,7 +343,6 @@ gst_buffer_create_sub
gst_buffer_merge
gst_buffer_is_span_fast
gst_buffer_span
gst_buffer_print_stats
<SUBSECTION Standard>
GST_TYPE_BUFFER
GST_TYPE_BUFFER_FLAG
@ -350,6 +353,7 @@ gst_buffer_flag_get_type
<FILE>gstbufferpool</FILE>
<TITLE>GstBufferPool</TITLE>
GST_BUFFER_POOL
GST_BUFFER_POOL_TRACE_NAME
GST_IS_BUFFER_POOL
GstBufferPool
GstBufferPoolBufferNewFunction
@ -402,6 +406,8 @@ GST_EVENT_RATE_VALUE
GST_EVENT_SEEK_ENDOFFSET
GST_EVENT_SIZE_FORMAT
GST_EVENT_SIZE_VALUE
GST_EVENT_IS_INTERRUPT
GST_EVENT_TRACE_NAME
GstEvent
gst_event_new
gst_event_copy
@ -415,7 +421,7 @@ gst_event_new_discontinuous
gst_event_discont_get_value
gst_event_new_filler
gst_event_new_flush
gst_event_print_stats
gst_event_masks_contains
GST_EVENT_MASK_FUNCTION
<SUBSECTION Standard>
GST_EVENT
@ -510,6 +516,10 @@ gst_element_set_valist
gst_element_query
gst_element_send_event
gst_element_get_event_masks
gst_element_get_formats
gst_element_get_query_types
gst_element_convert
gst_element_default_deep_notify
gst_element_default_error
@ -537,6 +547,9 @@ GST_ELEMENT_PADS
GST_ELEMENT_SCHED
GST_ELEMENT_MANAGER
GST_ELEMENT_CLOCK
GST_ELEMENT_EVENT_MASK_FUNCTION
GST_ELEMENT_FORMATS_FUNCTION
GST_ELEMENT_QUERY_TYPE_FUNCTION
<SUBSECTION Standard>
GstElementClass
GST_TYPE_ELEMENT
@ -544,6 +557,7 @@ GST_ELEMENT
GST_ELEMENT_CLASS
GST_ELEMENT_CAST
GST_ELEMENT_CLASS_CAST
GST_ELEMENT_GET_CLASS
GST_IS_ELEMENT
GST_IS_ELEMENT_CLASS
gst_element_get_type
@ -574,6 +588,7 @@ GST_ELEMENT_RANK_PRIMARY
GST_ELEMENT_RANK_SECONDARY
<SUBSECTION Standard>
GstElementFactory
GstElementFactoryClass
GST_ELEMENT_FACTORY
GST_IS_ELEMENT_FACTORY
GST_TYPE_ELEMENT_FACTORY
@ -592,6 +607,7 @@ gst_autoplug_signal_new_object
gst_autoplug_to_caps
gst_autoplug_to_renderers
<SUBSECTION Standard>
GstAutoplugClass
GST_AUTOPLUG
GST_IS_AUTOPLUG
GST_TYPE_AUTOPLUG
@ -638,6 +654,7 @@ GstClockEntry
GstClockCallback
GstClockEntryStatus
GstClockEntryType
GST_CLOCK_ENTRY_TRACE_NAME
GST_CLOCK_ENTRY
GST_CLOCK_ENTRY_CLOCK
GST_CLOCK_ENTRY_TYPE
@ -668,11 +685,13 @@ gst_clock_id_unschedule
gst_clock_id_unlock
gst_clock_id_free
<SUBSECTION Standard>
GstClockClass
GST_CLOCK
GST_IS_CLOCK
GST_TYPE_CLOCK
gst_clock_get_type
GST_CLOCK_CLASS
GST_CLOCK_GET_CLASS
GST_IS_CLOCK_CLASS
GST_TYPE_CLOCK_ENTRY_STATUS
gst_clock_entry_status_get_type
@ -707,16 +726,6 @@ gst_registry_find_feature
gst_registry_load_plugin
gst_registry_unload_plugin
gst_registry_update_plugin
gst_registry_pool_list
gst_registry_pool_add
gst_registry_pool_remove
gst_registry_pool_add_plugin
gst_registry_pool_load_all
gst_registry_pool_plugin_list
gst_registry_pool_feature_list
gst_registry_pool_find_plugin
gst_registry_pool_find_feature
gst_registry_pool_get_prefered
<SUBSECTION Standard>
REGISTRY_DIR_PERMS
REGISTRY_TMPFILE_PERMS
@ -737,6 +746,23 @@ GST_TYPE_REGISTRY_FLAGS
gst_registry_flags_get_type
GST_TYPE_REGISTRY_RETURN
gst_registry_return_get_type
GST_REGISTRY_GET_CLASS
GstRegistryClass
</SECTION>
<SECTION>
<FILE>gstregistrypool</FILE>
<TITLE>GstRegistryPool</TITLE>
gst_registry_pool_list
gst_registry_pool_add
gst_registry_pool_remove
gst_registry_pool_add_plugin
gst_registry_pool_load_all
gst_registry_pool_plugin_list
gst_registry_pool_feature_list
gst_registry_pool_find_plugin
gst_registry_pool_find_feature
gst_registry_pool_get_prefered
</SECTION>
<SECTION>
@ -751,6 +777,8 @@ GST_TYPE_SYSTEM_CLOCK
gst_system_clock_get_type
GST_SYSTEM_CLOCK_CLASS
GST_IS_SYSTEM_CLOCK_CLASS
GST_SYSTEM_CLOCK_GET_CLASS
GstSystemClockClass
</SECTION>
@ -786,6 +814,7 @@ gst_object_get_name
gst_object_unparent
gst_object_ref
gst_object_unref
gst_object_replace
gst_object_sink
gst_object_destroy
gst_object_save_thyself
@ -797,6 +826,7 @@ gst_class_signal_connect
<SUBSECTION Standard>
gst_object_get_type
GstObjectClass
GST_OBJECT_GET_CLASS
GST_TYPE_OBJECT
GST_OBJECT
GST_OBJECT_CLASS
@ -819,6 +849,9 @@ gst_query_type_get_by_nick
gst_query_types_contains
gst_query_type_get_details
gst_query_type_get_definitions
<SUBSECTION Standard>
GST_TYPE_QUERY_TYPE
gst_query_type_get_type
</SECTION>
<SECTION>
@ -1036,6 +1069,7 @@ gst_probe_dispatcher_dispatch
<TITLE>GstPadTemplate</TITLE>
GstPadPresence
GstPadTemplate
GstPadTemplateFlags
GST_PAD_TEMPLATE_CAPS
GST_PAD_TEMPLATE_DIRECTION
GST_PAD_TEMPLATE_NAME_TEMPLATE
@ -1043,7 +1077,6 @@ GST_PAD_TEMPLATE_PRESENCE
GST_PAD_TEMPLATE_NEW
GST_PAD_TEMPLATE_FACTORY
GST_PAD_TEMPLATE_GET
GST_PAD_TEMPLATE_FIXED
GST_PAD_TEMPLATE_IS_FIXED
gst_pad_template_new
gst_pad_template_get_caps
@ -1057,6 +1090,8 @@ GST_PAD_TEMPLATE_CLASS
GST_IS_PAD_TEMPLATE
GST_IS_PAD_TEMPLATE_CLASS
gst_pad_template_get_type
GST_TYPE_PAD_TEMPLATE_FLAGS
gst_pad_template_flags_get_type
</SECTION>
<SECTION>
@ -1119,6 +1154,7 @@ GstPluginFeature
GST_PLUGIN_FEATURE
GST_IS_PLUGIN_FEATURE
GST_TYPE_PLUGIN_FEATURE
GST_PLUGIN_FEATURE_GET_CLASS
gst_plugin_feature_get_type
GST_PLUGIN_FEATURE_CLASS
GST_IS_PLUGIN_FEATURE_CLASS
@ -1142,11 +1178,26 @@ GST_IS_THREAD_CLASS
gst_thread_details
GST_TYPE_THREAD_STATE
gst_thread_state_get_type
GST_THREAD_GET_CLASS
</SECTION>
<SECTION>
<FILE>gsttrace</FILE>
<TITLE>GstTrace</TITLE>
GstAllocTraceFlags
GstAllocTrace
gst_alloc_trace_available
gst_alloc_trace_list
gst_alloc_trace_print_all
gst_alloc_trace_set_flags_all
gst_alloc_trace_get
gst_alloc_trace_print
gst_alloc_trace_set_flags
gst_alloc_trace_register
gst_alloc_trace_new
gst_alloc_trace_free
<SUBSECTION Standard>
gst_trace_read_tsc
GstTrace
@ -1159,8 +1210,9 @@ gst_trace_get_size
gst_trace_get_offset
gst_trace_get_remaining
gst_trace_set_default
TRACE_ENABLE
gst_trace_add_entry
GST_TYPE_ALLOC_TRACE_FLAGS
gst_alloc_trace_flags_get_type
</SECTION>
<SECTION>
@ -1192,6 +1244,10 @@ GST_TYPE_TYPE_FACTORY
gst_type_factory_get_type
GST_TYPE_FACTORY_CLASS
GST_IS_TYPE_FACTORY_CLASS
GST_IS_TYPE_FIND
GST_IS_TYPE_FIND_CLASS
GST_TYPE_FACTORY_GET_CLASS
GstTypeFactoryClass
</SECTION>
<SECTION>
@ -1201,9 +1257,19 @@ GST_TYPE_CAPS
GST_CAPS_NEW
GST_CAPS_FACTORY
GST_CAPS_GET
GstCaps
GstCapsFlags
GST_CAPS_FLAGS
GST_CAPS_FLAG_IS_SET
GST_CAPS_FLAG_SET
GST_CAPS_FLAG_UNSET
GST_CAPS_IS_FLOATING
GST_CAPS_IS_CHAINED
GST_CAPS_IS_FIXED
GstCaps
GST_CAPS_NEXT
GST_CAPS_PROPERTIES
GST_CAPS_REFCOUNT
GST_CAPS_TRACE_NAME
gst_caps_new
gst_caps_new_id
gst_caps_destroy
@ -1215,6 +1281,10 @@ gst_caps_copy_on_write
gst_caps_chain
gst_caps_append
gst_caps_prepend
gst_caps_next
gst_caps_replace
gst_caps_replace_sink
gst_caps_sink
gst_caps_set_name
gst_caps_get_name
gst_caps_set_type_id
@ -1243,6 +1313,9 @@ gst_caps_load_thyself
gst_caps_debug
<SUBSECTION Standard>
GST_CAPS
GST_TYPE_CAPS_FLAGS
gst_caps_flags_get_type
gst_caps_union
</SECTION>
<SECTION>
@ -1250,6 +1323,16 @@ GST_CAPS
<TITLE>GstProps</TITLE>
GstProps
GstPropsType
GstPropsFlags
GST_PROPS_TRACE_NAME
GST_PROPS_FLAGS
GST_PROPS_FLAG_IS_SET
GST_PROPS_FLAG_SET
GST_PROPS_FLAG_UNSET
GST_PROPS_IS_FIXED
GST_PROPS_IS_FLOATING
GST_PROPS_PROPERTIES
GST_PROPS_REFCOUNT
GST_TYPE_PROPS
GST_MAKE_FOURCC
GST_STR_FOURCC
@ -1266,6 +1349,7 @@ GST_PROPS_FLOAT
GST_PROPS_FLOAT_RANGE
GST_PROPS_INT_POSITIVE
GstPropsEntry
GST_PROPS_ENTRY_TRACE_NAME
gst_props_new
gst_props_newv
gst_props_empty_new
@ -1275,6 +1359,9 @@ gst_props_copy_on_write
gst_props_destroy
gst_props_ref
gst_props_unref
gst_props_replace
gst_props_replace_sink
gst_props_sink
gst_props_check_compatibility
gst_props_has_property
gst_props_normalize
@ -1291,7 +1378,12 @@ gst_props_load_thyself
gst_props_get_entry
gst_props_add_entry
gst_props_remove_entry
gst_props_remove_entry_by_name
gst_props_entry_new
gst_props_entry_copy
gst_props_entry_destroy
gst_props_entry_get
gst_props_entry_get_boolean
gst_props_entry_get_float
@ -1307,6 +1399,9 @@ gst_props_entry_is_fixed
<SUBSECTION Standard>
GST_TYPE_PROPS_TYPE
gst_props_type_get_type
GST_TYPE_PROPS_ENTRY
GST_TYPE_PROPS_FLAGS
gst_props_flags_get_type
</SECTION>
<SECTION>
@ -1314,16 +1409,7 @@ gst_props_type_get_type
<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
gst_util_get_float_arg
gst_util_get_double_arg
gst_util_get_string_arg
gst_util_get_pointer_arg
gst_util_get_int64_arg
gst_util_dump_mem
gst_util_has_arg
gst_print_element_args
gst_print_pad_caps
<SUBSECTION Standard>
@ -1351,8 +1437,54 @@ GST_TYPE_XML
GST_XML_CLASS
GstXML
GstXMLClass
GST_XML_GET_CLASS
</SECTION>
<SECTION>
<FILE>gsturi</FILE>
<TITLE>GstURIHandler</TITLE>
gst_uri_handler_new
gst_uri_handler_find
gst_uri_handler_find_by_uri
gst_uri_handler_create
gst_uri_handler_make_by_uri
<SUBSECTION Standard>
GstURIHandler
GstURIHandlerClass
GST_URI_HANDLER
GST_IS_URI_HANDLER
GST_TYPE_URI_HANDLER
gst_uri_handler_get_type
GST_URI_HANDLER_CLASS
GST_IS_URI_HANDLER_CLASS
GST_URI_HANDLER_GET_CLASS
GST_TYPE_URI
gst_uri_get_uri_type
</SECTION>
<SECTION>
<FILE>gstcompat</FILE>
<SUBSECTION Standard>
gst_element_connect
gst_element_connect_pads
gst_element_connect_many
gst_element_connect_filtered
gst_element_disconnect
gst_pad_connect
gst_pad_connect_filtered
gst_pad_disconnect
gst_pad_proxy_connect
gst_pad_set_connect_function
GST_PAD_CONNECT_REFUSED
GST_PAD_CONNECT_DELAYED
GST_PAD_CONNECT_OK
GST_PAD_CONNECT_DONE
GstPadConnectReturn
GstPadConnectFunction
GST_PAD_IS_CONNECTED
</SECTION>
<SECTION>
<FILE>gstcpu</FILE>
<TITLE>GstCpu</TITLE>
@ -1371,6 +1503,10 @@ GstIndexGroup
GstIndexCertainty
GstIndexEntryType
GstIndexLookupMethod
GstIndexFlags
GST_INDEX_ID_INVALID
GST_INDEX_IS_READABLE
GST_INDEX_IS_WRITABLE
GST_INDEX_NASSOCS
GST_INDEX_ASSOC_FLAGS
GST_INDEX_ASSOC_FORMAT
@ -1382,6 +1518,8 @@ GST_INDEX_FORMAT_KEY
GST_INDEX_ID_DESCRIPTION
GstIndexFilter
GstIndexResolver
GstIndexResolverMethod
GstIndex
gst_index_new
gst_index_get_group
@ -1400,6 +1538,7 @@ gst_index_get_assoc_entry
gst_index_get_assoc_entry_full
gst_index_entry_free
gst_index_entry_assoc_map
gst_index_commit
<SUBSECTION Standard>
GST_INDEX
GST_IS_INDEX
@ -1415,6 +1554,14 @@ GST_TYPE_INDEX_ENTRY_TYPE
gst_index_entry_type_get_type
GST_TYPE_INDEX_LOOKUP_METHOD
gst_index_lookup_method_get_type
GST_INDEX_FACTORY_GET_CLASS
GST_INDEX_GET_CLASS
GstIndexClass
GstIndexFactoryClass
GST_TYPE_INDEX_FLAGS
GST_TYPE_INDEX_RESOLVER_METHOD
gst_index_flags_get_type
gst_index_resolver_method_get_type
</SECTION>
<SECTION>

View file

@ -82,6 +82,13 @@ Last reviewed on August 30th, 2002 (0.4.0.1)
#GstBufferPool, #GstPad, #GstData
</para>
<!-- ##### MACRO GST_BUFFER_TRACE_NAME ##### -->
<para>
The name used for tracing memory allocations
</para>
<!-- ##### MACRO GST_BUFFER ##### -->
<para>
Casts an object to a GstBuffer.
@ -420,10 +427,3 @@ It is dangerous to use this function, you should use gst_buffer_unref() instead.
@Returns:
<!-- ##### FUNCTION gst_buffer_print_stats ##### -->
<para>
</para>

View file

@ -66,6 +66,13 @@ Cast a pointer to a GstBufferPool
@pool: The pointer to cast
<!-- ##### MACRO GST_BUFFER_POOL_TRACE_NAME ##### -->
<para>
The name used for memory tracing.
</para>
<!-- ##### MACRO GST_IS_BUFFER_POOL ##### -->
<para>
Check if the given pointer is a bufferpool

View file

@ -146,6 +146,69 @@ A convenience macro to get a GstCaps from the given capsfactory.
@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
@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_FIXED: flag indicating the caps has no variable properties
@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.
@ -162,17 +225,36 @@ Check if the GstCaps has fixed properties, ie. it has no ranges or lists.
@caps: the caps to query
<!-- ##### STRUCT GstCaps ##### -->
<!-- ##### MACRO GST_CAPS_NEXT ##### -->
<para>
The gstcaps structure
Get a pointer to the next chained caps
</para>
@name: the name of the capability, for the application
@id: the typeid of the capability
@refcount: a refcounter for this caps structure
@fixed: a boolean indicating that this caps structure is fixed
@properties: the properties of the capability
@next: a pointer to the next caps.
@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>
@ -279,6 +361,41 @@ The gstcaps structure
@Returns:
<!-- ##### FUNCTION gst_caps_next ##### -->
<para>
</para>
@caps:
@Returns:
<!-- ##### FUNCTION gst_caps_replace ##### -->
<para>
</para>
@oldcaps:
@newcaps:
<!-- ##### FUNCTION gst_caps_replace_sink ##### -->
<para>
</para>
@oldcaps:
@newcaps:
<!-- ##### FUNCTION gst_caps_sink ##### -->
<para>
</para>
@caps:
<!-- ##### FUNCTION gst_caps_set_name ##### -->
<para>

View file

@ -143,6 +143,13 @@ The type of the clock entry
@GST_CLOCK_ENTRY_SINGLE: a single shot timeout
@GST_CLOCK_ENTRY_PERIODIC: a periodic timeout request
<!-- ##### MACRO GST_CLOCK_ENTRY_TRACE_NAME ##### -->
<para>
The name used for tracing clock entry allocations.
</para>
<!-- ##### MACRO GST_CLOCK_ENTRY ##### -->
<para>
Cast to a clock entry

View file

@ -0,0 +1,16 @@
<!-- ##### SECTION Title ##### -->
gstcompat
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>

View file

@ -700,6 +700,46 @@ is scheduled.
@Returns:
<!-- ##### FUNCTION gst_element_get_event_masks ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_get_formats ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_get_query_types ##### -->
<para>
</para>
@element:
@Returns:
<!-- ##### FUNCTION gst_element_convert ##### -->
<para>
</para>
@element:
@src_format:
@src_value:
@dest_format:
@dest_value:
@Returns:
<!-- ##### MACRO gst_element_default_deep_notify ##### -->
<para>
The default deep notify handler that prints out the property change
@ -912,9 +952,37 @@ Get the clock of this element
@obj: a #GstElement to query
<!-- ##### MACRO GST_ELEMENT_EVENT_MASK_FUNCTION ##### -->
<para>
A helper macro to create a mask function
</para>
@functionname: the name of the mask function
@...: Masks
<!-- ##### MACRO GST_ELEMENT_FORMATS_FUNCTION ##### -->
<para>
Halper macro to create element format functions
</para>
@functionname: The function name
@...: formats
<!-- ##### MACRO GST_ELEMENT_QUERY_TYPE_FUNCTION ##### -->
<para>
Helper macro to create query type functions
</para>
@functionname: The function name
@...: 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.

View file

@ -251,6 +251,21 @@ The value of the size event
@event: The event to query
<!-- ##### MACRO GST_EVENT_IS_INTERRUPT ##### -->
<para>
Check if the event is an interrupt event
</para>
@event: The event to check
<!-- ##### MACRO GST_EVENT_TRACE_NAME ##### -->
<para>
The name used for memory allocation tracing
</para>
<!-- ##### STRUCT GstEvent ##### -->
<para>
The event structure
@ -371,11 +386,14 @@ Create a new flush event.
<!-- ##### FUNCTION gst_event_print_stats ##### -->
<!-- ##### FUNCTION gst_event_masks_contains ##### -->
<para>
</para>
@masks:
@mask:
@Returns:
<!-- ##### MACRO GST_EVENT_MASK_FUNCTION ##### -->

View file

@ -61,6 +61,38 @@ Specify the method to find an index entry in the index.
@GST_INDEX_LOOKUP_BEFORE: The exact entry or the one before it
@GST_INDEX_LOOKUP_AFTER: The exact entry or the one after it
<!-- ##### ENUM GstIndexFlags ##### -->
<para>
Flags for this index
</para>
@GST_INDEX_WRITABLE: The index is writable
@GST_INDEX_READABLE: The index is readable
@GST_INDEX_FLAG_LAST: First flag that can be used by subclasses
<!-- ##### MACRO GST_INDEX_ID_INVALID ##### -->
<para>
An invalid index id
</para>
<!-- ##### MACRO GST_INDEX_IS_READABLE ##### -->
<para>
Check if the index can be read from
</para>
@obj: The index to check
<!-- ##### MACRO GST_INDEX_IS_WRITABLE ##### -->
<para>
Check if the index can be written to
</para>
@obj: The index to check
<!-- ##### MACRO GST_INDEX_NASSOCS ##### -->
<para>
Get the number of associations in the entry.
@ -162,6 +194,15 @@ Function to resolve ids to writer descriptions.
@writer_id: A pointer to the id that has to be assigned to this writer
<!-- ##### ENUM GstIndexResolverMethod ##### -->
<para>
The method used to resolve index writers
</para>
@GST_INDEX_RESOLVER_CUSTOM: Use a custom resolver
@GST_INDEX_RESOLVER_GTYPE: Resolve based on the GType of the object
@GST_INDEX_RESOLVER_PATH: Resolve on the path in graph
<!-- ##### STRUCT GstIndex ##### -->
<para>
The GstIndex object
@ -351,6 +392,15 @@ The GstIndex object
@Returns:
<!-- ##### FUNCTION gst_index_commit ##### -->
<para>
</para>
@index:
@id:
<!-- ##### SIGNAL GstIndex::entry-added ##### -->
<para>
Is emited when a new entry is added to the index.

View file

@ -212,6 +212,15 @@ Check if the object has been destroyed.
@object: the object
<!-- ##### FUNCTION gst_object_replace ##### -->
<para>
</para>
@oldobj:
@newobj:
<!-- ##### FUNCTION gst_object_sink ##### -->
<para>

View file

@ -87,6 +87,14 @@ The padtemplate object.
</para>
<!-- ##### ENUM GstPadTemplateFlags ##### -->
<para>
Flags for the padtemplate
</para>
@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties
@GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses.
<!-- ##### MACRO GST_PAD_TEMPLATE_CAPS ##### -->
<para>
Get a handle to the padtemplate #GstCaps
@ -151,14 +159,6 @@ Get the padtemplate of the factory created with GST_PAD_TEMPLATE_FACTORY()
@fact: the factory name to get the padtemplate from.
<!-- ##### MACRO GST_PAD_TEMPLATE_FIXED ##### -->
<para>
Get the flag indicating the properties are fixed from the template.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PAD_TEMPLATE_IS_FIXED ##### -->
<para>
Check if the properties of the padtemplate are fixed

View file

@ -21,7 +21,7 @@ The props structure
</para>
@refcount: a refcount for this struct
@fixed: indicates that this props has no lists or ranges
@flags:
@properties: the properties
<!-- ##### ENUM GstPropsType ##### -->
@ -43,6 +43,88 @@ The property type
@GST_PROPS_INT_RANGE_TYPE:
@GST_PROPS_LAST_TYPE:
<!-- ##### ENUM GstPropsFlags ##### -->
<para>
Flags for this property
</para>
@GST_PROPS_FIXED: The property has no variable entries
@GST_PROPS_FLOATING: The property is not owned by anyone
<!-- ##### MACRO GST_PROPS_TRACE_NAME ##### -->
<para>
The name used for tracing memory allocations for the properties
</para>
<!-- ##### MACRO GST_PROPS_FLAGS ##### -->
<para>
The flags of this property
</para>
@props: The props to query
<!-- ##### MACRO GST_PROPS_FLAG_IS_SET ##### -->
<para>
Check if a flag is set on the property
</para>
@props: The property to check
@flag: The flag to check for
<!-- ##### MACRO GST_PROPS_FLAG_SET ##### -->
<para>
Set a flag on the property
</para>
@props: The property to modify
@flag: The flag to set
<!-- ##### MACRO GST_PROPS_FLAG_UNSET ##### -->
<para>
Unset a flag in the property
</para>
@props: The property to modify
@flag: The flag to unset
<!-- ##### MACRO GST_PROPS_IS_FIXED ##### -->
<para>
Check if the property is fixed, ie. it has no variable property entries.
</para>
@props: The property to check
<!-- ##### MACRO GST_PROPS_IS_FLOATING ##### -->
<para>
Check if the property is floating
</para>
@props: The property to check
<!-- ##### MACRO GST_PROPS_PROPERTIES ##### -->
<para>
Get the property entries of this property
</para>
@props: The property to query
<!-- ##### MACRO GST_PROPS_REFCOUNT ##### -->
<para>
Get the refcount of the property
</para>
@props: The property to query
<!-- ##### MACRO GST_TYPE_PROPS ##### -->
<para>
The GType of the props boxed type, for use in GValues.
@ -181,6 +263,13 @@ An entry hols one key/value pair.
</para>
<!-- ##### MACRO GST_PROPS_ENTRY_TRACE_NAME ##### -->
<para>
The name used for tracing memory allocations.
</para>
<!-- ##### FUNCTION gst_props_new ##### -->
<para>
@ -251,6 +340,7 @@ An entry hols one key/value pair.
</para>
@props:
@Returns:
<!-- ##### FUNCTION gst_props_unref ##### -->
@ -258,6 +348,33 @@ An entry hols one key/value pair.
</para>
@props:
@Returns:
<!-- ##### FUNCTION gst_props_replace ##### -->
<para>
</para>
@oldprops:
@newprops:
<!-- ##### FUNCTION gst_props_replace_sink ##### -->
<para>
</para>
@oldprops:
@newprops:
<!-- ##### FUNCTION gst_props_sink ##### -->
<para>
</para>
@props:
@ -410,6 +527,24 @@ An entry hols one key/value pair.
@entry:
<!-- ##### FUNCTION gst_props_remove_entry ##### -->
<para>
</para>
@props:
@entry:
<!-- ##### FUNCTION gst_props_remove_entry_by_name ##### -->
<para>
</para>
@props:
@name:
<!-- ##### FUNCTION gst_props_entry_new ##### -->
<para>
@ -420,6 +555,23 @@ An entry hols one key/value pair.
@Returns:
<!-- ##### FUNCTION gst_props_entry_copy ##### -->
<para>
</para>
@entry:
@Returns:
<!-- ##### FUNCTION gst_props_entry_destroy ##### -->
<para>
</para>
@entry:
<!-- ##### FUNCTION gst_props_entry_get ##### -->
<para>

View file

@ -2668,6 +2668,30 @@ subclasses can use this value to start the enumeration of their flags
@klass:
<!-- ##### MACRO GST_PAD_CONNECT_DELAYED ##### -->
<para>
</para>
<!-- ##### MACRO GST_PAD_CONNECT_DONE ##### -->
<para>
</para>
<!-- ##### MACRO GST_PAD_CONNECT_OK ##### -->
<para>
</para>
<!-- ##### MACRO GST_PAD_CONNECT_REFUSED ##### -->
<para>
</para>
<!-- ##### MACRO GST_PAD_FACTORY_ALWAYS ##### -->
<para>
Indicate that this pad will always be available.
@ -2708,6 +2732,13 @@ Indicates a srcpad for the padfactory.
</para>
<!-- ##### MACRO GST_PAD_IS_CONNECTED ##### -->
<para>
</para>
@a:
<!-- ##### MACRO GST_PAD_LINKED ##### -->
<para>
Is this pad linked.
@ -2729,6 +2760,13 @@ Is this pad linked.
@klass:
<!-- ##### MACRO GST_PAD_TEMPLATE_FIXED ##### -->
<para>
Get the flag indicating the properties are fixed from the template.
</para>
@templ: the template to query
<!-- ##### MACRO GST_PIPELINE ##### -->
<para>
@ -5073,6 +5111,18 @@ Indicates this pad is active
<<<<<<< gstreamer-unused.sgml
<!-- ##### TYPEDEF GstPadConnectFunction ##### -->
<para>
</para>
<!-- ##### TYPEDEF GstPadConnectReturn ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GstPadDispatcherFunc ##### -->
<para>
The signature of the dispatcher callback.
@ -7396,6 +7446,12 @@ must be defined to activate the tracing functionality.
@pool:
@destroy:
<!-- ##### FUNCTION gst_buffer_print_stats ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_buffer_remove_meta ##### -->
<para>
@ -7871,6 +7927,49 @@ must be defined to activate the tracing functionality.
@first_name:
@Varargs:
<!-- ##### MACRO gst_element_connect ##### -->
<para>
</para>
@a:
@b:
<!-- ##### MACRO gst_element_connect_filtered ##### -->
<para>
</para>
@a:
@b:
@c:
<!-- ##### MACRO gst_element_connect_many ##### -->
<para>
</para>
@a:
@...:
<!-- ##### MACRO gst_element_connect_pads ##### -->
<para>
</para>
@a:
@b:
@c:
@d:
<!-- ##### MACRO gst_element_disconnect ##### -->
<para>
</para>
@a:
@b:
<!-- ##### FUNCTION gst_element_factory_add_sink ##### -->
<para>
@ -8244,6 +8343,12 @@ must be defined to activate the tracing functionality.
@Varargs:
@Returns:
<!-- ##### FUNCTION gst_event_print_stats ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_event_type_get_type ##### -->
<para>
@ -8607,6 +8712,23 @@ Create new meta data.
@pad:
@parent:
<!-- ##### MACRO gst_pad_connect ##### -->
<para>
</para>
@a:
@b:
<!-- ##### MACRO gst_pad_connect_filtered ##### -->
<para>
</para>
@a:
@b:
@c:
<!-- ##### FUNCTION gst_pad_direction_get_type ##### -->
<para>
@ -8614,6 +8736,14 @@ Create new meta data.
@Returns:
<!-- ##### MACRO gst_pad_disconnect ##### -->
<para>
</para>
@a:
@b:
<!-- ##### MACRO gst_pad_eos ##### -->
<para>
Call the EOS function of the pad
@ -8773,6 +8903,14 @@ Call the EOS function of the pad
@data:
@Returns:
<!-- ##### MACRO gst_pad_proxy_connect ##### -->
<para>
</para>
@a:
@b:
<!-- ##### FUNCTION gst_pad_pull_region ##### -->
<para>
@ -8844,6 +8982,14 @@ Call the EOS function of the pad
@pad:
@caps:
<!-- ##### MACRO gst_pad_set_connect_function ##### -->
<para>
</para>
@a:
@b:
<!-- ##### FUNCTION gst_pad_set_eos ##### -->
<para>
@ -9879,6 +10025,85 @@ Call the EOS function of the pad
@parent:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_destroy ##### -->
<para>
</para>
@handler:
<!-- ##### FUNCTION gst_util_get_bool_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_double_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_float_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_int64_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_int_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_long_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_pointer_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_string_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_widget_arg ##### -->
<para>
@ -9888,6 +10113,16 @@ Call the EOS function of the pad
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_has_arg ##### -->
<para>
</para>
@object:
@argname:
@arg_type:
@Returns:
<!-- ##### FUNCTION gst_xml_new_from_memory ##### -->
<para>

View file

@ -192,88 +192,3 @@ The registry object
@Returns:
<!-- ##### FUNCTION gst_registry_pool_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_registry_pool_add ##### -->
<para>
</para>
@registry:
@priority:
<!-- ##### FUNCTION gst_registry_pool_remove ##### -->
<para>
</para>
@registry:
<!-- ##### FUNCTION gst_registry_pool_add_plugin ##### -->
<para>
</para>
@plugin:
<!-- ##### FUNCTION gst_registry_pool_load_all ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_registry_pool_plugin_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_registry_pool_feature_list ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION gst_registry_pool_find_plugin ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_registry_pool_find_feature ##### -->
<para>
</para>
@name:
@type:
@Returns:
<!-- ##### FUNCTION gst_registry_pool_get_prefered ##### -->
<para>
</para>
@flags:
@Returns:

View file

@ -0,0 +1,102 @@
<!-- ##### SECTION Title ##### -->
GstRegistryPool
<!-- ##### SECTION Short_Description ##### -->
Manage a list of plugins and registries
<!-- ##### SECTION Long_Description ##### -->
<para>
The registry pool manages the available registries and plugins in
the system.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
GstRegistry
</para>
<!-- ##### FUNCTION gst_registry_pool_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_registry_pool_add ##### -->
<para>
</para>
@registry:
@priority:
<!-- ##### FUNCTION gst_registry_pool_remove ##### -->
<para>
</para>
@registry:
<!-- ##### FUNCTION gst_registry_pool_add_plugin ##### -->
<para>
</para>
@plugin:
<!-- ##### FUNCTION gst_registry_pool_load_all ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_registry_pool_plugin_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_registry_pool_feature_list ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION gst_registry_pool_find_plugin ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_registry_pool_find_feature ##### -->
<para>
</para>
@name:
@type:
@Returns:
<!-- ##### FUNCTION gst_registry_pool_get_prefered ##### -->
<para>
</para>
@flags:
@Returns:

View file

@ -14,3 +14,104 @@ Tracing functionality
</para>
<!-- ##### ENUM GstAllocTraceFlags ##### -->
<para>
Flags indicating which tracing feature to enable.
</para>
@GST_ALLOC_TRACE_LIVE: Trace number of non-freed memory
@GST_ALLOC_TRACE_MEM_LIVE: trace pointers of unfreed memory
<!-- ##### STRUCT GstAllocTrace ##### -->
<para>
The main tracing object
</para>
@name: The name of the tracing object
@flags: Flags for this object
@live: counter for live memory
@mem_live: list with pointers to unfreed memory
<!-- ##### FUNCTION gst_alloc_trace_available ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_alloc_trace_list ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gst_alloc_trace_print_all ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_alloc_trace_set_flags_all ##### -->
<para>
</para>
@flags:
<!-- ##### FUNCTION gst_alloc_trace_get ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_alloc_trace_print ##### -->
<para>
</para>
@trace:
<!-- ##### FUNCTION gst_alloc_trace_set_flags ##### -->
<para>
</para>
@trace:
@flags:
<!-- ##### MACRO gst_alloc_trace_register ##### -->
<para>
Register a new alloc tracer with the given name
</para>
@name: The name of the tracer object
<!-- ##### MACRO gst_alloc_trace_new ##### -->
<para>
Use the tracer to trace a new memory allocation
</para>
@trace: The tracer to use
@mem: The memory allocated
<!-- ##### MACRO gst_alloc_trace_free ##### -->
<para>
Trace a memory free operation
</para>
@trace: The traver to use
@mem: The memory that is freed

68
docs/gst/tmpl/gsturi.sgml Normal file
View file

@ -0,0 +1,68 @@
<!-- ##### SECTION Title ##### -->
GstURIHandler
<!-- ##### SECTION Short_Description ##### -->
Register URIs and the elements that can handle them.
<!-- ##### SECTION Long_Description ##### -->
<para>
The URIHandler is a pluginfeature that can be used to locate element
and the element property that can handle a given URI.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_uri_handler_new ##### -->
<para>
</para>
@name:
@uri:
@longdesc:
@element:
@property:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_find ##### -->
<para>
</para>
@name:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_find_by_uri ##### -->
<para>
</para>
@uri:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_create ##### -->
<para>
</para>
@handler:
@name:
@Returns:
<!-- ##### FUNCTION gst_uri_handler_make_by_uri ##### -->
<para>
</para>
@uri:
@name:
@Returns:

View file

@ -33,86 +33,6 @@ Some convenience functions
@value_str:
<!-- ##### FUNCTION gst_util_get_int_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_bool_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_long_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_float_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_double_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_string_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_pointer_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_get_int64_arg ##### -->
<para>
</para>
@object:
@argname:
@Returns:
<!-- ##### FUNCTION gst_util_dump_mem ##### -->
<para>
@ -122,17 +42,6 @@ Some convenience functions
@size:
<!-- ##### FUNCTION gst_util_has_arg ##### -->
<para>
</para>
@object:
@argname:
@arg_type:
@Returns:
<!-- ##### FUNCTION gst_print_element_args ##### -->
<para>

View file

@ -110,10 +110,6 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
</para>
@:
@:
@:
@gstxml: the object which received the signal.
@arg1:
@arg2:
@ -123,7 +119,7 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
</para>
@gstxml: the object which received the signal.
@arg1:
@arg2:
@:
@:
@:

View file

@ -344,6 +344,12 @@ gst_props_entry_clean (GstPropsEntry *entry)
}
}
/**
* gst_props_entry_destroy:
* @entry: the entry to destroy
*
* Free the given propsentry
*/
void
gst_props_entry_destroy (GstPropsEntry *entry)
{
@ -929,8 +935,14 @@ gst_props_destroy (GstProps *props)
#endif
}
/*
* copy entries
/**
* gst_props_entry_copy:
* @entry: the entry to copy
*
* Copy the propsentry.
*
* Returns: a new #GstPropsEntry that is a copy of the original
* given entry.
*/
GstPropsEntry*
gst_props_entry_copy (const GstPropsEntry *entry)

View file

@ -137,7 +137,7 @@ gst_uri_handler_find (const gchar *name)
return NULL;
}
/**
/*
* this is a straight copy from glib 2.2
* remove this function when glib 2.2 is sufficiently widespread and
* then change to using the regular g_str_has_prefix

View file

@ -60,7 +60,6 @@ GType gst_uri_handler_get_type (void);
GstURIHandler* gst_uri_handler_new (const gchar *name,
const gchar *uri, const gchar *longdesc,
const gchar *element, gchar *property);
void gst_uri_handler_destroy (GstURIHandler *handler);
GstURIHandler* gst_uri_handler_find (const gchar *name);
GstURIHandler* gst_uri_handler_find_by_uri (const gchar *uri);