org.freedesktop.gstreamer

Class GhostPad

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.Pad

org.freedesktop.gstreamer.GhostPad

All Implemented Interfaces:

AutoCloseable

public class GhostPad
extends Pad

Pseudo link pads.

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

GhostPads are useful when organizing pipelines with Bin like elements. The idea here is to create hierarchical element graphs. The bin element contains a sub-graph. Now one would like to treat the bin-element like any other Element. This is where GhostPads come into play. A GhostPad acts as a proxy for another pad. Thus the bin can have sink and source ghost-pads that are associated with sink and source pads of the child elements.

If the target pad is known at creation time, GhostPad(String, Pad) is the function to use to get a ghost-pad. Otherwise one can use GhostPad(String, PadDirection) to create the ghost-pad and use setTarget(org.freedesktop.gstreamer.Pad) to establish the association later on.

Note that GhostPads add overhead to the data processing of a pipeline.

See Also:

Pad

Nested Class Summary

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

Pad.DATA_PROBE, Pad.EVENT_PROBE, Pad.LINKED, Pad.PROBE, Pad.UNLINKED

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	GTYPE_NAME

Constructor Summary

Constructors

Constructor and Description
GhostPad(String name, Pad target) Create a new ghostpad with target as the target.
GhostPad(String name, PadDirection direction) Create a new ghostpad without a target with the given direction.
GhostPad(String name, Pad target, PadTemplate template) Create a new ghostpad with target as the target.
GhostPad(String name, PadTemplate template) Create a new ghostpad based on template, without setting a target.

Method Summary

Modifier and Type	Method and Description
Pad	getTarget() Get the target pad of this ghostpad.
boolean	setTarget(Pad pad) Set the new target of the ghostpad.

Methods inherited from class org.freedesktop.gstreamer.Pad

addDataProbe, addEventProbe, addProbe, addProbe, block, chain, connect, connect, disconnect, disconnect, getAllowedCaps, getCurrentCaps, getDirection, getParentElement, getPeer, getRange, getTemplate, hasCurrentCaps, isBlocked, isBlocking, isLinked, link, peerQueryAcceptCaps, peerQueryCaps, pullRange, push, pushEvent, queryAcceptCaps, queryCaps, removeDataProbe, removeEventProbe, removeProbe, sendEvent, setActive, unlink

Methods inherited from class org.freedesktop.gstreamer.GstObject

addControlBinding, getAsString, getControlBinding, getName, getParent, hasActiveControlBindings, removeControlBinding, setAsString, 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

GTYPE_NAME

public static final String GTYPE_NAME

See Also:

Constant Field Values

Constructor Detail

GhostPad

public GhostPad(String name,
                Pad target)

Create a new ghostpad with target as the target. The direction will be taken from the target pad. The target pad must be unlinked.

Parameters:

name - The name of the new pad, or null to assign a default name.

target - The Pad to ghost.

GhostPad

public GhostPad(String name,
                Pad target,
                PadTemplate template)

Create a new ghostpad with target as the target. The direction will be taken from the target pad. The template used on the ghostpad will be template.

Parameters:

name - The name of the new pad, or null to assign a default name.

target - The Pad to ghost.

template - The PadTemplate to use on the ghostpad.

GhostPad

public GhostPad(String name,
                PadDirection direction)

Create a new ghostpad without a target with the given direction. A target can be set on the ghostpad later with the setTarget(org.freedesktop.gstreamer.Pad) method.

The created ghostpad will not have a padtemplate.

Parameters:

name - The name of the new pad, or null to assign a default name.

direction - The direction of the ghostpad.

GhostPad

public GhostPad(String name,
                PadTemplate template)

Create a new ghostpad based on template, without setting a target. The direction will be taken from the template.

Parameters:

name - The name of the new pad, or null to assign a default name.

template - The PadTemplate to use on the ghostpad.

Method Detail

getTarget

public Pad getTarget()

Get the target pad of this ghostpad.

Returns:

the target Pad, can be null if the ghostpad has no target set

setTarget

public boolean setTarget(Pad pad)

Set the new target of the ghostpad. Any existing target is unlinked and links to the new target are established.

Parameters:

pad - The new pad target.

Returns:

true if the new target could be set. This function can return false when the internal pads could not be linked.