Index

Description GstIndex is used to generate a stream index of one or more elements in a pipeline.

class Index : ObjectGst {}

Constructors

this
this(GstIndex* gstIndex)

Sets our main struct and passes it to the parent class

this
this()

Create a new tileindex object

Members

Functions

addAssociationv
GstIndexEntry* addAssociationv(int id, GstAssocFlags flags, int n, GstIndexAssociation* list)

Associate given format/value pairs with each other.

addFormat
GstIndexEntry* addFormat(int id, GstFormat format)

Adds a format entry into the index. This function is used to map dynamic GstFormat ids to their original format key.

addId
GstIndexEntry* addId(int id, string description)

Add an id entry into the index.

addObject
GstIndexEntry* addObject(int id, string key, GType type, void* object)

Add the given object to the index with the given key. This function is not yet implemented.

addOnEntryAdded
void addOnEntryAdded(void delegate(GstIndexEntry*, Index) dlg, ConnectFlags connectFlags)

Is emitted when a new entry is added to the index. See Also GstIndexFactory

commit
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.

getAssocEntry
GstIndexEntry* getAssocEntry(int id, GstIndexLookupMethod method, GstAssocFlags flags, GstFormat format, long value)

Finds the given format/value in the index

getAssocEntryFull
GstIndexEntry* getAssocEntryFull(int id, GstIndexLookupMethod method, GstAssocFlags flags, GstFormat format, long value, GCompareDataFunc func, void* userData)

Finds the given format/value in the index with the given compare function and user_data.

getCertainty
GstIndexCertainty getCertainty()

Get the certainty of the given index.

getGroup
int getGroup()

Get the id of the current group.

getIndexStruct
GstIndex* getIndexStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

getWriterId
int getWriterId(ObjectGst writer, 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.

newGroup
int newGroup()

Create a new group for the given index. It will be set as the current group.

setCertainty
void setCertainty(GstIndexCertainty certainty)

Set the certainty of the given index.

setFilter
void setFilter(GstIndexFilter filter, void* userData)

Lets the app register a custom filter function so that it can select what entries should be stored in the index.

setFilterFull
void setFilterFull(GstIndexFilter filter, void* userData, GDestroyNotify userDataDestroy)

Lets the app register a custom filter function so that it can select what entries should be stored in the index.

setGroup
int setGroup(int groupnum)

Set the current groupnumber to the given argument.

setResolver
void setResolver(GstIndexResolver resolver, void* userData)

Lets the app register a custom function to map index ids to writer descriptions.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackEntryAdded
void callBackEntryAdded(GstIndex* gstindexStruct, GstIndexEntry* arg1, Index _index)
Undocumented in source. Be warned that the author may not have intended to support it.
entryAssocMap
int entryAssocMap(GstIndexEntry* entry, GstFormat format, long value)

Gets alternative formats associated with the indexentry.

entryCopy
GstIndexEntry* entryCopy(GstIndexEntry* entry)

Copies an entry and returns the result.

entryFree
void entryFree(GstIndexEntry* entry)

Free the memory used by the given entry.

Variables

connectedSignals
int[string] connectedSignals;
gstIndex
GstIndex* gstIndex;

the main Gtk struct

onEntryAddedListeners
void delegate(GstIndexEntry*, Index)[] onEntryAddedListeners;
Undocumented in source.

Inherited Members

From ObjectGst

gstObject
GstObject* gstObject;

the main Gtk struct

getObjectGstStruct
GstObject* getObjectGstStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals
int[string] connectedSignals;
onDeepNotifyListeners
void delegate(ObjectGst, ParamSpec, ObjectGst)[] onDeepNotifyListeners;
Undocumented in source.
addOnDeepNotify
void addOnDeepNotify(void delegate(ObjectGst, ParamSpec, ObjectGst) dlg, ConnectFlags connectFlags)

The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.

callBackDeepNotify
void callBackDeepNotify(GstObject* gstobjectStruct, GstObject* propObject, GParamSpec* prop, ObjectGst _objectGst)
Undocumented in source. Be warned that the author may not have intended to support it.
onObjectSavedListeners
void delegate(void*, ObjectGst)[] onObjectSavedListeners;
Undocumented in source.
addOnObjectSaved
void addOnObjectSaved(void delegate(void*, ObjectGst) dlg, ConnectFlags connectFlags)

Trigered whenever a new object is saved to XML. You can connect to this signal to insert custom XML tags into the core XML.

callBackObjectSaved
void callBackObjectSaved(GstObject* gstobjectStruct, void* xmlNode, ObjectGst _objectGst)
Undocumented in source. Be warned that the author may not have intended to support it.
onParentSetListeners
void delegate(ObjectG, ObjectGst)[] onParentSetListeners;
Undocumented in source.
addOnParentSet
void addOnParentSet(void delegate(ObjectG, ObjectGst) dlg, ConnectFlags connectFlags)

Emitted when the parent of an object is set.

callBackParentSet
void callBackParentSet(GstObject* gstobjectStruct, GObject* parent, ObjectGst _objectGst)
Undocumented in source. Be warned that the author may not have intended to support it.
onParentUnsetListeners
void delegate(ObjectG, ObjectGst)[] onParentUnsetListeners;
Undocumented in source.
addOnParentUnset
void addOnParentUnset(void delegate(ObjectG, ObjectGst) dlg, ConnectFlags connectFlags)

Emitted when the parent of an object is unset.

callBackParentUnset
void callBackParentUnset(GstObject* gstobjectStruct, GObject* parent, ObjectGst _objectGst)
Undocumented in source. Be warned that the author may not have intended to support it.
setName
int setName(string name)

Sets the name of object, or gives object a guaranteed unique name (if name is NULL). This function makes a copy of the provided name, so the caller retains ownership of the name it sent.

getName
string getName()

Returns a copy of the name of object. Caller should g_free() the return value after usage. For a nameless object, this returns NULL, which you can safely g_free() as well.

setParent
int setParent(ObjectGst parent)

Sets the parent of object to parent. The object's reference count will be incremented, and any floating reference will be removed (see gst_object_sink()). This function causes the parent-set signal to be emitted when the parent was successfully set.

getParent
ObjectGst getParent()

Returns the parent of object. This function increases the refcount of the parent object so you should gst_object_unref() it after usage.

unparent
void unparent()

Clear the parent of object, removing the associated reference. This function decreases the refcount of object. MT safe. Grabs and releases object's lock.

getNamePrefix
string getNamePrefix()

Returns a copy of the name prefix of object. Caller should g_free() the return value after usage. For a prefixless object, this returns NULL, which you can safely g_free() as well.

setNamePrefix
void setNamePrefix(string namePrefix)

Sets the name prefix of object to name_prefix. This function makes a copy of the provided name prefix, so the caller retains ownership of the name prefix it sent. MT safe. This function grabs and releases object's LOCK.

defaultDeepNotify
void defaultDeepNotify(ObjectG object, ObjectGst orig, ParamSpec pspec, string[] excludedProps)

A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print. MT safe. This function grabs and releases object's LOCK for getting its path string.

defaultError
void defaultError(ErrorG error, string dbug)

A default error function. The default handler will simply print the error string using g_print.

checkUniqueness
int checkUniqueness(ListG list, string name)

Checks to see if there is any object named name in list. This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each GstObject in the list to compare the name, so be carefull when passing a list with a locked object.

hasAncestor
int hasAncestor(ObjectGst ancestor)

Check if object has an ancestor ancestor somewhere up in the hierarchy.

doref
void* doref(void* object)

Increments the refence count on object. This function does not take the lock on object because it relies on atomic refcounting. This object returns the input parameter to ease writing

unref
void unref(void* object)

Decrements the refence count on object. If reference count hits zero, destroy object. This function does not take the lock on object as it relies on atomic refcounting. The unref method should never be called with the LOCK held since this might deadlock the dispose function.

sink
void sink(void* object)

If object was floating, the GST_OBJECT_FLOATING flag is removed and object is unreffed. When object was not floating, this function does nothing. Any newly created object has a refcount of 1 and is floating. This function should be used when creating a new object to symbolically 'take ownership' of object. This done by first doing a gst_object_ref() to keep a reference to object and then gst_object_sink() to remove and unref any floating references to object. Use gst_object_set_parent() to have this done for you. MT safe. This function grabs and releases object lock.

replace
void replace(ObjectGst oldobj, ObjectGst newobj)

Unrefs the GstObject pointed to by oldobj, refs newobj and puts newobj in *oldobj. Be carefull when calling this function, it does not take any locks. You might want to lock the object owning oldobj pointer before calling this function. Make sure not to LOCK oldobj because it might be unreffed which could cause a deadlock when it is disposed.

getPathString
string getPathString()

Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging.

Meta