org.freedesktop.gstreamer

Class Bin

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject

org.freedesktop.gstreamer.glib.RefCountedObject

org.freedesktop.gstreamer.glib.GObject

org.freedesktop.gstreamer.GstObject

org.freedesktop.gstreamer.Element

org.freedesktop.gstreamer.Bin

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

DecodeBin, Pipeline, URIDecodeBin, WebRTCBin

public class Bin
extends Element

Base class and element that can contain other elements.

See upstream documentation at https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer/html/GstBin.html

Bin is an element that can contain other Elements, allowing them to be managed as a group.

Pads from the child elements can be ghosted to the bin, see GhostPad. This makes the bin look like any other elements and enables creation of higher-level abstraction elements.

A new Bin is created with Bin(String). Use a Pipeline instead if you want to create a toplevel bin because a normal bin doesn't have a bus or handle clock distribution of its own.

After the bin has been created you will typically add elements to it with add(Element). Elements can be removed with remove(Element)

An element can be retrieved from a bin with getElementByName(String).

A list of elements contained in a bin can be retrieved with getElements() The Bin.ELEMENT_ADDED signal is fired whenever a new element is added to the bin. Likewise the Bin.ELEMENT_REMOVED signal is fired whenever an element is removed from the bin.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bin.DebugGraphDetails Available details for pipeline graphs produced by #debugToDotFile(int, java.lang.String, boolean)
static interface	Bin.DEEP_ELEMENT_ADDED Signal emitted when an Element is added to sub-bin of this Bin
static interface	Bin.DEEP_ELEMENT_REMOVED Signal emitted when an Element is removed from sub-bin of this Bin
static interface	Bin.DO_LATENCY Signal emitted when an Element has latency
static interface	Bin.ELEMENT_ADDED Signal emitted when an Element is added to this Bin
static interface	Bin.ELEMENT_REMOVED Signal emitted when an Element is removed from this Bin

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.Element

Element.NO_MORE_PADS, Element.PAD_ADDED, Element.PAD_REMOVED

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.GObject

GObject.GCallback, GObject.GInterface

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Field Summary

Fields

Modifier and Type	Field and Description
static String	GST_NAME
static String	GTYPE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
	Bin() Creates a new Bin with a unique name.
protected	Bin(NativeObject.Initializer init)
	Bin(String name) Creates a new Bin with the given name.

Method Summary

Modifier and Type	Method and Description
boolean	add(Element element) Adds an Element to this Bin.
void	addMany(Element... elements) Adds an array of Element objects to this Bin
void	connect(Bin.DEEP_ELEMENT_ADDED listener) Add a listener for the deep-element-added signal on this Bin
void	connect(Bin.DEEP_ELEMENT_REMOVED listener) Add a listener for the deep-element-removed signal on this Bin
void	connect(Bin.DO_LATENCY listener) Add a listener for the do-latency signal on this Bin
void	connect(Bin.ELEMENT_ADDED listener) Add a listener for the element-added signal on this Bin
void	connect(Bin.ELEMENT_REMOVED listener) Add a listener for the element-removed signal on this Bin
void	debugToDotFile(EnumSet<Bin.DebugGraphDetails> details, String fileName) To aid debugging applications one can use this method to write out the whole network of gstreamer elements that form the pipeline into a dot file.
void	debugToDotFileWithTS(EnumSet<Bin.DebugGraphDetails> details, String fileName) To aid debugging applications one can use this method to write out the whole network of gstreamer elements that form the pipeline into a dot file.
void	disconnect(Bin.DEEP_ELEMENT_ADDED listener) Disconnect the listener for the deep-element-added signal
void	disconnect(Bin.DEEP_ELEMENT_REMOVED listener) Disconnect the listener for the deep-element-removed signal
void	disconnect(Bin.DO_LATENCY listener) Disconnect the listener for the do-latency signal
void	disconnect(Bin.ELEMENT_ADDED listener) Disconnect the listener for the element-added signal
void	disconnect(Bin.ELEMENT_REMOVED listener) Disconnect the listener for the element-removed signal
Element	getElementByName(String name) Gets the Element with the given name from the bin.
Element	getElementByNameRecurseUp(String name) Gets the element with the given name from this bin.
List<Element>	getElements() Retrieve a list of the Elements contained in the Bin.
List<Element>	getElementsRecursive() Retrieve a list of the Elements contained in the Bin and its Bin children.
List<Element>	getElementsSorted() Gets an a list of the elements in this bin in topologically sorted order.
List<Element>	getSinks() Retrieve a list of the sink Elements contained in the Bin.
List<Element>	getSources() Retrieve a list of the source Elements contained in the Bin.
boolean	remove(Element element) Removes a Element from this Bin
void	removeMany(Element... elements) Removes an array of Element objects from this Bin

Methods inherited from class org.freedesktop.gstreamer.Element

addPad, connect, connect, connect, disconnect, disconnect, disconnect, getBaseTime, getBus, getClock, getFactory, getPads, getRequestPad, getSinkPads, getSrcPads, getStartTime, getState, getState, getState, getState, getStaticPad, isPlaying, link, linkFiltered, linkMany, linkPads, linkPadsFiltered, makeRawElement, pause, play, postMessage, query, ready, releaseRequestPad, removePad, sendEvent, setBaseTime, setCaps, setLockedState, setStartTime, setState, stop, syncStateWithParent, unlink, unlinkMany, unlinkPads

Methods inherited from class org.freedesktop.gstreamer.GstObject

addControlBinding, getControlBinding, getName, getParent, hasActiveControlBindings, removeControlBinding, setControlBindingDisabled, setControlBindingsDisabled, setName, suggestNextSync, syncValues, toString

Methods inherited from class org.freedesktop.gstreamer.glib.GObject

