Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Iterator

Import line:	Gst = imports.gi.Gst;
GIR File:	Gst-0.10.gir
C documentation:	GstIterator
Struct :	Iterator
	Show / Hide Inherited methods, properties and signals

GstIterator base structure. The values of this structure are protected for subclasses, use the methods to use the GstIterator.

Properties
Properties		Defined By
	_gst_reserved : Array	Gst.Iterator
	cookie : Number	Gst.Iterator
	free : [object Object]	Gst.Iterator
	item : [object Object]	Gst.Iterator
	lock : GLib.Mutex	Gst.Iterator
	master_cookie : void*	Gst.Iterator
	next : [object Object]	Gst.Iterator
	pushed : Gst.Iterator	Gst.Iterator
	resync : [object Object]	Gst.Iterator
	type : Number	Gst.Iterator

Methods / Constructors
Method / Constructor		Defined By
	new Gst.Iterator () Create a new Gst.Iterator Create a new Gst.Iterator
	new Gst.Iterator.c_new (Number *size, Number type, Mutex lock, Object out_values, Function next, Function item, Function resync, Function free) : Gst.Iterator Create a new Gst.Iterator Create a new Gst.Iterator Parameters: Number size* Required (not null) Number type Required (not null) GLib.Mutex lock Required (not null) Object out_values Number master_cookie Function (Iterator it, void* *result) : Gst.Iterator Required (not null) Function (Iterator it, void *item*) : Gst.Iterator Required (not null) Function (Iterator it) : Gst.Iterator Required (not null) Function (Iterator it) : Gst.Iterator Required (not null) Returns: Gst.Iterator
	new Gst.Iterator.list (Number *type, Mutex lock, Object out_values, Array list, void *owner, Function item, Function free) : Gst.Iterator Create a new Gst.Iterator Create a new Gst.Iterator Parameters: Number type* Required (not null) GLib.Mutex lock Required (not null) Object out_values Number master_cookie Array list Required (not null) void* owner Required (not null) Function (Iterator it, void* *item) : Gst.Iterator Required (not null) Function (void *owner*) : Gst.Iterator Required (not null) Returns: Gst.Iterator
	new Gst.Iterator.single (Number *type, void *object, Function copy, Function free) : Gst.Iterator Create a new Gst.Iterator Create a new Gst.Iterator Parameters: Number type* Required (not null) void* object Required (not null) Function (void* *object) : Gst.Iterator Required (not null) Function (void *data*) : Gst.Iterator Required (not null) Returns: Gst.Iterator
	filter (Function *func, void *user_data) : Gst.Iterator Create a new iterator from an existing iterator. Create a new iterator from an existing iterator. The new iterator will only return those elements that match the given compare function func. in the iterator. When this iterator is freed, it will also be freed. MT safe. Parameters: Function (void a, void* b) : Gst.Iterator Required (not null) void* user_data Required (not null) Returns: Gst.Iterator	Gst.Iterator
	find_custom (Function *func, void *user_data) : void Find the first element in it that matches the compare function func. Find the first element in it that matches the compare function func. the refcount of a refcounted object will be increased before func is called, and should be unrefed after use. The iterator will not be freed. This function will return NULL if an error or resync happened to the iterator. function or NULL when no element matched. MT safe. Parameters: Function (void* a, void* b) : void* Required (not null) void* user_data Required (not null) Returns: void*	Gst.Iterator
	fold (Function *func, Value ret, void *user_data) : Gst.IteratorResult Folds func* over the elements of iter. Folds func over the elements of iter. That is to say, func will be called as func (object, ret, user_data) for each object in it. The normal use of this procedure is to accumulate the results of operating on the objects in before func is called, and it should be unrefed after use in func. This procedure can be used (and is used internally) to implement the gst_iterator_foreach() and gst_iterator_find_custom() operations. The fold will proceed as long as func returns TRUE. When the iterator has no more arguments, GST_ITERATOR_DONE will be returned. If func returns FALSE, the fold will stop, and GST_ITERATOR_OK will be returned. Errors or resyncs will cause fold to return GST_ITERATOR_ERROR or GST_ITERATOR_RESYNC as appropriate. The iterator will not be freed. MT safe. Parameters: Function (void* *item, Value ret, void *user_data) : Gst.IteratorResult Required (not null) GObject.Value ret* Required (not null) void* user_data Required (not null) Returns: Gst.IteratorResult	Gst.Iterator
	foreach (Function *func, void *user_data) : Gst.IteratorResult Iterate over all element of it and call the given function func* for each element. Iterate over all element of it and call the given function func for each element. As in gst_iterator_fold(), the refcount of a refcounted object will be increased before func is called, and should be unrefed after use. freed. MT safe. Parameters: Function (void* *data, void *user_data) : Gst.IteratorResult Required (not null) void user_data Required (not null) Returns: Gst.IteratorResult The iterator will not be	Gst.Iterator
	free () : none Free the iterator. Free the iterator. MT safe. Returns: none	Gst.Iterator
	next (void* *elem) : Gst.IteratorResult Get the next item from the iterator in elem. Get the next item from the iterator in elem. Only when this function returns GST_ITERATOR_OK, elem* will contain a valid value. For iterators that return refcounted objects, the returned object will have its refcount increased and should therefore be unreffed after usage. When this function returns GST_ITERATOR_DONE, no more elements can be retrieved from it. A return value of GST_ITERATOR_RESYNC indicates that the element list was concurrently updated. The user of it should call gst_iterator_resync() to get the newly updated list. A return value of GST_ITERATOR_ERROR indicates an unrecoverable fatal error. is a refcounted object. MT safe. Parameters: void* elem Required (not null) Returns: Gst.IteratorResult	Gst.Iterator
	push (Iterator *other) : none Pushes other* iterator onto it. Pushes other iterator onto it. All calls performed on it are forwarded to other. If other returns GST_ITERATOR_DONE, it is popped again and calls are handled by it again. This function is mainly used by objects implementing the iterator next function to recurse into substructures. When gst_iterator_resync() is called on it, other will automatically be popped. MT safe. Parameters: Gst.Iterator other Required (not null) Returns: none	Gst.Iterator
	resync () : none Resync the iterator. Resync the iterator. this function is mostly called after gst_iterator_next() returned GST_ITERATOR_RESYNC. When an iterator was pushed on it, it will automatically be popped again with this function. MT safe. Returns: none	Gst.Iterator

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gst Method	Gst.format_iterate_definitions () : Gst.Iterator Iterate all the registered formats.
Gst Method	Gst.query_type_iterate_definitions () : Gst.Iterator Get a GstIterator of all the registered query types.
Gst.Bin Method	iterate_elements () : Gst.Iterator Gets an iterator for the elements in this bin.
Gst.Bin Method	iterate_sorted () : Gst.Iterator Gets an iterator for the elements in this bin in topologically sorted order.
Gst.Bin Method	iterate_recurse () : Gst.Iterator Gets an iterator for the elements in this bin.
Gst.Bin Method	iterate_sinks () : Gst.Iterator Gets an iterator for all elements in the bin that have the GST_ELEMENT_IS_SINK flag set.
Gst.Bin Method	iterate_sources () : Gst.Iterator Gets an iterator for all elements in the bin that have no sinkpads and have the GST_ELEMENT_IS_SINK flag unset.
Gst.Bin Method	iterate_all_by_interface (Number *iface*) : Gst.Iterator Looks for all elements inside the bin that implements the given interface.
Gst.Element Method	iterate_pads () : Gst.Iterator Retrieves an iterattor of element's pads.
Gst.Element Method	iterate_src_pads () : Gst.Iterator Retrieves an iterator of element's source pads.
Gst.Element Method	iterate_sink_pads () : Gst.Iterator Retrieves an iterator of element's sink pads.
Gst.Pad Method	iterate_internal_links () : Gst.Iterator Gets an iterator for the pads to which the given pad is linked to inside of the parent element.
Gst.Pad Method	iterate_internal_links_default () : Gst.Iterator Iterate the list of pads to which the given pad is linked to inside of the parent element.

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Tue Jun 22 2010 16:33:54 GMT+0800 (HKT)