Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gst.Object
Gst.Pad
Gst.ProxyPad
Gst.GhostPad

Class Gst.GhostPad

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

Opaque GstGhostPad structure.

Properties
Properties		Defined By
	_gst_reserved : void* read only	Gst.Object
	acceptcapsfunc : [object Object] read only	Gst.Pad
	activatefunc : [object Object] read only	Gst.Pad
	activatepullfunc : [object Object] read only	Gst.Pad
	activatepushfunc : [object Object] read only	Gst.Pad
	block_callback : [object Object] read only	Gst.Pad
	block_cond : GLib.Cond read only	Gst.Pad
	block_data : void* read only	Gst.Pad
	block_destroy_data : [object Object] read only	Gst.Pad
	bufferallocfunc : [object Object] read only	Gst.Pad
	caps : Gst.Caps read only	Gst.Pad
	chainfunc : [object Object] read only	Gst.Pad
	checkgetrangefunc : [object Object] read only	Gst.Pad
	direction : Gst.PadDirection	Gst.Pad
	do_buffer_signals : Number read only	Gst.Pad
	do_event_signals : Number read only	Gst.Pad
	element_private : void* read only	Gst.Pad
	eventfunc : [object Object] read only	Gst.Pad
	fixatecapsfunc : [object Object] read only	Gst.Pad
	flags : Number read only	Gst.Object
	getcapsfunc : [object Object] read only	Gst.Pad
	getrangefunc : [object Object] read only	Gst.Pad
	intlinkfunc : [object Object] read only	Gst.Pad
	iterintlinkfunc : [object Object] read only	Gst.Pad
	linkfunc : [object Object] read only	Gst.Pad
	lock : GLib.Mutex read only	Gst.Object
	mode : Gst.ActivateMode read only	Gst.Pad
	name : String	Gst.Object
	name_prefix : String read only	Gst.Object
	object : Gst.Object read only	Gst.Pad
	pad : Gst.ProxyPad read only	Gst.GhostPad
	padtemplate : Gst.PadTemplate read only	Gst.Pad
	parent : Gst.Object read only	Gst.Object
	peer : Gst.Pad read only	Gst.Pad
	preroll_cond : GLib.Cond read only	Gst.Pad
	preroll_lock : GLib.Mutex read only	Gst.Pad
	priv : Gst.GhostPadPrivate read only	Gst.GhostPad
	queryfunc : [object Object] read only	Gst.Pad
	querytypefunc : [object Object] read only	Gst.Pad
	refcount : Number read only	Gst.Object
	sched_private : void* read only	Gst.Pad
	setcapsfunc : [object Object] read only	Gst.Pad
	stream_rec_lock : GLib.StaticRecMutex read only	Gst.Pad
	task : Gst.Task read only	Gst.Pad
	template : Gst.PadTemplate	Gst.Pad
	unlinkfunc : [object Object] read only	Gst.Pad

