diff options
Diffstat (limited to 'docs/gst/tmpl')
| -rw-r--r-- | docs/gst/tmpl/gstelement.sgml | 24 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstenumtypes.sgml | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstimplementsinterface.sgml | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstindex.sgml | 434 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstindexfactory.sgml | 68 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstinfo.sgml | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstobject.sgml | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstpad.sgml | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstpadtemplate.sgml | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstpipeline.sgml | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstplugin.sgml | 3 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstpluginfeature.sgml | 112 | ||||
| -rw-r--r-- | docs/gst/tmpl/gsttypes.sgml | 64 | ||||
| -rw-r--r-- | docs/gst/tmpl/gstvalue.sgml | 3 |
14 files changed, 51 insertions, 678 deletions
diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 87cad85f2..faff527e6 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -65,6 +65,9 @@ and gst_element_set_clock(). You can wait for the clock to reach a given <!-- basic object functions --> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT GstElement ##### --> <para> @@ -154,6 +157,17 @@ This enum defines the standard flags that an element may have. @GST_ELEMENT_UNPARENTING: @GST_ELEMENT_FLAG_LAST: +<!-- ##### ENUM GstState ##### --> +<para> + +</para> + +@GST_STATE_VOID_PENDING: +@GST_STATE_NULL: +@GST_STATE_READY: +@GST_STATE_PAUSED: +@GST_STATE_PLAYING: + <!-- ##### ENUM GstStateChange ##### --> <para> @@ -166,6 +180,16 @@ This enum defines the standard flags that an element may have. @GST_STATE_CHANGE_PAUSED_TO_READY: @GST_STATE_CHANGE_READY_TO_NULL: +<!-- ##### ENUM GstStateChangeReturn ##### --> +<para> + +</para> + +@GST_STATE_CHANGE_FAILURE: +@GST_STATE_CHANGE_SUCCESS: +@GST_STATE_CHANGE_ASYNC: +@GST_STATE_CHANGE_NO_PREROLL: + <!-- ##### MACRO GST_STATE ##### --> <para> This macro returns the current state of the element. diff --git a/docs/gst/tmpl/gstenumtypes.sgml b/docs/gst/tmpl/gstenumtypes.sgml index e9361f1d4..52ba68c41 100644 --- a/docs/gst/tmpl/gstenumtypes.sgml +++ b/docs/gst/tmpl/gstenumtypes.sgml @@ -14,3 +14,6 @@ all gstreamer core related enumerations </para> +<!-- ##### SECTION Stability_Level ##### --> + + diff --git a/docs/gst/tmpl/gstimplementsinterface.sgml b/docs/gst/tmpl/gstimplementsinterface.sgml index 5683450ae..df7fb5fbb 100644 --- a/docs/gst/tmpl/gstimplementsinterface.sgml +++ b/docs/gst/tmpl/gstimplementsinterface.sgml @@ -14,6 +14,9 @@ Core interface implemented by #GstElements that allows runtime querying of inter </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT GstImplementsInterface ##### --> <para> diff --git a/docs/gst/tmpl/gstindex.sgml b/docs/gst/tmpl/gstindex.sgml deleted file mode 100644 index 74254d599..000000000 --- a/docs/gst/tmpl/gstindex.sgml +++ /dev/null @@ -1,434 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GstIndex - -<!-- ##### SECTION Short_Description ##### --> -Generate indexes on objects - -<!-- ##### SECTION Long_Description ##### --> -<para> -GstIndex is used to generate a stream index of one or more elements -in a pipeline. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#GstIndexFactory -</para> - -<!-- ##### STRUCT GstIndex ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GstIndex::entry-added ##### --> -<para> -Is emitted when a new entry is added to the index. -</para> - -@gstindex: the object which received the signal. -@arg1: The entry added to the index. - -<!-- ##### ARG GstIndex:resolver ##### --> -<para> - -</para> - -<!-- ##### STRUCT GstIndexEntry ##### --> -<para> -The basic element of an index. -</para> - -@type: -@id: - -<!-- ##### STRUCT GstIndexGroup ##### --> -<para> -A group of related entries in an index. -</para> - -@groupnum: -@entries: -@certainty: -@peergroup: - -<!-- ##### ENUM GstIndexCertainty ##### --> -<para> -The certainty of a group in the index. -</para> - -@GST_INDEX_UNKNOWN: accuracy is not known -@GST_INDEX_CERTAIN: accuracy is perfect -@GST_INDEX_FUZZY: accuracy is fuzzy - -<!-- ##### ENUM GstIndexEntryType ##### --> -<para> -The different types of entries in the index. -</para> - -@GST_INDEX_ENTRY_ID: This entry is an id that maps an index id to its owner object -@GST_INDEX_ENTRY_ASSOCIATION: This entry is an association between formats -@GST_INDEX_ENTRY_OBJECT: An object -@GST_INDEX_ENTRY_FORMAT: A format definition - -<!-- ##### ENUM GstIndexLookupMethod ##### --> -<para> -Specify the method to find an index entry in the index. -</para> - -@GST_INDEX_LOOKUP_EXACT: There has to be an exact indexentry with the given format/value -@GST_INDEX_LOOKUP_BEFORE: The exact entry or the one before it -@GST_INDEX_LOOKUP_AFTER: The exact entry or the one after it - -<!-- ##### MACRO GST_INDEX_NASSOCS ##### --> -<para> -Get the number of associations in the entry. -</para> - -@entry: The entry to query - - -<!-- ##### MACRO GST_INDEX_ASSOC_FLAGS ##### --> -<para> -Get the flags for this entry -</para> - -@entry: The entry to query - - -<!-- ##### MACRO GST_INDEX_ASSOC_FORMAT ##### --> -<para> -Get the i-th format of the entry. -</para> - -@entry: The entry to query -@i: The format index - - -<!-- ##### MACRO GST_INDEX_ASSOC_VALUE ##### --> -<para> -Get the i-th value of the entry. -</para> - -@entry: The entry to query -@i: The value index - - -<!-- ##### STRUCT GstIndexAssociation ##### --> -<para> -An association in an entry. -</para> - -@format: the format of the association -@value: the value of the association - -<!-- ##### ENUM GstAssocFlags ##### --> -<para> -flags for an association entry -</para> - -@GST_ASSOCIATION_FLAG_NONE: no extra flags -@GST_ASSOCIATION_FLAG_KEY_UNIT: the entry marks a key unit, a key unit is one - that marks a place where one can randomly seek to. -@GST_ASSOCIATION_FLAG_DELTA_UNIT: -@GST_ASSOCIATION_FLAG_LAST: extra user defined flags should start here. - -<!-- ##### MACRO GST_INDEX_FORMAT_FORMAT ##### --> -<para> -Get the format of the format entry -</para> - -@entry: The entry to query - - -<!-- ##### MACRO GST_INDEX_FORMAT_KEY ##### --> -<para> -Get the key of the format entry -</para> - -@entry: The entry to query - - -<!-- ##### MACRO GST_INDEX_ID_INVALID ##### --> -<para> -An invalid index id -</para> - - - -<!-- ##### MACRO GST_INDEX_ID_DESCRIPTION ##### --> -<para> -Get the description of the id entry -</para> - -@entry: The entry to query - - -<!-- ##### USER_FUNCTION GstIndexFilter ##### --> -<para> -Function to filter out entries in the index. -</para> - -@index: The index being queried -@entry: The entry to be added. -@Returns: This function should return TRUE if the entry is to be added - to the index, FALSE otherwise. - - -<!-- ##### 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 - -<!-- ##### USER_FUNCTION GstIndexResolver ##### --> -<para> -Function to resolve ids to writer descriptions. -</para> - -@index: the index being queried. -@writer: The object that wants to write -@writer_string: A description of the writer. -@user_data: user_data as registered -@Returns: TRUE if an id could be assigned to the writer. -<!-- # Unused Parameters # --> -@writer_id: A pointer to the id that has to be assigned to this writer - - -<!-- ##### 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_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 - - -<!-- ##### FUNCTION gst_index_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gst_index_commit ##### --> -<para> - -</para> - -@index: -@id: - - -<!-- ##### FUNCTION gst_index_get_group ##### --> -<para> - -</para> - -@index: -@Returns: - - -<!-- ##### FUNCTION gst_index_new_group ##### --> -<para> - -</para> - -@index: -@Returns: - - -<!-- ##### FUNCTION gst_index_set_group ##### --> -<para> - -</para> - -@index: -@groupnum: -@Returns: - - -<!-- ##### FUNCTION gst_index_set_certainty ##### --> -<para> - -</para> - -@index: -@certainty: - - -<!-- ##### FUNCTION gst_index_get_certainty ##### --> -<para> - -</para> - -@index: -@Returns: - - -<!-- ##### FUNCTION gst_index_set_filter ##### --> -<para> - -</para> - -@index: -@filter: -@user_data: - - -<!-- ##### FUNCTION gst_index_set_resolver ##### --> -<para> - -</para> - -@index: -@resolver: -@user_data: - - -<!-- ##### FUNCTION gst_index_get_writer_id ##### --> -<para> - -</para> - -@index: -@writer: -@id: -@Returns: - - -<!-- ##### FUNCTION gst_index_add_format ##### --> -<para> - -</para> - -@index: -@id: -@format: -@Returns: - - -<!-- ##### FUNCTION gst_index_add_association ##### --> -<para> - -</para> - -@index: -@id: -@flags: -@format: -@value: -@Varargs: -@Returns: - - -<!-- ##### FUNCTION gst_index_add_object ##### --> -<para> - -</para> - -@index: -@id: -@key: -@type: -@object: -@Returns: - - -<!-- ##### FUNCTION gst_index_add_id ##### --> -<para> - -</para> - -@index: -@id: -@description: -@Returns: - - -<!-- ##### FUNCTION gst_index_get_assoc_entry ##### --> -<para> - -</para> - -@index: -@id: -@method: -@flags: -@format: -@value: -@Returns: - - -<!-- ##### FUNCTION gst_index_get_assoc_entry_full ##### --> -<para> - -</para> - -@index: -@id: -@method: -@flags: -@format: -@value: -@func: -@user_data: -@Returns: - - -<!-- ##### FUNCTION gst_index_entry_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION gst_index_entry_copy ##### --> -<para> - -</para> - -@entry: -@Returns: - - -<!-- ##### FUNCTION gst_index_entry_free ##### --> -<para> - -</para> - -@entry: - - -<!-- ##### FUNCTION gst_index_entry_assoc_map ##### --> -<para> - -</para> - -@entry: -@format: -@value: -@Returns: - - diff --git a/docs/gst/tmpl/gstindexfactory.sgml b/docs/gst/tmpl/gstindexfactory.sgml deleted file mode 100644 index f458efdc3..000000000 --- a/docs/gst/tmpl/gstindexfactory.sgml +++ /dev/null @@ -1,68 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GstIndexFactory - -<!-- ##### SECTION Short_Description ##### --> -Create GstIndexes from a factory - -<!-- ##### SECTION Long_Description ##### --> -<para> -GstIndexFactory is used to dynamically create GstIndex implementations. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#GstIndex -</para> - -<!-- ##### STRUCT GstIndexFactory ##### --> -<para> -The GstIndexFactory object -</para> - - -<!-- ##### FUNCTION gst_index_factory_new ##### --> -<para> - -</para> - -@name: -@longdesc: -@type: -@Returns: - - -<!-- ##### FUNCTION gst_index_factory_destroy ##### --> -<para> - -</para> - -@factory: - - -<!-- ##### FUNCTION gst_index_factory_find ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION gst_index_factory_create ##### --> -<para> - -</para> - -@factory: -@Returns: - - -<!-- ##### FUNCTION gst_index_factory_make ##### --> -<para> - -</para> - -@name: -@Returns: - - diff --git a/docs/gst/tmpl/gstinfo.sgml b/docs/gst/tmpl/gstinfo.sgml index 59e5b431f..a8b3a38aa 100644 --- a/docs/gst/tmpl/gstinfo.sgml +++ b/docs/gst/tmpl/gstinfo.sgml @@ -68,6 +68,9 @@ categories. These are explained at GST_DEBUG_CATEGORY_INIT(). and environment variables that affect the debugging output. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### ENUM GstDebugLevel ##### --> <para> The level defines the importance of a debugging message. The more important a diff --git a/docs/gst/tmpl/gstobject.sgml b/docs/gst/tmpl/gstobject.sgml index 9a11e50c6..7baef0aae 100644 --- a/docs/gst/tmpl/gstobject.sgml +++ b/docs/gst/tmpl/gstobject.sgml @@ -67,6 +67,9 @@ object. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT GstObject ##### --> <para> diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 49983007c..3c0d226a7 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -57,6 +57,9 @@ Last reviewed on December 13th, 2002 (0.5.0.1) #GstPadTemplate, #GstElement, #GstEvent </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT GstPad ##### --> <para> diff --git a/docs/gst/tmpl/gstpadtemplate.sgml b/docs/gst/tmpl/gstpadtemplate.sgml index 9ea331595..117ebb677 100644 --- a/docs/gst/tmpl/gstpadtemplate.sgml +++ b/docs/gst/tmpl/gstpadtemplate.sgml @@ -73,6 +73,9 @@ The following example shows you how to add the padtemplate to an elementfactory: #GstPad, #GstElementFactory </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT GstPadTemplate ##### --> <para> The padtemplate object. diff --git a/docs/gst/tmpl/gstpipeline.sgml b/docs/gst/tmpl/gstpipeline.sgml index 15c5a6bdb..a5010b823 100644 --- a/docs/gst/tmpl/gstpipeline.sgml +++ b/docs/gst/tmpl/gstpipeline.sgml @@ -21,6 +21,9 @@ the pipeline, use gst_object_unref() to free its resources. #GstBin </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT GstPipeline ##### --> <para> diff --git a/docs/gst/tmpl/gstplugin.sgml b/docs/gst/tmpl/gstplugin.sgml index 6fd485e00..3e1cf6229 100644 --- a/docs/gst/tmpl/gstplugin.sgml +++ b/docs/gst/tmpl/gstplugin.sgml @@ -35,6 +35,9 @@ to bring the plugin into memory. #GstPluginFeature, #GstType, #GstAutoplug, #GstElementFactory </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### FUNCTION gst_plugin_error_quark ##### --> <para> Get the error quark diff --git a/docs/gst/tmpl/gstpluginfeature.sgml b/docs/gst/tmpl/gstpluginfeature.sgml deleted file mode 100644 index a257a56d3..000000000 --- a/docs/gst/tmpl/gstpluginfeature.sgml +++ /dev/null @@ -1,112 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GstPluginFeature - -<!-- ##### SECTION Short_Description ##### --> -Base class for contents of a GstPlugin - -<!-- ##### SECTION Long_Description ##### --> -<para> -This is a base class for anything that can be added to a #GstPlugin. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#GstPlugin -</para> - -<!-- ##### STRUCT GstPluginFeature ##### --> -<para> - -</para> - - -<!-- ##### MACRO GST_PLUGIN_FEATURE_NAME ##### --> -<para> -Get the name of the feature -</para> - -@feature: The feature to query - - -<!-- ##### STRUCT GstTypeNameData ##### --> -<para> - -</para> - -@name: -@type: - -<!-- ##### USER_FUNCTION GstPluginFeatureFilter ##### --> -<para> -A function that can be used with e.g. gst_registry_feature_filter() -to get a list of pluginfeature that match certain criteria. -</para> - -@feature: the pluginfeature to check -@user_data: the user_data that has been passed on e.g. gst_registry_feature_filter() -@Returns: TRUE for a positive match, FALSE otherwise - - -<!-- ##### FUNCTION gst_plugin_feature_type_name_filter ##### --> -<para> - -</para> - -@feature: -@data: -@Returns: - - -<!-- ##### FUNCTION gst_plugin_feature_set_rank ##### --> -<para> - -</para> - -@feature: -@rank: - - -<!-- ##### FUNCTION gst_plugin_feature_set_name ##### --> -<para> - -</para> - -@feature: -@name: - - -<!-- ##### FUNCTION gst_plugin_feature_get_rank ##### --> -<para> - -</para> - -@feature: -@Returns: - - -<!-- ##### FUNCTION gst_plugin_feature_get_name ##### --> -<para> - -</para> - -@feature: -@Returns: - - -<!-- ##### FUNCTION gst_plugin_feature_load ##### --> -<para> - -</para> - -@feature: -@Returns: - - -<!-- ##### FUNCTION gst_plugin_feature_list_free ##### --> -<para> - -</para> - -@list: - - diff --git a/docs/gst/tmpl/gsttypes.sgml b/docs/gst/tmpl/gsttypes.sgml deleted file mode 100644 index e1ca64c34..000000000 --- a/docs/gst/tmpl/gsttypes.sgml +++ /dev/null @@ -1,64 +0,0 @@ -<!-- ##### SECTION Title ##### --> -GstTypes - -<!-- ##### SECTION Short_Description ##### --> -various global enums and constants - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### ENUM GstState ##### --> -<para> - -</para> - -@GST_STATE_VOID_PENDING: -@GST_STATE_NULL: -@GST_STATE_READY: -@GST_STATE_PAUSED: -@GST_STATE_PLAYING: - -<!-- ##### ENUM GstStateChange ##### --> -<para> - -</para> - -@GST_STATE_CHANGE_NULL_TO_READY: -@GST_STATE_CHANGE_READY_TO_PAUSED: -@GST_STATE_CHANGE_PAUSED_TO_PLAYING: -@GST_STATE_CHANGE_PLAYING_TO_PAUSED: -@GST_STATE_CHANGE_PAUSED_TO_READY: -@GST_STATE_CHANGE_READY_TO_NULL: - -<!-- ##### ENUM GstStateChangeReturn ##### --> -<para> - -</para> - -@GST_STATE_CHANGE_FAILURE: -@GST_STATE_CHANGE_SUCCESS: -@GST_STATE_CHANGE_ASYNC: -@GST_STATE_CHANGE_NO_PREROLL: - -<!-- ##### ENUM GstRank ##### --> -<para> -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(). -</para> - -@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/gstvalue.sgml b/docs/gst/tmpl/gstvalue.sgml index 0e7aa4405..299cf4937 100644 --- a/docs/gst/tmpl/gstvalue.sgml +++ b/docs/gst/tmpl/gstvalue.sgml @@ -14,6 +14,9 @@ GValue implementations specific to GStreamer </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### MACRO GST_VALUE_HOLDS_FOURCC ##### --> |