fm.liveswitch.IdentityAudioPipe Class Reference

An audio pipe whose output matches its input. More...

Public Member Functions
String	getLabel ()
	Gets a label that identifies this class. More...
	IdentityAudioPipe (fm.liveswitch.AudioFormat format)
	Initializes a new fm.liveswitch.IdentityAudioPipe. More...
	IdentityAudioPipe (fm.liveswitch.AudioFormat inputFormat, fm.liveswitch.AudioFormat outputFormat)
	Initializes a new fm.liveswitch.IdentityAudioPipe. More...
void	updateCanChangeBitrate (boolean canChangeBitrate)
	Sets whether this pipe can change the output bitrate. More...
void	updateCanPauseBitrate (boolean canPauseBitrate)
	Sets whether this pipe can pause the output bitrate. More...
void	updateMaxInputBitrate (int maxInputBitrate)
	Sets the maximum allowed input bitrate, in kbps. More...
void	updateMaxInputEncoding (fm.liveswitch.EncodingInfo maxInputEncoding)
	Sets the maximum allowed input encoding. More...
void	updateMaxOutputBitrate (int maxOutputBitrate)
	Sets the maximum allowed output bitrate, in kbps. More...
void	updateMaxOutputEncoding (fm.liveswitch.EncodingInfo maxOutputEncoding)
	Sets the maximum allowed output encoding. More...
void	updateMinInputBitrate (int minInputBitrate)
	Sets the minimum allowed input bitrate, in kbps. More...
void	updateMinInputEncoding (fm.liveswitch.EncodingInfo minInputEncoding)
	Sets the minimum allowed input encoding. More...
void	updateMinOutputBitrate (int minOutputBitrate)
	Sets the minimum allowed output bitrate, in kbps. More...
void	updateMinOutputEncoding (fm.liveswitch.EncodingInfo minOutputEncoding)
	Sets the minimum allowed output encoding. More...
void	updateTargetOutputBitrate (int targetOutputBitrate)
	Sets the target output bitrate, in kbps. More...
void	updateTargetOutputEncoding (fm.liveswitch.EncodingInfo targetOutputEncoding)
	Sets the target output encoding. 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	getCanChangeBitrate ()
	Gets whether this pipe can change the output bitrate. More...
boolean	getCanPauseBitrate ()
	Gets whether this pipe can pause the output bitrate. 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

An audio pipe whose output matches its input.

Constructor & Destructor Documentation

IdentityAudioPipe() [1/2]

fm.liveswitch.IdentityAudioPipe.IdentityAudioPipe

(

fm.liveswitch.AudioFormat

format

)

Initializes a new fm.liveswitch.IdentityAudioPipe.

Parameters

format

The input/output format.

IdentityAudioPipe() [2/2]

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

Initializes a new fm.liveswitch.IdentityAudioPipe.

Allows for the input format of the audio to differ from the output format of the audio to satisfy a media pipeline where the output format is a superset of the input format, however this class will not change the format of any frames.

Parameters

inputFormat
outputFormat

Member Function Documentation

doDestroy()

void fm.liveswitch.IdentityAudioPipe.doDestroy ( )

protected

Destroys this instance.

doProcessFrame()

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

protected

Processes a frame.

Parameters

frame	The frame.
inputBuffer	The input buffer.

getCanChangeBitrate()

boolean fm.liveswitch.IdentityAudioPipe.getCanChangeBitrate ( )

protected

Gets whether this pipe can change the output bitrate.

getCanPauseBitrate()

boolean fm.liveswitch.IdentityAudioPipe.getCanPauseBitrate ( )

protected

Gets whether this pipe can pause the output bitrate.

getLabel()

String fm.liveswitch.IdentityAudioPipe.getLabel

(

)

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

updateCanChangeBitrate()

void fm.liveswitch.IdentityAudioPipe.updateCanChangeBitrate

(

boolean

canChangeBitrate

)