Methods / Constructors
Method / Constructor		Defined By
	new Gst.GhostPad (Object *properties) Create a new Gst.GhostPad Create a new Gst.GhostPad Parameters: Object properties*
	new Gst.GhostPad.c_new (String *name, Pad target) : Gst.GhostPad Create a new Gst.GhostPad Create a new Gst.GhostPad Parameters: String name* Required (not null) Gst.Pad target Required (not null) Returns: Gst.GhostPad
	new Gst.GhostPad.from_template (String *name, Pad target, PadTemplate templ) : Gst.GhostPad Create a new Gst.GhostPad Create a new Gst.GhostPad Parameters: String name* Required (not null) Gst.Pad target Required (not null) Gst.PadTemplate templ Required (not null) Returns: Gst.GhostPad
	new Gst.GhostPad.no_target (String *name, PadDirection dir) : Gst.GhostPad Create a new Gst.GhostPad Create a new Gst.GhostPad Parameters: String name* Required (not null) Gst.PadDirection dir Required (not null) Returns: Gst.GhostPad
	new Gst.GhostPad.no_target_from_template (String *name, PadTemplate templ) : Gst.GhostPad Create a new Gst.GhostPad Create a new Gst.GhostPad Parameters: String name* Required (not null) Gst.PadTemplate templ Required (not null) Returns: Gst.GhostPad
	accept_caps (Caps *caps) : Boolean Check if the given pad accepts the caps. Check if the given pad accepts the caps. Parameters: Gst.Caps caps* Required (not null) Returns: Boolean	Gst.Pad
	activate_pull (Boolean *active) : Boolean Activates or deactivates the given pad in pull mode via dispatching to the pad's activatepullfunc. Activates or deactivates the given pad in pull mode via dispatching to the pad's activatepullfunc. For use from within pad activation functions only. When called on sink pads, will first proxy the call to the peer pad, which is expected to activate its internally linked pads from within its activate_pull function. If you don't know what this is, you probably don't want to call it. MT safe. Parameters: Boolean active* Required (not null) Returns: Boolean	Gst.Pad
	activate_push (Boolean *active) : Boolean Activates or deactivates the given pad in push mode via dispatching to the pad's activatepushfunc. Activates or deactivates the given pad in push mode via dispatching to the pad's activatepushfunc. For use from within pad activation functions only. If you don't know what this is, you probably don't want to call it. MT safe. Parameters: Boolean active* Required (not null) Returns: Boolean	Gst.Pad
	add_buffer_probe (Function *handler, void *data) : Number Adds a probe that will be called for all buffers passing through a pad. Adds a probe that will be called for all buffers passing through a pad. See gst_pad_add_data_probe() for more information. Parameters: Function () : Number Required (not null) void data Required (not null) Returns: Number	Gst.Pad
	add_buffer_probe_full (Function *handler, void *data, Function notify) : Number Adds a probe that will be called for all buffers passing through a pad. Adds a probe that will be called for all buffers passing through a pad. See gst_pad_add_data_probe() for more information. The notify* function is called when the probe is disconnected and usually used to free data. Parameters: Function () : Number Required (not null) void* data Required (not null) Function (void* *data*) : Number Required (not null) Returns: Number	Gst.Pad
	add_data_probe (Function *handler, void *data) : Number Adds a "data probe" to a pad. Adds a "data probe" to a pad. This function will be called whenever data passes through a pad. In this case data means both events and buffers. The probe will be called with the data as an argument, meaning handler* should have the same callback signature as the GstPad::have-data signal. Note that the data will have a reference count greater than 1, so it will be immutable -- you must not change it. For source pads, the probe will be called after the blocking function, if any (see gst_pad_set_blocked_async()), but before looking up the peer to chain to. For sink pads, the probe function will be called before configuring the sink with new caps, if any, and before calling the pad's chain function. Your data probe should return TRUE to let the data continue to flow, or FALSE to drop it. Dropping data is rarely useful, but occasionally comes in handy with events. Although probes are implemented internally by connecting handler to the have-data signal on the pad, if you want to remove a probe it is insufficient to only call g_signal_handler_disconnect on the returned handler id. To remove a probe, use the appropriate function, such as gst_pad_remove_data_probe(). Parameters: Function () : Number Required (not null) void* data Required (not null) Returns: Number	Gst.Pad
	add_data_probe_full (Function *handler, void *data, Function notify) : Number Adds a "data probe" to a pad. Adds a "data probe" to a pad. This function will be called whenever data passes through a pad. In this case data means both events and buffers. The probe will be called with the data as an argument, meaning handler* should have the same callback signature as the GstPad::have-data signal. Note that the data will have a reference count greater than 1, so it will be immutable -- you must not change it. For source pads, the probe will be called after the blocking function, if any (see gst_pad_set_blocked_async()), but before looking up the peer to chain to. For sink pads, the probe function will be called before configuring the sink with new caps, if any, and before calling the pad's chain function. Your data probe should return TRUE to let the data continue to flow, or FALSE to drop it. Dropping data is rarely useful, but occasionally comes in handy with events. Although probes are implemented internally by connecting handler to the have-data signal on the pad, if you want to remove a probe it is insufficient to only call g_signal_handler_disconnect on the returned handler id. To remove a probe, use the appropriate function, such as gst_pad_remove_data_probe(). The notify function is called when the probe is disconnected and usually used to free data. Parameters: Function () : Number Required (not null) void* data Required (not null) Function (void* *data*) : Number Required (not null) Returns: Number	Gst.Pad
	add_event_probe (Function *handler, void *data) : Number Adds a probe that will be called for all events passing through a pad. Adds a probe that will be called for all events passing through a pad. See gst_pad_add_data_probe() for more information. Parameters: Function () : Number Required (not null) void data Required (not null) Returns: Number	Gst.Pad
	add_event_probe_full (Function *handler, void *data, Function notify) : Number Adds a probe that will be called for all events passing through a pad. Adds a probe that will be called for all events passing through a pad. See gst_pad_add_data_probe() for more information. The notify* function is called when the probe is disconnected and usually used to free data. Parameters: Function () : Number Required (not null) void* data Required (not null) Function (void* *data*) : Number Required (not null) Returns: Number	Gst.Pad
	alloc_buffer (Number *offset, Number size, Caps caps, Buffer buf) : Gst.FlowReturn Allocates a new, empty buffer optimized to push to pad pad. Allocates a new, empty buffer optimized to push to pad pad. This function only works if pad* is a source pad and has a peer. A new, empty GstBuffer will be put in the buf argument. You need to check the caps of the buffer after performing this function and renegotiate to the format if needed. If the caps changed, it is possible that the buffer returned in buf is not of the right size for the new format, buf needs to be unreffed and reallocated if this is the case. result code other than GST_FLOW_OK is an error and buf should not be used. An error can occur if the pad is not connected or when the downstream peer elements cannot provide an acceptable buffer. MT safe. Parameters: Number offset Required (not null) Number size Required (not null) Gst.Caps caps Required (not null) Gst.Buffer buf Required (not null) Returns: Gst.FlowReturn	Gst.Pad
	alloc_buffer_and_set_caps (Number *offset, Number size, Caps caps, Buffer buf) : Gst.FlowReturn In addition to the function gst_pad_alloc_buffer(), this function automatically calls gst_pad_set_caps() when the caps of the newly allocated buffer are different from the pad* caps. In addition to the function gst_pad_alloc_buffer(), this function automatically calls gst_pad_set_caps() when the caps of the newly allocated buffer are different from the pad caps. After a renegotiation, the size of the new buffer returned in buf could be of the wrong size for the new format and must be unreffed an reallocated in that case. result code other than GST_FLOW_OK is an error and buf should not be used. An error can occur if the pad is not connected or when the downstream peer elements cannot provide an acceptable buffer. MT safe. Parameters: Number offset Required (not null) Number size Required (not null) Gst.Caps caps Required (not null) Gst.Buffer buf Required (not null) Returns: Gst.FlowReturn	Gst.Pad
	can_link (Pad *sinkpad) : Boolean Checks if the source pad and the sink pad are compatible so they can be linked. Checks if the source pad and the sink pad are compatible so they can be linked. Parameters: Gst.Pad sinkpad* Required (not null) Returns: Boolean	Gst.Pad
	chain (Buffer *buffer) : Gst.FlowReturn Chain a buffer to pad. Chain a buffer to pad. The function returns GST_FLOW_WRONG_STATE* if the pad was flushing. If the caps on buffer are different from the current caps on pad, this function will call any setcaps function (see gst_pad_set_setcaps_function()) installed on pad. If the new caps are not acceptable for pad, this function returns GST_FLOW_NOT_NEGOTIATED. The function proceeds calling the chain function installed on pad (see gst_pad_set_chain_function()) and the return value of that function is returned to the caller. GST_FLOW_NOT_SUPPORTED is returned if pad has no chain function. In all cases, success or failure, the caller loses its reference to buffer after calling this function. MT safe. Parameters: Gst.Buffer buffer Required (not null) Returns: Gst.FlowReturn	Gst.Pad
	chain_list (BufferList *list) : Gst.FlowReturn Chain a bufferlist to pad. Chain a bufferlist to pad. The function returns GST_FLOW_WRONG_STATE* if the pad was flushing. If the caps on the first buffer of list are different from the current caps on pad, this function will call any setcaps function (see gst_pad_set_setcaps_function()) installed on pad. If the new caps are not acceptable for pad, this function returns GST_FLOW_NOT_NEGOTIATED. The function proceeds calling the chainlist function installed on pad (see gst_pad_set_chain_list_function()) and the return value of that function is returned to the caller. GST_FLOW_NOT_SUPPORTED is returned if pad has no chainlist function. In all cases, success or failure, the caller loses its reference to list after calling this function. MT safe. Parameters: Gst.BufferList list Required (not null) Returns: Gst.FlowReturn	Gst.Pad
	check_pull_range () : Boolean Checks if a gst_pad_pull_range() can be performed on the peer source pad. Checks if a gst_pad_pull_range() can be performed on the peer source pad. This function is used by plugins that want to check if they can use random access on the peer source pad. The peer sourcepad can implement a custom GstPadCheckGetRangeFunction if it needs to perform some logic to determine if pull_range is possible. MT safe. Returns: Boolean	Gst.Pad
	construct () : Boolean Finish initialization of a newly allocated ghost pad. Finish initialization of a newly allocated ghost pad. This function is most useful in language bindings and when subclassing GstGhostPad; plugin and application developers normally will not call this function. Call this function directly after a call to g_object_new (GST_TYPE_GHOST_PAD, "direction", dir, ..., NULL). Returns: Boolean	Gst.GhostPad
	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
	dispatcher (Function *dispatch, void *data) : Boolean Invokes the given dispatcher function on each respective peer of all pads that are internally linked to the given pad. Invokes the given dispatcher function on each respective peer of all pads that are internally linked to the given pad. The GstPadDispatcherFunction should return TRUE when no further pads need to be processed. Parameters: Function (Pad pad, void *data) : Boolean Required (not null) void data Required (not null) Returns: Boolean	Gst.Pad
	event_default (Event *event) : Boolean Invokes the default event handler for the given pad. Invokes the default event handler for the given pad. End-of-stream and discontinuity events are handled specially, and then the event is sent to all pads internally linked to pad. Note that if there are many possible sink pads that are internally linked to pad, only one will be sent an event. Multi-sinkpad elements should implement custom event handlers. Parameters: Gst.Event event* Required (not null) Returns: Boolean	Gst.Pad
	fixate_caps (Caps *caps) : none Fixate a caps on the given pad. Fixate a caps on the given pad. Modifies the caps in place, so you should make sure that the caps are actually writable (see gst_caps_make_writable()). Parameters: Gst.Caps caps* Required (not null) Returns: none	Gst.Pad
	get_allowed_caps () : Gst.Caps Gets the capabilities of the allowed media types that can flow through The allowed capabilities is calculated as the intersection of the results of calling gst_pad_get_caps() on pad and its peer. Gets the capabilities of the allowed media types that can flow through The allowed capabilities is calculated as the intersection of the results of calling gst_pad_get_caps() on pad and its peer. The caller owns a reference on the resulting caps. longer need it. This function returns NULL when pad has no peer. MT safe. Returns: Gst.Caps	Gst.Pad
	get_caps () : Gst.Caps Gets the capabilities this pad can produce or consume. Gets the capabilities this pad can produce or consume. Note that this method doesn't necessarily return the caps set by gst_pad_set_caps() - use GST_PAD_CAPS() for that instead. gst_pad_get_caps returns all possible caps a pad can operate with, using the pad's get_caps function; this returns the pad template caps if not explicitly set. MT safe. Returns: Gst.Caps	Gst.Pad
	get_caps_reffed () : Gst.Caps Gets the capabilities this pad can produce or consume. Gets the capabilities this pad can produce or consume. Preferred function if one only wants to read or intersect the caps. Returns: Gst.Caps	Gst.Pad
	get_direction () : Gst.PadDirection Gets the direction of the pad. Gets the direction of the pad. The direction of the pad is decided at construction time so this function does not take the LOCK. MT safe. Returns: Gst.PadDirection	Gst.Pad
	get_element_private () : void* Gets the private data of a pad. Gets the private data of a pad. No locking is performed in this function. Returns: void*	Gst.Pad
	get_fixed_caps_func () : Gst.Caps A helper function you can use as a GetCaps function that will return the currently negotiated caps or the padtemplate when NULL. A helper function you can use as a GetCaps function that will return the currently negotiated caps or the padtemplate when NULL. Returns: Gst.Caps	Gst.Pad
	get_internal_links () : Array Gets a list of pads to which the given pad is linked to inside of the parent element. Gets a list of pads to which the given pad is linked to inside of the parent element. The caller must free this list after use. Not MT safe. could become invalid by the time the application accesses them. It's also possible that the list changes while handling the pads, which the caller of this function is unable to know. Use the thread-safe gst_pad_iterate_internal_links() instead. Returns: Array	Gst.Pad
	get_internal_links_default () : Array Gets a list of pads to which the given pad is linked to inside of the parent element. Gets a list of pads to which the given pad is linked to inside of the parent element. This is the default handler, and thus returns a list of all of the pads inside the parent element with opposite direction. The caller must free this list after use with g_list_free(). Not MT safe. could become invalid by the time the application accesses them. It's also possible that the list changes while handling the pads, which the caller of this function is unable to know. Use the thread-safe gst_pad_iterate_internal_links_default() instead. Returns: Array	Gst.Pad
	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_negotiated_caps () : Gst.Caps Gets the capabilities of the media type that currently flows through pad and its peer. Gets the capabilities of the media type that currently flows through pad and its peer. This function can be used on both src and sinkpads. Note that srcpads are always negotiated before sinkpads so it is possible that the negotiated caps on the srcpad do not match the negotiated caps of the peer. you no longer need it. This function returns NULL when the pad has no peer or is not negotiated yet. MT safe. Returns: Gst.Caps	Gst.Pad
	get_pad_template () : Gst.PadTemplate Gets the template for pad. Gets the template for pad. if this pad has no template. Returns: Gst.PadTemplate	Gst.Pad
	get_pad_template_caps () : Gst.Caps Gets the capabilities for pad's template. Gets the capabilities for pad's template. reference on the caps, make a copy (see gst_caps_copy ()). Returns: Gst.Caps	Gst.Pad
	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_parent_element () : Gst.Element Gets the parent of pad, cast to a GstElement. Gets the parent of pad, cast to a GstElement. If a pad has no parent or its parent is not an element, return NULL. unref when you're finished with it. MT safe. Returns: Gst.Element	Gst.Pad
	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_peer () : Gst.Pad Gets the peer of pad. Gets the peer of pad. This function refs the peer pad so you need to unref it after use. MT safe. Returns: Gst.Pad	Gst.Pad
	get_query_types () : Gst.QueryType Get an array of supported queries that can be performed on this pad. Get an array of supported queries that can be performed on this pad. Returns: Gst.QueryType	Gst.Pad
	get_query_types_default () : Gst.QueryType Invoke the default dispatcher for the query types on the pad. Invoke the default dispatcher for the query types on the pad. internally-linked pads has a query types function. Returns: Gst.QueryType	Gst.Pad
	get_range (Number *offset, Number size, Buffer buffer) : Gst.FlowReturn When pad* is flushing this function returns GST_FLOW_WRONG_STATE immediatly. When pad is flushing this function returns GST_FLOW_WRONG_STATE immediatly. Calls the getrange function of pad, see GstPadGetRangeFunction for a description of a getrange function. If pad has no getrange function installed (see gst_pad_set_getrange_function()) this function returns GST_FLOW_NOT_SUPPORTED. This is a lowlevel function. Usualy gst_pad_pull_range() is used. MT safe. Parameters: Number offset Required (not null) Number size Required (not null) Gst.Buffer buffer Required (not null) Returns: Gst.FlowReturn	Gst.Pad
	get_target () : Gst.Pad Get the target pad of gpad. Get the target pad of gpad. Unref target pad after usage. has no target set. Unref target pad after usage. Returns: Gst.Pad	Gst.GhostPad
	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 () : Boolean Query if a pad is active MT safe. Query if a pad is active MT safe. Returns: Boolean	Gst.Pad
	is_blocked () : Boolean Checks if the pad is blocked or not. Checks if the pad is blocked or not. This function returns the last requested state of the pad. It is not certain that the pad is actually blocking at this point (see gst_pad_is_blocking()). MT safe. Returns: Boolean	Gst.Pad
	is_blocking () : Boolean Checks if the pad is blocking or not. Checks if the pad is blocking or not. This is a guaranteed state of whether the pad is actually blocking on a GstBuffer or a GstEvent. MT safe. Returns: Boolean	Gst.Pad
	is_linked () : Boolean Checks if a pad is linked to another pad or not. Checks if a pad is linked to another pad or not. MT safe. Returns: Boolean	Gst.Pad
	iterate_internal_links () : Gst.Iterator Gets an iterator for the pads to which the given pad is linked to inside of the parent element. Gets an iterator for the pads to which the given pad is linked to inside of the parent element. Each GstPad element yielded by the iterator will have its refcount increased, so unref after use. iterator function configured. Use gst_iterator_free() after usage. Returns: Gst.Iterator	Gst.Pad
	iterate_internal_links_default () : Gst.Iterator Iterate the list of pads to which the given pad is linked to inside of the parent element. Iterate the list of pads to which the given pad is linked to inside of the parent element. This is the default handler, and thus returns an iterator of all of the pads inside the parent element with opposite direction. The caller must free this iterator after use with gst_iterator_free(). returned pad with gst_object_unref(). Returns: Gst.Iterator	Gst.Pad
	link (Pad *sinkpad) : Gst.PadLinkReturn Links the source pad and the sink pad. Links the source pad and the sink pad. MT Safe. Parameters: Gst.Pad sinkpad* Required (not null) Returns: Gst.PadLinkReturn what went wrong.	Gst.Pad
	pause_task () : Boolean Pause the task of pad. Pause the task of pad. This function will also wait until the function executed by the task is finished if this function is not called from the task function. has no task. Returns: Boolean	Gst.Pad
	peer_accept_caps (Caps *caps) : Boolean Check if the peer of pad* accepts caps. Check if the peer of pad accepts caps. If pad has no peer, this function returns TRUE. Parameters: Gst.Caps caps Required (not null) Returns: Boolean	Gst.Pad
	peer_get_caps () : Gst.Caps Gets the capabilities of the peer connected to this pad. Gets the capabilities of the peer connected to this pad. Similar to gst_pad_get_caps(). gst_caps_unref() to get rid of it. This function returns NULL if there is no peer pad. Returns: Gst.Caps	Gst.Pad
	peer_get_caps_reffed () : Gst.Caps Gets the capabilities of the peer connected to this pad. Gets the capabilities of the peer connected to this pad. Preferred function if one only wants to read or intersect the caps. Returns: Gst.Caps	Gst.Pad
	peer_query (Query *query) : Boolean Performs gst_pad_query() on the peer of pad. Performs gst_pad_query() on the peer of pad. The caller is responsible for both the allocation and deallocation of the query structure. if pad* has no peer. Parameters: Gst.Query query Required (not null) Returns: Boolean	Gst.Pad
	proxy_getcaps () : Gst.Caps Calls gst_pad_get_allowed_caps() for every other pad belonging to the same element as pad, and returns the intersection of the results. Calls gst_pad_get_allowed_caps() for every other pad belonging to the same element as pad, and returns the intersection of the results. This function is useful as a default getcaps function for an element that can handle any stream format, but requires all its pads to have the same caps. Two such elements are tee and adder. Returns: Gst.Caps	Gst.Pad
	proxy_setcaps (Caps *caps) : Boolean Parameters: Gst.Caps caps* Required (not null) Returns: Boolean	Gst.Pad
	pull_range (Number *offset, Number size, Buffer buffer) : Gst.FlowReturn Pulls a buffer* from the peer pad. Pulls a buffer from the peer pad. This function will first trigger the pad block signal if it was installed. When pad is not linked GST_FLOW_NOT_LINKED is returned else this function returns the result of gst_pad_get_range() on the peer pad. See gst_pad_get_range() for a list of return values and for the semantics of the arguments of this function. configured on pad. Renegotiation within a running pull-mode pipeline is not supported. When this function returns GST_FLOW_OK, buffer will contain a valid GstBuffer that should be freed with gst_buffer_unref() after usage. GST_FLOW_OK is returned. MT safe. Parameters: Number offset Required (not null) Number size Required (not null) Gst.Buffer buffer Required (not null) Returns: Gst.FlowReturn	Gst.Pad
	push (Buffer *buffer) : Gst.FlowReturn Pushes a buffer to the peer of pad. Pushes a buffer to the peer of pad. This function will call an installed pad block before triggering any installed pad probes. If the caps on buffer* are different from the currently configured caps on gst_pad_set_setcaps_function()). In case of failure to renegotiate the new format, this function returns GST_FLOW_NOT_NEGOTIATED. The function proceeds calling gst_pad_chain() on the peer pad and returns the value from that function. If pad has no peer, GST_FLOW_NOT_LINKED will be returned. In all cases, success or failure, the caller loses its reference to buffer after calling this function. MT safe. Parameters: Gst.Buffer buffer Required (not null) Returns: Gst.FlowReturn	Gst.Pad
	push_event (Event *event) : Boolean Sends the event to the peer of the given pad. Sends the event to the peer of the given pad. This function is mainly used by elements to send events to their peer elements. This function takes owership of the provided event so you should gst_event_ref() it if you want to reuse the event after this call. MT safe. Parameters: Gst.Event event* Required (not null) Returns: Boolean	Gst.Pad
	push_list (BufferList *list) : Gst.FlowReturn Pushes a buffer list to the peer of pad. Pushes a buffer list to the peer of pad. This function will call an installed pad block before triggering any installed pad probes. If the caps on the first buffer in the first group of list* are different from the currently configured caps on pad, this function will call any installed setcaps function on pad (see gst_pad_set_setcaps_function()). In case of failure to renegotiate the new format, this function returns GST_FLOW_NOT_NEGOTIATED. If there are any probes installed on pad every group of the buffer list will be merged into a normal GstBuffer and pushed via gst_pad_push and the buffer list will be unreffed. The function proceeds calling the chain function on the peer pad and returns the value from that function. If pad has no peer, GST_FLOW_NOT_LINKED will be returned. If the peer pad does not have any installed chainlist function every group buffer of the list will be merged into a normal GstBuffer and chained via gst_pad_chain(). In all cases, success or failure, the caller loses its reference to list after calling this function. MT safe. Parameters: Gst.BufferList list Required (not null) Returns: Gst.FlowReturn	Gst.Pad
	query (Query *query) : Boolean Dispatches a query to a pad. Dispatches a query to a pad. The query should have been allocated by the caller via one of the type-specific allocation functions in gstquery.h. The element is responsible for filling the query with an appropriate response, which should then be parsed with a type-specific query parsing function. Again, the caller is responsible for both the allocation and deallocation of the query structure. Parameters: Gst.Query query* Required (not null) Returns: Boolean	Gst.Pad
	query_convert (Format *src_format, Number src_val, Format dest_format, Object out_values) : Boolean Queries a pad to convert src_val* in src_format to dest_format. Queries a pad to convert src_val in src_format to dest_format. Parameters: Gst.Format src_format Required (not null) Number src_val Required (not null) Gst.Format dest_format Required (not null) Object out_values Number dest_val Returns: Boolean	Gst.Pad
	query_default (Query *query) : Boolean Invokes the default query handler for the given pad. Invokes the default query handler for the given pad. The query is sent to all pads internally linked to pad. Note that if there are many possible sink pads that are internally linked to Multi-sinkpad elements should implement custom query handlers. Parameters: Gst.Query query* Required (not null) Returns: Boolean	Gst.Pad
	query_duration (Format *format, Object out_values) : Boolean Queries a pad for the total stream duration. Queries a pad for the total stream duration. Parameters: Gst.Format format* Required (not null) On return contains the GstFormat used. Object out_values Number duration Returns: Boolean	Gst.Pad
	query_peer_convert (Format *src_format, Number src_val, Format dest_format, Object out_values) : Boolean Queries the peer pad of a given sink pad to convert src_val* in src_format to dest_format. Queries the peer pad of a given sink pad to convert src_val in src_format to dest_format. Parameters: Gst.Format src_format Required (not null) Number src_val Required (not null) Gst.Format dest_format Required (not null) Object out_values Number dest_val Returns: Boolean	Gst.Pad
	query_peer_duration (Format *format, Object out_values) : Boolean Queries the peer pad of a given sink pad for the total stream duration. Queries the peer pad of a given sink pad for the total stream duration. Parameters: Gst.Format format* Required (not null) On return contains the GstFormat used. Object out_values Number duration Returns: Boolean	Gst.Pad
	query_peer_position (Format *format, Object out_values) : Boolean Queries the peer of a given sink pad for the stream position. Queries the peer of a given sink pad for the stream position. Parameters: Gst.Format format* Required (not null) On return contains the GstFormat used. Object out_values Number cur Returns: Boolean	Gst.Pad
	query_position (Format *format, Object out_values) : Boolean Queries a pad for the stream position. Queries a pad for the stream position. Parameters: Gst.Format format* Required (not null) a pointer to the GstFormat asked for. On return contains the GstFormat used. Object out_values Number cur Returns: Boolean	Gst.Pad
	remove_buffer_probe (Number *handler_id) : none Removes a buffer probe from pad. Removes a buffer probe from pad. Parameters: Number handler_id* Required (not null) Returns: none	Gst.Pad
	remove_data_probe (Number *handler_id) : none Removes a data probe from pad. Removes a data probe from pad. Parameters: Number handler_id* Required (not null) Returns: none	Gst.Pad
	remove_event_probe (Number *handler_id) : none Removes an event probe from pad. Removes an event probe from pad. Parameters: Number handler_id* Required (not null) Returns: none	Gst.Pad
	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
	send_event (Event *event) : Boolean Sends the event to the pad. Sends the event to the pad. This function can be used by applications to send events in the pipeline. If pad* is a source pad, event should be an upstream event. If pad is a sink pad, event should be a downstream event. For example, you would not send a GST_EVENT_EOS on a src pad; EOS events only propagate downstream. Furthermore, some downstream events have to be serialized with data flow, like EOS, while some can travel out-of-band, like GST_EVENT_FLUSH_START. If the event needs to be serialized with data flow, this function will take the pad's stream lock while calling its event function. To find out whether an event type is upstream, downstream, or downstream and serialized, see GstEventTypeFlags, gst_event_type_get_flags(), GST_EVENT_IS_UPSTREAM, GST_EVENT_IS_DOWNSTREAM, and GST_EVENT_IS_SERIALIZED. Note that in practice that an application or plugin doesn't need to bother itself with this information; the core handles all necessary locks and checks. This function takes owership of the provided event so you should gst_event_ref() it if you want to reuse the event after this call. Parameters: Gst.Event event Required (not null) Returns: Boolean	Gst.Pad
	set_acceptcaps_function (Function *acceptcaps) : none Sets the given acceptcaps function for the pad. Sets the given acceptcaps function for the pad. The acceptcaps function will be called to check if the pad can accept the given caps. Setting the acceptcaps function to NULL restores the default behaviour of allowing any caps that matches the caps from gst_pad_get_caps. Parameters: Function (Pad pad, Caps caps*) : none Required (not null) Returns: none	Gst.Pad
	set_activate_function (Function *activate) : none Sets the given activate function for pad. Sets the given activate function for pad. The activate function will dispatch to gst_pad_activate_push() or gst_pad_activate_pull() to perform the actual activation. Only makes sense to set on sink pads. Call this function if your sink pad can start a pull-based task. Parameters: Function (Pad pad*) : none Required (not null) Returns: none	Gst.Pad
	set_activatepull_function (Function *activatepull) : none Sets the given activate_pull function for the pad. Sets the given activate_pull function for the pad. An activate_pull function prepares the element and any upstream connections for pulling. See XXX part-activation.txt for details. Parameters: Function (Pad pad, Boolean active*) : none Required (not null) Returns: none	Gst.Pad
	set_activatepush_function (Function *activatepush) : none Sets the given activate_push function for the pad. Sets the given activate_push function for the pad. An activate_push function prepares the element for pushing. See XXX part-activation.txt for details. Parameters: Function (Pad pad, Boolean active*) : none Required (not null) Returns: none	Gst.Pad
	set_active (Boolean *active) : Boolean Activates or deactivates the given pad. Activates or deactivates the given pad. Normally called from within core state change functions. If active, makes sure the pad is active. If it is already active, either in push or pull mode, just return. Otherwise dispatches to the pad's activate function to perform the actual activation. If not active, checks the pad's current mode and calls gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a FALSE argument. MT safe. Parameters: Boolean active* Required (not null) Returns: Boolean	Gst.Pad
	set_blocked (Boolean *blocked) : Boolean Blocks or unblocks the dataflow on a pad. Blocks or unblocks the dataflow on a pad. This function is a shortcut for gst_pad_set_blocked_async() with a NULL callback. wrong parameters were passed or the pad was already in the requested state. MT safe. Parameters: Boolean blocked* Required (not null) Returns: Boolean	Gst.Pad
	set_blocked_async (Boolean *blocked, Function callback, void *user_data) : Boolean Blocks or unblocks the dataflow on a pad. Blocks or unblocks the dataflow on a pad. The provided callback is called when the operation succeeds; this happens right before the next attempt at pushing a buffer on the pad. This can take a while as the pad can only become blocked when real dataflow is happening. When the pipeline is stalled, for example in PAUSED, this can take an indeterminate amount of time. You can pass NULL as the callback to make this call block. Be careful with this blocking call as it might not return for reasons stated above. wrong parameters were passed or the pad was already in the requested state. MT safe. Parameters: Boolean blocked* Required (not null) Function (Pad *pad, Boolean blocked, void *user_data) : Boolean Required (not null) operation succeeds void user_data Required (not null) Returns: Boolean	Gst.Pad
	set_blocked_async_full (Boolean *blocked, Function callback, void *user_data, Function destroy_data) : Boolean Blocks or unblocks the dataflow on a pad. Blocks or unblocks the dataflow on a pad. The provided callback is called when the operation succeeds; this happens right before the next attempt at pushing a buffer on the pad. This can take a while as the pad can only become blocked when real dataflow is happening. When the pipeline is stalled, for example in PAUSED, this can take an indeterminate amount of time. You can pass NULL as the callback to make this call block. Be careful with this blocking call as it might not return for reasons stated above. wrong parameters were passed or the pad was already in the requested state. MT safe. Parameters: Boolean blocked* Required (not null) Function (Pad *pad, Boolean blocked, void *user_data) : Boolean Required (not null) operation succeeds void user_data Required (not null) Function (void* *data*) : Boolean Required (not null) Returns: Boolean	Gst.Pad
	set_bufferalloc_function (Function *bufalloc) : none Sets the given bufferalloc function for the pad. Sets the given bufferalloc function for the pad. Note that the bufferalloc function can only be set on sinkpads. Parameters: Function (Pad pad, Number offset, Number size, Caps caps, Buffer buf*) : none Required (not null) Returns: none	Gst.Pad
	set_caps (Caps *caps) : Boolean Sets the capabilities of this pad. Sets the capabilities of this pad. The caps must be fixed. Any previous caps on the pad will be unreffed. This function refs the caps so you should unref if as soon as you don't need it anymore. It is possible to set NULL caps, which will make the pad unnegotiated again. or bad parameters were provided to this function. MT safe. Parameters: Gst.Caps caps* Required (not null) Returns: Boolean	Gst.Pad
	set_chain_function (Function *chain) : none Sets the given chain function for the pad. Sets the given chain function for the pad. The chain function is called to process a GstBuffer* input buffer. see GstPadChainFunction for more details. Parameters: Function (Pad *pad, Buffer buffer*) : none Required (not null) Returns: none	Gst.Pad
	set_chain_list_function (Function *chainlist) : none Sets the given chain list function for the pad. Sets the given chain list function for the pad. The chainlist function is called to process a GstBufferList* input buffer list. See GstPadChainListFunction for more details. Parameters: Function (Pad *pad, BufferList list*) : none Required (not null) Returns: none	Gst.Pad
	set_checkgetrange_function (Function *check) : none Sets the given checkgetrange function for the pad. Sets the given checkgetrange function for the pad. Implement this function on a pad if you dynamically support getrange based scheduling on the pad. Parameters: Function (Pad pad*) : none Required (not null) Returns: none	Gst.Pad
	set_element_private (void* *priv) : none Set the given private data gpointer on the pad. Set the given private data gpointer on the pad. This function can only be used by the element that owns the pad. No locking is performed in this function. Parameters: void priv Required (not null) Returns: none	Gst.Pad
	set_event_function (Function *event) : none Sets the given event handler for the pad. Sets the given event handler for the pad. Parameters: Function (Pad pad, Event event*) : none Required (not null) Returns: none	Gst.Pad
	set_fixatecaps_function (Function *fixatecaps) : none Sets the given fixatecaps function for the pad. Sets the given fixatecaps function for the pad. The fixatecaps function will be called whenever the default values for a GstCaps needs to be filled in. Parameters: Function (Pad pad, Caps caps*) : none Required (not null) Returns: none	Gst.Pad
	set_getcaps_function (Function *getcaps) : none Sets the given getcaps function for the pad. Sets the given getcaps function for the pad. getcaps* should return the allowable caps for a pad in the context of the element's state, its link to other elements, and the devices or files it has opened. These caps must be a subset of the pad template caps. In the NULL state with no links, getcaps should ideally return the same caps as the pad template. In rare circumstances, an object property can affect the caps returned by getcaps, but this is discouraged. You do not need to call this function if pad's allowed caps are always the same as the pad template caps. This can only be true if the padtemplate has fixed simple caps. For most filters, the caps returned by getcaps is directly affected by the allowed caps on other pads. For demuxers and decoders, the caps returned by the srcpad's getcaps function is directly related to the stream data. Again, helps with autoplugging. Note that the return value from getcaps is owned by the caller, so the caller should unref the caps after usage. Parameters: Function (Pad *pad*) : none Required (not null) Returns: none	Gst.Pad
	set_getrange_function (Function *get) : none Sets the given getrange function for the pad. Sets the given getrange function for the pad. The getrange function is called to produce a new GstBuffer* to start the processing pipeline. see GstPadGetRangeFunction for a description of the getrange function. Parameters: Function (Pad *pad, Number offset, Number length, Buffer buffer*) : none Required (not null) Returns: none	Gst.Pad
	set_internal_link_function (Function *intlink) : none Sets the given internal link function for the pad. Sets the given internal link function for the pad. Parameters: Function (Pad pad*) : none Required (not null) Returns: none	Gst.Pad
	set_iterate_internal_links_function (Function *iterintlink) : none Sets the given internal link iterator function for the pad. Sets the given internal link iterator function for the pad. Parameters: Function (Pad pad*) : none Required (not null) Returns: none	Gst.Pad
	set_link_function (Function *link) : none Sets the given link function for the pad. Sets the given link function for the pad. It will be called when the pad is linked with another pad. The return value GST_PAD_LINK_OK* should be used when the connection can be made. The return value GST_PAD_LINK_REFUSED should be used when the connection cannot be made for some reason. If link is installed on a source pad, it should call the GstPadLinkFunction of the peer sink pad, if present. Parameters: Function (Pad *pad, Pad peer*) : none Required (not null) Returns: none	Gst.Pad
	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_query_function (Function *query) : none Set the given query function for the pad. Set the given query function for the pad. Parameters: Function (Pad pad, Query query*) : none Required (not null) Returns: none	Gst.Pad
	set_query_type_function (Function *type_func) : none Set the given query type function for the pad. Set the given query type function for the pad. Parameters: Function (Pad pad*) : none Required (not null) Returns: none	Gst.Pad
	set_setcaps_function (Function *setcaps) : none Sets the given setcaps function for the pad. Sets the given setcaps function for the pad. The setcaps function will be called whenever a buffer with a new media type is pushed or pulled from the pad. The pad/element needs to update its internal structures to process the new media type. If this new type is not acceptable, the setcaps function should return FALSE. Parameters: Function (Pad pad, Caps caps*) : none Required (not null) Returns: none	Gst.Pad
	set_target (Pad *newtarget) : Boolean Set the new target of the ghostpad gpad. Set the new target of the ghostpad gpad. Any existing target is unlinked and links to the new target are established. if newtarget* is NULL the target will be cleared. when the internal pads could not be linked. Parameters: Gst.Pad newtarget Required (not null) Returns: Boolean	Gst.GhostPad
	set_unlink_function (Function *unlink) : none Sets the given unlink function for the pad. Sets the given unlink function for the pad. It will be called when the pad is unlinked. Parameters: Function (Pad pad*) : none Required (not null) Returns: none	Gst.Pad
	start_task (Function *func, void *data) : Boolean Starts a task that repeatedly calls func* with data. Starts a task that repeatedly calls func with data. This function is mostly used in pad activation functions to start the dataflow. The GST_PAD_STREAM_LOCK of pad will automatically be acquired before func is called. Parameters: Function (void* *data) : Boolean Required (not null) void data Required (not null) Returns: Boolean	Gst.Pad
	stop_task () : Boolean Stop the task of pad. Stop the task of pad. This function will also make sure that the function executed by the task will effectively stop if not called from the GstTaskFunction. This function will deadlock if called from the GstTaskFunction of the task. Use gst_task_pause() instead. Regardless of whether the pad has a task, the stream lock is acquired and released so as to ensure that streaming through this pad has finished. Returns: Boolean	Gst.Pad
	unlink (Pad *sinkpad) : Boolean Unlinks the source pad from the sink pad. Unlinks the source pad from the sink pad. Will emit the GstPad::unlinked signal on both pads. the pads were not linked together. MT safe. Parameters: Gst.Pad sinkpad* Required (not null) Returns: Boolean	Gst.Pad
	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
	use_fixed_caps () : none A helper function you can use that sets the pad. A helper function you can use that sets the pad. This way the function will always return the negotiated caps or in case the pad is not negotiated, the padtemplate caps. Use this function on a pad that, once gst_pad_set_caps() has been called on it, cannot be renegotiated to something else. Returns: none	Gst.Pad

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
	have_data (Pad *self, MiniObject mini_obj) : Boolean Signals that new data is available on the pad. Signals that new data is available on the pad. This signal is used internally for implementing pad probes. See gst_pad_add__probe functions. Parameters: Gst.Pad self Gst.MiniObject mini_obj Returns: {Boolean}	Gst.Pad
	linked (Pad *self, Pad peer) : none Signals that a pad has been linked to the peer pad. Signals that a pad has been linked to the peer pad. Parameters: Gst.Pad self* Gst.Pad peer Returns: {none}	Gst.Pad
	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
	request_link (Pad *self) : none Signals that a pad connection has been requested. Signals that a pad connection has been requested. Parameters: Gst.Pad self* Returns: {none}	Gst.Pad
	unlinked (Pad *self, Pad peer) : none Signals that a pad has been unlinked from the peer pad. Signals that a pad has been unlinked from the peer pad. Parameters: Gst.Pad self* Gst.Pad peer Returns: {none}	Gst.Pad

Un-official Seed Documentation

Gst

Classes

Interfaces

Structs

Unions

Enums

Class Gst.GhostPad