fm.liveswitch.audioprocessing.AecProcessor Class Reference

A libaudioprocessing-based AEC processor. More...

Public Member Functions

 AecProcessor ()
 Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class. More...
 
 AecProcessor (fm.liveswitch.AudioConfig config)
 Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class. More...
 
 AecProcessor (fm.liveswitch.AudioConfig config, int tailLength)
 Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class. More...
 
 AecProcessor (fm.liveswitch.AudioFormat format)
 Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class. More...
 
 AecProcessor (fm.liveswitch.AudioFormat format, int tailLength)
 Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class. More...
 
 AecProcessor (fm.liveswitch.IAudioOutput microphone)
 Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class. More...
 
 AecProcessor (fm.liveswitch.IAudioOutput microphone, int tailLength)
 Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class. More...
 
 AecProcessor (int tailLength)
 Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class. More...
 
String getLabel ()
 Gets a label that identifies this class. More...
 
int getTailLength ()
 Gets the tail length in milliseconds. More...
 
void setTailLength (int value)
 Sets the tail length in milliseconds. More...
 
- Public Member Functions inherited from fm.liveswitch.AecPipe
 AecPipe (fm.liveswitch.AudioFormat format)
 Initializes a new instance of the fm.liveswitch.AecPipe class. More...
 
fm.liveswitch.IAudioInput getSpeaker ()
 Gets the speaker sink. More...
 
void setSpeaker (fm.liveswitch.IAudioInput value)
 Sets the speaker sink. 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...
 
void processSpeakerFrame (fm.liveswitch.AudioFrame frame)
 Processes a speaker frame. 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 libaudioprocessing-based AEC processor.

Constructor & Destructor Documentation

◆ AecProcessor() [1/8]

fm.liveswitch.audioprocessing.AecProcessor.AecProcessor ( )

Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class.

◆ AecProcessor() [2/8]

fm.liveswitch.audioprocessing.AecProcessor.AecProcessor ( fm.liveswitch.AudioConfig  config)

Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class.

Parameters
configThe input/output configuration.

◆ AecProcessor() [3/8]

fm.liveswitch.audioprocessing.AecProcessor.AecProcessor ( fm.liveswitch.AudioConfig  config,
int  tailLength 
)

Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class.

Parameters
configThe input/output configuration.
tailLengthThe tail length in milliseconds.

◆ AecProcessor() [4/8]

fm.liveswitch.audioprocessing.AecProcessor.AecProcessor ( fm.liveswitch.AudioFormat  format)

Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class.

Parameters
formatThe input/output format.

◆ AecProcessor() [5/8]

fm.liveswitch.audioprocessing.AecProcessor.AecProcessor ( fm.liveswitch.AudioFormat  format,
int  tailLength 
)

Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class.

Parameters
formatThe input/output format.
tailLengthThe tail length in milliseconds.

◆ AecProcessor() [6/8]

fm.liveswitch.audioprocessing.AecProcessor.AecProcessor ( fm.liveswitch.IAudioOutput  microphone)

Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class.

Parameters
microphoneThe microphone.

◆ AecProcessor() [7/8]

fm.liveswitch.audioprocessing.AecProcessor.AecProcessor ( fm.liveswitch.IAudioOutput  microphone,
int  tailLength 
)

Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class.

Parameters
microphoneThe microphone.
tailLengthThe tail length in milliseconds.

◆ AecProcessor() [8/8]

fm.liveswitch.audioprocessing.AecProcessor.AecProcessor ( int  tailLength)

Initializes a new instance of the fm.liveswitch.audioprocessing.AecProcessor class.

Parameters
tailLengthThe tail length in milliseconds.

Member Function Documentation

◆ doDestroy()

void fm.liveswitch.audioprocessing.AecProcessor.doDestroy ( )
protected

Destroys this instance.

Reimplemented from fm.liveswitch.AecPipe.

◆ doProcessFrame()

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

Processes a frame.

Parameters
frameThe frame.
inputBufferThe input buffer.

◆ getLabel()

String fm.liveswitch.audioprocessing.AecProcessor.getLabel ( )

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

◆ getTailLength()

int fm.liveswitch.audioprocessing.AecProcessor.getTailLength ( )

Gets the tail length in milliseconds.

Minimum allowed value is 32. Maximum allowed value is 512.

◆ processSpeakerFrame()

void fm.liveswitch.audioprocessing.AecProcessor.processSpeakerFrame ( fm.liveswitch.AudioFrame  frame)
protected

Processes a speaker frame.

Parameters
frameThe frame.

Reimplemented from fm.liveswitch.AecPipe.

◆ setTailLength()

void fm.liveswitch.audioprocessing.AecProcessor.setTailLength ( int  value)

Sets the tail length in milliseconds.

Minimum allowed value is 32. Maximum allowed value is 512.