Sets whether this pipe can change the output bitrate.

Parameters

canChangeBitrate

Whether this pipe can change the output bitrate.

updateCanPauseBitrate()

void fm.liveswitch.IdentityAudioPipe.updateCanPauseBitrate

(

boolean

canPauseBitrate

)

Sets whether this pipe can pause the output bitrate.

Parameters

canPauseBitrate

Whether this pipe can pause the output bitrate.

updateMaxInputBitrate()

void fm.liveswitch.IdentityAudioPipe.updateMaxInputBitrate

(

int

maxInputBitrate

)

Sets the maximum allowed input bitrate, in kbps.

A value of -1 indicates unset, in which case the maximum input bitrate becomes the minimum of all output maximum input bitrates.

Parameters

maxInputBitrate

The maximum allowed input bitrate, in kbps.

updateMaxInputEncoding()

void fm.liveswitch.IdentityAudioPipe.updateMaxInputEncoding

(

fm.liveswitch.EncodingInfo

maxInputEncoding

)

Sets the maximum allowed input encoding.

A value of null indicates unset (no maximum).

Parameters

maxInputEncoding

The maximum allowed input encoding.

updateMaxOutputBitrate()

void fm.liveswitch.IdentityAudioPipe.updateMaxOutputBitrate

(

int

maxOutputBitrate

)

Sets the maximum allowed output bitrate, in kbps.

A value of -1 indicates unset (no maximum).

Parameters

maxOutputBitrate

The maximum allowed output bitrate, in kbps.

updateMaxOutputEncoding()

void fm.liveswitch.IdentityAudioPipe.updateMaxOutputEncoding

(

fm.liveswitch.EncodingInfo

maxOutputEncoding

)

Sets the maximum allowed output encoding.

A value of null indicates unset (no maximum).

Parameters

maxOutputEncoding

The maximum allowed output encoding.

updateMinInputBitrate()

void fm.liveswitch.IdentityAudioPipe.updateMinInputBitrate

(

int

minInputBitrate

)

Sets the minimum allowed input bitrate, in kbps.

A value of -1 indicates unset, in which case the minimum input bitrate becomes the maximum of all output minimum input bitrates.

Parameters

minInputBitrate

The minimum allowed input bitrate, in kbps.

updateMinInputEncoding()

void fm.liveswitch.IdentityAudioPipe.updateMinInputEncoding

(

fm.liveswitch.EncodingInfo

minInputEncoding

)

Sets the minimum allowed input encoding.

A value of null indicates unset (no minimum).

Parameters

minInputEncoding

The minimum allowed input encoding.

updateMinOutputBitrate()

void fm.liveswitch.IdentityAudioPipe.updateMinOutputBitrate

(

int

minOutputBitrate

)

Sets the minimum allowed output bitrate, in kbps.

A value of -1 indicates unset (no minimum).

Parameters

minOutputBitrate

The minimum allowed output bitrate, in kbps.

updateMinOutputEncoding()

void fm.liveswitch.IdentityAudioPipe.updateMinOutputEncoding

(

fm.liveswitch.EncodingInfo

minOutputEncoding

)

Sets the minimum allowed output encoding.

A value of null indicates unset (no minimum).

Parameters

minOutputEncoding

The minimum allowed output encoding.

updateTargetOutputBitrate()

void fm.liveswitch.IdentityAudioPipe.updateTargetOutputBitrate

(

int

targetOutputBitrate

)

Sets the target output bitrate, in kbps.

A value of -1 indicates unset (no minimum).

Parameters

targetOutputBitrate

The target output bitrate, in kbps.

updateTargetOutputEncoding()

void fm.liveswitch.IdentityAudioPipe.updateTargetOutputEncoding

(

fm.liveswitch.EncodingInfo

targetOutputEncoding

)

Sets the target output encoding.

A value of null indicates unset (no target).

Parameters

targetOutputEncoding

The target output encoding.