A DTMF (telephone-event) sender. More...

Public Member Functions
void	addOnTone (fm.liveswitch.IAction1< fm.liveswitch.dtmf.Tone > value)
	Adds a handler that is raised when a tone is sent. More...

void	addOnToneChange (fm.liveswitch.IAction1< fm.liveswitch.dtmf.Tone > value)
	Adds a handler that is raised when the tone changes. More...

String	getLabel ()
	Gets a label that identifies this class. More...

fm.liveswitch.dtmf.Tone	getTone ()
	Gets the current tone. More...

boolean	hasTone ()
	Determines whether any tones are queued for delivery. More...

void	insertTones (fm.liveswitch.dtmf.Tone[] tones)
	Inserts tones into the DTMF stream. More...

boolean	raiseTone (int duration, long timestamp, long synchronizationSource)
	Adds the next tone to the frame. More...

void	removeOnTone (fm.liveswitch.IAction1< fm.liveswitch.dtmf.Tone > value)
	Removes a handler that is raised when a tone is sent. More...

void	removeOnToneChange (fm.liveswitch.IAction1< fm.liveswitch.dtmf.Tone > value)
	Removes a handler that is raised when the tone changes. More...

	Sender ()
	Initializes a new instance of the fm.liveswitch.dtmf.Sender class. More...

	Sender (int clockRate)
	Initializes a new instance of the fm.liveswitch.dtmf.Sender class. 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...

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

A DTMF (telephone-event) sender.

Constructor & Destructor Documentation

◆ Sender() [1/2]

fm.liveswitch.dtmf.Sender.Sender ( )

Initializes a new instance of the fm.liveswitch.dtmf.Sender class.

◆ Sender() [2/2]

fm.liveswitch.dtmf.Sender.Sender ( int clockRate )

Initializes a new instance of the fm.liveswitch.dtmf.Sender class.

Parameters

clockRate The clock rate.

Member Function Documentation

◆ addOnTone()

void fm.liveswitch.dtmf.Sender.addOnTone ( fm.liveswitch.IAction1< fm.liveswitch.dtmf.Tone > value )

Adds a handler that is raised when a tone is sent.

◆ addOnToneChange()

void fm.liveswitch.dtmf.Sender.addOnToneChange ( fm.liveswitch.IAction1< fm.liveswitch.dtmf.Tone > value )

Adds a handler that is raised when the tone changes.

An empty string indicates the end of a tone.

◆ doDestroy()

void fm.liveswitch.dtmf.Sender.doDestroy ( )

protected

Destroys this instance.

◆ doProcessFrame()

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

protected

Processes a frame.

Parameters

frame	The frame.
inputBuffer	The input buffer.

◆ getLabel()

String fm.liveswitch.dtmf.Sender.getLabel ( )

Gets a label that identifies this class.

Implements fm.liveswitch.IMediaElement.

◆ getTone()

fm.liveswitch.dtmf.Tone fm.liveswitch.dtmf.Sender.getTone ( )

Gets the current tone.

◆ hasTone()

boolean fm.liveswitch.dtmf.Sender.hasTone ( )

Determines whether any tones are queued for delivery.

◆ insertTones()

void fm.liveswitch.dtmf.Sender.insertTones ( fm.liveswitch.dtmf.Tone[] tones )

Inserts tones into the DTMF stream.

Parameters

tones The tones.

◆ raiseTone()

boolean fm.liveswitch.dtmf.Sender.raiseTone	(	int	duration,
		long	timestamp,
		long	synchronizationSource
	)

Adds the next tone to the frame.

Parameters

duration	The duration.
timestamp	The timestamp.
synchronizationSource	The synchronization source.

◆ removeOnTone()

void fm.liveswitch.dtmf.Sender.removeOnTone ( fm.liveswitch.IAction1< fm.liveswitch.dtmf.Tone > value )

Removes a handler that is raised when a tone is sent.

◆ removeOnToneChange()

void fm.liveswitch.dtmf.Sender.removeOnToneChange ( fm.liveswitch.IAction1< fm.liveswitch.dtmf.Tone > value )

Removes a handler that is raised when the tone changes.

An empty string indicates the end of a tone.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Sender() [1/2]

◆ Sender() [2/2]

Member Function Documentation

◆ addOnTone()

◆ addOnToneChange()

◆ doDestroy()

◆ doProcessFrame()

◆ getLabel()

◆ getTone()

◆ hasTone()

◆ insertTones()

◆ raiseTone()

◆ removeOnTone()

◆ removeOnToneChange()