mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 04:01:08 +00:00
Added new files
Original commit message from CVS: Added new files
This commit is contained in:
Wim Taymans
parent
229bc1f1e9
commit
27e981de45
4 changed files with 649 additions and 0 deletions
86
docs/gst/tmpl/gstformat.sgml
Normal file
86
docs/gst/tmpl/gstformat.sgml
Normal file
|
|
@ -0,0 +1,86 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstFormat
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Dynamically register new formats
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
GstFormats functions are used to register a new format to the gstreamer core.
|
||||
formats can be used to perform seeking or conversions/query operations.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GstFormat ##### -->
|
||||
<para>
|
||||
Standard predefined formats
|
||||
</para>
|
||||
|
||||
@GST_FORMAT_UNDEFINED: undefined format
|
||||
@GST_FORMAT_DEFAULT: the default format of the pad/element
|
||||
@GST_FORMAT_BYTES: bytes
|
||||
@GST_FORMAT_TIME: time in nanoseconds
|
||||
@GST_FORMAT_BUFFERS: buffers
|
||||
@GST_FORMAT_PERCENT: percentage of stream
|
||||
@GST_FORMAT_UNITS: frames for video, samples for audio, other definitions as
|
||||
defined by the media type.
|
||||
|
||||
<!-- ##### STRUCT GstFormatDefinition ##### -->
|
||||
<para>
|
||||
A format definition
|
||||
</para>
|
||||
|
||||
@value: The unique id of this format
|
||||
@nick: A short nick of the format
|
||||
@description: A longer description of the format
|
||||
|
||||
<!-- ##### MACRO GST_FORMATS_FUNCTION ##### -->
|
||||
<para>
|
||||
A convenience function to define a function that returns an array
|
||||
of formats.
|
||||
</para>
|
||||
|
||||
@functionname: The name of the function
|
||||
@...: comma separated list of functions closed with 0
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_format_register ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@nick:
|
||||
@description:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_format_get_by_nick ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@nick:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_format_get_details ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@format:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_format_get_definitions ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
356
docs/gst/tmpl/gstindex.sgml
Normal file
356
docs/gst/tmpl/gstindex.sgml
Normal file
|
|
@ -0,0 +1,356 @@
|
|||
<!-- ##### 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>
|
||||
|
||||
</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_ACCOCIATION_FLAG_NONE: no flags
|
||||
@GST_ACCOCIATION_FLAG_KEY_UNIT: this entry marks a key unit.
|
||||
|
||||
<!-- ##### 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_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.
|
||||
|
||||
|
||||
<!-- ##### 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_id: A pointer to the id that has to be assigned to this writer
|
||||
@writer_string: A description of the writer.
|
||||
@user_data: user_data as registered
|
||||
@Returns: TRUE if an id could be assigned to the writer.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstIndex ##### -->
|
||||
<para>
|
||||
The GstIndex object
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### 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:
|
||||
@format:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_get_assoc_entry_full ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@index:
|
||||
@id:
|
||||
@method:
|
||||
@format:
|
||||
@value:
|
||||
@func:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@entry:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_index_entry_assoc_map ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@entry:
|
||||
@format:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GstIndex::entry-added ##### -->
|
||||
<para>
|
||||
Is emited when a new entry is added to the index.
|
||||
</para>
|
||||
|
||||
@gstindex: the object which received the signal.
|
||||
@arg1: The entry added to the index.
|
||||
|
||||
68
docs/gst/tmpl/gstindexfactory.sgml
Normal file
68
docs/gst/tmpl/gstindexfactory.sgml
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
<!-- ##### 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:
|
||||
|
||||
|
||||
139
docs/gst/tmpl/gstprobe.sgml
Normal file
139
docs/gst/tmpl/gstprobe.sgml
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
GstProbe
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Receive callbacks of data passing
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
PadProbes are used to be signalled with a callback when certain GstData
|
||||
passes through pads.
|
||||
</para>
|
||||
<para>
|
||||
Probes are usually used in combination with a probe dispatcher that will
|
||||
enumerate all registered probes to signal them.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstProbe ##### -->
|
||||
<para>
|
||||
The probe structure
|
||||
</para>
|
||||
|
||||
@single_shot:
|
||||
@callback:
|
||||
@user_data:
|
||||
|
||||
<!-- ##### USER_FUNCTION GstProbeCallback ##### -->
|
||||
<para>
|
||||
The function that will be called when a probe is activated.
|
||||
</para>
|
||||
|
||||
@probe: The probe that signalled the callback
|
||||
@data: The GstData that triggered the probe
|
||||
@user_data: user data
|
||||
@Returns: TRUE if the GstData should be removed from the stream.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@single_shot:
|
||||
@callback:
|
||||
@user_data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@probe:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_perform ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@probe:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GstProbeDispatcher ##### -->
|
||||
<para>
|
||||
The structure of the probe dispatcher
|
||||
</para>
|
||||
|
||||
@active:
|
||||
@probes:
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_dispatcher_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_dispatcher_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@disp:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_dispatcher_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@disp:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_dispatcher_set_active ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@disp:
|
||||
@active:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_dispatcher_add_probe ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@disp:
|
||||
@probe:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_dispatcher_remove_probe ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@disp:
|
||||
@probe:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_probe_dispatcher_dispatch ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@disp:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
Loading…
Reference in a new issue