fm.liveswitch.AudioEncoder Class Reference

An audio encoder. More...

Public Member Functions
void	addOnBitrateChange (fm.liveswitch.IAction0 value)
	Adds a handler that is raised when the bitrate changes. More...
	AudioEncoder (fm.liveswitch.AudioFormat inputFormat, fm.liveswitch.AudioFormat outputFormat)
	Initializes a new instance of the fm.liveswitch.AudioEncoder class. More...
int	getBitrate ()
	Gets the current bitrate, in kbps. More...
long	getFramesEncoded ()
	Gets the number of encoded frames. More...
int	getMaxBitrate ()
	Gets the maximum bitrate, in kbps. More...
int	getMaxCodecBitrate ()
	Gets the maximum possible codec bitrate, in kbps. More...
int	getMaxOutputBitrate ()
	Gets the maximum output bitrate, in kbps. More...
int	getMinBitrate ()
	Gets the minimum bitrate, in kbps. More...
int	getMinCodecBitrate ()
	Gets the minimum possible codec bitrate, in kbps. More...
int	getMinOutputBitrate ()
	Gets the minimum output bitrate, in kbps. More...
boolean	getStaticOutputBitrate ()
	Gets whether fm.liveswitch.AudioEncoder#getMinOutputBitrate and fm.liveswitch.AudioEncoder#getMaxOutputBitrate should return fm.liveswitch.AudioEncoder#getMinCodecBitrate and fm.liveswitch.AudioEncoder#getMaxCodecBitrate, respectively, or response to changes in fm.liveswitch.AudioEncoder#getMinBitrate and fm.liveswitch.AudioEncoder#getMaxBitrate. More...
int	getTargetBitrate ()
	Gets the target bitrate, in kbps. More...
int	getTargetOutputBitrate ()
	Gets the target output bitrate, in kbps. More...
void	removeOnBitrateChange (fm.liveswitch.IAction0 value)
	Removes a handler that is raised when the bitrate changes. More...
void	setMaxBitrate (int value)
	Sets the maximum bitrate, in kbps. More...
void	setMinBitrate (int value)
	Sets the minimum bitrate, in kbps. More...
void	setStaticOutputBitrate (boolean value)
	Sets whether fm.liveswitch.AudioEncoder#getMinOutputBitrate and fm.liveswitch.AudioEncoder#getMaxOutputBitrate should return fm.liveswitch.AudioEncoder#getMinCodecBitrate and fm.liveswitch.AudioEncoder#getMaxCodecBitrate, respectively, or response to changes in fm.liveswitch.AudioEncoder#getMinBitrate and fm.liveswitch.AudioEncoder#getMaxBitrate. More...
void	setTargetBitrate (int value)
	Sets the target bitrate, in kbps. 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 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
void	doProcessTrackStatsFromOutput (fm.liveswitch.MediaTrackStats trackStats)
	Processes track stats from an output. More...
boolean	getCanChangeBitrate ()
	Gets whether this pipe can change the output bitrate. More...
void	raiseFrame (fm.liveswitch.AudioFrame frame)
	Raises the frame. More...
void	setBitrate (int value)
	Sets the current bitrate, in kbps. More...
void	setMaxOutputBitrate (int value)
	Sets the maximum output bitrate, in kbps. More...
void	setMinOutputBitrate (int value)
	Sets the minimum output bitrate, in kbps. More...
void	setTargetOutputBitrate (int value)
	Sets the target output bitrate, in kbps. 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...
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 encoder.

Constructor & Destructor Documentation

AudioEncoder()

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

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

Parameters

inputFormat	The input format.
outputFormat	The output format.

Member Function Documentation

addOnBitrateChange()

void fm.liveswitch.AudioEncoder.addOnBitrateChange

(

fm.liveswitch.IAction0

value

)

Adds a handler that is raised when the bitrate changes.

doProcessTrackStatsFromOutput()

void fm.liveswitch.AudioEncoder.doProcessTrackStatsFromOutput ( fm.liveswitch.MediaTrackStats  trackStats )

protected

Processes track stats from an output.

Parameters

trackStats

The track stats.

getBitrate()

int fm.liveswitch.AudioEncoder.getBitrate

(

)

Gets the current bitrate, in kbps.

A value of -1 indicates unset.

getCanChangeBitrate()

