ADI_COLLECT_PARMS

Dependent function: adiCollectDigits

Field name

Type

Default

Units

Description

firsttimeout

DWORD

10000

ms

Maximum time to wait for the first digit.

Use 0 to wait forever. Otherwise, the valid range is 1 through 2147483647.

intertimeout

DWORD

5000

ms

Maximum time to wait for any digit after the first digit.

Use 0 to wait forever. Otherwise, the valid range is 1 through 2147483647.

terminators

DWORD

0x0C00

mask

Mask that specifies which digits cause collection to terminate. A value can be formed by using the OR operation with any of the values for the validDTMFs field. Use 0 to indicate no terminators.

validDTMFs

DWORD

0x07FF

mask

Mask that specifies the digits to collect; only specified digits are added to the collected digit string. Specify ADI_DIGIT_ANY to accept all digits. See Valid DTMF values for information.

Optionally, the value ADI_COLLECT_QUIETLY can be added to this parameter to suppress all but the final ADIEVN_DIGIT_BEGIN and ADIEVN_DIGIT_END events that are normally generated as each digit arrives.

waitendtone

DWORD

0

mask

Flag to indicate that collection ends at the trailing edge of the last digit. If 0, collection ends as soon as the final digit is detected. If 1, collection does not end until the end of the final digit.

Valid DTMF values

A value that combines all of the valid DTMF values can be formed by using ADI_DIGIT_ALL (0xFFFF). Values can also be formed by using the OR operation with any of the following values:

Digit

Name

Value

0  

ADI_DIGIT_0

0x0001

1

ADI_DIGIT_1

0x0002

2

ADI_DIGIT_2

0x0004

3

ADI_DIGIT_3

0x0008

4

ADI_DIGIT_4

0x0010

5

ADI_DIGIT_5

0x0020

6

ADI_DIGIT_6

0x0040

7

ADI_DIGIT_7

0x0080

8

ADI_DIGIT_8

0x0100

9

ADI_DIGIT_9

0x0200

*

ADI_DIGIT_STAR

0x0400

#

ADI_DIGIT_POUND

0x0800

A

ADI_DIGIT_A

0x1000

B

ADI_DIGIT_B

0x2000

C

ADI_DIGIT_C

0x4000

D

ADI_DIGIT_D

0x8000