Package heronarts.lx.audio

Class LXAudioEngine

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.audio.LXAudioEngine

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class LXAudioEngine
extends LXModulatorComponent
implements LXOscComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LXAudioEngine.Meter
static enum	LXAudioEngine.Mode

Nested classes/interfaces inherited from class heronarts.lx.LXModulatorComponent

LXModulatorComponent.Profiler

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Hidden, LXComponent.Placeholder, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final ADM	adm
final BooleanParameter	enabled
final Envelop	envelop
final BooleanParameter	expandedPerformance
final LXAudioInput	input	Audio input object
final BooleanParameter	ioExpanded
final LXAudioEngine.Meter	meter
final EnumParameter<LXAudioEngine.Mode>	mode
final LXAudioOutput	output
final Reaper	reaper
final SoundStage	soundStage

Fields inherited from class heronarts.lx.LXModulatorComponent

modulators, profiler

Fields inherited from class heronarts.lx.LXComponent

children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
LXAudioEngine(LX lx)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
final LXAudioInput	getInput()	Retrieves the audio input object at default sample rate of 44.1kHz
void	load(LX lx, JsonObject obj)	Loads the LX component.
void	loop(double deltaMs)
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.

Methods inherited from class heronarts.lx.LXModulatorComponent

addModulator, addModulator, addModulator, addModulator, addModulator, constructProfiler, getModulator, getModulators, moveModulator, removeModulator, startModulator

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

enabled

public final BooleanParameter enabled

expandedPerformance

public final BooleanParameter expandedPerformance

input

public final LXAudioInput input

Audio input object

output

public final LXAudioOutput output

meter

public final LXAudioEngine.Meter meter

soundStage

public final SoundStage soundStage

adm

public final ADM adm

envelop

public final Envelop envelop

reaper

public final Reaper reaper

mode

public final EnumParameter<LXAudioEngine.Mode> mode

ioExpanded

public final BooleanParameter ioExpanded

Constructor Details

LXAudioEngine

public LXAudioEngine(LX lx)

Method Details

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

Overrides:

loop in class LXModulatorComponent

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXComponent

Parameters:

p - Parameter that has a value change

getInput

public final LXAudioInput getInput()

Retrieves the audio input object at default sample rate of 44.1kHz

Returns:

Audio input object

dispose

public void dispose()

Description copied from class: LXComponent

Invoked when a component is being removed from the system and will no longer be used at all. This unregisters the component and should free up any resources and parameter listeners. Ideally after this method is called the object should be eligible for garbage collection. Subclasses are generally expected to override this method to handle their particular cleanup work. They should also generally call super.dispose() at the appropriate time to perform the basic cleanup, which may need to happen either before or after cleaning up other objects.

Overrides:

dispose in class LXModulatorComponent

load

public void load(LX lx,
 JsonObject obj)

Description copied from class: LXComponent

Loads the LX component. Restores the ID of the component, as well as its internal and user-facing parameters. Any explicitly registered children will be automatically loaded, so long as they are direct descendants. Dynamic arrays will not be automatically loaded, this is left to subclasses to implement.

Specified by:

load in interface LXSerializable

Overrides:

load in class LXComponent

Parameters:

lx - LX instance

obj - Object to deserialize