GstIndex
Generate indexes on objects
GstIndex is used to generate a stream index of one or more elements
in a pipeline.
#GstIndexFactory
The basic element of an index.
@type:
@id:
A group of related entries in an index.
@groupnum:
@entries:
@certainty:
@peergroup:
The certainty of a group in the index.
@GST_INDEX_UNKNOWN: accuracy is not known
@GST_INDEX_CERTAIN: accuracy is perfect
@GST_INDEX_FUZZY: accuracy is fuzzy
The different types of entries in the index.
@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
Specify the method to find an index entry in the index.
@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
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.
@entry: The entry to query
Get the flags for this entry
@entry: The entry to query
Get the i-th format of the entry.
@entry: The entry to query
@i: The format index
Get the i-th value of the entry.
@entry: The entry to query
@i: The value index
An association in an entry.
@format: the format of the association
@value: the value of the association
flags for an association entry
@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.
Get the format of the format entry
@entry: The entry to query
Get the key of the format entry
@entry: The entry to query
Get the description of the id entry
@entry: The entry to query
Function to filter out entries in the index.
@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.
Function to resolve ids to writer descriptions.
@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.
@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
Is emited when a new entry is added to the index.
@gstindex: the object which received the signal.
@arg1: The entry added to the index.
@Returns:
@index:
@Returns:
@index:
@Returns:
@index:
@groupnum:
@Returns:
@index:
@certainty:
@index:
@Returns:
@index:
@filter:
@user_data:
@index:
@resolver:
@user_data:
@index:
@writer:
@id:
@Returns:
@index:
@id:
@format:
@Returns:
@index:
@id:
@flags:
@format:
@value:
@Varargs:
@Returns:
@index:
@id:
@key:
@type:
@object:
@Returns:
@index:
@id:
@description:
@Returns:
@index:
@id:
@method:
@flags:
@format:
@value:
@Returns:
@index:
@id:
@method:
@flags:
@format:
@value:
@func:
@user_data:
@Returns:
@entry:
@entry:
@format:
@value:
@Returns:
@index:
@id: