An audio pipe. More...

Public Member Functions
	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 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.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

An audio pipe.

Constructor & Destructor Documentation

◆ AudioPipe() [1/2]

fm.liveswitch.AudioPipe.AudioPipe	(	fm.liveswitch.AudioFormat	inputFormat,
		fm.liveswitch.AudioFormat	outputFormat
	)

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

Parameters

inputFormat	The input format.
outputFormat	The output format.

◆ AudioPipe() [2/2]

fm.liveswitch.AudioPipe.AudioPipe ( fm.liveswitch.AudioFormat outputFormat )

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

Parameters

outputFormat The output format.

Member Function Documentation

◆ createFrame()

fm.liveswitch.AudioFrame fm.liveswitch.AudioPipe.createFrame ( fm.liveswitch.AudioBuffer buffer )

protected

Creates a frame.

Parameters

buffer The buffer.

◆ createInputCollection()

fm.liveswitch.IAudioInputCollection fm.liveswitch.AudioPipe.createInputCollection ( fm.liveswitch.IAudioOutput output )

protected

Creates an input collection.

Parameters

output The output.

◆ createOutputCollection()

fm.liveswitch.IAudioOutputCollection fm.liveswitch.AudioPipe.createOutputCollection ( fm.liveswitch.IAudioInput input )

protected

Creates an output collection.

Parameters

input The input.

◆ getConfig()

fm.liveswitch.AudioConfig fm.liveswitch.AudioPipe.getConfig ( )

Gets the output configuration.

(Alias for fm.liveswitch.AudioPipe#getOutputConfig.)

Implements fm.liveswitch.IAudioInput.

◆ getGain()

double fm.liveswitch.AudioPipe.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.

◆ getInputConfig()

fm.liveswitch.AudioConfig fm.liveswitch.AudioPipe.getInputConfig ( )

Gets the input configuration.

◆ getOutputConfig()

fm.liveswitch.AudioConfig fm.liveswitch.AudioPipe.getOutputConfig ( )

Gets the output configuration.

◆ getVolume()

double fm.liveswitch.AudioPipe.getVolume ( )

Gets a value indicating the volume (output resistance) of this source.

Valid value range is 0.0 to 1.0, inclusive.

Implements fm.liveswitch.IAudioOutput.

◆ processFrame()

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

Processes a frame.

Parameters

frame The frame.

Reimplemented in fm.liveswitch.AudioPacketizer, and fm.liveswitch.AudioDecoder.

◆ raiseFrame()

void fm.liveswitch.AudioPipe.raiseFrame ( fm.liveswitch.AudioFrame frame )

protected

Raises a frame.

Parameters

frame The frame.

Reimplemented in fm.liveswitch.AudioEncoder, fm.liveswitch.AudioDepacketizer, and fm.liveswitch.AudioDecoder.

◆ setGain()

void fm.liveswitch.AudioPipe.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.

◆ setVolume()

void fm.liveswitch.AudioPipe.setVolume ( double value )

Sets a value indicating the volume (output resistance) of this source.

Valid value range is 0.0 to 1.0, inclusive.

Implements fm.liveswitch.IAudioOutput.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AudioPipe() [1/2]

◆ AudioPipe() [2/2]

Member Function Documentation

◆ createFrame()

◆ createInputCollection()

◆ createOutputCollection()

◆ getConfig()

◆ getGain()

◆ getInputConfig()

◆ getOutputConfig()

◆ getVolume()

◆ processFrame()

◆ raiseFrame()

◆ setGain()

◆ setVolume()