gstreamer/docs/gst/tmpl/old/GstIndex.sgml

524 lines
7.4 KiB
Text
Raw Normal View History

docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do majo... Original commit message from CVS: * docs/gst/gstreamer-docs.sgml: I got tired of the reference manual being such complete crap, that I decided to do major hacking of it. This checkin replaces any fine tuning that may have been done previously, with the benefit of actually being complete for much of the API that was changed since 0.6. Further fine tuning will occur shortly. (bug #134721) * docs/gst/gstreamer-sections.txt: * docs/gst/tmpl/GstBin.sgml: * docs/gst/tmpl/GstBuffer.sgml: * docs/gst/tmpl/GstCaps.sgml: * docs/gst/tmpl/GstClock.sgml: * docs/gst/tmpl/GstCompat.sgml: * docs/gst/tmpl/GstData.sgml: * docs/gst/tmpl/GstElement.sgml: * docs/gst/tmpl/GstEvent.sgml: * docs/gst/tmpl/GstIndex.sgml: * docs/gst/tmpl/GstStructure.sgml: * docs/gst/tmpl/GstTag.sgml: * docs/gst/tmpl/cothreads.sgml: * docs/gst/tmpl/cothreads_compat.sgml: * docs/gst/tmpl/gettext.sgml: * docs/gst/tmpl/grammar.tab.sgml: * docs/gst/tmpl/gst-i18n-app.sgml: * docs/gst/tmpl/gst-i18n-lib.sgml: * docs/gst/tmpl/gst.sgml: * docs/gst/tmpl/gst_private.sgml: * docs/gst/tmpl/gstaggregator.sgml: * docs/gst/tmpl/gstarch.sgml: * docs/gst/tmpl/gstatomic.sgml: * docs/gst/tmpl/gstatomic_impl.sgml: * docs/gst/tmpl/gstbin.sgml: * docs/gst/tmpl/gstbuffer.sgml: * docs/gst/tmpl/gstbufferstore.sgml: * docs/gst/tmpl/gstcaps.sgml: * docs/gst/tmpl/gstclock.sgml: * docs/gst/tmpl/gstcompat.sgml: * docs/gst/tmpl/gstconfig.sgml: * docs/gst/tmpl/gstcpu.sgml: * docs/gst/tmpl/gstdata.sgml: * docs/gst/tmpl/gstdata_private.sgml: * docs/gst/tmpl/gstelement.sgml: * docs/gst/tmpl/gstenumtypes.sgml: * docs/gst/tmpl/gsterror.sgml: * docs/gst/tmpl/gstevent.sgml: * docs/gst/tmpl/gstfakesink.sgml: * docs/gst/tmpl/gstfakesrc.sgml: * docs/gst/tmpl/gstfilesink.sgml: * docs/gst/tmpl/gstfilter.sgml: * docs/gst/tmpl/gstindex.sgml: * docs/gst/tmpl/gstinfo.sgml: * docs/gst/tmpl/gstinterface.sgml: * docs/gst/tmpl/gstlog.sgml: * docs/gst/tmpl/gstmacros.sgml: * docs/gst/tmpl/gstmarshal.sgml: * docs/gst/tmpl/gstmd5sink.sgml: * docs/gst/tmpl/gstmultifilesrc.sgml: * docs/gst/tmpl/gstobject.sgml: * docs/gst/tmpl/gstpad.sgml: * docs/gst/tmpl/gstparse.sgml: * docs/gst/tmpl/gstpipeline.sgml: * docs/gst/tmpl/gstplugin.sgml: * docs/gst/tmpl/gstpluginfeature.sgml: * docs/gst/tmpl/gstqueue.sgml: * docs/gst/tmpl/gstreamer-unused.sgml: * docs/gst/tmpl/gstregistry.sgml: * docs/gst/tmpl/gstregistrypool.sgml: * docs/gst/tmpl/gstscheduler.sgml: * docs/gst/tmpl/gstsearchfuncs.sgml: * docs/gst/tmpl/gstshaper.sgml: * docs/gst/tmpl/gstspider.sgml: * docs/gst/tmpl/gstspideridentity.sgml: * docs/gst/tmpl/gststructure.sgml: * docs/gst/tmpl/gstsystemclock.sgml: * docs/gst/tmpl/gsttag.sgml: * docs/gst/tmpl/gsttaginterface.sgml: * docs/gst/tmpl/gsttee.sgml: * docs/gst/tmpl/gstthread.sgml: * docs/gst/tmpl/gsttrace.sgml: * docs/gst/tmpl/gsttrashstack.sgml: * docs/gst/tmpl/gsttypefind.sgml: * docs/gst/tmpl/gsttypes.sgml: * docs/gst/tmpl/gsturi.sgml: * docs/gst/tmpl/gsturitype.sgml: * docs/gst/tmpl/gstutils.sgml: * docs/gst/tmpl/gstvalue.sgml: * docs/gst/tmpl/gstversion.sgml: * docs/gst/tmpl/gstxml.sgml: * docs/gst/tmpl/gstxmlregistry.sgml: * docs/gst/tmpl/gthread-cothreads.sgml: * docs/gst/tmpl/types.sgml:
2004-03-25 04:20:33 +00:00
<!-- ##### SECTION Title ##### -->
GstIndexFactory
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GST_TYPE_INDEX_ENTRY ##### -->
<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_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:
<!-- ##### MACRO GST_TYPE_INDEX_FACTORY ##### -->
<para>
</para>
<!-- ##### MACRO GST_INDEX_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_IS_INDEX_FACTORY ##### -->
<para>
</para>
@obj:
<!-- ##### MACRO GST_INDEX_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_IS_INDEX_FACTORY_CLASS ##### -->
<para>
</para>
@klass:
<!-- ##### MACRO GST_INDEX_FACTORY_GET_CLASS ##### -->
<para>
</para>
@obj:
<!-- ##### FUNCTION gst_index_factory_get_type ##### -->
<para>
</para>
@Returns:
<!-- ##### 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: