GstBin

Gst.Bin

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──Gst.Element
                ╰──Gst.Bin
                    ╰──Gst.Pipeline

Gst.Bin.prototype.new

function Gst.Bin.prototype.new(name: String): {
    // javascript wrapper for 'gst_bin_new'
}

Creates a new bin with the given name.

Gst.Bin.prototype.add

function Gst.Bin.prototype.add(element: Gst.Element): {
    // javascript wrapper for 'gst_bin_add'
}

Adds the given element to the bin. Sets the element's parent, and thus takes ownership of the element. An element can only be added to one bin.

If the element's pads are linked to other pads, the pads will be unlinked before the element is added to the bin.

When you add an element to an already-running pipeline, you will have to take care to set the state of the newly-added element to the desired state (usually PLAYING or PAUSED, same you set the pipeline to originally) with Gst.Element.prototype.set_state, or use Gst.Element.prototype.sync_state_with_parent. The bin or pipeline will not take care of this for you.

Gst.Bin.prototype.find_unlinked_pad

function Gst.Bin.prototype.find_unlinked_pad(direction: Gst.PadDirection): {
    // javascript wrapper for 'gst_bin_find_unlinked_pad'
}

Recursively looks for elements with an unlinked pad of the given direction within the specified bin and returns an unlinked pad if one is found, or null otherwise. If a pad is found, the caller owns a reference to it and should use Gst.Object.prototype.unref on the pad when it is not needed any longer.

Gst.Bin.prototype.get_by_interface

function Gst.Bin.prototype.get_by_interface(iface: GObject.Type): {
    // javascript wrapper for 'gst_bin_get_by_interface'
}

Looks for an element inside the bin that implements the given interface. If such an element is found, it returns the element. You can cast this element to the given interface afterwards. If you want all elements that implement the interface, use Gst.Bin.prototype.iterate_all_by_interface. This function recurses into child bins.

Gst.Bin.prototype.get_by_name

function Gst.Bin.prototype.get_by_name(name: String): {
    // javascript wrapper for 'gst_bin_get_by_name'
}

Gets the element with the given name from a bin. This function recurses into child bins.

Gst.Bin.prototype.get_by_name_recurse_up

function Gst.Bin.prototype.get_by_name_recurse_up(name: String): {
    // javascript wrapper for 'gst_bin_get_by_name_recurse_up'
}

Gets the element with the given name from this bin. If the element is not found, a recursion is performed on the parent bin.

Gst.Bin.prototype.get_suppressed_flags

function Gst.Bin.prototype.get_suppressed_flags(): {
    // javascript wrapper for 'gst_bin_get_suppressed_flags'
}

Since : 1.10

Gst.Bin.prototype.iterate_all_by_element_factory_name

function Gst.Bin.prototype.iterate_all_by_element_factory_name(factory_name: String): {
    // javascript wrapper for 'gst_bin_iterate_all_by_element_factory_name'
}

Looks for all elements inside the bin with the given element factory name. The function recurses inside child bins. The iterator will yield a series of Gst.Element.

Since : 1.18

Gst.Bin.prototype.iterate_all_by_interface

function Gst.Bin.prototype.iterate_all_by_interface(iface: GObject.Type): {
    // javascript wrapper for 'gst_bin_iterate_all_by_interface'
}

Looks for all elements inside the bin that implements the given interface. You can safely cast all returned elements to the given interface. The function recurses inside child bins. The iterator will yield a series of Gst.Element.

Gst.Bin.prototype.iterate_elements

function Gst.Bin.prototype.iterate_elements(): {
    // javascript wrapper for 'gst_bin_iterate_elements'
}

Gets an iterator for the elements in this bin.

Gst.Bin.prototype.iterate_recurse

function Gst.Bin.prototype.iterate_recurse(): {
    // javascript wrapper for 'gst_bin_iterate_recurse'
}

Gets an iterator for the elements in this bin. This iterator recurses into GstBin children.

Gst.Bin.prototype.iterate_sinks

function Gst.Bin.prototype.iterate_sinks(): {
    // javascript wrapper for 'gst_bin_iterate_sinks'
}

Gets an iterator for all elements in the bin that have the Gst.ElementFlags.SINK flag set.

Gst.Bin.prototype.iterate_sorted

function Gst.Bin.prototype.iterate_sorted(): {
    // javascript wrapper for 'gst_bin_iterate_sorted'
}

Gets an iterator for the elements in this bin in topologically sorted order. This means that the elements are returned from the most downstream elements (sinks) to the sources.

This function is used internally to perform the state changes of the bin elements and for clock selection.

Gst.Bin.prototype.iterate_sources

function Gst.Bin.prototype.iterate_sources(): {
    // javascript wrapper for 'gst_bin_iterate_sources'
}

Gets an iterator for all elements in the bin that have the Gst.ElementFlags.SOURCE flag set.

Gst.Bin.prototype.recalculate_latency

function Gst.Bin.prototype.recalculate_latency(): {
    // javascript wrapper for 'gst_bin_recalculate_latency'
}

Queries bin for the current latency and reconfigures this latency on all the elements using a LATENCY event.

This method is typically called on the pipeline when a Gst.MessageType.LATENCY is posted on the bus.

This function simply emits the do-latency signal so any custom latency calculations will be performed.

Gst.Bin.prototype.remove

