From a6dfa0f7929055b7961899673a6aabcc68a93372 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Mon, 10 Feb 2003 23:01:55 +0000 Subject: [PATCH] Documentation updates Original commit message from CVS: Documentation updates --- docs/gst/gstreamer-docs.sgml | 4 + docs/gst/gstreamer-sections.txt | 195 ++++++++++++++++++++++++++---- docs/gst/tmpl/gstbuffer.sgml | 14 +-- docs/gst/tmpl/gstbufferpool.sgml | 7 ++ docs/gst/tmpl/gstcaps.sgml | 133 ++++++++++++++++++-- docs/gst/tmpl/gstclock.sgml | 7 ++ docs/gst/tmpl/gstcompat.sgml | 16 +++ docs/gst/tmpl/gstelement.sgml | 70 ++++++++++- docs/gst/tmpl/gstevent.sgml | 20 ++- docs/gst/tmpl/gstindex.sgml | 50 ++++++++ docs/gst/tmpl/gstobject.sgml | 9 ++ docs/gst/tmpl/gstpadtemplate.sgml | 16 +-- docs/gst/tmpl/gstprops.sgml | 154 ++++++++++++++++++++++- docs/gst/tmpl/gstreamer-unused.sgml | 235 ++++++++++++++++++++++++++++++++++++ docs/gst/tmpl/gstregistry.sgml | 85 ------------- docs/gst/tmpl/gstregistrypool.sgml | 102 ++++++++++++++++ docs/gst/tmpl/gsttrace.sgml | 101 ++++++++++++++++ docs/gst/tmpl/gsturi.sgml | 68 +++++++++++ docs/gst/tmpl/gstutils.sgml | 91 -------------- docs/gst/tmpl/gstxml.sgml | 10 +- gst/gstprops.c | 16 ++- gst/gsturi.c | 2 +- gst/gsturi.h | 1 - 23 files changed, 1169 insertions(+), 237 deletions(-) create mode 100644 docs/gst/tmpl/gstcompat.sgml create mode 100644 docs/gst/tmpl/gstregistrypool.sgml create mode 100644 docs/gst/tmpl/gsturi.sgml diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index 6693281..df93a31 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -27,6 +27,7 @@ + @@ -37,6 +38,7 @@ + @@ -114,6 +116,7 @@ with some more specialized elements. &GstQuery; &GstQueue; &GstRegistry; + &GstRegistryPool; &GstScheduler; &GstSchedulerFactory; &GstSystemClock; @@ -121,6 +124,7 @@ with some more specialized elements. &GstType; &GstTypeFactory; &GstTypeFind; + &GstUri; &GstUtils; &GstXML; diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 5ee591c..e8c5a82 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -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
@@ -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
gstbuffer GstBuffer +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 GST_TYPE_BUFFER GST_TYPE_BUFFER_FLAG @@ -350,6 +353,7 @@ gst_buffer_flag_get_type gstbufferpool GstBufferPool 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 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 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 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 +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 +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 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 +
+ +
+gstregistrypool +GstRegistryPool +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
@@ -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
@@ -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 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 + +GST_TYPE_QUERY_TYPE +gst_query_type_get_type
@@ -1036,6 +1069,7 @@ gst_probe_dispatcher_dispatch GstPadTemplate 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
@@ -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
gsttrace GstTrace + +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 + 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
@@ -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
@@ -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 GST_CAPS +GST_TYPE_CAPS_FLAGS +gst_caps_flags_get_type +gst_caps_union
@@ -1250,6 +1323,16 @@ GST_CAPS GstProps 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 GST_TYPE_PROPS_TYPE gst_props_type_get_type +GST_TYPE_PROPS_ENTRY +GST_TYPE_PROPS_FLAGS +gst_props_flags_get_type
@@ -1314,16 +1409,7 @@ gst_props_type_get_type GstUtils 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 @@ -1351,9 +1437,55 @@ GST_TYPE_XML GST_XML_CLASS GstXML GstXMLClass +GST_XML_GET_CLASS
+gsturi +GstURIHandler +gst_uri_handler_new +gst_uri_handler_find +gst_uri_handler_find_by_uri +gst_uri_handler_create +gst_uri_handler_make_by_uri + +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 +
+ +
+gstcompat + +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 +
+ + +
gstcpu GstCpu GstCPUFlags @@ -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 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
diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index 1fa1bb7..4aa55b0 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -82,6 +82,13 @@ Last reviewed on August 30th, 2002 (0.4.0.1) #GstBufferPool, #GstPad, #GstData + + +The name used for tracing memory allocations + + + + 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: - - - - - - - diff --git a/docs/gst/tmpl/gstbufferpool.sgml b/docs/gst/tmpl/gstbufferpool.sgml index f3c3780..5072f9f 100644 --- a/docs/gst/tmpl/gstbufferpool.sgml +++ b/docs/gst/tmpl/gstbufferpool.sgml @@ -66,6 +66,13 @@ Cast a pointer to a GstBufferPool @pool: The pointer to cast + + +The name used for memory tracing. + + + + Check if the given pointer is a bufferpool diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index ff7bad4..6673aae 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -146,6 +146,69 @@ A convenience macro to get a GstCaps from the given capsfactory. @fact: the factory to use. + + +The gstcaps structure + + +@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. + + + +Flags for this caps. + + +@GST_CAPS_FIXED: flag indicating the caps has no variable properties +@GST_CAPS_FLOATING: the caps is not owned by anyone + + + +Get the flags of the caps + + +@caps: The caps to get the flags of + + + + +Test is a flag is set + + +@caps: The caps to test +@flag: The flag to check + + + + +Set a flag on the caps + + +@caps: The caps to modify +@flag: The flag to set + + + + +Unset a flag on the caps + + +@caps: The caps to modify +@flag: The flag to unset + + + + +Test if a caps is floating + + +@caps: The caps to test + + 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 - + -The gstcaps structure +Get a pointer to the next chained caps -@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 + + + + +Get the properties of the caps + + +@caps: The caps to query + + + + +Get the refcount of the caps. + + +@caps: The caps to query + + + + +The name used for tracing + + + @@ -279,6 +361,41 @@ The gstcaps structure @Returns: + + + + + +@caps: +@Returns: + + + + + + + +@oldcaps: +@newcaps: + + + + + + + +@oldcaps: +@newcaps: + + + + + + + +@caps: + + diff --git a/docs/gst/tmpl/gstclock.sgml b/docs/gst/tmpl/gstclock.sgml index ce9ce23..da3b748 100644 --- a/docs/gst/tmpl/gstclock.sgml +++ b/docs/gst/tmpl/gstclock.sgml @@ -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 + + +The name used for tracing clock entry allocations. + + + + Cast to a clock entry diff --git a/docs/gst/tmpl/gstcompat.sgml b/docs/gst/tmpl/gstcompat.sgml new file mode 100644 index 0000000..551a878 --- /dev/null +++ b/docs/gst/tmpl/gstcompat.sgml @@ -0,0 +1,16 @@ + +gstcompat + + + + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index c4b90ee..8800f95 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -700,6 +700,46 @@ is scheduled. @Returns: + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@Returns: + + + + + + + +@element: +@src_format: +@src_value: +@dest_format: +@dest_value: +@Returns: + + 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 - + + +A helper macro to create a mask function + + +@functionname: the name of the mask function +@...: Masks + + + + +Halper macro to create element format functions + + +@functionname: The function name +@...: formats + + + +Helper macro to create query type functions + + +@functionname: The function name +@...: list of query types. + + + +Signal emited when the element goes to PAUSED due to an end-of-stream +condition. @gstelement: the object which received the signal. diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index 6ea735d..edcd883 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -251,6 +251,21 @@ The value of the size event @event: The event to query + + +Check if the event is an interrupt event + + +@event: The event to check + + + + +The name used for memory allocation tracing + + + + The event structure @@ -371,11 +386,14 @@ Create a new flush event. - + +@masks: +@mask: +@Returns: diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml index fcedfd6..d828fa3 100644 --- a/docs/gst/tmpl/gstindex.sgml +++ b/docs/gst/tmpl/gstindex.sgml @@ -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 + + +Flags for this index + + +@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 + + + +An invalid index id + + + + + + +Check if the index can be read from + + +@obj: The index to check + + + + +Check if the index can be written to + + +@obj: The index to check + + 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 + + +The method used to resolve index writers + + +@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 + The GstIndex object @@ -351,6 +392,15 @@ The GstIndex object @Returns: + + + + + +@index: +@id: + + Is emited when a new entry is added to the index. diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index a701b6f..c1e9adc 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -212,6 +212,15 @@ Check if the object has been destroyed. @object: the object + + + + + +@oldobj: +@newobj: + + diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml index ad690b3..f26e9c5 100644 --- a/docs/gst/tmpl/gstpadtemplate.sgml +++ b/docs/gst/tmpl/gstpadtemplate.sgml @@ -87,6 +87,14 @@ The padtemplate object. + + +Flags for the padtemplate + + +@GST_PAD_TEMPLATE_FIXED: The padtemplate has no variable properties +@GST_PAD_TEMPLATE_FLAG_LAST: first flag that can be used by subclasses. + 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. - - -Get the flag indicating the properties are fixed from the template. - - -@templ: the template to query - - Check if the properties of the padtemplate are fixed diff --git a/docs/gst/tmpl/gstprops.sgml b/docs/gst/tmpl/gstprops.sgml index 4358f3a..24e1c95 100644 --- a/docs/gst/tmpl/gstprops.sgml +++ b/docs/gst/tmpl/gstprops.sgml @@ -21,7 +21,7 @@ The props structure @refcount: a refcount for this struct -@fixed: indicates that this props has no lists or ranges +@flags: @properties: the properties @@ -43,6 +43,88 @@ The property type @GST_PROPS_INT_RANGE_TYPE: @GST_PROPS_LAST_TYPE: + + +Flags for this property + + +@GST_PROPS_FIXED: The property has no variable entries +@GST_PROPS_FLOATING: The property is not owned by anyone + + + +The name used for tracing memory allocations for the properties + + + + + + +The flags of this property + + +@props: The props to query + + + + +Check if a flag is set on the property + + +@props: The property to check +@flag: The flag to check for + + + + +Set a flag on the property + + +@props: The property to modify +@flag: The flag to set + + + + +Unset a flag in the property + + +@props: The property to modify +@flag: The flag to unset + + + + +Check if the property is fixed, ie. it has no variable property entries. + + +@props: The property to check + + + + +Check if the property is floating + + +@props: The property to check + + + + +Get the property entries of this property + + +@props: The property to query + + + + +Get the refcount of the property + + +@props: The property to query + + The GType of the props boxed type, for use in GValues. @@ -181,6 +263,13 @@ An entry hols one key/value pair. + + +The name used for tracing memory allocations. + + + + @@ -251,6 +340,7 @@ An entry hols one key/value pair. @props: +@Returns: @@ -259,6 +349,33 @@ An entry hols one key/value pair. @props: +@Returns: + + + + + + + +@oldprops: +@newprops: + + + + + + + +@oldprops: +@newprops: + + + + + + + +@props: @@ -410,6 +527,24 @@ An entry hols one key/value pair. @entry: + + + + + +@props: +@entry: + + + + + + + +@props: +@name: + + @@ -420,6 +555,23 @@ An entry hols one key/value pair. @Returns: + + + + + +@entry: +@Returns: + + + + + + + +@entry: + + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index e58938b..4fc1913 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -2668,6 +2668,30 @@ subclasses can use this value to start the enumeration of their flags @klass: + + + + + + + + + + + + + + + + + + + + + + + + Indicate that this pad will always be available. @@ -2708,6 +2732,13 @@ Indicates a srcpad for the padfactory. + + + + + +@a: + Is this pad linked. @@ -2729,6 +2760,13 @@ Is this pad linked. @klass: + + +Get the flag indicating the properties are fixed from the template. + + +@templ: the template to query + @@ -5073,6 +5111,18 @@ Indicates this pad is active <<<<<<< gstreamer-unused.sgml + + + + + + + + + + + + The signature of the dispatcher callback. @@ -7396,6 +7446,12 @@ must be defined to activate the tracing functionality. @pool: @destroy: + + + + + + @@ -7871,6 +7927,49 @@ must be defined to activate the tracing functionality. @first_name: @Varargs: + + + + + +@a: +@b: + + + + + + +@a: +@b: +@c: + + + + + + +@a: +@...: + + + + + + +@a: +@b: +@c: +@d: + + + + + + +@a: +@b: + @@ -8244,6 +8343,12 @@ must be defined to activate the tracing functionality. @Varargs: @Returns: + + + + + + @@ -8607,6 +8712,23 @@ Create new meta data. @pad: @parent: + + + + + +@a: +@b: + + + + + + +@a: +@b: +@c: + @@ -8614,6 +8736,14 @@ Create new meta data. @Returns: + + + + + +@a: +@b: + Call the EOS function of the pad @@ -8773,6 +8903,14 @@ Call the EOS function of the pad @data: @Returns: + + + + + +@a: +@b: + @@ -8844,6 +8982,14 @@ Call the EOS function of the pad @pad: @caps: + + + + + +@a: +@b: + @@ -9879,6 +10025,85 @@ Call the EOS function of the pad @parent: @Returns: + + + + + +@handler: + + + + + + +@object: +@argname: +@Returns: + + + + + + +@object: +@argname: +@Returns: + + + + + + +@object: +@argname: +@Returns: + + + + + + +@object: +@argname: +@Returns: + + + + + + +@object: +@argname: +@Returns: + + + + + + +@object: +@argname: +@Returns: + + + + + + +@object: +@argname: +@Returns: + + + + + + +@object: +@argname: +@Returns: + @@ -9888,6 +10113,16 @@ Call the EOS function of the pad @argname: @Returns: + + + + + +@object: +@argname: +@arg_type: +@Returns: + diff --git a/docs/gst/tmpl/gstregistry.sgml b/docs/gst/tmpl/gstregistry.sgml index fc74b3d..df4ebe4 100644 --- a/docs/gst/tmpl/gstregistry.sgml +++ b/docs/gst/tmpl/gstregistry.sgml @@ -192,88 +192,3 @@ The registry object @Returns: - - - - - -@Returns: - - - - - - - -@registry: -@priority: - - - - - - - -@registry: - - - - - - - -@plugin: - - - - - - - - - - - - - - -@Returns: - - - - - - - -@type: -@Returns: - - - - - - - -@name: -@Returns: - - - - - - - -@name: -@type: -@Returns: - - - - - - - -@flags: -@Returns: - - diff --git a/docs/gst/tmpl/gstregistrypool.sgml b/docs/gst/tmpl/gstregistrypool.sgml new file mode 100644 index 0000000..b268b63 --- /dev/null +++ b/docs/gst/tmpl/gstregistrypool.sgml @@ -0,0 +1,102 @@ + +GstRegistryPool + + +Manage a list of plugins and registries + + + +The registry pool manages the available registries and plugins in +the system. + + + + +GstRegistry + + + + + + + +@Returns: + + + + + + + +@registry: +@priority: + + + + + + + +@registry: + + + + + + + +@plugin: + + + + + + + + + + + + + + +@Returns: + + + + + + + +@type: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@name: +@type: +@Returns: + + + + + + + +@flags: +@Returns: + + diff --git a/docs/gst/tmpl/gsttrace.sgml b/docs/gst/tmpl/gsttrace.sgml index 3ed6fe9..bf6b236 100644 --- a/docs/gst/tmpl/gsttrace.sgml +++ b/docs/gst/tmpl/gsttrace.sgml @@ -14,3 +14,104 @@ Tracing functionality + + +Flags indicating which tracing feature to enable. + + +@GST_ALLOC_TRACE_LIVE: Trace number of non-freed memory +@GST_ALLOC_TRACE_MEM_LIVE: trace pointers of unfreed memory + + + +The main tracing object + + +@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 + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + + + + + + + + +@flags: + + + + + + + +@name: +@Returns: + + + + + + + +@trace: + + + + + + + +@trace: +@flags: + + + + +Register a new alloc tracer with the given name + + +@name: The name of the tracer object + + + + +Use the tracer to trace a new memory allocation + + +@trace: The tracer to use +@mem: The memory allocated + + + + +Trace a memory free operation + + +@trace: The traver to use +@mem: The memory that is freed + + diff --git a/docs/gst/tmpl/gsturi.sgml b/docs/gst/tmpl/gsturi.sgml new file mode 100644 index 0000000..603da64 --- /dev/null +++ b/docs/gst/tmpl/gsturi.sgml @@ -0,0 +1,68 @@ + +GstURIHandler + + +Register URIs and the elements that can handle them. + + + +The URIHandler is a pluginfeature that can be used to locate element +and the element property that can handle a given URI. + + + + + + + + + + + + +@name: +@uri: +@longdesc: +@element: +@property: +@Returns: + + + + + + + +@name: +@Returns: + + + + + + + +@uri: +@Returns: + + + + + + + +@handler: +@name: +@Returns: + + + + + + + +@uri: +@name: +@Returns: + + diff --git a/docs/gst/tmpl/gstutils.sgml b/docs/gst/tmpl/gstutils.sgml index 88a3b7d..a61c50c 100644 --- a/docs/gst/tmpl/gstutils.sgml +++ b/docs/gst/tmpl/gstutils.sgml @@ -33,86 +33,6 @@ Some convenience functions @value_str: - - - - - -@object: -@argname: -@Returns: - - - - - - - -@object: -@argname: -@Returns: - - - - - - - -@object: -@argname: -@Returns: - - - - - - - -@object: -@argname: -@Returns: - - - - - - - -@object: -@argname: -@Returns: - - - - - - - -@object: -@argname: -@Returns: - - - - - - - -@object: -@argname: -@Returns: - - - - - - - -@object: -@argname: -@Returns: - - @@ -122,17 +42,6 @@ Some convenience functions @size: - - - - - -@object: -@argname: -@arg_type: -@Returns: - - diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index 08450b2..32d00bc 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -110,10 +110,6 @@ All GstElements can be serialized to an XML presentation and subsequently loaded -@: -@: -@: - @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 -@gstxml: the object which received the signal. -@arg1: -@arg2: +@: +@: +@: diff --git a/gst/gstprops.c b/gst/gstprops.c index 2e4659d..bcec9dd 100644 --- a/gst/gstprops.c +++ b/gst/gstprops.c @@ -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) diff --git a/gst/gsturi.c b/gst/gsturi.c index b6126b1..2efb302 100644 --- a/gst/gsturi.c +++ b/gst/gsturi.c @@ -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 diff --git a/gst/gsturi.h b/gst/gsturi.h index be104f0..b7f3a82 100644 --- a/gst/gsturi.h +++ b/gst/gsturi.h @@ -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); -- 2.7.4