NCC.X.ADI_START

Dependent function: nccStartProtocol

Note: All field names in this structure are prefaced with NCC.X.ADI_START; for example, NCC.X.ADI_START.mediamask.

Field name

Type

Default

Units

Description

mediamask

DWORD

0x001F

mask

Controls which functions are running or reserved when the call enters the connected (conversation) state. (The NOCC protocol enters this state immediately).

Reserved indicates that the DSP MIPS are committed to the operation before the operation actually starts. The application must reserve DSP resources in advance by using this parameter for DTMF detection, silence detection, cleardown detection, and echo cancelation. See callctl.mediamask valid values.

debugmask

DWORD

0x0000

mask

Not applicable.

protocoldebugmask

DWORD

0x0000

mask

Not used.

dial.method

DWORD

0

mask

Not applicable.

dial.breaktime

DWORD

60

ms

Not applicable.

dial.maketime

DWORD

40

ms

Not applicable.

dial.interpulse

DWORD

700

ms

Not applicable.

dial.flashtime

DWORD

500

ms

Not applicable.

dial.shortpause

DWORD

2000

ms

Not applicable.

dial.longpause

DWORD

5000

ms

Not applicable.

dial.dtmfampl1

INT32

-6

dBm

Not applicable.

dial.dtmfampl2

INT32

-4

dBm

Not applicable.

dial.dtmfontime

DWORD

80

ms

Not applicable.

dial.dtmfofftime

DWORD

80

ms

Not applicable.

dial.dialtonewait

DWORD

5000

ms

Not applicable.

dial.tonefreq1

DWORD

350

Hz

Not applicable.

dial.tonebandw1

DWORD

40

Hz

Not applicable.

dial.tonefreq2

DWORD

440

Hz

Not applicable.

tonebandw2

DWORD

40

Hz

Not applicable.

dial.tonequalampl

INT32

-28

dBm

Not applicable.

dial.tonequaltime

DWORD

50

ms

Not applicable.

dial.tonereflevel

DWORD

0xB000

IDU

Not applicable.

dial.reserved

DWORD

0

internal

Not applicable.

dial.tonetotaltime

DWORD

0

ms

Total time for which the interrupted dialtone must be present. Valid values are:

0: Does not detect an interrupted dialtone.

n (where n is 1 or higher): Detects an interrupted dialtone that is present for at least n ms.

dtmfdet.columnfour

DWORD

1

 

Flag that indicates whether to detect the A, B, C, and D DTMF digits. Set this value to 1 to detect these digits, or 0 to ignore them.

dtmfdet.onqualampl

INT32

-39

dBm

Minimum signal level recognized as a DTMF signal. Valid AG board, CG board, and PacketMedia HMP range is -51 through -15.

Not used for QX boards.

dtmfdet.onthreshold

DWORD

0xCAB0

IDU

Do not modify. Not used for QX 2000 boards.

dtmfdet.onqualtime

DWORD

50

ms

Minimum duration of a recognized DTMF signal before a digit event is emitted.

Valid AG board, CG board, and PacketMedia HMP range is 22 through 32767.

Valid QX board range is 30 through 32766.

dtmfdet.offqualampl

INT32

-45

dBm

Minimum signal required to maintain recognition of a DTMF signal once recognition starts.

Valid AG board, CG board, and PacketMedia HMP range is -51 through 15.

Not used for QX boards.

dtmfdet.offthreshold

DWORD

0x92E0

IDU

Do not modify. Not used for QX 2000 boards.

dtmfdet.offqualtime

DWORD

40

ms

Minimum duration of absence of a recognized DTMF signal before an end-of-digit event is emitted.

Valid AG board, CG board, and PacketMedia HMP range is 5 through 32767.

Valid QX board range is 0 through 32766.

echocancel.mode

DWORD

0

Bit field

Controls echo canceler operation. Set the mode to one of the following:

0 = No echo cancelation.

1 = Use internal defaults for filter length and adaptation time based on board type.

2 = Use specified values.

3 = Ignore specified filterlength and adapttime values for adiModifyEchoCanceller only.

 

Additional values can be formed by using the OR operation. See echocancel.mode valid values.

echocancel.filterlength

DWORD

0

ms

Filter length of echo canceler for echocancel.mode = 2. Set this value to 0 to omit echo canceling. Valid range is 0 through 20. Higher values require more DSP processing power.

echocancel.adapttime

DWORD

0

ms

Echo canceler adaptation time for echocancel.mode = 2 . The valid AG board and CG board range is 100 through 1000. Lower values require more DSP processing power. Not used for QX boards.

echocancel.gain

INT32

0

dB

Amount of amplification applied to echo-canceled output. Valid AG board and CG board range is -54 through 24. Done by the automatic gain control (AGC) module for QX boards.

echocancel.predelay

DWORD

0

ms

Output sample delay. Valid range is 0 through 9.

For AG boards and CG boards, valid range is 0 through 20.

For QX boards, the default value is 0.

cleardown.freq1

DWORD

350

Hz

Not applicable.

cleardown.bandw1

DWORD

40

Hz

Not applicable.

ceardown.freq2

DWORD

440

Hz

Not applicable.

cleardown.bandw2

DWORD

40

Hz

Not applicable.

cleardown.qualampl

INT32

-28

dBm

Not applicable.

cleardown.qualtime

DWORD

1000

ms

Not applicable.

cleardown.reflevel

DWORD

0xB000

IDU

Not applicable.

cleardown.reserved

DWORD

0

internal

Not applicable.

cleardown.tonecount

DWORD

0

integer

Not applicable.

cleardown.minontime

DWORD

0

ms

Not applicable.

cleardown.maxontime

DWORD

0

ms

Not applicable.

cleardown.minofftime

DWORD

0

ms

Not applicable.

cleardown.maxofftime

DWORD

0

ms

Not applicable.


callctl.mediamask valid values

A value can be formed by using the OR operation with any of the following values:

Value

Description

0x0001

Reserve DTMF detector. Not used for QX boards.

0x0002

Reserve silence detector. Not used for QX boards.

0x0004

Reserve cleardown detector. Not used for QX boards.

0x0008

Start DTMF detector.

0x0010

Start echo canceler.


echocancel.mode valid values

Value

Description

0x0004

Enable dynamic windowing. QX boards only.

0x0008

Enable echo suppressor.

0x0010

Do not reset echo canceler.

0x0020

Disable filter taps adaptation.

0x0040

Bypass echo cancelation. AG boards and CG boards only.

0x0080

Request status of echo canceler. AG boards and CG boards only.

0x0100

Enable auto-status event generation when status of echo canceler changes. AG boards and CG boards only.

0x0200

Enable comfort noise generation. AG boards and CG boards only.