fm.liveswitch.NullAudioSink Class Reference

An audio sink that discards frames. More...

Public Member Functions
long	getFrameCount ()
	Gets the current frame count. More...
String	getLabel ()
	Gets a label that identifies this class. More...
String	getOutputRtpStreamId ()
	Gets the output RTP stream identifier. More...
long	getOutputSynchronizationSource ()
	Gets the output synchronization source. More...
	NullAudioSink ()
	Initializes a new fm.liveswitch.NullAudioSink. More...
	NullAudioSink (fm.liveswitch.AudioFormat inputFormat)
	Initializes a new fm.liveswitch.NullAudioSink. More...
void	processControlFrame (fm.liveswitch.MediaControlFrame controlFrame)
	Processes a control frame by raising it. More...
void	processControlFrames (fm.liveswitch.MediaControlFrame[] controlFrames)
	Processes control frames by raising them. More...
fm.liveswitch.Future< Object >	processedFrames (long count)
	Creates a future that resolves when the specified number of frames have been processed. More...
void	setOutputRtpStreamId (String value)
	Sets the output RTP stream identifier. More...
void	setOutputSynchronizationSource (long value)
	Sets the output synchronization source. 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	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	updateSystemDelay (long systemDelay)
	Sets the system delay in ticks. 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...
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...
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...
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 ()
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 sink that discards frames.

Constructor & Destructor Documentation

NullAudioSink() [1/2]

fm.liveswitch.NullAudioSink.NullAudioSink

(

)

Initializes a new fm.liveswitch.NullAudioSink.

NullAudioSink() [2/2]

fm.liveswitch.NullAudioSink.NullAudioSink

(

fm.liveswitch.AudioFormat

inputFormat

)

Initializes a new fm.liveswitch.NullAudioSink.

Parameters

inputFormat

The input format.

Member Function Documentation

doDestroy()

void fm.liveswitch.NullAudioSink.doDestroy ( )

protected

Destroys this instance.

doProcessFrame()

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

protected

Processes a frame.

Parameters

frame	The frame.
inputBuffer	The input buffer.

getFrameCount()

long fm.liveswitch.NullAudioSink.getFrameCount

(

)

Gets the current frame count.

getLabel()

String fm.liveswitch.NullAudioSink.getLabel

(

)

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

getOutputRtpStreamId()

String fm.liveswitch.NullAudioSink.getOutputRtpStreamId

(

)

Gets the output RTP stream identifier.

If the output RTP stream identifier is null (unset), then getting this property returns the InputRtpStreamId.

getOutputSynchronizationSource()

long fm.liveswitch.NullAudioSink.getOutputSynchronizationSource

(

)

Gets the output synchronization source.

If the output synchronization source is -1 (unset), then getting this property returns the InputSynchronizationSource.

processControlFrame()

void fm.liveswitch.NullAudioSink.processControlFrame

(

fm.liveswitch.MediaControlFrame

controlFrame

)

Processes a control frame by raising it.

Parameters

controlFrame

The control frame.

processControlFrames()

void fm.liveswitch.NullAudioSink.processControlFrames

(

fm.liveswitch.MediaControlFrame[]

controlFrames

)

Processes control frames by raising them.

Parameters

controlFrames

The control frames.

processedFrames()

fm.liveswitch.Future<Object> fm.liveswitch.NullAudioSink.processedFrames

(

long

count

)

Creates a future that resolves when the specified number of frames have been processed.

Parameters

count

setOutputRtpStreamId()

void fm.liveswitch.NullAudioSink.setOutputRtpStreamId

(

String

value

)

Sets the output RTP stream identifier.

If the output RTP stream identifier is null (unset), then getting this property returns the InputRtpStreamId.

setOutputSynchronizationSource()

void fm.liveswitch.NullAudioSink.setOutputSynchronizationSource

(

long

value

)

Sets the output synchronization source.

If the output synchronization source is -1 (unset), then getting this property returns the InputSynchronizationSource.

updateMaxInputBitrate()

void fm.liveswitch.NullAudioSink.updateMaxInputBitrate

(

int

maxInputBitrate

)

Sets the maximum allowed input bitrate, in kbps.

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

Parameters

maxInputBitrate

The maximum allowed input bitrate, in kbps.

updateMaxInputEncoding()

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

updateMinInputBitrate()

void fm.liveswitch.NullAudioSink.updateMinInputBitrate

(

int

minInputBitrate

)

Sets the minimum allowed input bitrate, in kbps.

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

Parameters

minInputBitrate

The minimum allowed input bitrate, in kbps.

updateMinInputEncoding()

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

updateSystemDelay()

void fm.liveswitch.NullAudioSink.updateSystemDelay

(

long

systemDelay

)

Sets the system delay in ticks.

Parameters

systemDelay

The system delay.