Methods
| StartTone | (u: Stream_ID, y: Event) | → | nothing | |
| StopTone | (u: Stream_ID) | → | nothing |
Types
| DTMF_Event | Enum | y |
Objects implementing this interface must also implement:
Description
An interface that gives a Channel the ability to send DTMF events over
audio streams which have been established using the StreamedMedia channel
type. The event codes used are in common with those defined in RFC4733, and are
listed in the DTMF_Event enumeration.
Methods
(Permalink)
StartTone (u: Stream_ID, y: Event) → nothing
Parameters
- Stream_ID — u (Stream_ID)
- Event — y (DTMF_Event)
A stream ID as defined in the StreamedMedia channel type.
A numeric event code from the DTMF_Event enum.
Start sending a DTMF tone on this stream. 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.
Possible Errors
- Network Error
- Invalid Argument
- Not Available
Raised when there is an error reading from or writing to the network.
The given stream ID was invalid.
The requested event is not available on this stream.
(Permalink)
StopTone (u: Stream_ID) → nothing
Parameters
- Stream_ID — u (Stream_ID)
A stream ID as defined in the StreamedMedia channel type.
Stop sending any DTMF tone which has been started using the
StartTone
method. If there is no current tone, this method will do nothing.
Possible Errors
- Network Error
- Invalid Argument
- Not Available
Raised when there is an error reading from or writing to the network.
The given stream ID was invalid.
Continuous tones are not supported by this stream.
Types
Enum (Permalink)
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)
0
1
2
3
4
5
6
7
8
9
*
#
A
B
C
D