fm.liveswitch.NullAudioSource Class Reference

An audio source that raises nothing. More...

Public Member Functions
void	generateAndProcessPcmFrame ()
	Generates and processes a 20ms PCM frame. More...
void	generateAndProcessPcmFrame (int duration)
	Generates and processes a PCM frame. More...
String	getInputRtpStreamId ()
	Gets the input RTP stream identifier. More...
long	getInputSynchronizationSource ()
	Gets the input synchronization source. More...
String	getLabel ()
	Gets a label that identifies this class. More...
	NullAudioSource (fm.liveswitch.AudioFormat outputFormat)
	Initializes a new fm.liveswitch.NullAudioSource. More...
void	processControlFrameResponse (fm.liveswitch.MediaControlFrame controlFrameResponse)
	Processes a control frame response by raising it. More...
void	processControlFrameResponses (fm.liveswitch.MediaControlFrame[] controlFrameResponses)
	Processes control frame responses by raising them. More...
void	processFrame (fm.liveswitch.AudioFrame frame)
	Processes a frame by raising it. More...
void	setInputRtpStreamId (String value)
	Sets the input RTP stream identifier. More...
void	setInputSynchronizationSource (long value)
	Sets the input synchronization source. More...
void	updateCanChangeBitrate (boolean canChangeBitrate)
	Sets whether this source can change the output bitrate. More...
void	updateCanPauseBitrate (boolean canPauseBitrate)
	Sets whether this source can pause the output bitrate. 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	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	updateOutputSynchronizable (boolean outputSynchronizable)
	Sets whether output is synchronizable. More...
void	updateSystemDelay (long systemDelay)
	Sets the system delay in ticks. 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.AudioSource
	AudioSource (fm.liveswitch.AudioFormat outputFormat)
	Initializes a new instance of the fm.liveswitch.AudioSource class. More...
	AudioSource (fm.liveswitch.AudioFormat outputFormat, int frameDuration)
	Initializes a new instance of the fm.liveswitch.AudioSource class. More...
int	calculateDuration (int dataLength)
	Calculates the duration of an audio chunk given its data length (the number of bytes) and assuming that the clock rate and channel count match the output format. More...
int	calculateDurationFloat (int dataLength)
	Calculates the duration of an audio chunk given its data length (the number of bytes) and assuming that the clock rate and channel count match the output format. More...
fm.liveswitch.AudioConfig	getConfig ()
	Gets the output configuration. More...
boolean	getDisableTimestampReset ()
	Gets whether the timestamp should be reset using the wall clock after fm.liveswitch.AudioSource#getTimestampResetInterval milliseconds elapse between frames. More...
boolean	getForceTimestampReset ()
	Gets whether the timestamp should be reset before the next frame is processed. More...
int	getFrameDuration ()
	Gets the frame duration in milliseconds. More...
int	getTimestampResetInterval ()
	Gets the amount of time in milliseconds between audio frames that will trigger a reset of the timestamp to the wall clock. More...
double	getVolume ()
	Gets a value indicating the volume (output resistance) of this source. More...
void	setDisableTimestampReset (boolean value)
	Sets whether the timestamp should be reset using the wall clock after fm.liveswitch.AudioSource#getTimestampResetInterval milliseconds elapse between frames. More...
void	setForceTimestampReset (boolean value)
	Sets whether the timestamp should be reset before the next frame is processed. More...
void	setTimestampResetInterval (int value)
	Sets the amount of time in milliseconds between audio frames that will trigger a reset of the timestamp to the wall clock. More...
void	setVolume (double value)
	Sets a value indicating the volume (output resistance) of this source. More...
Public Member Functions inherited from fm.liveswitch.MediaSourceBase
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...
abstract fm.liveswitch.Future< Object >	start ()
	Starts this instance. More...
abstract fm.liveswitch.Future< Object >	stop ()
	Stops 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 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...
fm.liveswitch.Future< Object >	doStart ()
	Starts the source. More...
fm.liveswitch.Future< Object >	doStop ()
	Stops the source. More...
boolean	getCanChangeBitrate ()
	Gets whether this source can change the output bitrate. More...
boolean	getCanPauseBitrate ()
	Gets whether this source can pause the output bitrate. More...
Protected Member Functions inherited from fm.liveswitch.AudioSource
fm.liveswitch.IAudioInputCollection	createInputCollection (fm.liveswitch.IAudioOutput output)
	Creates an input collection. More...
void	raiseFrame (fm.liveswitch.AudioFrame frame)
	Raises a frame. More...
boolean	trySetSystemTimestamp (fm.liveswitch.AudioFrame frame)
	Tries to set the system timestamp on an audio frame. More...
boolean	trySetTimestamp (fm.liveswitch.AudioFrame frame)
	Tries to set the timestamp on an audio frame. More...
Protected Member Functions inherited from fm.liveswitch.MediaSourceBase
fm.liveswitch.LogContext	getLogContext ()
	Gets the log context for this connection. More...
	MediaSourceBase ()
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...

