Methods
StartTone | (u: Stream_ID, y: Event) | → | nothing | |
StopTone | (u: Stream_ID) | → | nothing | |
MultipleTones | (s: Tones) | → | nothing |
Signals
SendingTones | (s: Tones) | |
StoppedTones | (b: Cancelled) |
Properties
CurrentlySendingTones | b | Read only | |
InitialTones | s | Read only |
Types
DTMF_Event | Enum | y |
Description
Methods
StartTone (u: Stream_ID, y: Event) → nothing
Parameters
- Stream_ID — u (Stream_ID)
- Event — y (DTMF_Event)
Start sending a DTMF tone to all eligible streams in the channel. Where possible, the tone will continue until StopTone is called. On certain protocols, it may only be possible to send events with a predetermined length. In this case, the implementation MAY emit a fixed-length tone, and the StopTone method call SHOULD return NotAvailable.
Tone overlaping or queueing is not supported, so this method can only be called if no DTMF tones are already being played.
Possible Errors
- Network Error
- Invalid Argument
- Not Available
- Service Busy
StopTone (u: Stream_ID) → nothing
Parameters
- Stream_ID — u (Stream_ID)
Possible Errors
- Network Error
- Invalid Argument
- Not Available
MultipleTones (s: Tones) → nothing
Parameters
- Tones — s
Send multiple DTMF events to all eligible streams in the channel. Each character in the Tones string must be a valid DTMF event (as defined by RFC4733). Each tone will be played for a pre-defined number of milliseconds, followed by a pause before the next tone is played. The duration/pause is defined by the protocol or connection manager.
Tone overlaping or queueing is not supported, so this method can only be called if no DTMF tones are already being played.
Possible Errors
- Network Error
- Invalid Argument
- Not Available
- Service Busy
Signals
SendingTones (s: Tones)
Parameters
- Tones — s
DTMF tone(s)are being sent to all eligible streams in the channel. The signal is provided to indicating the fact that the streams are currently being used to send one or more DTMF tones, so any other media input is not getting through to the audio stream. It also serves as a cue for the StopTone method.
Properties
CurrentlySendingTones — b
InitialTones — s
If non-empty in a channel request that will create a new channel, the connection manager should send the tones immediately after at least one eligible audio stream has been created in the channel.
This property is immutable (cannot change).
Types
DTMF_Event — y
- Digit_0 (0)
- Digit_1 (1)
- Digit_2 (2)
- Digit_3 (3)
- Digit_4 (4)
- Digit_5 (5)
- Digit_6 (6)
- Digit_7 (7)
- Digit_8 (8)
- Digit_9 (9)
- Asterisk (10)
- Hash (11)
- Letter_A (12)
- Letter_B (13)
- Letter_C (14)
- Letter_D (15)