fm.liveswitch.AudioMixer Class Reference

A mixer that mixes multiple audio inputs into a single output. More...

Public Member Functions

 AudioMixer (fm.liveswitch.AudioConfig config)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.AudioConfig config, int latency)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.AudioConfig config, int latency, int frameDuration)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.AudioFormat format)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.AudioFormat format, int latency)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.AudioFormat format, int latency, int frameDuration)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.IAudioOutput input)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.IAudioOutput input, int latency)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.IAudioOutput input, int latency, int frameDuration)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.IAudioOutput[] inputs)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.IAudioOutput[] inputs, int latency)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
 AudioMixer (fm.liveswitch.IAudioOutput[] inputs, int latency, int frameDuration)
 Initializes a new instance of the fm.liveswitch.AudioMixer class. More...
 
int getFrameDuration ()
 Gets the frame duration in milliseconds. More...
 
String getLabel ()
 Gets a label that identifies this class. More...
 
int getLatency ()
 Gets the latency. More...
 
- Public Member Functions inherited from fm.liveswitch.AudioPipe
 AudioPipe (fm.liveswitch.AudioFormat inputFormat, fm.liveswitch.AudioFormat outputFormat)
 Initializes a new instance of the fm.liveswitch.AudioPipe class. More...
 
 AudioPipe (fm.liveswitch.AudioFormat outputFormat)
 Initializes a new instance of the fm.liveswitch.AudioPipe class. More...
 
fm.liveswitch.AudioConfig getConfig ()
 Gets the output configuration. More...
 
double getGain ()
 Gets a value indicating the gain (input amplification) of this sink. More...
 
fm.liveswitch.AudioConfig getInputConfig ()
 Gets the input configuration. More...
 
fm.liveswitch.AudioConfig getOutputConfig ()
 Gets the output configuration. More...
 
double getVolume ()
 Gets a value indicating the volume (output resistance) of this source. More...
 
boolean processFrame (fm.liveswitch.AudioFrame frame)
 Processes a frame. More...
 
void setGain (double value)
 Sets a value indicating the gain (input amplification) of this sink. More...
 
void setVolume (double value)
 Sets a value indicating the volume (output resistance) of this source. More...
 
- Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object > getDynamicProperties ()
 Gets all dynamic properties on this instance. More...
 
Object getDynamicValue (String key)
 Gets a property value from the local cache. More...
 
void setDynamicValue (String key, Object value)
 Sets a property value in the local cache. More...
 
boolean unsetDynamicValue (String key)
 Removes a property value from the local cache. More...
 
- Public Member Functions inherited from fm.liveswitch.IElement
abstract String getExternalId ()
 Gets the external identifier. More...
 
abstract String getId ()
 Gets the identifier. More...
 
abstract String getPipelineJson ()
 Gets the pipeline JSON with this as the central point. More...
 
abstract void setExternalId (String value)
 Sets the external identifier. More...
 
- Public Member Functions inherited from fm.liveswitch.IMediaElement
abstract boolean destroy ()
 Destroys this instance. More...
 
abstract boolean getDeactivated ()
 Gets a value indicating whether this instance is deactivated. More...
 
abstract boolean getDisabled ()
 Gets a value indicating whether this instance is disabled. More...
 
abstract boolean getMuted ()
 Gets a value indicating whether this instance is muted. More...
 
abstract boolean getPaused ()
 Gets a value indicating whether this instance is paused. More...
 
abstract boolean getPersistent ()
 Gets a value indicating whether this instance is persistent. More...
 
abstract void setDeactivated (boolean value)
 Sets a value indicating whether this instance is deactivated. More...
 
abstract void setMuted (boolean value)
 Sets a value indicating whether this instance is muted. More...
 

Protected Member Functions

void doDestroy ()
 Destroys this instance. More...
 
void doProcessFrame (fm.liveswitch.AudioFrame frame, fm.liveswitch.AudioBuffer inputBuffer)
 Processes a frame. More...
 
boolean getAllowDurationTimer ()
 Gets whether this media pipe output rate is allowed to be timed. More...
 
boolean getAllowInputRateTimer ()
 Gets whether this media pipe input rate is allowed to be timed. More...
 
boolean getIsMixer ()
 Gets whether this pipe processes media from different sources. More...
 
- Protected Member Functions inherited from fm.liveswitch.AudioPipe
fm.liveswitch.AudioFrame createFrame (fm.liveswitch.AudioBuffer buffer)
 Creates a frame. More...
 
fm.liveswitch.IAudioInputCollection createInputCollection (fm.liveswitch.IAudioOutput output)
 Creates an input collection. More...
 
fm.liveswitch.IAudioOutputCollection createOutputCollection (fm.liveswitch.IAudioInput input)
 Creates an output collection. More...
 
void raiseFrame (fm.liveswitch.AudioFrame frame)
 Raises a frame. More...
 
- Protected Member Functions inherited from fm.liveswitch.Dynamic
 Dynamic ()
 
- Protected Member Functions inherited from fm.liveswitch.Serializable
boolean getIsDirty ()
 Gets a value indicating whether this instance is dirty. More...
 
 Serializable ()
 Initializes a new instance of the fm.liveswitch.Serializable class. More...
 
void setIsDirty (boolean value)
 Sets a value indicating whether this instance is dirty. More...
 

Detailed Description

A mixer that mixes multiple audio inputs into a single output.

Constructor & Destructor Documentation

◆ AudioMixer() [1/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.AudioConfig  config)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
configThe configuration.

◆ AudioMixer() [2/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.AudioConfig  config,
int  latency 
)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
configThe configuration.
latencyThe latency in milliseconds.

◆ AudioMixer() [3/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.AudioConfig  config,
int  latency,
int  frameDuration 
)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
configThe configuration.
latencyThe latency in milliseconds.
frameDurationThe output frame duration in milliseconds.

◆ AudioMixer() [4/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.AudioFormat  format)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
formatThe format.

◆ AudioMixer() [5/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.AudioFormat  format,
int  latency 
)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
formatThe format.
latencyThe latency in milliseconds.

◆ AudioMixer() [6/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.AudioFormat  format,
int  latency,
int  frameDuration 
)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
formatThe format.
latencyThe latency in milliseconds.
frameDurationThe output frame duration in milliseconds.

◆ AudioMixer() [7/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.IAudioOutput  input)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
inputThe input.

◆ AudioMixer() [8/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.IAudioOutput  input,
int  latency 
)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
inputThe input.
latencyThe latency in milliseconds.

◆ AudioMixer() [9/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.IAudioOutput  input,
int  latency,
int  frameDuration 
)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
inputThe input.
latencyThe latency in milliseconds.
frameDurationThe output frame duration in milliseconds.

◆ AudioMixer() [10/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.IAudioOutput[]  inputs)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
inputsThe inputs.

◆ AudioMixer() [11/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.IAudioOutput[]  inputs,
int  latency 
)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
inputsThe inputs.
latencyThe latency in milliseconds.

◆ AudioMixer() [12/12]

fm.liveswitch.AudioMixer.AudioMixer ( fm.liveswitch.IAudioOutput[]  inputs,
int  latency,
int  frameDuration 
)

Initializes a new instance of the fm.liveswitch.AudioMixer class.

Parameters
inputsThe inputs.
latencyThe latency in milliseconds.
frameDurationThe output frame duration in milliseconds.

Member Function Documentation

◆ doDestroy()

void fm.liveswitch.AudioMixer.doDestroy ( )
protected

Destroys this instance.

◆ doProcessFrame()

void fm.liveswitch.AudioMixer.doProcessFrame ( fm.liveswitch.AudioFrame  frame,
fm.liveswitch.AudioBuffer  inputBuffer 
)
protected

Processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

◆ getAllowDurationTimer()

boolean fm.liveswitch.AudioMixer.getAllowDurationTimer ( )
protected

Gets whether this media pipe output rate is allowed to be timed.

◆ getAllowInputRateTimer()

boolean fm.liveswitch.AudioMixer.getAllowInputRateTimer ( )
protected

Gets whether this media pipe input rate is allowed to be timed.

◆ getFrameDuration()

int fm.liveswitch.AudioMixer.getFrameDuration ( )

Gets the frame duration in milliseconds.

Defaults to 20.

◆ getIsMixer()

boolean fm.liveswitch.AudioMixer.getIsMixer ( )
protected

Gets whether this pipe processes media from different sources.

◆ getLabel()

String fm.liveswitch.AudioMixer.getLabel ( )

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

◆ getLatency()

int fm.liveswitch.AudioMixer.getLatency ( )

Gets the latency.