boolean fm.liveswitch.AudioEncoder.getCanChangeBitrate ( )

protected

Gets whether this pipe can change the output bitrate.

getFramesEncoded()

long fm.liveswitch.AudioEncoder.getFramesEncoded

(

)

Gets the number of encoded frames.

getMaxBitrate()

int fm.liveswitch.AudioEncoder.getMaxBitrate

(

)

Gets the maximum bitrate, in kbps.

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

getMaxCodecBitrate()

int fm.liveswitch.AudioEncoder.getMaxCodecBitrate

(

)

Gets the maximum possible codec bitrate, in kbps.

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

getMaxOutputBitrate()

int fm.liveswitch.AudioEncoder.getMaxOutputBitrate

(

)

Gets the maximum output bitrate, in kbps.

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

getMinBitrate()

int fm.liveswitch.AudioEncoder.getMinBitrate

(

)

Gets the minimum bitrate, in kbps.

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

getMinCodecBitrate()

int fm.liveswitch.AudioEncoder.getMinCodecBitrate

(

)

Gets the minimum possible codec bitrate, in kbps.

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

getMinOutputBitrate()

int fm.liveswitch.AudioEncoder.getMinOutputBitrate

(

)

Gets the minimum output bitrate, in kbps.

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

getStaticOutputBitrate()

boolean fm.liveswitch.AudioEncoder.getStaticOutputBitrate

(

)

Gets whether fm.liveswitch.AudioEncoder#getMinOutputBitrate and fm.liveswitch.AudioEncoder#getMaxOutputBitrate should return fm.liveswitch.AudioEncoder#getMinCodecBitrate and fm.liveswitch.AudioEncoder#getMaxCodecBitrate, respectively, or response to changes in fm.liveswitch.AudioEncoder#getMinBitrate and fm.liveswitch.AudioEncoder#getMaxBitrate.

getTargetBitrate()

int fm.liveswitch.AudioEncoder.getTargetBitrate

(

)

Gets the target bitrate, in kbps.

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

getTargetOutputBitrate()

int fm.liveswitch.AudioEncoder.getTargetOutputBitrate

(

)

Gets the target output bitrate, in kbps.

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

raiseFrame()

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

protected

Raises the frame.

Parameters

frame

The frame.

Reimplemented from fm.liveswitch.AudioPipe.

removeOnBitrateChange()

void fm.liveswitch.AudioEncoder.removeOnBitrateChange

(

fm.liveswitch.IAction0

value

)

Removes a handler that is raised when the bitrate changes.

setBitrate()

void fm.liveswitch.AudioEncoder.setBitrate ( int  value )

protected

Sets the current bitrate, in kbps.

A value of -1 indicates unset.

setMaxBitrate()

void fm.liveswitch.AudioEncoder.setMaxBitrate

(

int

value

)

Sets the maximum bitrate, in kbps.

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

setMaxOutputBitrate()

void fm.liveswitch.AudioEncoder.setMaxOutputBitrate ( int  value )

protected

Sets the maximum output bitrate, in kbps.

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

setMinBitrate()

void fm.liveswitch.AudioEncoder.setMinBitrate

(

int

value

)

Sets the minimum bitrate, in kbps.

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

setMinOutputBitrate()

void fm.liveswitch.AudioEncoder.setMinOutputBitrate ( int  value )

protected

Sets the minimum output bitrate, in kbps.

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

setStaticOutputBitrate()

void fm.liveswitch.AudioEncoder.setStaticOutputBitrate

(

boolean

value

)

Sets whether fm.liveswitch.AudioEncoder#getMinOutputBitrate and fm.liveswitch.AudioEncoder#getMaxOutputBitrate should return fm.liveswitch.AudioEncoder#getMinCodecBitrate and fm.liveswitch.AudioEncoder#getMaxCodecBitrate, respectively, or response to changes in fm.liveswitch.AudioEncoder#getMinBitrate and fm.liveswitch.AudioEncoder#getMaxBitrate.

setTargetBitrate()

void fm.liveswitch.AudioEncoder.setTargetBitrate

(

int

value

)

Sets the target bitrate, in kbps.

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

setTargetOutputBitrate()

void fm.liveswitch.AudioEncoder.setTargetOutputBitrate ( int  value )

protected

Sets the target output bitrate, in kbps.

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