Package org.freedesktop.gstreamer.gst

Class ControlBinding

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.freedesktop.gstreamer.gst.GstObject

org.freedesktop.gstreamer.gst.ControlBinding

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

ControlBinding.ControlBinding$Impl

@Generated("io.github.jwharm.JavaGI")
public abstract class ControlBinding
extends GstObject

A base class for value mapping objects that attaches control sources to GObject properties. Such an object is taking one or more GstControlSource instances, combines them and maps the resulting value to the type and value range of the bound property.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ControlBinding.Builder<B extends ControlBinding.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ControlBinding.ControlBinding$Impl	The ControlBinding$Impl type represents a native instance of the abstract ControlBinding class.
static class	ControlBinding.ControlBindingClass	The class structure of GstControlBinding.

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.gst.GstObject

GstObject.DeepNotifyCallback, GstObject.Object$Impl, GstObject.ObjectClass

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback

Constructor Summary

Constructors

Constructor	Description
ControlBinding()	Creates a new ControlBinding.
ControlBinding(MemorySegment address)	Create a ControlBinding proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ControlBinding	asParent()	Returns this instance as if it were its parent type.
boolean	getGValueArray(ClockTime timestamp, ClockTime interval, @Nullable Value @Nullable [] values)	Gets a number of GValues for the given controlled property starting at the requested time.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the ControlBinding class
@Nullable Value	getValue(ClockTime timestamp)	Gets the value for the given controlled property at the requested time.
boolean	getValueArray(ClockTime timestamp, ClockTime interval, @Nullable MemorySegment @Nullable [] values)	Gets a number of values for the given controlled property starting at the requested time.
boolean	isDisabled()	Checks if the control binding is disabled.
void	setDisabled(boolean disabled)	This function is used to disable a control binding for some time, i.e.
boolean	syncValues(GstObject object, ClockTime timestamp, ClockTime lastSync)	Sets the property of the object, according to the GstControlSources that handles it and for the given timestamp.

Methods inherited from class org.freedesktop.gstreamer.gst.GstObject

addControlBinding, checkUniqueness, deepNotify, defaultDeepNotify, defaultError, emitDeepNotify, getControlBinding, getControlRate, getGValueArray, getName, getParent, getPathString, getValue, getValueArray, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, onDeepNotify, ref, refSink, removeControlBinding, replace, setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setName, setParent, suggestNextSync, syncValues, unparent, unref

Methods inherited from class org.gnome.gobject.InitiallyUnowned

builder

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

ControlBinding

public ControlBinding(MemorySegment address)

Create a ControlBinding proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

ControlBinding

public ControlBinding()

Creates a new ControlBinding.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the ControlBinding class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected ControlBinding asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GstObject

getGValueArray

public boolean getGValueArray(ClockTime timestamp,
 ClockTime interval,
 @Nullable Value @Nullable [] values)

Gets a number of GValues for the given controlled property starting at the requested time. The array values need to hold enough space for nValues of GValue.

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.

Parameters:

timestamp - the time that should be processed

interval - the time spacing between subsequent values

values - array to put control-values in

Returns:

true if the given array could be filled, false otherwise

getValue

public @Nullable Value getValue(ClockTime timestamp)

Gets the value for the given controlled property at the requested time.

Parameters:

timestamp - the time the control-change should be read from

Returns:

the GValue of the property at the given time, or null if the property isn't controlled.

getValueArray

public boolean getValueArray(ClockTime timestamp,
 ClockTime interval,
 @Nullable MemorySegment @Nullable [] values)

Gets a number of values for the given controlled property starting at the requested time. The array values needs to hold enough space for nValues of the same type as the objects property's type.

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 values are unboxed and ready to be used. The similar function gst_control_binding_get_g_value_array() returns the array as GValues and is more suitable for bindings.

Parameters:

timestamp - the time that should be processed

interval - the time spacing between subsequent values

values - array to put control-values in

Returns:

true if the given array could be filled, false otherwise

isDisabled

public boolean isDisabled()

Checks if the control binding is disabled.

Returns:

true if the binding is inactive

setDisabled

public void setDisabled(boolean disabled)

This function is used to disable a control binding for some time, i.e. gst_object_sync_values() will do nothing.

Parameters:

disabled - boolean that specifies whether to disable the controller or not.

syncValues

public boolean syncValues(GstObject object,
 ClockTime timestamp,
 ClockTime lastSync)

Sets the property of the object, according to the GstControlSources that handles it 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.

Parameters:

object - the object that has controlled properties

timestamp - the time that should be processed

lastSync - the last time this was called

Returns:

true if the controller value could be applied to the object property, false otherwise