fm.liveswitch.AudioSink Class Referenceabstract

An audio sink. More...

Public Member Functions

 AudioSink ()
 Initializes a new instance of the fm.liveswitch.AudioSink class. More...
 
 AudioSink (fm.liveswitch.AudioFormat inputFormat)
 Initializes a new instance of the fm.liveswitch.AudioSink class. More...
 
fm.liveswitch.AudioConfig getConfig ()
 Gets the input configuration. More...
 
double getGain ()
 Gets a value indicating the gain (input amplification) of this sink. 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...
 
- Public Member Functions inherited from fm.liveswitch.MediaSinkBase
String getExternalId ()
 Gets the external identifier. More...
 
String getId ()
 Gets the identifier. More...
 
String getTag ()
 Gets optional data to associate with this instance. More...
 
void setExternalId (String value)
 Sets the external identifier. More...
 
void setTag (String value)
 Sets optional data to associate with this instance. 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 String getLabel ()
 Gets a label that identifies this instance. 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

fm.liveswitch.IAudioOutputCollection createOutputCollection (fm.liveswitch.IAudioInput input)
 Creates an output collection. More...
 
- Protected Member Functions inherited from fm.liveswitch.MediaSinkBase
 MediaSinkBase ()
 
- 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

An audio sink.

Constructor & Destructor Documentation

◆ AudioSink() [1/2]

fm.liveswitch.AudioSink.AudioSink ( )

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

◆ AudioSink() [2/2]

fm.liveswitch.AudioSink.AudioSink ( fm.liveswitch.AudioFormat  inputFormat)

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

Parameters
inputFormatThe input format.

Member Function Documentation

◆ createOutputCollection()

fm.liveswitch.IAudioOutputCollection fm.liveswitch.AudioSink.createOutputCollection ( fm.liveswitch.IAudioInput  input)
protected

Creates an output collection.

Parameters
inputThe input.

◆ getConfig()

fm.liveswitch.AudioConfig fm.liveswitch.AudioSink.getConfig ( )

Gets the input configuration.

Implements fm.liveswitch.IAudioInput.

◆ getGain()

double fm.liveswitch.AudioSink.getGain ( )

Gets a value indicating the gain (input amplification) of this sink.

Any value greater than or equal to 0.0 is acceptable.

Implements fm.liveswitch.IAudioInput.

◆ processFrame()

boolean fm.liveswitch.AudioSink.processFrame ( fm.liveswitch.AudioFrame  frame)

Processes a frame.

Parameters
frameThe frame.

◆ setGain()

void fm.liveswitch.AudioSink.setGain ( double  value)

Sets a value indicating the gain (input amplification) of this sink.

Any value greater than or equal to 0.0 is acceptable.

Implements fm.liveswitch.IAudioInput.