Package org.freedesktop.gstreamer.gst

Class ControlSource

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.freedesktop.gstreamer.gst.GstObject

org.freedesktop.gstreamer.gst.ControlSource

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

ControlSource.ControlSourceImpl

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

The GstControlSource is a base class for control value sources that could be used to get timestamp-value pairs. A control source essentially is a function over time.

A GstControlSource is used by first getting an instance of a specific control-source, creating a binding for the control-source to the target property of the element and then adding the binding to the element. The binding will convert the data types and value range to fit to the bound property.

For implementing a new GstControlSource one has to implement GstControlSourceGetValue and GstControlSourceGetValueArray functions. These are then used by gst_control_source_get_value() and gst_control_source_get_value_array() to get values for specific timestamps.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ControlSource.Builder<B extends ControlSource.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	ControlSource.ControlSourceClass	The class structure of GstControlSource.
static class	ControlSource.ControlSourceImpl	The ControlSourceImpl type represents a native instance of the abstract ControlSource class.

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

GstObject.DeepNotifyCallback, GstObject.ObjectClass, GstObject.ObjectImpl

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
ControlSource(MemorySegment address)	Create a ControlSource proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected ControlSource	asParent()	Returns this instance as if it were its parent type.
static ControlSource.Builder<? extends ControlSource.Builder>	builder()	A ControlSource.Builder object constructs a ControlSource with the specified properties.
boolean	controlSourceGetValue(ClockTime timestamp, Out<Double> value)	Gets the value for this GstControlSource at a given timestamp.
boolean	controlSourceGetValueArray(ClockTime timestamp, ClockTime interval, double[] values)	Gets an array of values for for this GstControlSource.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the ControlSource class

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.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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

ControlSource

public ControlSource(MemorySegment address)

Create a ControlSource proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the ControlSource class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected ControlSource 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

controlSourceGetValue

public boolean controlSourceGetValue(ClockTime timestamp,
 Out<Double> value)

Gets the value for this GstControlSource at a given timestamp.

Parameters:

timestamp - the time for which the value should be returned

value - the value

Returns:

false if the value couldn't be returned, true otherwise.

controlSourceGetValueArray

public boolean controlSourceGetValueArray(ClockTime timestamp,
 ClockTime interval,
 double[] values)

Gets an array of values for for this GstControlSource. Values that are undefined contain NANs.

Parameters:

timestamp - the first timestamp

interval - the time steps

values - array to put control-values in

Returns:

true if the given array could be filled, false otherwise

builder

public static ControlSource.Builder<? extends ControlSource.Builder> builder()

A ControlSource.Builder object constructs a ControlSource with the specified properties. Use the various set...() methods to set properties, and finish construction with ControlSource.Builder.build().