fm.liveswitch.java.SoundSink Class Reference

A javax.sound-based audio sink. More...

Public Member Functions
Future< SinkOutput[]>	getOutputs ()
	Gets the available outputs. More...
void	setMaxQueueLengthMillis (int value)
	Sets the max audio queue length in milliseconds. More...
int	getMaxQueueLengthMillis ()
	Gets the max audio queue length in milliseconds. More...
String	getLabel ()
	Gets a label that identifies this class. More...
	SoundSink (AudioConfig config)
	Initializes a new instance of the SoundSink class. More...
	SoundSink (IAudioOutput input)
	Initializes a new instance of the SoundSink class. More...
	SoundSink (IAudioOutput[] inputs)
	Initializes a new instance of the SoundSink class. More...
Public Member Functions inherited from fm.liveswitch.AudioSink
	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...
fm.liveswitch.LogContext	getLogContext ()
	Gets the log context. 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...
void	updateLogContext (fm.liveswitch.LogContext context)
	Updates the log context. 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	doProcessFrame (AudioFrame frame, AudioBuffer inputBuffer)
void	doDestroy ()
Protected Member Functions inherited from fm.liveswitch.AudioSink
fm.liveswitch.IAudioOutputCollection	createOutputCollection (fm.liveswitch.IAudioInput input)
	Creates an output collection. More...
Protected Member Functions inherited from fm.liveswitch.MediaSinkBase
	MediaSinkBase ()
void	setLogContext (fm.liveswitch.LogContext value)
	Sets the log context. 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 javax.sound-based audio sink.

Constructor & Destructor Documentation

SoundSink() [1/3]

fm.liveswitch.java.SoundSink.SoundSink

(

AudioConfig

config

)

Initializes a new instance of the SoundSink class.

Parameters

config

The configuration.

SoundSink() [2/3]

fm.liveswitch.java.SoundSink.SoundSink

(

IAudioOutput

input

)

Initializes a new instance of the SoundSink class.

Parameters

input

The input.

SoundSink() [3/3]

fm.liveswitch.java.SoundSink.SoundSink

(

IAudioOutput[]

inputs

)

Initializes a new instance of the SoundSink class.

Parameters

inputs

The inputs.

Member Function Documentation

doDestroy()

void fm.liveswitch.java.SoundSink.doDestroy ( )

protected

doProcessFrame()

void fm.liveswitch.java.SoundSink.doProcessFrame ( AudioFrame  frame, AudioBuffer  inputBuffer  )

protected

getLabel()

String fm.liveswitch.java.SoundSink.getLabel

(

)

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

getMaxQueueLengthMillis()

int fm.liveswitch.java.SoundSink.getMaxQueueLengthMillis

(

)

Gets the max audio queue length in milliseconds.

Returns

The max audio queue length in milliseconds.

getOutputs()

Future<SinkOutput[]> fm.liveswitch.java.SoundSink.getOutputs

(

)

Gets the available outputs.

setMaxQueueLengthMillis()

void fm.liveswitch.java.SoundSink.setMaxQueueLengthMillis

(

int

value

)

Sets the max audio queue length in milliseconds.

Parameters

value

The max audio queue length in milliseconds.