diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 1aff42490c..8bdd9a68c6 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -258,6 +258,8 @@ gst_clock_get_type
gstcompat GstCompat + +GST_PAD_IS_CONNECTED gst_element_connect gst_element_connect_pads gst_element_connect_many @@ -277,8 +279,8 @@ GST_PAD_CONNECT_DONE GstPadConnectReturn GstPadConnectFunction gst_info - -GST_PAD_IS_CONNECTED + +
@@ -314,7 +316,6 @@ GST_DATA_TYPE GST_DATA_FLAGS GST_DATA_FLAG_SHIFT GST_DATA_FLAG_UNSET -GST_TYPE_DATA GstData GstDataFreeFunction GstDataCopyFunction @@ -333,6 +334,7 @@ gst_data_ref gst_data_ref_by_count gst_data_unref +GST_TYPE_DATA GST_DATA_FLAG_SET GST_DATA_FLAG_IS_SET @@ -343,7 +345,6 @@ gst_data_get_type gstelement GstElement GstElement -GST_TYPE_ELEMENT GST_NUM_STATES GST_STATE GST_STATE_PENDING @@ -459,6 +460,7 @@ GST_IS_ELEMENT GST_ELEMENT_CLASS GST_IS_ELEMENT_CLASS GST_ELEMENT_GET_CLASS +GST_TYPE_ELEMENT gst_element_get_type
@@ -475,7 +477,6 @@ GST_IS_ELEMENT_DETAILS
gstelementfactory GstElementFactory -GST_TYPE_ELEMENT_FACTORY GstElementFactory gst_element_register gst_element_factory_find @@ -498,6 +499,7 @@ GST_ELEMENT_FACTORY GST_IS_ELEMENT_FACTORY GST_ELEMENT_FACTORY_CLASS GST_IS_ELEMENT_FACTORY_CLASS +GST_TYPE_ELEMENT_FACTORY gst_element_factory_get_type
@@ -505,6 +507,7 @@ gst_element_factory_get_type
gstenumtypes GstEnumTypes + GST_TYPE_ALLOC_TRACE_FLAGS GST_TYPE_ASSOC_FLAGS GST_TYPE_BIN_FLAGS @@ -543,6 +546,7 @@ GST_TYPE_REGISTRY_FLAGS GST_TYPE_REGISTRY_RETURN GST_TYPE_RESOURCE_ERROR GST_TYPE_RESULT +GST_TYPE_RANK GST_TYPE_SCHEDULER_FLAGS GST_TYPE_SCHEDULER_STATE GST_TYPE_SEEK_ACCURACY @@ -592,6 +596,7 @@ gst_registry_flags_get_type gst_registry_return_get_type gst_resource_error_get_type gst_result_get_type +gst_rank_get_type gst_scheduler_flags_get_type gst_scheduler_state_get_type gst_seek_accuracy_get_type @@ -611,7 +616,6 @@ GstCoreError GstLibraryError GstResourceError GstStreamError -GST_TYPE_G_ERROR GST_LIBRARY_ERROR GST_RESOURCE_ERROR GST_CORE_ERROR @@ -622,6 +626,8 @@ gst_stream_error_quark gst_core_error_quark gst_resource_error_quark gst_library_error_quark + +GST_TYPE_G_ERROR gst_g_error_get_type
@@ -629,7 +635,6 @@ gst_g_error_get_type
gstevent GstEvent -GST_TYPE_EVENT GstEvent GstEventType GST_EVENT_ANY @@ -678,6 +683,7 @@ gst_event_new_flush GST_EVENT GST_IS_EVENT +GST_TYPE_EVENT gst_event_get_type
@@ -717,6 +723,7 @@ GST_GHOST_PAD GST_IS_GHOST_PAD GST_GHOST_PAD_CLASS GST_IS_GHOST_PAD_CLASS +GST_TYPE_GHOST_PAD gst_ghost_pad_get_type @@ -725,7 +732,6 @@ gst_ghost_pad_get_type gstindex GstIndex GstIndex -GST_TYPE_INDEX_ENTRY GstIndexEntry GstIndexGroup GstIndexCertainty @@ -775,6 +781,7 @@ GST_TYPE_INDEX GST_INDEX_CLASS GST_IS_INDEX_CLASS GST_INDEX_GET_CLASS +GST_TYPE_INDEX_ENTRY gst_index_get_type @@ -782,7 +789,6 @@ gst_index_get_type
gstindexfactory GstIndexFactory -GST_TYPE_INDEX_FACTORY GstIndexFactory gst_index_factory_new gst_index_factory_destroy @@ -796,6 +802,7 @@ GST_IS_INDEX_FACTORY GST_INDEX_FACTORY_CLASS GST_IS_INDEX_FACTORY_CLASS GST_INDEX_FACTORY_GET_CLASS +GST_TYPE_INDEX_FACTORY gst_index_factory_get_type
@@ -806,9 +813,6 @@ gst_index_factory_get_type GstDebugLevel GST_LEVEL_DEFAULT GstDebugColorFlags -GST_DEBUG_FG_MASK -GST_DEBUG_BG_MASK -GST_DEBUG_FORMAT_MASK GstDebugCategory GST_STR_NULL GST_DEBUG_PAD_NAME @@ -874,12 +878,15 @@ gst_debug_category_unset_threshold_for_name gst_debug_print_stack_trace GST_TIME_FORMAT GST_TIME_ARGS + +GST_DEBUG_FG_MASK +GST_DEBUG_BG_MASK +GST_DEBUG_FORMAT_MASK
gstimplementsinterface GstImplementsInterface -GST_TYPE_IMPLEMENTS_INTERFACE GstImplementsInterface GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE @@ -893,6 +900,7 @@ GST_IMPLEMENTS_INTERFACE_CLASS GST_IS_IMPLEMENTS_INTERFACE GST_IS_IMPLEMENTS_INTERFACE_CLASS GST_IMPLEMENTS_INTERFACE_GET_CLASS +GST_TYPE_IMPLEMENTS_INTERFACE gst_implements_interface_get_type
@@ -920,7 +928,6 @@ gst_mem_chunk_free gstobject GstObject GstObject -GST_TYPE_OBJECT GstObjectFlags GST_FLAGS GST_FLAG_IS_SET @@ -957,6 +964,7 @@ GST_IS_OBJECT GST_OBJECT_CLASS GST_IS_OBJECT_CLASS GST_OBJECT_GET_CLASS +GST_TYPE_OBJECT gst_object_get_type xmlNodePtr @@ -1006,7 +1014,6 @@ GST_PAD_IS_USABLE GST_PAD_CAN_PULL GST_PAD_IS_SRC GST_PAD_IS_SINK -GST_TYPE_PAD_TEMPLATE GstPadPresence gst_pad_new gst_pad_new_from_template @@ -1102,6 +1109,7 @@ GST_PAD GST_IS_PAD GST_PAD_CLASS GST_IS_PAD_CLASS +GST_TYPE_PAD gst_pad_get_type @@ -1111,8 +1119,6 @@ gst_pad_get_type GstPadTemplate GstPadTemplate GstStaticPadTemplate -GST_TYPE_PAD -GST_TYPE_GHOST_PAD GST_IS_GHOST_PAD_FAST GST_IS_PAD_FAST GST_PAD_TEMPLATE_NAME_TEMPLATE @@ -1132,6 +1138,7 @@ GST_IS_PAD_TEMPLATE GST_PAD_TEMPLATE_CLASS GST_IS_PAD_TEMPLATE_CLASS GST_STATIC_PAD_TEMPLATE +GST_TYPE_PAD_TEMPLATE gst_pad_template_get_type @@ -1155,10 +1162,10 @@ gst_pipeline_new GstPipelineClass GST_PIPELINE GST_IS_PIPELINE -GST_TYPE_PIPELINE GST_PIPELINE_CLASS GST_IS_PIPELINE_CLASS GST_PIPELINE_GET_CLASS +GST_TYPE_PIPELINE gst_pipeline_get_type @@ -1177,7 +1184,6 @@ GST_PLUGIN_DEFINE GST_PLUGIN_DEFINE_STATIC GST_LICENSE_UNKNOWN GstPluginFilter -GST_TYPE_PLUGIN gst_plugin_get_name gst_plugin_get_description gst_plugin_get_filename @@ -1199,6 +1205,7 @@ gst_plugin_load gst_library_load GST_PLUGIN +GST_TYPE_PLUGIN gst_plugin_get_type @@ -1221,10 +1228,10 @@ gst_plugin_feature_get_name GstPluginFeatureClass GST_PLUGIN_FEATURE GST_IS_PLUGIN_FEATURE -GST_TYPE_PLUGIN_FEATURE GST_PLUGIN_FEATURE_CLASS GST_IS_PLUGIN_FEATURE_CLASS GST_PLUGIN_FEATURE_GET_CLASS +GST_TYPE_PLUGIN_FEATURE gst_plugin_feature_get_type @@ -1270,9 +1277,9 @@ GstQueueSize GstQueueClass GST_QUEUE GST_IS_QUEUE -GST_TYPE_QUEUE GST_QUEUE_CLASS GST_IS_QUEUE_CLASS +GST_TYPE_QUEUE gst_queue_get_type @@ -1282,7 +1289,6 @@ gst_queue_get_type gstrealpad GstRealPad GstRealPad -GST_TYPE_REAL_PAD GST_IS_REAL_PAD_FAST GST_RPAD_DIRECTION GST_RPAD_CAPS @@ -1313,6 +1319,7 @@ GST_REAL_PAD GST_IS_REAL_PAD GST_REAL_PAD_CLASS GST_IS_REAL_PAD_CLASS +GST_TYPE_REAL_PAD gst_real_pad_get_type @@ -1353,10 +1360,10 @@ gst_registry_update_plugin GstRegistryClass GST_REGISTRY GST_IS_REGISTRY -GST_TYPE_REGISTRY GST_REGISTRY_CLASS GST_IS_REGISTRY_CLASS GST_REGISTRY_GET_CLASS +GST_TYPE_REGISTRY gst_registry_get_type @@ -1414,10 +1421,10 @@ GST_SCHEDULER_DEFAULT_NAME GstSchedulerClass GST_SCHEDULER GST_IS_SCHEDULER -GST_TYPE_SCHEDULER GST_SCHEDULER_CLASS GST_IS_SCHEDULER_CLASS GST_SCHEDULER_GET_CLASS +GST_TYPE_SCHEDULER gst_scheduler_get_type @@ -1426,7 +1433,6 @@ gst_scheduler_get_type gstschedulerfactory GstSchedulerFactory GstSchedulerFactory -GST_TYPE_SCHEDULER_FACTORY gst_scheduler_register gst_scheduler_factory_new gst_scheduler_factory_destroy @@ -1442,6 +1448,7 @@ GST_IS_SCHEDULER_FACTORY GST_SCHEDULER_FACTORY_CLASS GST_IS_SCHEDULER_FACTORY_CLASS GST_SCHEDULER_FACTORY_GET_CLASS +GST_TYPE_SCHEDULER_FACTORY gst_scheduler_factory_get_type @@ -1449,7 +1456,6 @@ gst_scheduler_factory_get_type
gststructure GstStructure -GST_TYPE_STRUCTURE GstStructure GstStructureForeachFunc gst_structure_empty_new @@ -1486,6 +1492,7 @@ gst_structure_from_string GST_STRUCTURE GST_IS_STRUCTURE +GST_TYPE_STRUCTURE gst_structure_get_type
@@ -1494,7 +1501,6 @@ gst_structure_get_type gstsystemclock GstSystemClock GstSystemClock -GST_TYPE_SYSTEM_CLOCK gst_system_clock_obtain GstSystemClockClass @@ -1504,13 +1510,13 @@ gst_system_clock_get_type GST_SYSTEM_CLOCK_CLASS GST_IS_SYSTEM_CLOCK_CLASS GST_SYSTEM_CLOCK_GET_CLASS +GST_TYPE_SYSTEM_CLOCK
gsttaglist GstTagList GstTagList -GST_TYPE_TAG_LIST GstTagMergeMode GstTagFlag GstTagForeachFunc @@ -1606,6 +1612,7 @@ GST_TAG_LIST GST_IS_TAG_LIST GST_TAG_FLAG_IS_VALID GST_TAG_MODE_IS_VALID +GST_TYPE_TAG_LIST gst_tag_list_get_type
@@ -1615,7 +1622,6 @@ gst_tag_list_get_type GstTagSetter GstTagSetter GstTagSetterIFace -GST_TYPE_TAG_SETTER gst_tag_setter_merge gst_tag_setter_add gst_tag_setter_add_values @@ -1629,6 +1635,7 @@ GST_TAG_SETTER GST_IS_TAG_SETTER GST_TAG_SETTER_CLASS GST_TAG_SETTER_GET_IFACE +GST_TYPE_TAG_SETTER gst_tag_setter_get_type @@ -1637,7 +1644,6 @@ gst_tag_setter_get_type gstthread GstThread GstThread -GST_TYPE_THREAD gst_thread_current GstThreadState gst_thread_new @@ -1650,6 +1656,7 @@ GST_IS_THREAD GST_THREAD_CLASS GST_IS_THREAD_CLASS GST_THREAD_GET_CLASS +GST_TYPE_THREAD gst_thread_get_type @@ -1712,7 +1719,6 @@ gst_type_find_register gsttypefindfactory GstTypeFindFactory GstTypeFindFactory -GST_TYPE_TYPE_FIND_FACTORY gst_type_find_factory_get_list gst_type_find_factory_get_extensions gst_type_find_factory_get_caps @@ -1724,6 +1730,7 @@ GST_IS_TYPE_FIND_FACTORY GST_TYPE_FIND_FACTORY_CLASS GST_IS_TYPE_FIND_FACTORY_CLASS GST_TYPE_FIND_FACTORY_GET_CLASS +GST_TYPE_TYPE_FIND_FACTORY gst_type_find_factory_get_type @@ -1734,10 +1741,7 @@ gst_type_find_factory_get_type GstElementState GstElementStateReturn GstResult -GST_RANK_PRIMARY -GST_RANK_SECONDARY -GST_RANK_MARGINAL -GST_RANK_NONE +GstRank GST_PADDING GST_PADDING_INIT @@ -1747,7 +1751,6 @@ GST_PADDING_INIT gsturihandler GstUriHandler GstURIHandler -GST_TYPE_URI_HANDLER GST_URI_TYPE_IS_VALID gst_uri_protocol_is_valid gst_uri_is_valid @@ -1766,6 +1769,7 @@ GST_URI_HANDLER GST_IS_URI_HANDLER GST_URI_HANDLER_CLASS GST_URI_HANDLER_GET_INTERFACE +GST_TYPE_URI_HANDLER gst_uri_handler_get_type @@ -1774,6 +1778,7 @@ gst_uri_handler_get_type gsturitype GstUriType GstURIType + GST_TYPE_URI gst_uri_get_uri_type @@ -1822,12 +1827,6 @@ GST_VALUE_HOLDS_LIST GST_VALUE_HOLDS_FIXED_LIST GST_VALUE_HOLDS_CAPS GST_VALUE_HOLDS_FRACTION -GST_TYPE_FOURCC -GST_TYPE_INT_RANGE -GST_TYPE_DOUBLE_RANGE -GST_TYPE_LIST -GST_TYPE_FIXED_LIST -GST_TYPE_FRACTION GST_VALUE_LESS_THAN GST_VALUE_EQUAL GST_VALUE_GREATER_THAN @@ -1874,6 +1873,13 @@ gst_value_register_subtract_func gst_value_intersect gst_value_can_intersect gst_value_register_intersect_func + +GST_TYPE_FOURCC +GST_TYPE_INT_RANGE +GST_TYPE_DOUBLE_RANGE +GST_TYPE_LIST +GST_TYPE_FIXED_LIST +GST_TYPE_FRACTION
@@ -1902,10 +1908,10 @@ gst_xml_make_element GstXMLClass GST_XML GST_IS_XML -GST_TYPE_XML GST_XML_CLASS GST_IS_XML_CLASS GST_XML_GET_CLASS +GST_TYPE_XML gst_xml_get_type
diff --git a/docs/gst/tmpl/gstbin.sgml b/docs/gst/tmpl/gstbin.sgml index 7f48bdd825..2b29fb1b9a 100644 --- a/docs/gst/tmpl/gstbin.sgml +++ b/docs/gst/tmpl/gstbin.sgml @@ -63,7 +63,7 @@ clock providers in the bin. - +Will be emmited if a new element was removed/added to this bin. @gstbin: the object which received the signal. @@ -71,7 +71,7 @@ clock providers in the bin. - +Will be emmited if an element was removed from this bin. @gstbin: the object which received the signal. diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index fda83c942b..56000aaafd 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -282,10 +282,10 @@ Copies the given buffer using the copy function of the parent GstData structure. - +Tests if you can safely write data into a buffer's data array. -@buf: +@buf: a #GstBuffer to check diff --git a/docs/gst/tmpl/gstcaps.sgml b/docs/gst/tmpl/gstcaps.sgml index 10d73356a1..7cba16ca96 100644 --- a/docs/gst/tmpl/gstcaps.sgml +++ b/docs/gst/tmpl/gstcaps.sgml @@ -16,37 +16,43 @@ Structure describing sets of media formats - +Flags that this caps has no specific content, but can contain anything. - +Means that the element/pad can output 'anything'. Useful for elements +that output unknown media, such as filesrc. - +The opposite of GST_CAPS_ANY: it means that the pad/element outputs an +undefined media type that can not be detected. - +Creates a static caps that matches anything. This can be used in pad +templates. +@Returns: a new #GstCaps instance - +Creates a static caps that matches nothing. This can be used in pad +templates. +@Returns: a new #GstCaps instance @@ -76,10 +82,12 @@ Structure describing sets of media formats - +Creates a static caps from an input string. This can be used in pad +templates. -@string: +@string: the string describing the caps. +@Returns: a new #GstCaps instance diff --git a/docs/gst/tmpl/gstcompat.sgml b/docs/gst/tmpl/gstcompat.sgml index e2742ea385..ba67b5bd3a 100644 --- a/docs/gst/tmpl/gstcompat.sgml +++ b/docs/gst/tmpl/gstcompat.sgml @@ -2,11 +2,12 @@ GstCompat -Deprecated API entries +Deprecated API entries. - +Please do not use in new code. This symbols are hidden by the GST_DISABLE_DEPRECATED define. +One would have to add this to the CFLAGS when compiling old code. @@ -14,166 +15,3 @@ Deprecated API entries - - - - - -@a: -@b: - - - - - - - -@a: -@b: -@c: -@d: - - - - - - - -@a: -@...: - - - - - - - -@a: -@b: -@c: - - - - - - - -@a: -@b: - - - - - - - -@a: -@b: - - - - - - - -@a: -@b: -@c: - - - - - - - -@a: -@b: - - - - - - - -@a: -@b: - - - - - - - -@a: -@b: - - - - - - - -@pad: -@data: - - - - - - - -@pad: -@Returns: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@...: - -@format: -@args...: - - diff --git a/docs/gst/tmpl/gstdata.sgml b/docs/gst/tmpl/gstdata.sgml index 1b5673e240..d7e2c65d5e 100644 --- a/docs/gst/tmpl/gstdata.sgml +++ b/docs/gst/tmpl/gstdata.sgml @@ -57,13 +57,6 @@ Unset the given flag @flag: The flag to unset - - - - - - - The base structure diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index fe5f2b3247..1a1dd83678 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -152,13 +152,6 @@ and gst_element_set_clock(). You can wait for the clock to reach a given @arg1: @arg2: - - - - - - - The maximun number of states. diff --git a/docs/gst/tmpl/gstelementfactory.sgml b/docs/gst/tmpl/gstelementfactory.sgml index 17f7f8fd09..aac5b9f99e 100644 --- a/docs/gst/tmpl/gstelementfactory.sgml +++ b/docs/gst/tmpl/gstelementfactory.sgml @@ -54,13 +54,6 @@ so that the autopluggers can select a plugin more appropriatly #GstElement, #GstPlugin, #GstPluginFeature, #GstPadTemplate. - - - - - - - diff --git a/docs/gst/tmpl/gstenumtypes.sgml b/docs/gst/tmpl/gstenumtypes.sgml index ecc0dd7371..16a337523d 100644 --- a/docs/gst/tmpl/gstenumtypes.sgml +++ b/docs/gst/tmpl/gstenumtypes.sgml @@ -14,339 +14,3 @@ GstEnumTypes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gsterror.sgml b/docs/gst/tmpl/gsterror.sgml index 6a59eec53e..888b33ec59 100644 --- a/docs/gst/tmpl/gsterror.sgml +++ b/docs/gst/tmpl/gsterror.sgml @@ -84,13 +84,6 @@ Categorized error messages @GST_STREAM_ERROR_FORMAT: @GST_STREAM_ERROR_NUM_ERRORS: - - - - - - - diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index 21a7619715..953aaa6e51 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -27,13 +27,6 @@ gst_event_new_flush() creates a new flush event. #GstPad, #GstElement - - - - - - - diff --git a/docs/gst/tmpl/gstimplementsinterface.sgml b/docs/gst/tmpl/gstimplementsinterface.sgml index 907dfa11d2..5683450aeb 100644 --- a/docs/gst/tmpl/gstimplementsinterface.sgml +++ b/docs/gst/tmpl/gstimplementsinterface.sgml @@ -14,13 +14,6 @@ Core interface implemented by #GstElements that allows runtime querying of inter - - - - - - - diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml index 255969ea06..04a60a2f6c 100644 --- a/docs/gst/tmpl/gstindex.sgml +++ b/docs/gst/tmpl/gstindex.sgml @@ -34,13 +34,6 @@ Is emited when a new entry is added to the index. - - - - - - - The basic element of an index. diff --git a/docs/gst/tmpl/gstindexfactory.sgml b/docs/gst/tmpl/gstindexfactory.sgml index 7e72305f1d..f458efdc31 100644 --- a/docs/gst/tmpl/gstindexfactory.sgml +++ b/docs/gst/tmpl/gstindexfactory.sgml @@ -14,13 +14,6 @@ GstIndexFactory is used to dynamically create GstIndex implementations. #GstIndex - - - - - - - The GstIndexFactory object diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml index b7e2a24a1b..d877e51721 100644 --- a/docs/gst/tmpl/gstinfo.sgml +++ b/docs/gst/tmpl/gstinfo.sgml @@ -135,27 +135,6 @@ categories to make them stand out in debugging output. @GST_DEBUG_BOLD: Make the output bold. @GST_DEBUG_UNDERLINE: Underline the output. - - - - - - - - - - - - - - - - - - - - - This is the struct that describes the categories. Once initialized with diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index 235b76353c..d5c09f5047 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -72,13 +72,6 @@ Is emitted when the parent of an object is unset. The name of the object - - - - - - - Flags for an object diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 3c53762479..c386b91fb6 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -83,18 +83,20 @@ The result of a pad link. - +Macro to test if the given #GstPadLinkReturn value indicates a +failed negotiation step (REFUSED/DELAYED). -@ret: +@ret: the #GstPadLinkReturn value - +Macro to test if the given #GstPadLinkReturn value indicates a +successfull negotiation step (OK/DONE). -@ret: +@ret: the #GstPadLinkReturn value @@ -439,13 +441,6 @@ Checks if the pad is a sink pad. @pad: a #GstPad to check. - - - - - - - Indicates when this pad will become available. diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml index 1ae66c76ed..ce843c0491 100644 --- a/docs/gst/tmpl/gstpadtemplate.sgml +++ b/docs/gst/tmpl/gstpadtemplate.sgml @@ -98,20 +98,6 @@ template. @presence: @static_caps: - - - - - - - - - - - - - - diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index 126c96393c..e042b50593 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -6,12 +6,12 @@ Container for features loaded from a shared object module -GStreamer is extensible so GstElements can be loaded at runtime. A plugin +GStreamer is extensible, so GstElements can be loaded at runtime. A plugin system can provide one or more of the basic GStreamer #GstPluginFeature subclasses. -A plugin should export a symbol plugin_desc that is a struct of type #GstPluginDesc. +A plugin should export a symbol plugin_desc that is a struct of type #GstPluginDesc. the plugin loader will check the version of the core library the plugin was linked against and will create a new #GstPlugin. It will then call the #GstPluginInitFunc function that was provided in the plugin_desc. @@ -20,7 +20,7 @@ that was provided in the plugin_desc. Once you have a handle to a #GstPlugin, you can add any object that subclasses #GstPluginFeature. -use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin. +Use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin. Usually plugins are always automaticlly loaded so you don't need to call gst_plugin_load() explicitly @@ -160,13 +160,6 @@ One would use this macro to define a local plugin that can only be used by the o @Returns: - - - - - - - diff --git a/docs/gst/tmpl/gstqueue.sgml b/docs/gst/tmpl/gstqueue.sgml index 477e851f89..71ce9c54d9 100644 --- a/docs/gst/tmpl/gstqueue.sgml +++ b/docs/gst/tmpl/gstqueue.sgml @@ -33,7 +33,10 @@ The queue blocks by default. - +Reports that the buffer became full (overrun). +A buffer is full if the total amount of data inside it (num-buffers, time, +size) is higher than the boundary values which can be set through the GObject +properties. @gstqueue: the object which received the signal. @@ -47,7 +50,10 @@ The queue blocks by default. - +Reports that the buffer became empty (underrun). +A buffer is empty if the total amount of data inside it (num-buffers, time, +size) is lower than the boundary values which can be set through the GObject +properties. @gstqueue: the object which received the signal. diff --git a/docs/gst/tmpl/gstschedulerfactory.sgml b/docs/gst/tmpl/gstschedulerfactory.sgml index ebc48da1ff..a9a53134d5 100644 --- a/docs/gst/tmpl/gstschedulerfactory.sgml +++ b/docs/gst/tmpl/gstschedulerfactory.sgml @@ -37,13 +37,6 @@ Use gst_scheduler_factory_destroy() to remove the factory from the global list. - - - - - - - diff --git a/docs/gst/tmpl/gststructure.sgml b/docs/gst/tmpl/gststructure.sgml index 122fb2097f..a0b2b7eab4 100644 --- a/docs/gst/tmpl/gststructure.sgml +++ b/docs/gst/tmpl/gststructure.sgml @@ -14,13 +14,6 @@ Generic structure containing fields of names and values - - - - - - - diff --git a/docs/gst/tmpl/gstsystemclock.sgml b/docs/gst/tmpl/gstsystemclock.sgml index c8afc01a6f..1f5f6ebf0b 100644 --- a/docs/gst/tmpl/gstsystemclock.sgml +++ b/docs/gst/tmpl/gstsystemclock.sgml @@ -25,13 +25,6 @@ system time. @cond: @_gst_reserved: - - - - - - - diff --git a/docs/gst/tmpl/gsttaglist.sgml b/docs/gst/tmpl/gsttaglist.sgml index d0c51645ad..64559f8c9a 100644 --- a/docs/gst/tmpl/gsttaglist.sgml +++ b/docs/gst/tmpl/gsttaglist.sgml @@ -20,13 +20,6 @@ List of tags and values used to describe media metadata - - - - - - - diff --git a/docs/gst/tmpl/gsttagsetter.sgml b/docs/gst/tmpl/gsttagsetter.sgml index a6aaa4bf35..4c55270c64 100644 --- a/docs/gst/tmpl/gsttagsetter.sgml +++ b/docs/gst/tmpl/gsttagsetter.sgml @@ -27,13 +27,6 @@ Element interface that allows setting and retrieval of media metadata @g_iface: - - - - - - - diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 96aae36c78..3bc273836a 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -36,13 +36,6 @@ A Thread can act as a toplevel bin as it has its own scheduler. The thread priority - - - - - - - diff --git a/docs/gst/tmpl/gsttypefindfactory.sgml b/docs/gst/tmpl/gsttypefindfactory.sgml index a8aa9cfd5e..9aea96a320 100644 --- a/docs/gst/tmpl/gsttypefindfactory.sgml +++ b/docs/gst/tmpl/gsttypefindfactory.sgml @@ -73,13 +73,6 @@ Object that stores information about a typefind function - - - - - - - diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml index b56d58a594..75548b547c 100644 --- a/docs/gst/tmpl/gsttypes.sgml +++ b/docs/gst/tmpl/gsttypes.sgml @@ -16,23 +16,25 @@ various global enums and constants - +These contants describe the state a #GstElement is in and transition scheduled for the #GstElement (the pending state). -@GST_STATE_VOID_PENDING: -@GST_STATE_NULL: -@GST_STATE_READY: -@GST_STATE_PAUSED: -@GST_STATE_PLAYING: +@GST_STATE_VOID_PENDING: no transition is schedules for this element +@GST_STATE_NULL: this is the default state all elements are in, after they have been created and are doing nothing +@GST_STATE_READY: the element is ready to start doing something +@GST_STATE_PAUSED: the element is paused for a period of time +@GST_STATE_PLAYING: the element is doing something - +One of these values is returned from a gst_element_set_state() call. +As GST_STATE_FAILURE is equal to 0, one can use a boolean comparission +against the GstElementStateReturn value. -@GST_STATE_FAILURE: -@GST_STATE_SUCCESS: -@GST_STATE_ASYNC: +@GST_STATE_FAILURE: the state of the element could not be changed +@GST_STATE_SUCCESS: the state of the element has already be changed +@GST_STATE_ASYNC: the state of the element will change in the near future @@ -43,33 +45,20 @@ various global enums and constants @GST_RESULT_NOK: @GST_RESULT_NOT_IMPL: - + - +Element priority ranks. Defines the order in which the autoplugger (or similar +rank-picking mechanisms) will choose this element over an alternative one +with the same function. +The rank is a unsigned integer ranging from 0 (GST_RANK_NONE) to 256 (GST_RANK_PRIMARY). +These constants serve as a rough guidiance for defining the rank of a #GstPlugin using +gst_plugin_feature_set_rank(). - - - - - - - - - - - - - - - - - - - - - - +@GST_RANK_NONE: will be chosen last or not at all +@GST_RANK_MARGINAL: unlikly to be chosen +@GST_RANK_SECONDARY: likely to be chosen +@GST_RANK_PRIMARY: will be chosen first diff --git a/docs/gst/tmpl/gsturihandler.sgml b/docs/gst/tmpl/gsturihandler.sgml index 29fa2d6605..fb5512f4bb 100644 --- a/docs/gst/tmpl/gsturihandler.sgml +++ b/docs/gst/tmpl/gsturihandler.sgml @@ -21,13 +21,6 @@ and the element property that can handle a given URI. - - - - - - - diff --git a/docs/gst/tmpl/gsturitype.sgml b/docs/gst/tmpl/gsturitype.sgml index 77aec06e70..99e0afcb1b 100644 --- a/docs/gst/tmpl/gsturitype.sgml +++ b/docs/gst/tmpl/gsturitype.sgml @@ -23,10 +23,3 @@ describes URI types @GST_URI_SINK: @GST_URI_SRC: - - - - - - - diff --git a/docs/gst/tmpl/gstvalue.sgml b/docs/gst/tmpl/gstvalue.sgml index 3ddac44052..27ecf0c890 100644 --- a/docs/gst/tmpl/gstvalue.sgml +++ b/docs/gst/tmpl/gstvalue.sgml @@ -16,13 +16,14 @@ GValue implementations specific to GStreamer - +will transform four characters into a host-endiannness guint32 fourcc: +guint32 fourcc = GST_MAKE_FOURCC ('M','J','P','G'); -@a: -@b: -@c: -@d: +@a: the first component +@b: the second component +@c: the third component +@d: the fourth component @@ -35,17 +36,21 @@ GValue implementations specific to GStreamer - +Can be used to properly output a fourcc (a guint32) value in a +printf()-style text message. +printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc)); - +Can be used to properly output a fourcc (a guint32) value in a +printf()-style text message. +printf ("fourcc: %" GST_FOURCC_FORMAT "\n", GST_FOURCC_ARGS (fcc)); -@fourcc: +@fourcc: the fourcc value to print @@ -104,48 +109,6 @@ GValue implementations specific to GStreamer @x: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/gst/gstinfo.h b/gst/gstinfo.h index fb2570d73c..17db990a54 100644 --- a/gst/gstinfo.h +++ b/gst/gstinfo.h @@ -105,7 +105,7 @@ struct _GstDebugCategory { /********** some convenience macros for debugging **********/ -/* This is needed in printf's if a char* might be NULL. Solaris crashes then */ +/* This is needed in printf's if a char* might be NULL. Solaris crashes then. */ #define GST_STR_NULL(str) ((str) ? (str) : "(NULL)") /* easier debugging for pad names */ @@ -114,8 +114,7 @@ struct _GstDebugCategory { GST_STR_NULL (GST_OBJECT_NAME (GST_OBJECT_PARENT(pad))) : \ "''", GST_OBJECT_NAME (pad) -/* You might want to define GST_FUNCTION in apps' configure script */ - +/* You might want to define GST_FUNCTION in apps' configure script. */ #ifndef GST_FUNCTION #if defined (__GNUC__) # define GST_FUNCTION ((const char*) (__PRETTY_FUNCTION__)) diff --git a/gst/gsttag.c b/gst/gsttag.c index 79a780619a..127a7d2218 100644 --- a/gst/gsttag.c +++ b/gst/gsttag.c @@ -355,7 +355,7 @@ gst_tag_get_nick (const gchar * tag) * Returns the human-readable description of this tag, You must not change or * free this string. * - * Return the human-readable description of this tag + * Returns: the human-readable description of this tag */ const gchar * gst_tag_get_description (const gchar * tag) diff --git a/gst/gsttaglist.c b/gst/gsttaglist.c index 79a780619a..127a7d2218 100644 --- a/gst/gsttaglist.c +++ b/gst/gsttaglist.c @@ -355,7 +355,7 @@ gst_tag_get_nick (const gchar * tag) * Returns the human-readable description of this tag, You must not change or * free this string. * - * Return the human-readable description of this tag + * Returns: the human-readable description of this tag */ const gchar * gst_tag_get_description (const gchar * tag) diff --git a/gst/gsttypes.h b/gst/gsttypes.h index 836cb4ad3b..0c091cba1b 100644 --- a/gst/gsttypes.h +++ b/gst/gsttypes.h @@ -58,10 +58,12 @@ typedef enum { GST_RESULT_NOT_IMPL } GstResult; -#define GST_RANK_PRIMARY 256 -#define GST_RANK_SECONDARY 128 -#define GST_RANK_MARGINAL 64 -#define GST_RANK_NONE 0 +typedef enum { + GST_RANK_NONE = 0, + GST_RANK_MARGINAL = 64, + GST_RANK_SECONDARY = 128, + GST_RANK_PRIMARY = 256 +} GstRank; #define GST_PADDING 4 #define GST_PADDING_INIT { 0 } diff --git a/gst/gstvalue.c b/gst/gstvalue.c index 4efe859843..a1c752523e 100644 --- a/gst/gstvalue.c +++ b/gst/gstvalue.c @@ -1974,7 +1974,7 @@ gst_value_register_union_func (GType type1, GType type2, GstValueUnionFunc func) /* intersection */ -/* +/** * gst_value_can_intersect: * @value1: * @value2: @@ -2183,7 +2183,7 @@ gst_value_register_subtract_func (GType minuend_type, GType subtrahend_type, g_array_append_val (gst_value_subtract_funcs, info); } -/* +/** * gst_value_register: * @table: * @@ -2194,7 +2194,7 @@ gst_value_register (const GstValueTable * table) g_array_append_val (gst_value_table, *table); } -/* +/** * gst_value_init_and_copy: * @dest: * @src: @@ -2207,7 +2207,7 @@ gst_value_init_and_copy (GValue * dest, const GValue * src) g_value_copy (src, dest); } -/* +/** * gst_value_serialize: * @value: a #GValue to serialize * @@ -2253,7 +2253,7 @@ gst_value_serialize (const GValue * value) return s; } -/* +/** * gst_value_deserialize: * @dest: #GValue to fill with contents of deserialization * @src: string to deserialize @@ -2291,11 +2291,16 @@ gst_value_deserialize (GValue * dest, const gchar * src) return FALSE; } -/* +/** * gst_type_is_fixed: - * @type: + * @type: the #GType to check * - * Returns: + * Tests if the given GType, if available in a GstStructure (or any other + * container) will contain a "fixed" (which means: one possible value) or + * an "unfixed" (which means: multiple possible values, such as data lists + * or data ranges) value. + * + * Returns: true if the type is "fixed". */ gboolean gst_type_is_fixed (GType type)