ThbTapiLine.CallOptions.GatherDigits
Unit: hbTapi

This property is used as a default value for the GatherDigits property of new calls. See the GatherDigits property of ThbTapiCall for further Information.

GatherDigits has the following sub-property:

DigitModes
FirstDigitTimeout
InterDigitTimeout
NumDigits
TerminationDigits

Availability

Design-Time: Read, Write / Run-Time: Read, Write

Declaration

property GatherDigits : ThbTapiCallGatherDigitsParams;

See Also

ThbTapiCall.GatherDigits, ThbTapiLine.OnDigits

ThbTapiLine.CallOptions.GatherDigits.DigitModes

Type: DWord

The digit mode(s) to be monitored. This parameter uses one or more of the LINEDIGITMODE_ constants:

Constant

Meaning

LINEDIGITMODE_PULSE

Use this mode to detect rotary pulse sequences to signal digits. Valid digits are 0 through 9.

LINEDIGITMODE_DTMF

Use this mode to detect DTMF tones. Valid digits are 0 through 9, '*', '#', 'A', 'B', 'C', and 'D'.

LINEDIGITMODE_DTMFEND

Use this mode to detect DTMF tones and detect the down edges. Valid digits are 0 through 9, '*', '#', 'A', 'B', 'C', and 'D'.

ThbTapiLine.CallOptions.GatherDigits.FirstDigitTimeout

Type: DWord

This member defines the time duration in milliseconds in which the first digit is expected. If the first digit is not received in this timeframe, the digit collection is aborted and the ThbTapiLine.OnDigits event is triggered with a Termination parameter of the value LINEGATHERTERM_FIRSTTIMEOUT.

ThbTapiLine.CallOptions.GatherDigits.InterDigitTimeout

Type: DWord

This member defines the maximum time duration in milliseconds between consecutive digits. If no digits is received in this timeframe, the digit collection is aborted and the ThbTapiLine.OnDigits event is triggered with a Termination parameter of the value LINEGATHERTERM_INTERTIMEOUT.

ThbTapiLine.CallOptions.GatherDigits.NumDigits

Type: DWord

The number of digits to be collected before a ThbTapiLine.OnDigits event is triggered (in TAPI terms a LINE_GATHERDIGITS message is sent).

ThbTapiLine.CallOptions.GatherDigits.TerminationDigits

Type: String

Specifies a string of termination digits as text characters. If one of the digits in the string is detected, that termination digit is appended to the buffer, digit collection is terminated, and the ThbTapiLine.OnDigits event is called.