org.webrtc

Class DtmfSender

java.lang.Object

org.webrtc.DtmfSender

public class DtmfSender
extends java.lang.Object

Java wrapper for a C++ DtmfSenderInterface.

Constructor Summary

Constructors

Constructor and Description
DtmfSender(long nativeDtmfSender)

Method Summary

Modifier and Type	Method and Description
boolean	canInsertDtmf()
void	dispose()
int	duration()
boolean	insertDtmf(java.lang.String tones, int duration, int interToneGap) Queues a task that sends the provided DTMF tones.
int	interToneGap()
java.lang.String	tones()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DtmfSender

public DtmfSender(long nativeDtmfSender)

Method Detail

canInsertDtmf

public boolean canInsertDtmf()

Returns:

true if this DtmfSender is capable of sending DTMF. Otherwise false.

insertDtmf

public boolean insertDtmf(java.lang.String tones,
                          int duration,
                          int interToneGap)

Queues a task that sends the provided DTMF tones.

If insertDtmf is called on the same object while an existing task for this object to generate DTMF is still running, the previous task is canceled.

Parameters:

tones - This parameter is treated as a series of characters. The characters 0 through 9, A through D, #, and * generate the associated DTMF tones. The characters a to d are equivalent to A to D. The character ',' indicates a delay of 2 seconds before processing the next character in the tones parameter. Unrecognized characters are ignored.

duration - Indicates the duration in ms to use for each character passed in the tones parameter. The duration cannot be more than 6000 or less than 70.

interToneGap - Indicates the gap between tones in ms. Must be at least 50 ms but should be as short as possible.

Returns:

true on success and false on failure.

tones

public java.lang.String tones()

Returns:

The tones remaining to be played out

duration

public int duration()

Returns:

The current tone duration value in ms. This value will be the value last set via the insertDtmf() method, or the default value of 100 ms if insertDtmf() was never called.

interToneGap

public int interToneGap()

Returns:

The current value of the between-tone gap in ms. This value will be the value last set via the insertDtmf() method, or the default value of 50 ms if insertDtmf() was never called.

dispose

public void dispose()