fm.liveswitch.matroska.AudioSource Class Reference

A Matroska-file-based audio source. More...

Public Member Functions
void	addOnEnded (fm.liveswitch.IAction0 value)
	Adds a handler that is raised when the file ends. More...
	AudioSource (String path)
	Initializes a new instance of the fm.liveswitch.matroska.AudioSource class. More...
fm.liveswitch.Future< fm.liveswitch.SourceInput[]>	getInputs ()
	Gets the source inputs (tracks). More...
String	getLabel ()
	Gets the label. More...
String	getPath ()
	Gets the path. More...
boolean	getStopCaptureOnEnd ()
	Gets whether capturing should stop when the file ends. More...
void	removeOnEnded (fm.liveswitch.IAction0 value)
	Removes a handler that is raised when the file ends. More...
void	setStopCaptureOnEnd (boolean value)
	Sets whether capturing should stop when the file ends. 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
abstract fm.liveswitch.AudioDecoder	createOpusDecoder (fm.liveswitch.AudioConfig config)
	Creates an Opus decoder. More...
fm.liveswitch.AudioDecoder	createPcmaDecoder (fm.liveswitch.AudioConfig config)
	Creates a PCMA decoder. More...
fm.liveswitch.AudioDecoder	createPcmuDecoder (fm.liveswitch.AudioConfig config)
	Creates a PCMU decoder. More...
void	doDestroy ()
	Destroys this instance. More...
fm.liveswitch.Future< Object >	doStart ()
	Starts the source. More...
fm.liveswitch.Future< Object >	doStop ()
	Stops the source. 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
	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

A Matroska-file-based audio source.

Constructor & Destructor Documentation

AudioSource()

fm.liveswitch.matroska.AudioSource.AudioSource

(

String

path

)

Initializes a new instance of the fm.liveswitch.matroska.AudioSource class.

Parameters

path

The path.

Member Function Documentation

addOnEnded()

void fm.liveswitch.matroska.AudioSource.addOnEnded

(

fm.liveswitch.IAction0

value

)

Adds a handler that is raised when the file ends.

createOpusDecoder()

abstract fm.liveswitch.AudioDecoder fm.liveswitch.matroska.AudioSource.createOpusDecoder ( fm.liveswitch.AudioConfig  config )

abstractprotected

Creates an Opus decoder.

createPcmaDecoder()

fm.liveswitch.AudioDecoder fm.liveswitch.matroska.AudioSource.createPcmaDecoder ( fm.liveswitch.AudioConfig  config )

protected

Creates a PCMA decoder.

createPcmuDecoder()

fm.liveswitch.AudioDecoder fm.liveswitch.matroska.AudioSource.createPcmuDecoder ( fm.liveswitch.AudioConfig  config )

protected

Creates a PCMU decoder.

doDestroy()

void fm.liveswitch.matroska.AudioSource.doDestroy ( )

protected

Destroys this instance.

Reimplemented from fm.liveswitch.AudioSource.

doStart()

fm.liveswitch.Future<Object> fm.liveswitch.matroska.AudioSource.doStart ( )

protected

Starts the source.

doStop()

fm.liveswitch.Future<Object> fm.liveswitch.matroska.AudioSource.doStop ( )

protected

Stops the source.

getInputs()

fm.liveswitch.Future<fm.liveswitch.SourceInput[]> fm.liveswitch.matroska.AudioSource.getInputs

(

)

Gets the source inputs (tracks).

getLabel()

String fm.liveswitch.matroska.AudioSource.getLabel

(

)

Gets the label.

Implements fm.liveswitch.IMediaElement.

getPath()

String fm.liveswitch.matroska.AudioSource.getPath

(

)

Gets the path.

getStopCaptureOnEnd()

boolean fm.liveswitch.matroska.AudioSource.getStopCaptureOnEnd

(

)

Gets whether capturing should stop when the file ends.

Default: false.

removeOnEnded()

void fm.liveswitch.matroska.AudioSource.removeOnEnded

(

fm.liveswitch.IAction0

value

)

Removes a handler that is raised when the file ends.

setStopCaptureOnEnd()

void fm.liveswitch.matroska.AudioSource.setStopCaptureOnEnd

(

boolean

value

)

Sets whether capturing should stop when the file ends.

Default: false.