Additional Inherited Members
Static Public Member Functions inherited from fm.liveswitch.AudioSource
static int	calculateDuration (int dataLength, int clockRate, int channelCount)
	Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count. More...
static int	calculateDuration (int dataLength, fm.liveswitch.AudioConfig config)
	Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count. More...
static int	calculateDurationFloat (int dataLength, int clockRate, int channelCount)
	Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count. More...

Detailed Description

An audio source that raises nothing.

Constructor & Destructor Documentation

NullAudioSource()

fm.liveswitch.NullAudioSource.NullAudioSource

(

fm.liveswitch.AudioFormat

outputFormat

)

Initializes a new fm.liveswitch.NullAudioSource.

Parameters

outputFormat

The output format.

Member Function Documentation

doDestroy()

void fm.liveswitch.NullAudioSource.doDestroy ( )

protected

Destroys this instance.

Reimplemented from fm.liveswitch.AudioSource.

doStart()

fm.liveswitch.Future<Object> fm.liveswitch.NullAudioSource.doStart ( )

protected

Starts the source.

doStop()

fm.liveswitch.Future<Object> fm.liveswitch.NullAudioSource.doStop ( )

protected

Stops the source.

generateAndProcessPcmFrame() [1/2]

void fm.liveswitch.NullAudioSource.generateAndProcessPcmFrame

(

)

Generates and processes a 20ms PCM frame.

generateAndProcessPcmFrame() [2/2]

void fm.liveswitch.NullAudioSource.generateAndProcessPcmFrame

(

int

duration

)

Generates and processes a PCM frame.

Parameters

duration

The duration.

getCanChangeBitrate()

boolean fm.liveswitch.NullAudioSource.getCanChangeBitrate ( )

protected

Gets whether this source can change the output bitrate.

getCanPauseBitrate()

boolean fm.liveswitch.NullAudioSource.getCanPauseBitrate ( )

protected

Gets whether this source can pause the output bitrate.

getInputRtpStreamId()

String fm.liveswitch.NullAudioSource.getInputRtpStreamId

(

)

Gets the input RTP stream identifier.

getInputSynchronizationSource()

long fm.liveswitch.NullAudioSource.getInputSynchronizationSource

(

)

Gets the input synchronization source.

getLabel()

String fm.liveswitch.NullAudioSource.getLabel

(

)

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

processControlFrameResponse()

void fm.liveswitch.NullAudioSource.processControlFrameResponse

(

fm.liveswitch.MediaControlFrame

controlFrameResponse

)

Processes a control frame response by raising it.

Parameters

controlFrameResponse

The control frame response.

processControlFrameResponses()

void fm.liveswitch.NullAudioSource.processControlFrameResponses

(

fm.liveswitch.MediaControlFrame[]

controlFrameResponses

)

Processes control frame responses by raising them.

Parameters

controlFrameResponses

The control frame responses.

processFrame()

void fm.liveswitch.NullAudioSource.processFrame

(

fm.liveswitch.AudioFrame

frame

)

Processes a frame by raising it.

Parameters

frame

The frame.

setInputRtpStreamId()

void fm.liveswitch.NullAudioSource.setInputRtpStreamId

(

String

value

)

Sets the input RTP stream identifier.

setInputSynchronizationSource()

void fm.liveswitch.NullAudioSource.setInputSynchronizationSource

(

long

value

)

Sets the input synchronization source.

updateCanChangeBitrate()

void fm.liveswitch.NullAudioSource.updateCanChangeBitrate

(

boolean

canChangeBitrate

)

Sets whether this source can change the output bitrate.

Parameters

canChangeBitrate

Whether this source can change the output bitrate.

updateCanPauseBitrate()

void fm.liveswitch.NullAudioSource.updateCanPauseBitrate

(

boolean

canPauseBitrate

)

Sets whether this source can pause the output bitrate.

Parameters

canPauseBitrate

Whether this source can pause the output bitrate.

updateMaxOutputBitrate()

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

updateMinOutputBitrate()

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

updateOutputSynchronizable()

void fm.liveswitch.NullAudioSource.updateOutputSynchronizable

(

boolean

outputSynchronizable

)

Sets whether output is synchronizable.

Parameters

outputSynchronizable

Whether output is synchronizable.

updateSystemDelay()

void fm.liveswitch.NullAudioSource.updateSystemDelay

(

long

systemDelay

)

Sets the system delay in ticks.

Parameters

systemDelay

The system delay.

updateTargetOutputBitrate()

void fm.liveswitch.NullAudioSource.updateTargetOutputBitrate

(

int

targetOutputBitrate

)

Sets the target output bitrate, in kbps.

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

Parameters

targetOutputBitrate

The target output bitrate, in kbps.

updateTargetOutputEncoding()

void fm.liveswitch.NullAudioSource.updateTargetOutputEncoding

(

fm.liveswitch.EncodingInfo

targetOutputEncoding

)

Sets the target output encoding.

A value of null indicates unset (no target).

Parameters

targetOutputEncoding

The target output encoding.