addCallback, connect, connect, disconnect, dispose, emit, emit, get, getPropertyDefaultValue, getPropertyMaximumValue, getPropertyMinimumValue, getRefCount, getTypeName, invalidate, listPropertyNames, removeCallback, set

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

close, disown, equals, getPointer, getRawPointer, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

GST_NAME

public static final String GST_NAME

See Also:

Constant Field Values

GTYPE_NAME

public static final String GTYPE_NAME

See Also:

Constant Field Values

Constructor Detail

Bin

protected Bin(NativeObject.Initializer init)

Bin

public Bin()

Creates a new Bin with a unique name.

Bin

public Bin(String name)

Creates a new Bin with the given name.

Parameters:

name - The Name to assign to the new Bin

Method Detail

add

public boolean add(Element element)

Adds an Element to this 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.

Parameters:

element - The Element to add to this Bin.

Returns:

true if the element was successfully added, false if the Bin will not accept the element.

addMany

public void addMany(Element... elements)

Adds an array of Element objects to this Bin

Parameters:

elements - The array of Element to add to this Bin

See Also:

add(Element)

remove

public boolean remove(Element element)

Removes a Element from this Bin

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

Parameters:

element - The Element to remove

Returns:

true if the element was successfully removed

removeMany

public void removeMany(Element... elements)

Removes an array of Element objects from this Bin

Parameters:

elements - The list Element to remove

getElements

public List<Element> getElements()

Retrieve a list of the Elements contained in the Bin.

Returns:

The List of Elements.

getElementsSorted

public List<Element> getElementsSorted()

Gets an a list of 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.

Returns:

The List of Elements.

getElementsRecursive

public List<Element> getElementsRecursive()

Retrieve a list of the Elements contained in the Bin and its Bin children. This differs from getElements() as it will also return Elements that are in any Bin elements contained in this Bin, also recursing down those Bins.

Returns:

The List of Elements.

getSinks

public List<Element> getSinks()

Retrieve a list of the sink Elements contained in the Bin.

Returns:

The List of sink Elements.

getSources

public List<Element> getSources()

Retrieve a list of the source Elements contained in the Bin.

Returns:

The List of source Elements.

getElementByName

public Element getElementByName(String name)

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

Parameters:

name - The name of the Element to find.

Returns:

The Element if found, else null.

getElementByNameRecurseUp

public Element getElementByNameRecurseUp(String name)

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

Parameters:

name - The name of the Element to find.

Returns:

The Element if found, else null.

debugToDotFile

public void debugToDotFile(EnumSet<Bin.DebugGraphDetails> details,
                           String fileName)

To aid debugging applications one can use this method to write out the whole network of gstreamer elements that form the pipeline into a dot file. This file can be processed with graphviz to get an image. e.g. dot -Tpng -oimage.png graph_lowlevel.dot

The function is only active if gstreamer is configured with "--gst-enable-gst-debug" and the environment variable GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).

Parameters:

details - to show in the graph

fileName - output base filename (e.g. "myplayer")

debugToDotFileWithTS

public void debugToDotFileWithTS(EnumSet<Bin.DebugGraphDetails> details,
                                 String fileName)

To aid debugging applications one can use this method to write out the whole network of gstreamer elements that form the pipeline into a dot file. This file can be processed with graphviz to get an image. e.g. dot -Tpng -oimage.png graph_lowlevel.dot

The function is only active if gstreamer is configured with "--gst-enable-gst-debug" and the environment variable GST_DEBUG_DUMP_DOT_DIR is set to a basepath (e.g. /tmp).

Unlike debugToDotFile(java.util.EnumSet, java.lang.String) this method adds the current timestamp to the filename, so that it can be used to take multiple snapshots.

Parameters:

details - to show in the graph

fileName - output base filename (e.g. "myplayer")

connect

public void connect(Bin.ELEMENT_ADDED listener)

Add a listener for the element-added signal on this Bin

Parameters:

listener - The listener to be called when an Element is added.

disconnect

public void disconnect(Bin.ELEMENT_ADDED listener)

Disconnect the listener for the element-added signal

Parameters:

listener - The listener that was registered to receive the signal.

connect

public void connect(Bin.ELEMENT_REMOVED listener)

Add a listener for the element-removed signal on this Bin

Parameters:

listener - The listener to be called when an Element is removed.

disconnect

public void disconnect(Bin.ELEMENT_REMOVED listener)

Disconnect the listener for the element-removed signal

Parameters:

listener - The listener that was registered to receive the signal.

connect

@Gst.Since(minor=10)
public void connect(Bin.DEEP_ELEMENT_ADDED listener)

Add a listener for the deep-element-added signal on this Bin

Parameters:

listener - The listener to be called when an Element is added.

disconnect

@Gst.Since(minor=10)
public void disconnect(Bin.DEEP_ELEMENT_ADDED listener)

Disconnect the listener for the deep-element-added signal

Parameters:

listener - The listener that was registered to receive the signal.

connect

@Gst.Since(minor=10)
public void connect(Bin.DEEP_ELEMENT_REMOVED listener)

Add a listener for the deep-element-removed signal on this Bin

Parameters:

listener - The listener to be called when an Element is removed.

disconnect

@Gst.Since(minor=10)
public void disconnect(Bin.DEEP_ELEMENT_REMOVED listener)

Disconnect the listener for the deep-element-removed signal

Parameters:

listener - The listener that was registered to receive the signal.

connect

public void connect(Bin.DO_LATENCY listener)

Add a listener for the do-latency signal on this Bin

Parameters:

listener - The listener to be called when an Element is removed.

disconnect

public void disconnect(Bin.DO_LATENCY listener)

Disconnect the listener for the do-latency signal

Parameters:

listener - The listener that was registered to receive the signal.