org.freedesktop.gstreamer.controller

Class LFOControlSource

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

org.freedesktop.gstreamer.controller.LFOControlSource

All Implemented Interfaces:

AutoCloseable

public class LFOControlSource
extends ControlSource

LFO control source.

See upstream documentation at https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer-libs/html/GstLFOControlSource.html

LFOControlSource is a ControlSource, that provides several periodic waveforms as control values.

To use InterpolationControlSource create a new instance, bind it to a GParamSpec and set the relevant properties.

All functions are MT-safe.

Nested Class Summary

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

ControlSource.TimedValue

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
LFOControlSource() Create a new, unbound LFOControlSource.

Method Summary

Modifier and Type	Method and Description
double	getAmplitude() Get the amplitude of the waveform.
double	getFrequency() Get the frequency of the waveform.
double	getOffset() Get the value offset of the waveform.
long	getTimeshift() Get the timeshift of the waveform.
LFOWaveform	getWaveform() Get the waveform.
LFOControlSource	setAmplitude(double value) Specifies the amplitude for the waveform of this LFOControlSource.
LFOControlSource	setFrequency(double value) Specifies the frequency that should be used for the waveform of this LFOControlSource.
LFOControlSource	setOffset(double value) Specifies the value offset for the waveform of this LFOControlSource.
LFOControlSource	setTimeshift(long value) Specifies the timeshift to the right that should be used for the waveform of this LFOControlSource in nanoseconds.
LFOControlSource	setWaveform(LFOWaveform value) Specifies the waveform that should be used for this LFOControlSource.

Methods inherited from class org.freedesktop.gstreamer.ControlSource

getValue, getValueArray

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

LFOControlSource

public LFOControlSource()

Create a new, unbound LFOControlSource.

Method Detail

setAmplitude

public LFOControlSource setAmplitude(double value)

Specifies the amplitude for the waveform of this LFOControlSource.

Allowed values: [0,1]

Default value: 1

Parameters:

value - amplitude between 0 and 1

Returns:

this

getAmplitude

public double getAmplitude()

Get the amplitude of the waveform.

Returns:

amplitude

setFrequency

public LFOControlSource setFrequency(double value)

Specifies the frequency that should be used for the waveform of this LFOControlSource. It should be large enough so that the period is longer than one nanosecond.

Allowed values: >= Double.MIN_VALUE

Default value: 1

Parameters:

value - frequency >= Double.MIN_VALUE

Returns:

this

getFrequency

public double getFrequency()

Get the frequency of the waveform.

Returns:

amplitude

setOffset

public LFOControlSource setOffset(double value)

Specifies the value offset for the waveform of this LFOControlSource.

Allowed values: [0,1]

Default value: 1

Parameters:

value - offset between 0 and 1

Returns:

this

getOffset

public double getOffset()

Get the value offset of the waveform.

Returns:

offset

setTimeshift

public LFOControlSource setTimeshift(long value)

Specifies the timeshift to the right that should be used for the waveform of this LFOControlSource in nanoseconds.

Default value: 0

Parameters:

value - timeshift in nanoseconds

Returns:

this

getTimeshift

public long getTimeshift()

Get the timeshift of the waveform.

Returns:

timeshift

setWaveform

public LFOControlSource setWaveform(LFOWaveform value)

Specifies the waveform that should be used for this LFOControlSource.

Default value: LFOWaveform.SINE

Parameters:

value - waveform

Returns:

this

getWaveform

public LFOWaveform getWaveform()

Get the waveform.

Returns:

waveform