TAPIEx.NET Component Documentation

MonitorTones_Add  Method

Description

The MonitorTones_Add method enables the detection of inband tones on this call. Each time when a specified tone is detected, OnToneDetected will be fired.

[Visual Basic]
Public Function MonitorTones_Add(
ByVal AppSpecific As Integer, ByVal Duration As Integer,
ByVal Frequency1 As Integer, ByVal Frequency2 As Integer, ByVal Frequency3 As Integer) As Boolean
[C#]
public Boolean MonitorTones_Add (
System.Int32 AppSpecific , System.Int32 Duration ,
System.Int32 Frequency1 , System.Int32 Frequency2 , System.Int32 Frequency3 )

Parameters

AppSpecific
Used by the application for tagging the tone. When this tone is detected, Event OnToneDetected() fires with the value of the AppSpecific as parameter.
Duration
The duration, in milliseconds, during which the tone should be present before a detection is made.
Frequency1, Frequency2, Frequency3
The frequency, in hertz, of a component of the tone. If fewer than three frequencies are needed in the tone, a value of 0 should be used for the unused frequencies. A tone with all three frequencies set to zero is interpreted as silence and can be used for silence detection.

Return values

If the method succeeds, return TRUE. If the function fails, the return value is FALSE.

Remarks

Example: Detect the '0'-'#' DTMF keys use MonitorTones_Add
        .MonitorTones_Add 1, 80, 697, 1209, 0      ' "1"
        .MonitorTones_Add 2, 80, 697, 1336, 0      ' "2"
        .MonitorTones_Add 3, 80, 697, 1477, 0      ' "3"
        .MonitorTones_Add 4, 80, 770, 1209, 0      ' "4"
        .MonitorTones_Add 5, 80, 770, 1336, 0      ' "5"
        .MonitorTones_Add 6, 80, 770, 1477, 0      ' "6"
        .MonitorTones_Add 7, 80, 852, 1209, 0      ' "7"
        .MonitorTones_Add 8, 80, 852, 1336, 0      ' "8"
        .MonitorTones_Add 9, 80, 852, 1477, 0      ' "9"
        .MonitorTones_Add 10, 80, 941, 1209, 0     ' "*"
        .MonitorTones_Add 0,  80, 941, 1336, 0      ' "0"
        .MonitorTones_Add 12, 80, 941, 1477, 0     ' "#"

See Also

OnToneDetected

Support editions