NCC API global parameters

This topic describes the following NCC implementation-independent, protocol-independent parameters, defined in nccstart.pf:

The parameters are alphabetized by category and subcategories. Within each category, fields are listed alphabetically. For information on implementation-dependent or protocol-dependent parameters, see your protocol-specific documentation.

NCC.START structure

NCC.START

Dependent Function(s): nccStartProtocol

Field name

Type

Default

Units

Description

eventmask

DWORD

0x0000

mask

Determines which events are sent to the application.

debugflag

WORD

0

integer

Reports low-level debug events to the application. Off (0) or on (non-zero).

waitforPCtime

WORD

10000

ms

Specifies the time to wait for the application to respond after an NCCEVN_INCOMING_CALL. If a response is not received within the timeout, the incoming call is rejected.

overlappedreceiving

WORD

0

integer

Determines if the protocol will receive digits in overlapped receiving mode.

NCC.START.callproggenerate parameters

NCC.START.callproggenerate

Dependent function(s): nccStartProtocol

Field name

Type

Default

Units

Description

dialtonefreq1

WORD

350

Hz

First frequency of dialtone.

dialtonefreq2

WORD

440

Hz

Second frequency of dialtone.

dialtoneontime1

WORD

-1

ms

Cadenced dialtone: first ON time.

dialtoneontime2

WORD

0

ms

Cadenced dialtone: second ON time.

dialtoneofftime1

WORD

0

ms

Cadenced dialtone: first OFF time.

dialtoneofftime2

WORD

0

ms

Cadenced dialtone: second OFF time.

dialtonelevel

WORD

150

IDU

Dialtone amplitude.

ringfreq1

WORD

440

Hz

First frequency of ringback tone.

ringfreq2

WORD

480

Hz

Second frequency of ringback tone.

ringontime

WORD

1000

ms

Ringback tone ON time.

ringofftime1

WORD

3000

ms

Ringback tone first (or only) OFF time.

ringofftime2

WORD

0

ms

Ringback tone second OFF time.

ringtonelevel

WORD

112

IDU

Ringback tone amplitude.

busyfreq1

WORD

480

Hz

First frequency of busy tone.

busyfreq2

WORD

620

Hz

Second frequency of busy tone.

busyontime

WORD

500

ms

Busy tone ON time.

busyofftime

WORD

500

ms

Busy tone OFF time.

busytonelevel

WORD

63

Hz

Busy tone amplitude.

fastbusyfreq1

WORD

480

Hz

First frequency of fast busy (reorder) tone.

fastbusyfreq2

WORD

620

Hz

Second frequency of fast busy (reorder) tone.

fastbusyontime

WORD

250

ms

Fast busy tone ON time.

fastbusyofftime

WORD

250

ms

Fast busy tone OFF time.

fastbusytonelevel

WORD

63

IDU

Fast busy tone amplitude.

NCC.START.eventmask bits

The NCC.START.eventmask parameter controls which events are returned to the application. The following table lists the eventmask bits and the events they control:

Value

Bit name

Event reported

0x4

NCC_REPORT_ALERTING

NCCEVN_REMOTE_ALERTING

0x8

NCC_REPORT_ANSWERED

NCCEVN_REMOTE_ANSWERED

0x20

NCC_REPORT_BILLING

NCCEVN_BILLING_INDICATION

0x40

NCC_REPORT_STATUSINFO

NCCEVN_CALL_STATUS_UPDATE

NCCEVN_EXTENDED_CALL_STATUS_UPDATE

0x10000

NCC_REPORT_CALLID

NCCEVN_CALLID_AVAILABLE