Back to Seed Clases

GstBase

Classes

Interfaces

Structs

Unions

Enums

BaseSrcFlags

GObject.Object
parent-child marker Gst.Object
GstBase.CollectPads

Class GstBase.CollectPads

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

Collectpads object. Note that data doesn't contain the complete GstCollectData list at all times and should not be used for iterating them.

Properties
Properties		Defined By
	_gst_reserved : void* read only	Gst.Object
	cond : GLib.Cond read only	GstBase.CollectPads
	cookie : Number read only	GstBase.CollectPads
	data : Array read only	GstBase.CollectPads
	eospads : Number read only	GstBase.CollectPads
	flags : Number read only	Gst.Object
	func : [object Object] read only	GstBase.CollectPads
	lock : GLib.Mutex read only	Gst.Object
	name : String	Gst.Object
	name_prefix : String read only	Gst.Object
	numpads : Number read only	GstBase.CollectPads
	object : Gst.Object read only	GstBase.CollectPads
	parent : Gst.Object read only	Gst.Object
	queuedpads : Number read only	GstBase.CollectPads
	refcount : Number read only	Gst.Object
	started : Boolean read only	GstBase.CollectPads
	user_data : void* read only	GstBase.CollectPads

Methods / Constructors
Method / Constructor		Defined By
	new GstBase.CollectPads (Object *properties) Create a new GstBase.CollectPads Create a new GstBase.CollectPads Parameters: Object properties*
	add_pad (Pad *pad, Number size) : GstBase.CollectData Add a pad to the collection of collect pads. Add a pad to the collection of collect pads. The pad has to be a sinkpad. The refcount of the pad is incremented. Use gst_collect_pads_remove_pad() to remove the pad from the collection again. This function will override the chain and event functions of the pad along with the element_private data, which is used to store private information for the collectpads. You specify a size for the returned GstCollectData* structure so that you can use it to store additional information. The pad will be automatically activated in push mode when pads is started. This function calls gst_collect_pads_add_pad() passing a value of NULL for destroy_notify. MT safe. Parameters: Gst.Pad pad Required (not null) Number size Required (not null) Returns: GstBase.CollectData if wrong parameters are supplied.	GstBase.CollectPads
	add_pad_full (Pad *pad, Number size, Function destroy_notify) : GstBase.CollectData structure is freed Add a pad to the collection of collect pads. structure is freed Add a pad to the collection of collect pads. The pad has to be a sinkpad. The refcount of the pad is incremented. Use gst_collect_pads_remove_pad() to remove the pad from the collection again. You specify a size for the returned GstCollectData* structure so that you can use it to store additional information. You can also specify a GstCollectDataDestroyNotify that will be called just before the GstCollectData structure is freed. It is passed the pointer to the structure and should free any custom memory and resources allocated for it. The pad will be automatically activated in push mode when pads is started. MT safe. Parameters: Gst.Pad pad Required (not null) Number size Required (not null) Function (CollectData *data*) : GstBase.CollectData Required (not null) Returns: GstBase.CollectData if wrong parameters are supplied.	GstBase.CollectPads
	available () : Number Query how much bytes can be read from each queued buffer. Query how much bytes can be read from each queued buffer. This means that the result of this call is the maximum number of bytes that can be read from each of the pads. This function should be called with pads LOCK held, such as in the callback. returns 0 if a pad has no queued buffer. MT safe. Returns: Number	GstBase.CollectPads
	collect () : Gst.FlowReturn Collect data on all pads. Collect data on all pads. This function is usually called from a GstTask function in an element. This function is currently not implemented. MT safe. Returns: Gst.FlowReturn	GstBase.CollectPads
	collect_range (Number *offset, Number length) : Gst.FlowReturn Collect data with offset* and length on all pads. Collect data with offset and length on all pads. This function is typically called in the getrange function of an element. This function is currently not implemented. MT safe. Parameters: Number offset Required (not null) Number length Required (not null) Returns: Gst.FlowReturn	GstBase.CollectPads
	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
	flush (CollectData *data, Number size) : Number Flush size* bytes from the pad data. Flush size bytes from the pad data. This function should be called with pads LOCK held, such as in the callback. is 0 if the pad was end-of-stream. MT safe. Parameters: GstBase.CollectData data Required (not null) Number size Required (not null) Returns: Number	GstBase.CollectPads
	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
	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
	is_active (Pad *pad) : Boolean Check if a pad is active. Check if a pad is active. This function is currently not implemented. MT safe. Parameters: Gst.Pad pad* Required (not null) Returns: Boolean	GstBase.CollectPads
	peek (CollectData *data) : Gst.Buffer Peek at the buffer currently queued in data. Peek at the buffer currently queued in data. This function should be called with the pads* LOCK held, such as in the callback handler. MT safe. Parameters: GstBase.CollectData data Required (not null) Returns: Gst.Buffer should unref the buffer after usage.	GstBase.CollectPads
	pop (CollectData *data) : Gst.Buffer Pop the buffer currently queued in data. Pop the buffer currently queued in data. This function should be called with the pads* LOCK held, such as in the callback handler. MT safe. Parameters: GstBase.CollectData data Required (not null) Returns: Gst.Buffer You should unref the buffer after usage.	GstBase.CollectPads
	read (CollectData *data, Object out_values, Number size) : Number Get a pointer in bytes* where size bytes can be read from the given pad data. Get a pointer in bytes where size bytes can be read from the given pad data. This function should be called with pads LOCK held, such as in the callback. memory pointed to by bytes. This can be less than size and is 0 if the pad is end-of-stream. MT safe. Parameters: GstBase.CollectData data Required (not null) Object out_values Number bytes Number size Required (not null) Returns: Number	GstBase.CollectPads
	read_buffer (CollectData *data, Number size) : Gst.Buffer Get a buffer of size* bytes from the given pad data. Get a buffer of size bytes from the given pad data. This function should be called with pads LOCK held, such as in the callback. A return of NULL signals that the pad is end-of-stream. Unref the buffer after use. MT safe. Parameters: GstBase.CollectData data Required (not null) Number size Required (not null) Returns: Gst.Buffer	GstBase.CollectPads
	remove_pad (Pad *pad) : Boolean Remove a pad from the collection of collect pads. Remove a pad from the collection of collect pads. This function will also free the GstCollectData* and all the resources that were allocated with gst_collect_pads_add_pad(). The pad will be deactivated automatically when pads is stopped. MT safe. Parameters: Gst.Pad pad Required (not null) Returns: Boolean	GstBase.CollectPads
	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_clip_function (Function *clipfunc, void *user_data) : none Install a clipping function that is called right after a buffer is received on a pad managed by pads. Install a clipping function that is called right after a buffer is received on a pad managed by pads. See GstCollectDataClipFunction* for more info. Parameters: Function (CollectPads *pads, CollectData data, Buffer buffer, void *user_data) : none Required (not null) void user_data Required (not null) Returns: none	GstBase.CollectPads
	set_flushing (Boolean *flushing) : none Change the flushing state of all the pads in the collection. Change the flushing state of all the pads in the collection. No pad is able to accept anymore data when flushing* is TRUE. Calling this function with flushing FALSE makes pads accept data again. MT safe. Parameters: Boolean flushing Required (not null) Returns: none	GstBase.CollectPads
	set_function (Function *func, void *user_data) : none Set the callback function and user data that will be called when all the pads added to the collection have buffers queued. Set the callback function and user data that will be called when all the pads added to the collection have buffers queued. MT safe. Parameters: Function (CollectPads pads, void *user_data) : none Required (not null) void user_data Required (not null) Returns: none	GstBase.CollectPads
	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
	start () : none Starts the processing of data in the collect_pads. Starts the processing of data in the collect_pads. MT safe. Returns: none	GstBase.CollectPads
	stop () : none Stops the processing of data in the collect_pads. Stops the processing of data in the collect_pads. this function will also unblock any blocking operations. MT safe. Returns: none	GstBase.CollectPads
	take_buffer (CollectData *data, Number size) : Gst.Buffer Get a buffer of size* bytes from the given pad data. Get a buffer of size bytes from the given pad data. Flushes the amount of read bytes. This function should be called with pads LOCK held, such as in the callback. A return of NULL signals that the pad is end-of-stream. Unref the buffer after use. MT safe. Parameters: GstBase.CollectData data Required (not null) Number size Required (not null) Returns: Gst.Buffer	GstBase.CollectPads
	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
	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

Un-official Seed Documentation

GstBase

Classes

Interfaces

Structs

Unions

Enums

Class GstBase.CollectPads