Package heronarts.lx.audio

Class SoundObject

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.audio.SoundObject

All Implemented Interfaces:

LXComponent.Renamable, LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXNormalizedParameter, LXParameter, LXParameterListener, Comparable<SoundObject>

@LXCategory("Audio")
@Global("Sound Object")
public class SoundObject
extends LXModulator
implements Comparable<SoundObject>, LXOscComponent, LXNormalizedParameter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SoundObject.AudioMeterSource
static enum	SoundObject.MeterSource
static class	SoundObject.Selector

Nested classes/interfaces inherited from class heronarts.lx.modulator.LXModulator

LXModulator.Device, LXModulator.Global, LXModulator.Placeholder

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

LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.PluginRequired, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXNormalizedParameter

LXNormalizedParameter.OscMode

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
final DiscreteParameter	admObjId
final BooleanParameter	admSync
final BoundedParameter	attackMs
final EnumParameter<SoundObject.AudioMeterSource>	audioMeterSource
final CompoundParameter	azimuth
final MutableParameter	cartesianChanged
final BooleanParameter	controlsExpanded
final CompoundParameter	distance
final CompoundParameter	elevation
final DiscreteParameter	envelopSource
final NormalizedParameter	input
final BoundedParameter	meterCeiling
final BoundedParameter	meterFloor
final EnumParameter<SoundObject.MeterSource>	meterSource
final LXVector	normalized	Holds the normalized position of the sound object, assuming that distance is set to 100%.
final LXVector	position	Holds the position of the sound object in coordinate space where (.5, .5, .5) is the center.
final DiscreteParameter	reaperSource
final BoundedParameter	releaseMs

Fields inherited from class heronarts.lx.modulator.LXModulator

crashed, midiFilter, midiSource

Fields inherited from class heronarts.lx.LXRunnableComponent

runMs, running, trigger

Fields inherited from class heronarts.lx.LXComponent

childArrays, 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

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
SoundObject(LX lx)

Method Summary

Modifier and Type	Method	Description
int	compareTo(SoundObject that)
protected double	computeValue(double deltaMs)	Implementation method to advance the modulator's internal state.
void	dispose()	Invoked when a component is being removed from the system and will no longer be used at all.
static SoundObject	get(LX lx)
double	getNormalized()	Gets the value of the parameter in a normalized space from 0 to 1
void	onParameterChanged(LXParameter p)	Subclasses are free to override this if desired.
LXNormalizedParameter	setNormalized(double value)	Sets the value or the parameter in normalized space from 0 to 1
void	updateCartesian()

Methods inherited from class heronarts.lx.modulator.LXModulator

autostart, disableAutoStart, getCrash, getCrashStackTrace, getFormatter, getIndex, getOscAddress, getOscPath, getPath, getPolarity, getUnits, getValue, isMappingSource, loop, onSetValue, run, setComponent, setFormatter, setIndex, setMappingSource, setPolarity, setUnits, setValue, setValue, updateValue

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, onReset, onStart, onStop, onTrigger, postRun, reset, start, stop, toggle, trigger

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscLabel, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isValidOscParameter, load, 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.parameter.LXNormalizedParameter

getBaseNormalized, getBaseNormalizedf, getExponent, getNormalizedf, getOscMode, getValueFromNormalized, isWrappable

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.parameter.LXParameter

getBaseValue, getBaseValuef, getFormatter, getLabel, getParentParameter, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setFormatter, setMappable, setValue

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Field Details

admSync

public final BooleanParameter admSync

admObjId

public final DiscreteParameter admObjId

meterSource

public final EnumParameter<SoundObject.MeterSource> meterSource

audioMeterSource

public final EnumParameter<SoundObject.AudioMeterSource> audioMeterSource

envelopSource

public final DiscreteParameter envelopSource

reaperSource

public final DiscreteParameter reaperSource

input

public final NormalizedParameter input

meterFloor

public final BoundedParameter meterFloor

meterCeiling

public final BoundedParameter meterCeiling

attackMs

public final BoundedParameter attackMs

releaseMs

public final BoundedParameter releaseMs

azimuth

public final CompoundParameter azimuth

elevation

public final CompoundParameter elevation

distance

public final CompoundParameter distance

cartesianChanged

public final MutableParameter cartesianChanged

controlsExpanded

public final BooleanParameter controlsExpanded

position

public final LXVector position

Holds the position of the sound object in coordinate space where (.5, .5, .5) is the center. For distance values larger than 100%, values may fall outside of the bounds [0,1]. Note that this position is relative to the sound stage bounds, not the absolute space.

normalized

public final LXVector normalized

Holds the normalized position of the sound object, assuming that distance is set to 100%. All values will fall in the range [-1,1] and the amplitude of this vector will be 1. Note that this position is relative to the sound stage bounds, not the absolute space.

Constructor Details

SoundObject

public SoundObject(LX lx)

Method Details

get

public static SoundObject get(LX lx)

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 LXRunnableComponent

Parameters:

p - Parameter that has a value change

updateCartesian

public void updateCartesian()

computeValue

protected double computeValue(double deltaMs)

Description copied from class: LXModulator

Implementation method to advance the modulator's internal state. Subclasses must provide and update value appropriately.

Specified by:

computeValue in class LXModulator

Parameters:

deltaMs - Number of milliseconds to advance by

Returns:

Computed value

setNormalized

public LXNormalizedParameter setNormalized(double value)

Description copied from interface: LXNormalizedParameter

Sets the value or the parameter in normalized space from 0 to 1

Specified by:

setNormalized in interface LXNormalizedParameter

Parameters:

value - The normalized value, from 0 to 1

Returns:

this, for method chaining

getNormalized

public double getNormalized()

Description copied from interface: LXNormalizedParameter

Gets the value of the parameter in a normalized space from 0 to 1

Specified by:

getNormalized in interface LXNormalizedParameter

Returns:

Value of parameter, normalized to range from 0 to 1

compareTo

public int compareTo(SoundObject that)

Specified by:

compareTo in interface Comparable<SoundObject>

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.

Specified by:

dispose in interface LXParameter

Overrides:

dispose in class LXComponent