Copyright © 2005-2010 Collabora Limited Copyright © 2005-2010 Nokia Corporation Copyright © 2006 INdT

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

The Stream_IDs in this interface should now be ignored by CMs. This is primarily to allow this interface to be used with Call.DRAFT channels. 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. The Stream_ID parameter became vestigial. A stream ID as defined in the StreamedMedia channel type. This argument is included for backwards compatibility and MUST be ignored by the implementations - the tone SHOULD be sent to all eligible streams in the channel. A numeric event code from the DTMF_Event enum.

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.

The client may wish to control the exact duration and timing of the tones sent as a result of user's interaction with the dialpad, thus starting and stopping the tone sending explicitly.

Tone overlaping or queueing is not supported, so this method can only be called if no DTMF tones are already being played.

The given stream ID was invalid. Deprecated, since stream IDs are ignored. There are no eligible audio streams. DTMF tones are already being played.
The Stream_ID parameter became vestigial. A stream ID as defined in the StreamedMedia channel type. This argument is included for backwards compatibility and MUST be ignored by the implementations - the sending SHOULD be stoped in all eligible streams in the channel. Stop sending any DTMF tones which have been started using the StartTone or MultipleTones methods. If there is no current tone, this method will do nothing. If MultipleTones was used, the client should not assume the sending has stopped immediately; instead, the client should wait for the StoppedTones signal. On some protocols it might be impossible to cancel queued tones immediately. The given stream ID was invalid. Deprecated, since stream IDs are ignored. Continuous tones are not supported by this stream. Deprecated, since stream IDs are ignored. A string representation of one or more DTMF events.

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.

In cases where the client knows in advance the tone sequence it wants to send, it's easier to use this method than manually start and stop each tone in the sequence.

Tone overlaping or queueing is not supported, so this method can only be called if no DTMF tones are already being played.

The supplied Tones string was invalid. There are no eligible audio streams. DTMF tones are already being played.
Indicates whether there are DTMF tones currently being sent in the channel. If so, the client should wait for StoppedTones signal before trying to send more tones.

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).

DTMF string (one or more events) that is to be played.

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.

True if the DTMF tones were actively cancelled via StopTone.

DTMF tones have finished playing on streams in this channel.

0 1 2 3 4 5 6 7 8 9 * # A B C D