Optionalproperties: Partial<GstGL.GLMixerPad.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeThe parent of the object. Please note, that when changing the 'parent' property, we don't emit GObject.Object::notify and Gst.Object.SignalSignatures.deep_notify | Gst.Object::deep-notify signals due to locking issues. In some cases one can use Gst.Bin.SignalSignatures.element_added | Gst.Bin::element-added or Gst.Bin.SignalSignatures.element_removed | Gst.Bin::element-removed signals on the parent to achieve a similar effect.
SignalconnectSignalconnect_SignalemitActivates or deactivates the given pad in mode via dispatching to the
pad's activatemodefunc. For use from within pad activation functions only.
If you don't know what this is, you probably don't want to call it.
true if the operation was successful. MT safe.
Attach the Gst.ControlBinding to the object. If there already was a Gst.ControlBinding for this property it will be replaced.
The object's reference count will be incremented, and any floating
reference will be removed (see gst_object_ref_sink())
the Gst.ControlBinding that should be used
false if the given binding has not been setup for this object or has been setup for a non suitable property, true otherwise.
Be notified of different states of pads. The provided callback is called for
every state that matches mask.
Probes are called in groups: First GST_PAD_PROBE_TYPE_BLOCK probes are
called, then others, then finally GST_PAD_PROBE_TYPE_IDLE. The only
exception here are GST_PAD_PROBE_TYPE_IDLE probes that are called
immediately if the pad is already idle while calling gst_pad_add_probe().
In each of the groups, probes are called in the order in which they were
added.
the probe mask
Gst.PadProbeCallback that will be called with notifications of the pad state
an id or 0 if no probe is pending. The id can be used to remove the probe with gst_pad_remove_probe(). When using GST_PAD_PROBE_TYPE_IDLE it can happen that the probe can be run immediately and if the probe returns GST_PAD_PROBE_REMOVE this functions returns 0. MT safe.
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Equivalent to gst_element_call_async() but this API allows func to be called
with Gst.Object. See also gst_element_call_async()
function to call asynchronously from another thread
Chain a buffer to pad.
The function returns #GST_FLOW_FLUSHING if the pad was flushing.
If the buffer type is not acceptable for pad (as negotiated with a
preceding GST_EVENT_CAPS event), 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.
the Gst.Buffer to send, return GST_FLOW_ERROR if not.
a Gst.FlowReturn from the pad. MT safe.
Chain a bufferlist to pad.
The function returns #GST_FLOW_FLUSHING if the pad was flushing.
If pad was not negotiated properly with a CAPS event, 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.
the Gst.BufferList to send, return GST_FLOW_ERROR if not.
a Gst.FlowReturn from the pad.
Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on pad and return true
if the flag was set.
true is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on pad.
Creates a stream-id for the source Gst.Pad pad by combining the
upstream information with the optional stream_id of the stream
of pad. pad must have a parent Gst.Element and which must have zero
or one sinkpad. stream_id can only be null if the parent element
of pad has only a single source pad.
This function generates an unique stream-id by getting the upstream
stream-start event stream ID and appending stream_id to it. If the
element has no sinkpad it will generate an upstream stream-id by
doing an URI query on the element and in the worst case just uses
a random number. Source elements that don't implement the URI
handler interface should ideally generate a unique, deterministic
stream-id manually instead.
Since stream IDs are sorted alphabetically, any numbers in the stream ID should be printed with a fixed number of characters, preceded by 0's, such as by using the format %03u instead of %u.
Parent Gst.Element of pad
Optionalstream_id: stringThe stream-id
A stream-id for pad. g_free() after usage.
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
Drop the buffer currently queued in pad.
TRUE if there was a buffer queued in pad, or FALSE if not.
Invokes the default event handler for the given pad.
The EOS event will pause the task associated with pad before it is forwarded
to all internally linked pads,
The event is sent to all pads internally linked to pad. This function
takes ownership of event.
true if the event was sent successfully.
This function is intended for GObject.Object implementations to re-enforce
a floating object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Calls forward for all internally linked pads of pad. This function deals with
dynamically changing internal pads and will make sure that the forward
function is only called once for each pad.
When forward returns true, no further pads will be processed.
true if one of the dispatcher functions returned true.
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets the capabilities of the allowed media types that can flow through
pad and its peer.
The allowed capabilities is calculated as the intersection of the results of
calling gst_pad_query_caps() on pad and its peer. The caller owns a reference
on the resulting caps.
the allowed Gst.Caps of the pad link. Unref the caps when you no longer need it. This function returns null when pad has no peer. MT safe.
Gets the corresponding Gst.ControlBinding for the property. This should be unreferenced again after use.
name of the property
the Gst.ControlBinding for property_name or null if the property is not controlled.
Obtain the control-rate for this object. Audio processing Gst.Element
objects will use this rate to sub-divide their processing loop and call
gst_object_sync_values() in between. The length of the processing segment
should be up to control-rate nanoseconds.
If the object is not under property control, this will return
GST_CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.
The control-rate is not expected to change if the element is in Gst.State.PAUSED or Gst.State.PLAYING.
the control rate in nanoseconds
Returns the currently queued buffer that is going to be used for the current output frame.
This must only be called from the GstVideo.VideoAggregatorClass.SignalSignatures.aggregate_frames | GstVideo.VideoAggregatorClass::aggregate_frames virtual method, or from the GstVideo.VideoAggregatorPadClass.SignalSignatures.prepare_frame | GstVideo.VideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.
The return value is only valid until GstVideo.VideoAggregatorClass.SignalSignatures.aggregate_frames | GstVideo.VideoAggregatorClass::aggregate_frames or GstVideo.VideoAggregatorPadClass.SignalSignatures.prepare_frame | GstVideo.VideoAggregatorPadClass::prepare_frame returns.
The currently queued buffer
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets the direction of the pad. The direction of the pad is decided at construction time so this function does not take the LOCK.
the Gst.PadDirection of the pad. MT safe.
Gets the private data of a pad. No locking is performed in this function.
a gpointer to the private data.
Gets a number of GValues for the given controlled property starting at the
requested time. The array values need to hold enough space for n_values of
GObject.Value.
This function is useful if one wants to e.g. draw a graph of the control curve or apply a control curve sample by sample.
the name of the property to get
the time that should be processed
the time spacing between subsequent values
array to put control-values in
true if the given array could be filled, false otherwise
Gets the Gst.FlowReturn return from the last data passed by this pad.
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.
Free-function: g_free
the name of object. g_free() after usage. MT safe. This function grabs and releases object's LOCK.
Get the offset applied to the running time of pad. pad has to be a source
pad.
the offset.
Gets the template for pad.
the Gst.PadTemplate from which this pad was instantiated, or null if this pad has no template. Unref after usage.
Gets the parent of pad, cast to a Gst.Element. If a pad has no parent or
its parent is not an element, return null.
the parent of the pad. The caller has a reference on the parent, so unref when you're finished with it. MT safe.
Generates a string describing the path of object in
the object hierarchy. Only useful (or used) for debugging.
Free-function: g_free
a string describing the path of object. You must g_free() the string after usage. MT safe. Grabs and releases the Gst.Object's LOCK for all objects in the hierarchy.
Returns the currently prepared video frame that has to be aggregated into the current output frame.
This must only be called from the GstVideo.VideoAggregatorClass.SignalSignatures.aggregate_frames | GstVideo.VideoAggregatorClass::aggregate_frames virtual method, or from the GstVideo.VideoAggregatorPadClass.SignalSignatures.prepare_frame | GstVideo.VideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.
The return value is only valid until GstVideo.VideoAggregatorClass.SignalSignatures.aggregate_frames | GstVideo.VideoAggregatorClass::aggregate_frames or GstVideo.VideoAggregatorPadClass.SignalSignatures.prepare_frame | GstVideo.VideoAggregatorPadClass::prepare_frame returns.
The currently prepared video frame
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
When pad is flushing this function returns #GST_FLOW_FLUSHING
immediately and buffer is null.
Calls the getrange function of pad, see Gst.PadGetRangeFunction 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.
If buffer points to a variable holding null, a valid new Gst.Buffer will be
placed in buffer when this function returns #GST_FLOW_OK. The new buffer
must be freed with gst_buffer_unref() after usage.
When buffer points to a variable that points to a valid Gst.Buffer, the
buffer will be filled with the result data when this function returns
#GST_FLOW_OK. If the provided buffer is larger than size, only
size bytes will be filled in the result buffer and its size will be updated
accordingly.
Note that less than size bytes can be returned in buffer when, for example,
an EOS condition is near or when buffer is not large enough to hold size
bytes. The caller should check the result buffer size to get the result size.
When this function returns any other result value than #GST_FLOW_OK, buffer
will be unchanged.
This is a lowlevel function. Usually gst_pad_pull_range() is used.
The start offset of the buffer
The length of the buffer
a Gst.FlowReturn from the pad. MT safe.
Returns a new reference of the sticky event of type event_type
from the event.
the Gst.EventType that should be retrieved.
the index of the event
a Gst.Event of type event_type or null when no event of event_type was on pad. Unref after usage.
Returns the current Gst.Stream for the pad, or null if none has been
set yet, i.e. the pad has not received a stream-start event yet.
This is a convenience wrapper around gst_pad_get_sticky_event() and
gst_event_parse_stream().
the current Gst.Stream for pad, or null. unref the returned stream when no longer needed.
Returns the current stream-id for the pad, or null if none has been
set yet, i.e. the pad has not received a stream-start event yet.
This is a convenience wrapper around gst_pad_get_sticky_event() and
gst_event_parse_stream_start().
The returned stream-id string should be treated as an opaque string, its contents should not be interpreted.
a newly-allocated copy of the stream-id for pad, or null. g_free() the returned string when no longer needed.
Gets the value for the given controlled property at the requested time.
the name of the property to get
the time the control-change should be read from
the GValue of the property at the given time, or null if the property isn't controlled.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Check if the object has active controlled properties.
true if the object has active controlled properties
Check if object has an ancestor ancestor somewhere up in
the hierarchy. One can e.g. check if a Gst.Element is inside a Gst.Pipeline.
a Gst.Object to check as ancestor
true if ancestor is an ancestor of object.
Check if object has an ancestor ancestor somewhere up in
the hierarchy. One can e.g. check if a Gst.Element is inside a Gst.Pipeline.
a Gst.Object to check as ancestor
true if ancestor is an ancestor of object. MT safe. Grabs and releases object's locks.
Check if parent is the parent of object.
E.g. a Gst.Element can check if it owns a given Gst.Pad.
a Gst.Object to check as parent
false if either object or parent is null. true if parent is the parent of object. Otherwise false. MT safe. Grabs and releases object's locks.
This checks if a pad has a buffer available that will be returned by
a call to gst_aggregator_pad_peek_buffer() or
gst_aggregator_pad_pop_buffer().
true if the pad has a buffer available as the next thing.
Checks if the pad currently has a buffer queued that is going to be used for the current output frame.
This must only be called from the GstVideo.VideoAggregatorClass.SignalSignatures.aggregate_frames | GstVideo.VideoAggregatorClass::aggregate_frames virtual method, or from the GstVideo.VideoAggregatorPadClass.SignalSignatures.prepare_frame | GstVideo.VideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.
true if the pad has currently a buffer queued
Check if pad has caps set on it with a #GST_EVENT_CAPS event.
true when pad has caps associated with it.
Query if a pad is active
true if the pad is active. MT safe.
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()).
true if the pad is blocked. MT safe.
Checks if the pad is blocking or not. This is a guaranteed state of whether the pad is actually blocking on a Gst.Buffer or a Gst.Event.
true if the pad is blocking. MT safe.
true if the pad is EOS, otherwise false.
Checks whether object has a floating reference.
true if object has a floating reference
It is only valid to call this method from GstBase.AggregatorClass.SignalSignatures.aggregate | GstBase.AggregatorClass::aggregate()
true if the pad is inactive, false otherwise. See gst_aggregator_ignore_inactive_pads() for more info.
Checks if a pad is linked to another pad or not.
true if the pad is linked, false otherwise. MT safe.
Gets an iterator for the pads to which the given pad is linked to inside of the parent element.
Each Gst.Pad element yielded by the iterator will have its refcount increased, so unref after use.
Free-function: gst_iterator_free
a new Gst.Iterator of Gst.Pad or null when the pad does not have an iterator function configured. Use gst_iterator_free() after usage.
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().
a Gst.Iterator of Gst.Pad, or null if pad has no parent. Unref each returned pad with gst_object_unref().
Links the source pad and the sink pad.
A result code indicating if the connection worked or what went wrong. MT Safe.
Links the source pad and the sink pad.
This variant of gst_pad_link provides a more granular control on the
checks being done when linking. While providing some considerable speedups
the caller of this method must be aware that wrong usage of those flags
can cause severe issues. Refer to the documentation of Gst.PadLinkCheck
for more information.
MT Safe.
the sink Gst.Pad to link.
the checks to validate when linking
A result code indicating if the connection worked or what went wrong.
Links src to sink, creating any Gst.GhostPad's in between as necessary.
This is a convenience function to save having to create and add intermediate Gst.GhostPad's as required for linking across Gst.Bin boundaries.
If src or sink pads don't have parent elements or do not share a common
ancestor, the link will fail.
whether the link succeeded.
Links src to sink, creating any Gst.GhostPad's in between as necessary.
This is a convenience function to save having to create and add intermediate Gst.GhostPad's as required for linking across Gst.Bin boundaries.
If src or sink pads don't have parent elements or do not share a common
ancestor, the link will fail.
Calling gst_pad_link_maybe_ghosting_full() with
flags == Gst.PadLinkCheck.DEFAULT is the recommended way of linking
pads with safety checks applied.
a Gst.Pad
some Gst.PadLinkCheck flags
whether the link succeeded.
Mark a pad for needing reconfiguration. The next call to
gst_pad_check_reconfigure() will return true after this call.
Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on pad and return true
if the flag was set.
true is the GST_PAD_FLAG_NEED_RECONFIGURE flag is set on pad.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
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.
a true if the task could be paused or false when the pad has no task.
Gets the capabilities of the peer connected to this pad. Similar to
gst_pad_query_caps().
When called on srcpads filter contains the caps that
upstream could produce in the order preferred by upstream. When
called on sinkpads filter contains the caps accepted by
downstream in the preferred order. filter might be null but
if it is not null the returned caps will be a subset of filter.
the caps of the peer pad with incremented ref-count. When there is no peer pad, this function returns filter or, when filter is null, ANY caps.
Queries the peer pad of a given sink pad to convert src_val in src_format
to dest_format.
a Gst.Format to convert from.
a value to convert.
the Gst.Format to convert to.
true if the query could be performed.
Queries the peer pad of a given sink pad for the total stream duration.
the Gst.Format requested
true if the query could be performed.
Queries the peer of a given sink pad for the stream position.
the Gst.Format requested
true if the query could be performed.
Checks if all internally linked pads of pad accepts the caps in query and
returns the intersection of the results.
This function is useful as a default accept caps query function for an element that can handle any stream format, but requires caps that are acceptable for all opposite pads.
true if query could be executed
Calls gst_pad_query_caps() for all internally linked pads of pad and returns
the intersection of the results.
This function is useful as a default caps query 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.
true if query could be executed
Pulls a buffer from the peer pad or fills up a provided buffer.
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.
If buffer points to a variable holding null, a valid new Gst.Buffer will be
placed in buffer when this function returns #GST_FLOW_OK. The new buffer
must be freed with gst_buffer_unref() after usage. When this function
returns any other result value, buffer will still point to null.
When buffer points to a variable that points to a valid Gst.Buffer, the
buffer will be filled with the result data when this function returns
#GST_FLOW_OK. When this function returns any other result value,
buffer will be unchanged. If the provided buffer is larger than size, only
size bytes will be filled in the result buffer and its size will be updated
accordingly.
Note that less than size bytes can be returned in buffer when, for example,
an EOS condition is near or when buffer is not large enough to hold size
bytes. The caller should check the result buffer size to get the result size.
The start offset of the buffer
The length of the buffer
a Gst.FlowReturn from the peer pad. MT safe.
Pushes a buffer to the peer of pad.
This function will call installed block probes before triggering any installed data probes.
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.
the Gst.Buffer to push returns GST_FLOW_ERROR if not.
a Gst.FlowReturn from the peer pad. MT safe.
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 ownership of the provided event so you should
gst_event_ref() it if you want to reuse the event after this call.
true if the event was handled. MT safe.
Pushes a buffer list to the peer of pad.
This function will call installed block probes before triggering any installed data probes.
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 Gst.Buffer and
chained via gst_pad_chain().
In all cases, success or failure, the caller loses its reference to list
after calling this function.
the Gst.BufferList to push returns GST_FLOW_ERROR if not.
a Gst.FlowReturn from the peer pad. MT safe.
Dispatches a query to a pad. The query should have been allocated by the caller via one of the type-specific allocation functions. The element that the pad belongs to 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.
Please also note that some queries might need a running pipeline to work.
true if the query could be performed.
Gets the capabilities this pad can produce or consume.
Note that this method doesn't necessarily return the caps set by sending a
gst_event_new_caps() - use gst_pad_get_current_caps() for that instead.
gst_pad_query_caps returns all possible caps a pad can operate with, using
the pad's CAPS query function, If the query fails, this function will return
filter, if not null, otherwise ANY.
When called on sinkpads filter contains the caps that
upstream could produce in the order preferred by upstream. When
called on srcpads filter contains the caps accepted by
downstream in the preferred order. filter might be null but
if it is not null the returned caps will be a subset of filter.
Note that this function does not return writable Gst.Caps, use
gst_caps_make_writable() before modifying the caps.
the caps of the pad with incremented ref-count.
Queries a pad to convert src_val in src_format to dest_format.
a Gst.Format to convert from.
a value to convert.
the Gst.Format to convert to.
true if the query could be performed.
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
pad, only one will be sent the query.
Multi-sinkpad elements should implement custom query handlers.
true if the query was performed successfully.
Queries a pad for the total stream duration.
the Gst.Format requested
true if the query could be performed.
Queries a pad for the stream position.
the Gst.Format requested
true if the query could be performed.
Increase the reference count of object, and possibly remove the
floating reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Removes the corresponding Gst.ControlBinding. If it was the last ref of the binding, it will be disposed.
the binding
true if the binding could be removed.
Remove the probe with id from pad.
MT safe.
the probe id to remove
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
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 Gst.EventTypeFlags, 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 ownership of the provided event so you should
gst_event_ref() it if you want to reuse the event after this call.
true if the event was handled.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Sets the given activate function for pad. The activate function will
dispatch to gst_pad_activate_mode() 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.
the Gst.PadActivateFunction to set.
Sets the given activate_mode function for the pad. An activate_mode function prepares the element for data passing.
the Gst.PadActivateModeFunction to set.
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, calls gst_pad_activate_mode() with the pad's current mode
and a false argument.
whether or not the pad should be active.
true if the operation was successful. MT safe.
Sets the given chain function for the pad. The chain function is called to process a Gst.Buffer input buffer. see Gst.PadChainFunction for more details.
the Gst.PadChainFunction to set.
Sets the given chain list function for the pad. The chainlist function is called to process a Gst.BufferList input buffer list. See Gst.PadChainListFunction for more details.
the Gst.PadChainListFunction to set.
This function is used to disable the control bindings on a property for
some time, i.e. gst_object_sync_values() will do nothing for the
property.
property to disable
boolean that specifies whether to disable the controller or not.
This function is used to disable all controlled properties of the object for
some time, i.e. gst_object_sync_values() will do nothing.
boolean that specifies whether to disable the controller or not.
Change the control-rate for this object. Audio processing Gst.Element
objects will use this rate to sub-divide their processing loop and call
gst_object_sync_values() in between. The length of the processing segment
should be up to control-rate nanoseconds.
The control-rate should not change if the element is in Gst.State.PAUSED or Gst.State.PLAYING.
the new control-rate in nanoseconds.
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
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.
Optionalpriv: anyThe private data to attach to the pad.
Sets the given event handler for the pad.
the Gst.PadEventFullFunction to set.
Sets the given event handler for the pad.
the Gst.PadEventFunction to set.
Sets the given getrange function for the pad. The getrange function is called to produce a new Gst.Buffer to start the processing pipeline. see Gst.PadGetRangeFunction for a description of the getrange function.
the Gst.PadGetRangeFunction to set.
Sets the given internal link iterator function for the pad.
the Gst.PadIterIntLinkFunction to set.
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 Gst.PadLinkFunction
of the peer sink pad, if present.
the Gst.PadLinkFunction to set.
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.
Optionalname: stringnew name of object
true if the name could be set. Since Objects that have a parent cannot be renamed, this function returns false in those cases. MT safe. This function grabs and releases object's LOCK.
Allows selecting that this pad requires an output format with alpha
true if this pad requires alpha output
Set the offset that will be applied to the running time of pad. Upon next
buffer, every sticky events (notably segment) will be pushed again with
their running time adjusted. For that reason this is only reliable on
source pads.
the offset
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_ref_sink()).
true if parent could be set or false when object already had a parent or object and parent are the same. MT safe. Grabs and releases object's LOCK.
Sets a property on an object.
The name of the property to set
The value to set the property to
Set the given query function for the pad.
the Gst.PadQueryFunction to set.
Sets the given unlink function for the pad. It will be called when the pad is unlinked.
Note that the pad's lock is already held when the unlink function is called, so most pad functions cannot be called from within the callback.
the Gst.PadUnlinkFunction to set.
Starts a task that repeatedly calls func with user_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.
the task function to call
a true if the task could be started.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Iterates all sticky events on pad and calls foreach_func for every
event. If foreach_func returns false the iteration is immediately stopped.
the Gst.PadStickyEventsForeachFunction that should be called for every event.
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
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.
a true if the task could be stopped or false on error.
Store the sticky event on pad
#GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad was flushing or #GST_FLOW_EOS when the pad was EOS.
Returns a suggestion for timestamps where buffers should be split to get best controller results.
Returns the suggested timestamp or GST_CLOCK_TIME_NONE if no control-rate was set.
Sets the properties of the object, according to the GstControlSources that
(maybe) handle them and for the given timestamp.
If this function fails, it is most likely the application developers fault. Most probably the control sources are not setup correctly.
the time that should be processed
true if the controller values could be applied to the object properties, false otherwise
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Unlinks the source pad from the sink pad. Will emit the Gst.Pad::unlinked signal on both pads.
true if the pads were unlinked. This function returns false if the pads were not linked together. MT safe.
Clear the parent of object, removing the associated reference.
This function decreases the refcount of object.
MT safe. Grabs and releases object's lock.
Decrements the reference 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.
A helper function you can use that sets the FIXED_CAPS flag This way the default CAPS query will always return the negotiated caps or in case the pad is not negotiated, the padtemplate caps.
The negotiated caps are the caps of the last CAPS event that passed on the pad. Use this function on a pad that, once it negotiated to a CAPS, cannot be renegotiated to something else.
Virtualvfunc_clean the frame previously prepared in prepare_frame
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Optional Called when the pad has received a flush stop, this is the place to flush any information specific to the pad, it allows for individual pads to be flushed while others might not be.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_Prepare the frame from the pad buffer and sets it to prepared_frame. Implementations should always return TRUE. Returning FALSE will cease iteration over subsequent pads.
Virtualvfunc_Finish preparing prepared_frame.
If overriden, prepare_frame_start must also be overriden.
the parent GstVideo.VideoAggregator
the GstVideo.VideoFrame to prepare into
Virtualvfunc_Begin preparing the frame from the pad buffer and sets it to prepared_frame.
If overriden, prepare_frame_finish must also be overriden.
the parent GstVideo.VideoAggregator
the input Gst.Buffer to prepare
the GstVideo.VideoFrame to prepare into
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
Virtualvfunc_Optional
Called before input buffers are queued in the pad, return true
if the buffer should be skipped.
Virtualvfunc_Virtualvfunc_Called when either the input or output formats have changed.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcheck_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 Gst.Object in the list to compare the name, so be
careful when passing a list with a locked object.
a list of Gst.Object to check through
the name to search for
Staticcompat_Optionaldata: anyStaticdefault_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.
the GObject.Object that signalled the notify.
a Gst.Object that initiated the notify.
a GObject.ParamSpec of the property.
Optionalexcluded_props: string[]a set of user-specified properties to exclude or null to show all changes.
Staticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlink_Gets a string representing the given pad-link return.
a Gst.PadLinkReturn to get the name of.
Staticlist_StaticnewStaticnew_Staticnew_Optionalname: stringStaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
StaticreplaceAtomically modifies a pointer to point to a new object.
The reference count of oldobj is decreased and the reference count of
newobj is increased.
Either newobj and the value pointed to by oldobj may be null.
Optionaloldobj: Gst.Objectpointer to a place of a Gst.Object to replace
Optionalnewobj: Gst.Objecta new Gst.Object
Since
1.24