function Gst.Bin.prototype.remove(element: Gst.Element): {
    // javascript wrapper for 'gst_bin_remove'
}

Removes the element from the bin, unparenting it as well. Unparenting the element means that the element will be dereferenced, so if the bin holds the only reference to the element, the element will be freed in the process of removing it from the bin. If you want the element to still exist after removing, you need to call Gst.Object.prototype.ref before removing it from the bin.

If the element's pads are linked to other pads, the pads will be unlinked before the element is removed from the bin.

Gst.Bin.prototype.set_suppressed_flags

function Gst.Bin.prototype.set_suppressed_flags(flags: Gst.ElementFlags): {
    // javascript wrapper for 'gst_bin_set_suppressed_flags'
}

Suppresses the given flags on the bin. Gst.ElementFlags of a child element are propagated when it is added to the bin. When suppressed flags are set, those specified flags will not be propagated to the bin.

Since : 1.10

Gst.Bin.prototype.sync_children_states

function Gst.Bin.prototype.sync_children_states(): {
    // javascript wrapper for 'gst_bin_sync_children_states'
}

Synchronizes the state of every child of bin with the state of bin. See also Gst.Element.prototype.sync_state_with_parent.

Since : 1.6

deep-element-added

function deep_element_added_callback(self: Gst.Bin, sub_bin: Gst.Bin, element: Gst.Element, user_data: Object): {
    // javascript callback for the 'deep-element-added' signal
}

Will be emitted after the element was added to sub_bin.

Flags: Run First

Since : 1.10

deep-element-removed

function deep_element_removed_callback(self: Gst.Bin, sub_bin: Gst.Bin, element: Gst.Element, user_data: Object): {
    // javascript callback for the 'deep-element-removed' signal
}

Will be emitted after the element was removed from sub_bin.

Flags: Run First

Since : 1.10

do-latency

function do_latency_callback(self: Gst.Bin, user_data: Object): {
    // javascript callback for the 'do-latency' signal
}

Will be emitted when the bin needs to perform latency calculations. This signal is only emitted for toplevel bins or when async-handling is enabled.

Only one signal handler is invoked. If no signals are connected, the default handler is invoked, which will query and distribute the lowest possible latency to all sinks.

Connect to this signal if the default latency calculations are not sufficient, like when you need different latencies for different sinks in the same pipeline.

Flags: Run Last

element-added

function element_added_callback(self: Gst.Bin, element: Gst.Element, user_data: Object): {
    // javascript callback for the 'element-added' signal
}

Will be emitted after the element was added to the bin.

Flags: Run First

element-removed

function element_removed_callback(self: Gst.Bin, element: Gst.Element, user_data: Object): {
    // javascript callback for the 'element-removed' signal
}

Will be emitted after the element was removed from the bin.

Flags: Run First

async-handling

“async-handling” Number

If set to true, the bin will handle asynchronous state changes. This should be used only if the bin subclass is modifying the state of its children on its own.

Flags : Read / Write

message-forward

“message-forward” Number

Forward all children messages, even those that would normally be filtered by the bin. This can be interesting when one wants to be notified of the EOS state of individual elements, for example.

The messages are converted to an ELEMENT message with the bin as the source. The structure of the message is named GstBinForwarded and contains a field named message that contains the original forwarded Gst.Message.

Flags : Read / Write

vfunc_add_element

function vfunc_add_element(bin: Gst.Bin, element: Gst.Element): {
    // javascript implementation of the 'add_element' virtual method
}

Method to add an element to the bin.

vfunc_deep_element_added

function vfunc_deep_element_added(bin: Gst.Bin, sub_bin: Gst.Bin, child: Gst.Element): {
    // javascript implementation of the 'deep_element_added' virtual method
}

Method called when an element was added somewhere in the bin hierarchy.

vfunc_deep_element_removed

function vfunc_deep_element_removed(bin: Gst.Bin, sub_bin: Gst.Bin, child: Gst.Element): {
    // javascript implementation of the 'deep_element_removed' virtual method
}

Method called when an element was removed somewhere in the bin hierarchy.

vfunc_do_latency

function vfunc_do_latency(bin: Gst.Bin): {
    // javascript implementation of the 'do_latency' virtual method
}

vfunc_element_added

function vfunc_element_added(bin: Gst.Bin, child: Gst.Element): {
    // javascript implementation of the 'element_added' virtual method
}

Method called when an element was added to the bin.

vfunc_element_removed

function vfunc_element_removed(bin: Gst.Bin, child: Gst.Element): {
    // javascript implementation of the 'element_removed' virtual method
}

Method called when an element was removed from the bin.

vfunc_handle_message

function vfunc_handle_message(bin: Gst.Bin, message: Gst.Message): {
    // javascript implementation of the 'handle_message' virtual method
}

Method to handle a message from the children.

vfunc_remove_element

function vfunc_remove_element(bin: Gst.Bin, element: Gst.Element): {
    // javascript implementation of the 'remove_element' virtual method
}

Method to remove an element from the bin.

Gst.BinFlags

GstBinFlags are a set of flags specific to bins. Most are set/used internally. They can be checked using the GST_OBJECT_FLAG_IS_SET (not introspectable) macro, and (un)set using GST_OBJECT_FLAG_SET (not introspectable) and GST_OBJECT_FLAG_UNSET (not introspectable).