Index
Object Hierarchy:
Description:
public abstract class Index :
Object
GstIndex is used to generate a stream index of one or more elements in a pipeline. Elements will overload the set_index and get_index
virtual methods in Element. When streaming data, the element will add index entries
if it has an index set. Each element that adds to the index will do that using a writer_id. The writer_id is obtained from
get_writer_id. The application that wants to index the stream will
create a new index object using Index or
make. The index is assigned to a specific element, a bin or the whole
pipeline. This will cause indexable elements to add entires to the index while playing.
Namespace: Gst
Package: gstreamer-0.10
Content:
Properties:
Creation methods:
-
public Index ()
Create a new dummy index object. Use
set_index to assign that to an element or pipeline. This index is not storing anything, but will still emit e.g. the
entry_added signal.
Methods:
-
public unowned IndexEntry add_association (int id, AssocFlags flags, Format format, int64 value, ...)
Associate given format/value pairs with each other. Be sure to pass gint64 values to this functions
varargs, you might want to use a gint64 cast to be sure.
-
public unowned IndexEntry? add_associationv (int id, AssocFlags flags, IndexAssociation[] list)
Associate given format/value pairs with each other.
-
public virtual void add_entry (IndexEntry entry)
-
public unowned IndexEntry? add_format (int id, Format format)
Adds a format entry into the index. This function is used to map dynamic GstFormat ids to their original
format key.
-
public unowned IndexEntry? add_id (int id, string description)
Add an id entry into the index.
-
public unowned IndexEntry? add_object (int id, string key, Type type, void* object)
Add the given object to the index with the given key. This function is not yet implemented.
-
public virtual void commit (int id)
Tell the index that the writer with the given id is done with this index and is not going to write any
more entries to it.
-
public virtual unowned IndexEntry? get_assoc_entry (int id, IndexLookupMethod method, AssocFlags flags, Format format, int64 value)
Finds the given format/value in the index value was not found.
-
public unowned IndexEntry? get_assoc_entry_full (int id, IndexLookupMethod method, AssocFlags flags, Format format, int64 value, CompareDataFunc func)
Finds the given format/value in the index with the given compare function and user_data. value was not
found.
-
public IndexCertainty get_certainty ()
Get the certainty of the given index.
-
public int get_group ()
Get the id of the current group.
-
public virtual bool get_writer_id (Object writer, out int id)
Before entries can be added to the index, a writer should obtain a unique id. The methods to add new
entries to the index require this id as an argument. The application can implement a custom function to map the writer object to a
string. That string will be used to register or look up an id in the index.
-
public bool is_readable ()
-
public bool is_writable ()
-
public int new_group ()
Create a new group for the given index. It will be set as the current group.
-
public void set_certainty (IndexCertainty certainty)
Set the certainty of the given index.
-
public void set_filter (owned IndexFilter filter)
Lets the app register a custom filter function so that it can select what entries should be stored in
the index.
-
public bool set_group (int groupnum)
Set the current groupnumber to the given argument. did not exist.
-
public void set_resolver (owned IndexResolver resolver)
Lets the app register a custom function to map index ids to writer descriptions.
Signals:
