Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gst.Object
Gst.Index

Class Gst.Index

Import line:	Gst = imports.gi.Gst;
GIR File:	Gst-0.10.gir
C documentation:	GstIndex
Class :	Index
Extends:	Gst.Object
	Show / Hide Inherited methods, properties and signals

Opaque GstIndex structure.

Properties
Properties		Defined By
	_gst_reserved : Array read only	Gst.Index
	curgroup : Gst.IndexGroup read only	Gst.Index
	filter : [object Object] read only	Gst.Index
	filter_user_data : void* read only	Gst.Index
	filter_user_data_destroy : [object Object] read only	Gst.Index
	flags : Number read only	Gst.Object
	groups : Array read only	Gst.Index
	last_id : Number read only	Gst.Index
	lock : GLib.Mutex read only	Gst.Object
	maxgroup : Number read only	Gst.Index
	method : Gst.IndexResolverMethod read only	Gst.Index
	name : String	Gst.Object
	name_prefix : String read only	Gst.Object
	object : Gst.Object read only	Gst.Index
	parent : Gst.Object read only	Gst.Object
	refcount : Number read only	Gst.Object
	resolver : [object Object]	Gst.Index
	resolver : [object Object] read only	Gst.Index
	resolver_user_data : void* read only	Gst.Index
	resolver_user_data_destroy : [object Object] read only	Gst.Index
	writers : Object read only	Gst.Index

Methods / Constructors
Method / Constructor		Defined By
	new Gst.Index (Object *properties) Create a new Gst.Index Create a new Gst.Index Parameters: Object properties*
	add_associationv (Number id, AssocFlags *flags, Number n, IndexAssociation list) : Gst.IndexEntry Associate given format/value pairs with each other. Associate given format/value pairs with each other. Parameters: Number id Required (not null) Gst.AssocFlags flags* Required (not null) Number n Required (not null) Gst.IndexAssociation list Required (not null) Returns: Gst.IndexEntry	Gst.Index
	add_format (Number id, Format *format) : Gst.IndexEntry Adds a format entry into the index. Adds a format entry into the index. This function is used to map dynamic GstFormat ids to their original format key. Parameters: Number id Required (not null) Gst.Format format* Required (not null) Returns: Gst.IndexEntry	Gst.Index
	add_id (Number id, String *description) : Gst.IndexEntry Add an id entry into the index. Add an id entry into the index. Parameters: Number id Required (not null) String description* Required (not null) Returns: Gst.IndexEntry	Gst.Index
	add_object (Number id, String *key, Number type, void *object) : Gst.IndexEntry Add the given object to the index with the given key. Add the given object to the index with the given key. This function is not yet implemented. Parameters: Number id Required (not null) String key* Required (not null) Number type Required (not null) void* object Required (not null) Returns: Gst.IndexEntry	Gst.Index
	commit (Number id) : none 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. 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. Parameters: Number id Required (not null) Returns: none	Gst.Index
	default_error (Object *error, String debug) : none A default error function. A default error function. The default handler will simply print the error string using g_print. Parameters: Object error* Required (not null) String debug Required (not null) Returns: none	Gst.Object
	get_assoc_entry (Number id, IndexLookupMethod *method, AssocFlags flags, Format format, Number value) : Gst.IndexEntry Finds the given format/value in the index Finds the given format/value in the index Parameters: Number id Required (not null) Gst.IndexLookupMethod method* Required (not null) Gst.AssocFlags flags Required (not null) Gst.Format format Required (not null) Number value Required (not null) Returns: Gst.IndexEntry value was not found.	Gst.Index
	get_assoc_entry_full (Number id, IndexLookupMethod *method, AssocFlags flags, Format format, Number value, Function func, void *user_data) : Gst.IndexEntry Finds the given format/value in the index with the given compare function and user_data. Finds the given format/value in the index with the given compare function and user_data. Parameters: Number id Required (not null) Gst.IndexLookupMethod method* Required (not null) Gst.AssocFlags flags Required (not null) Gst.Format format Required (not null) Number value Required (not null) Function (void* a, void* b, void* *user_data) : Gst.IndexEntry Required (not null) void user_data Required (not null) Returns: Gst.IndexEntry value was not found.	Gst.Index
	get_certainty () : Gst.IndexCertainty Get the certainty of the given index. Get the certainty of the given index. Returns: Gst.IndexCertainty	Gst.Index
	get_group () : Number Get the id of the current group. Get the id of the current group. Returns: Number	Gst.Index
	get_name () : String Returns a copy of the name of object. 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. MT safe. This function grabs and releases object's LOCK. Returns: String after usage.	Gst.Object
	get_name_prefix () : String Returns a copy of the name prefix of object. 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. MT safe. This function grabs and releases object's LOCK. Returns: String after usage.	Gst.Object
	get_parent () : Gst.Object Returns the parent of object. Returns the parent of object. This function increases the refcount of the parent object so you should gst_object_unref() it after usage. MT safe. Grabs and releases object's LOCK. Returns: Gst.Object parent. unref after usage.	Gst.Object
	get_path_string () : String Generates a string describing the path of object in the object hierarchy. Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging. MT safe. Grabs and releases the GstObject's LOCK for all objects in the hierarchy. Returns: String g_free() the string after usage.	Gst.Object
	get_writer_id (Object *writer, Object out_values) : Boolean Before entries can be added to the index, a writer should obtain a unique 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. Parameters: Gst.Object writer* Required (not null) Object out_values Number id Returns: Boolean	Gst.Index
	has_ancestor (Object *ancestor) : Boolean Check if object* has an ancestor ancestor somewhere up in the hierarchy. Check if object has an ancestor ancestor somewhere up in the hierarchy. MT safe. Grabs and releases object's locks. Parameters: Gst.Object ancestor Required (not null) Returns: Boolean	Gst.Object
	new_group () : Number Create a new group for the given index. Create a new group for the given index. It will be set as the current group. Returns: Number	Gst.Index
	replace (Object *newobj) : none Unrefs the GstObject* pointed to by oldobj, refs newobj and puts newobj in *oldobj. 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. Parameters: Gst.Object newobj Required (not null) Returns: none	Gst.Object
	restore_thyself (Node *self) : none Restores object* with the data from the parent XML node. Restores object with the data from the parent XML node. Parameters: libxml2.Node self Required (not null) Returns: none	Gst.Object
	save_thyself (Node *parent) : libxml2.Node Saves object* into the parent XML node. Saves object into the parent XML node. Parameters: libxml2.Node parent Required (not null) Returns: libxml2.Node	Gst.Object
	set_certainty (IndexCertainty *certainty) : none Set the certainty of the given index. Set the certainty of the given index. Parameters: Gst.IndexCertainty certainty* Required (not null) Returns: none	Gst.Index
	set_filter (Function *filter, void *user_data) : none Lets the app register a custom filter function so that it can select what entries should be stored in the index. Lets the app register a custom filter function so that it can select what entries should be stored in the index. Parameters: Function (Index index, IndexEntry entry, void *user_data) : none Required (not null) void user_data Required (not null) Returns: none	Gst.Index
	set_filter_full (Function *filter, void *user_data, Function user_data_destroy) : none Lets the app register a custom filter function so that it can select what entries should be stored in the index. Lets the app register a custom filter function so that it can select what entries should be stored in the index. Parameters: Function (Index index, IndexEntry entry, void *user_data) : none Required (not null) void user_data Required (not null) Function (void* *data*) : none Required (not null) Returns: none	Gst.Index
	set_group (Number *groupnum) : Boolean Set the current groupnumber to the given argument. Set the current groupnumber to the given argument. did not exist. Parameters: Number groupnum* Required (not null) Returns: Boolean	Gst.Index
	set_name (String *name) : Boolean Sets the name of object, or gives object* a guaranteed unique name (if name is NULL). 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. a parent cannot be renamed, this function returns FALSE in those cases. MT safe. This function grabs and releases object's LOCK. Parameters: String name Required (not null) Returns: Boolean	Gst.Object
	set_name_prefix (String *name_prefix) : none Sets the name prefix of object* to name_prefix. 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. Parameters: String name_prefix Required (not null) Returns: none	Gst.Object
	set_parent (Object *parent) : Boolean Sets the parent of object* to 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. already had a parent or object and parent are the same. MT safe. Grabs and releases object's LOCK. Parameters: Gst.Object parent Required (not null) Returns: Boolean	Gst.Object
	set_resolver (Function *resolver, void *user_data) : none Lets the app register a custom function to map index ids to writer descriptions. Lets the app register a custom function to map index ids to writer descriptions. Parameters: Function (Index index, Object writer, Array writer_string, void *user_data) : none Required (not null) void user_data Required (not null) Returns: none	Gst.Index
	set_resolver_full (Function *resolver, void *user_data, Function user_data_destroy) : none Lets the app register a custom function to map index ids to writer descriptions. Lets the app register a custom function to map index ids to writer descriptions. Parameters: Function (Index index, Object writer, Array writer_string, void *user_data) : none Required (not null) void user_data Required (not null) Function (void* *data*) : none Required (not null) Returns: none	Gst.Index
	unparent () : none Clear the parent of object, removing the associated reference. Clear the parent of object, removing the associated reference. This function decreases the refcount of object. MT safe. Grabs and releases object's lock. Returns: none	Gst.Object

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	deep_notify (Object *self, Object prop_object, ParamSpec prop) : none The deep notify signal is used to be notified of property changes. 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. Parameters: Gst.Object self* Gst.Object prop_object GObject.ParamSpec prop Returns: {none}	Gst.Object
	entry_added (Index *self, IndexEntry object) : none Parameters: Gst.Index self* Gst.IndexEntry object Returns: {none}	Gst.Index
	object_saved (Object *self, void *xml_node) : none Trigered whenever a new object is saved to XML. Trigered whenever a new object is saved to XML. You can connect to this signal to insert custom XML tags into the core XML. Parameters: Gst.Object self* void* xml_node Returns: {none}	Gst.Object
	parent_set (Object *self, Object parent) : none Emitted when the parent of an object is set. Emitted when the parent of an object is set. Parameters: Gst.Object self* Gst.Object parent Returns: {none}	Gst.Object
	parent_unset (Object *self, Object parent) : none Emitted when the parent of an object is unset. Emitted when the parent of an object is unset. Parameters: Gst.Object self* Gst.Object parent Returns: {none}	Gst.Object

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gst.Element Method	set_index (Index *index) : none Set index* on the element.
Gst.Element Method	get_index () : Gst.Index Gets the index from the element.
Gst.IndexFactory Method	Gst.IndexFactory.make (String *name) : Gst.Index Create a new GstIndex* instance from the indexfactory with the given name.
Gst.IndexFactory Method	create () : Gst.Index Create a new GstIndex instance from the given indexfactory.

Un-official Seed Documentation

Gst

Classes

Interfaces

Structs

Unions

Enums

Class Gst.Index