Version
Appendix B
Call Control Parameters
Parameters
NCC Function Parameters
Parameters
Many NCC functions have behavior controlled by multiple parameters. These parameters are grouped together into structures. Each parameter structure has a set of default values that is sufficient for many configurations. The parameters can, however, be modified to:
Enable or disable function features.
Adapt the function for exceptional configurations.
For example, when recording voice data, the application programmer can alter the function's behavior by modifying any of the record parameters which specify:
Any subset of DTMF keys entered by the telephone caller which abort the function.
Gain applied to the input signal.
An initial timeout which defines the time during which the caller must start speaking before the operation terminates.
The amount of silence after a caller has stopped speaking before the operation terminates.
Record-sync prompt frequency, amplitude, and duration.
Automatic gain control settings.
The parameters are alphabetized by category in two groups: function parameters, which control the behavior of NCC Service functions, and protocol parameters, which control the behavior of telephony protocols. Within each category, fields are listed alphabetically.
NCC Function Parameters
The following tables contain NCC service parameters organized by category. These parameters control the behavior of their associated function calls. For a detailed discussion of parameter management in Natural Access, refer to the
Natural Call Control Service Developer's Reference Manual
.
NCC.X.ADI_START.callctl
Dependent Function(s):
nccStartProtocol
Field Name
Type
Default
Units
Description
mediamask
DWORD
0x001F
mask
Controls which functions will be running or reserved when the call enters the Connected (conversation) state. (The
NOCC
protocol enters this state immediately).
Reserved
indicates that the DSP MIPS have been committed to the operation before the operation has actually started. The application must reserve DSP resources in advance by using this parameter for DTMF detection, silence detection, cleardown detection, and echo cancellation.
A value may be formed by ORing any of the following or using one of the specified constants :
Constant
NCC_RESERVE_DTMF
Event
0x0001
Event
Reserve DTMF detection (not used for QX boards)
NCC_RESERVE_SILENCE
0x0002
Reserve cleardown detector (not used for QX boards)
NCC_RESERVE_CLEARDOWN
0x0004
Reserve DTMF detection (not used for QX boards)
NCC_AUTO_DTMF
0x0008
Start DTMF detection
NCC_AUTO_ECHO
0x0010
Start echo cancellor
NCC_ALL_MEDIA
0x0040
(
NCC_RESV_CLEARDOWN|
NCC_RESV_SILENCE|
NCC_RESV_DTMF|
NCC_RESV_AUTO_DTMF|
NCC_RESV_AUTO_ECHO
)
NCC_ACCEPT_DTMF
0x100
DTMF detection in accept
NCC.X.ADI_START.cleardown
Dependent Function(s):
nccStartProtocol
Field Name
Type
Default
Units
Description
bandw1
DWORD
40
Hz
Bandwidth for first frequency of the cleardown detector. Valid range is 20-800.
bandw2
DWORD
40
Hz
Bandwidth for second frequency.
Valid range is 20-800.
freq1
DWORD
350
Hz
First frequency to detect. Valid range is 1-4000.
freq2
DWORD
440
Hz
Second frequency to detect, or 0 if detecting single frequency. Valid range is 1-4000.
maxofftime
DWORD
0
ms
Maximum time tone may be OFF to qualify. For continuous tones, this parameter is ignored. For cadenced tones, the count is reset if the interval between any two tones is longer than this time.
Valid range is 0-32767.
maxontime
DWORD
0
ms
Maximum time tone must be ON to qualify. For continuous tones, this parameter is ignored. For cadenced tones, the count is reset if any tone is longer than this time. Valid range is 0-32767.
minofftime
DWORD
0
ms
Minimum time tone must be OFF to qualify. For continuous tones, this parameter is ignored. For cadenced tones, the count is reset if the interval between any two tones is shorter than this time.
Valid range is 0-32767.
minontime
DWORD
0
ms
Minimum time tone must be ON to qualify. For continuous tones, this parameter is ignored. For cadenced tones, the count is reset if any tone is shorter than this time. Valid range is 0-32767.
qualampl
INT32
-28
dBm
The minimum signal level recognized as a hang-up tone. Valid AG range is -51 to -15. Valid QX range is -48 to 0.
qualtime
DWORD
1000
ms
The minimum duration of tone before a hang-up is recognized. The valid range is 0 to 32767.
qualtime
is ignored if
tonecount
is non-zero (cadenced tones).
reflevel
DWORD
0xB000
IDU
Do not modify.
reserved
DWORD
0
internal
Do not modify.
tonecount
DWORD
0
integer
Minimum number of cadenced tones detected before reporting the cleardown event. For continuous tones, set this parameter to 0.
NCC.X.ADI_START.dial
Dependent Function(s):
nccStartProtocol
Field Name
Type
Default
Units
Description
breaktime
DWORD
60
ms
The break (on-hook) duration for dial pulses.
Valid AG range is 0-30000. Valid QX range is 0-32767.
dialtonewait
DWORD
5000
ms
The maximum time to wait for dial tone (applies only to the ';' character). Valid range is 0-65535.
dtmfampl1
INT32
-6
dBm
The amplitude of the low frequency component of the DTMF pair. Valid AG range is -54 to -3. Valid QX range is -90 to 0.
dtmfampl2
INT32
-4
dBm
The amplitude of the high frequency component of the DTMF pair. Valid AG range is -54 to -3. Valid QX range is -90 to 0.
dtmfofftime
DWORD
80
ms
The duration of the silence time between each digit. Valid AG range is 0-65534. Valid QX range is 0-2047.
dtmfontime
DWORD
80
ms
The duration of each DTMF or MF digit.
Valid AG range is 0-65534. Valid QX range is 0-2047.
flashtime
DWORD
500
ms
The amount of time to assert the on-hook signaling pattern for a flash (!) character.
Valid AG range is 0-65535. Valid QX range is 0-32767.
interpulse
DWORD
700
ms
The inter-digit time for pulsed dialing.
Valid AG range is 0-30000. Valid QX range is 0-32767.
longpause
DWORD
5000
ms
The amount of delay associated with the period (.) character. Valid range is 0-65535.
maketime
DWORD
40
ms
The make (off-hook) duration for dial pulses.
Valid AG range is 0-30000. Valid QX range is 0-32767.
method
DWORD
0
mask
Type of signaling: 0=DTMF, 1=Pulse, 2=MF (US).
reserved
DWORD
0
internal
Do not modify.
shortpause
DWORD
2000
ms
The amount of delay associated with the comma (,) character. Valid range is 0-65535.
tonebandw1
DWORD
40
Hz
Bandwidth of the first frequency of the dial tone detector. Valid AG range is 20-800. Valid QX range is 40-2000.
tonebandw2
DWORD
40
Hz
Bandwidth of the second frequency of the dial tone detector. Valid AG range is 20-800. Valid QX range is 40-2000.
tonefreq1
DWORD
350
Hz
First (or only) dial tone frequency.
Valid AG range is 330-3600. Valid QX range is 1-4000.
tonefreq2
DWORD
440
Hz
Second dial tone frequency. Set this to 0 to detect a single frequency. Valid AG range is 330-3600. Valid QX range is 1-4000.
tonequalampl
INT32
-28
dBm
Minimum broadband signal amplitude to qualify for dial tone detection. Valid AG range is -40 to 0. Valid QX range is -48 to 0.
tonequaltime
DWORD
50
ms
Minimum duration of a qualified tone to be considered dial tone. Valid range is 0-32767.
tonereflevel
DWORD
0xb000
IDU
Do not modify.
tonetotaltime
DWORD
0
ms
Total time interrupted dialtone must be present.
NCC.X.ADI_START.dtmfdet
Dependent Function(s):
nccStartProtocol
Field Name
Type
Default
Units
Description
columnfour
DWORD
1
mask
A flag that indicates whether to detect the A, B, C, and D DTMF digits. Set this to 1 to detect these, or 0 to ignore them.
offqualampl
INT32
-45
dBm
The minimum signal required to maintain recognition of a DTMF signal once recognition has started.
Valid AG range is -51 to -15. Not used for QX boards.
offqualtime
DWORD
40
ms
The minimum duration of absence of a recognized DTMF signal before an end-of-digit event is emitted. Valid AG range is 5-32767. Valid QX range is 0-32766.
offthreshold
DWORD
0x92e0
IDU
Do not modify.
onqualampl
INT32
-39
dBm
The minimum signal level recognized as a DTMF signal.
Valid AG range is -51 to -15. Not used for QX boards.
onqualtime
DWORD
50
ms
The minimum duration of a recognized DTMF signal before a digit event is emitted. Valid AG range is 22-32767. Valid QX range is 0-32766.
onthreshold
DWORD
0xcab0
IDU
Do not modify.
NCC.X.ADI_START.echocancel
Dependent Function(s):
nccStartProtocol
Field Name
Type
Default
Units
Description
adapttime
DWORD
0
ms
Echo canceller adaptation time for MODE=2. The valid AG range is 100-1000. Smaller values require more DSP processing power. Not used for QX boards.
filterlength
DWORD
0
ms
Filter length of echo canceller for MODE=2. Valid range is 2-20. Greater values require more DSP processing power.
gain
INT32
0
dB
Amount of amplification applied to echo-cancelled output. Valid AG range is -54 to 24. Done by the AGC module for QX boards.
mode
DWORD
0
integer
Controls echo canceller operation:
A value may be formed by ORing any of the following bit masks or using one of the specified :
Constant
NCC_ECHOCANCEL_DEFAULT
Value
1
Event
Choose best length and adapt time based on board type.
NCC_ECHOCANCEL_DEFAULT
2
Use specified length and adapt time.
Default = 0: No echo cancellation.
predelay
DWORD
0
ms
Output sample delay. Valid range is 0-9 (ignored on AG-8 board).
NCC.X.ADI_PLACECALL
Dependent Function(s):
nccPlaceCall
,
nccAutomaticTransfer
Field Name
Type
Default
Units
Description
connectmask
DWORD
0x0103
mask
Controls which network events cause an outgoing call to transition to the Connected state. A value may be formed by ORing any of the following bit masks:
Constant
NCC_CON_ON_SIGNAL
Value
0x0001
Event
out-of-band signal
NCC_CON_ON_VOICE_BEGIN
0x0002
voice detected
NCC_CON_ON_VOICE_MEDIUM
0x0004
medium length voice
NCC_CON_ON_VOICE_LONG
0x0008
long voice
NCC_CON_ON_VOICE_EXTENDED
0x0010
extended voice
NCC_CON_ON_VOICE_END
0x0020
voice ended
NCC_CON_RING_QUIT
0x0080
ring ended
NCC_CON_ON_CED
0x0100
modem detected
NCC_CON_ON_DIALTONE
0x0200
dial tone
NCC_CON_ON_SIT
0x0400
SIT detected
NCC_CON_ON_RING_BEGIN
0x0800
connect immediately
NCC_CON_ON_PROCEEDING
0x8000
connect immediately
disconnectmask
DWORD
0x0040
mask
Controls which network events cause an outgoing call to disconnect (not complete). A value may be formed by ORing any of the following:
Constant
NCC_DIS_ON_VOICE_BEGIN
Value
0x0002
Event
voice detected
NCC_DIS_ON_VOICE_MEDIUM
0x0004
medium length voice
NCC_DIS_ON_VOICE_LONG
0x0008
long voice
NCC_DIS_ON_VOICE_EXTENDED
0x0010
extended voice
NCC_DIS_ON_VOICE_END
0x0020
voice ended
NCC_DIS_ON_TIMEOUT
0x0040
call progress timeout
NCC_DIS_ON_RING_QUIT
0x0080
call progress ring quit
NCC_DIS_ON_CED
0x0100
dial tone
NCC_DIS_ON_RING_BEGIN
0x0800
callprogreess ring begin
NCC.X.ADI_PLACECALL.callprog
Dependent Function(s):
nccPlaceCall
,
nccAutomaticTransfer
Field Name
Type
Default
Units
Description
busycount
DWORD
4
count
The number of non-precise busy tones that must occur before busy or fast busy is reported. Valid range is 1-32767.
leakagetime
DWORD
8
ms
Do not modify.
maxbusy
DWORD
1500
ms
The threshold time defining the total time period (on time plus off time) for distinguishing between slow busy and ringing tone.
Valid range is 0-32767.
maxreorder
DWORD
700
ms
The threshold time defining the total time period (on time plus off time) for distinguishing between fast busy (reorder) and slow busy. Valid range is 0-32767.
maxring
DWORD
3000
ms
The maximum duration of a tone to distinguish a ringing tone from a dial tone. Valid range is 0-32767.
maxringperiod
DWORD
8000
ms
The length of time of the last ringing tone plus the silence that follows, before call progress reports a ringing-ended event. Valid range is 0-32767.
noiselevel
DWORD
0x14000
IDU
Do not modify.
precmask
DWORD
7
mask
Mask to control which precise detectors to run. A value may be formed by ORing any of the following values:
Constant
NCC_CPMSK_PRECISE_CED
Value
0x0001
Event
CED tone modem
NCC_CPMSK_PRECISE_SIT
0x0002
SIT
NCC_CPMSK_PRECISE_BUSY
0x0004
Busy tone
precqualtime
DWORD
150
ms
Precise tone qualification time. All precise tones must be longer than this value to qualify. Valid range is 0-32767.
qualtonetime1
DWORD
60
ms
Do not modify.
qualtonetime2
DWORD
80
ms
Do not modify.
qualvoicetime1
DWORD
60
ms
Do not modify.
qualvoicetime2
DWORD
60
ms
Do not modify.
ringcount
DWORD
7
count
The number of ring tones that must occur before
NO_ANSWER
is reported. Valid range is 1-32767.
silencelevel
INT32
-40
dBm
The maximum signal level that is considered to be silence. Valid AG range is -46 to -34. Valid QX range is -45 to 0.
silencetime
DWORD
1500
ms
The minimum length of a silent period after voice is detected before call progress reports a voice-ended event.
stopmask
DWORD
0
mask
Mask to control which events cause call progress to stop. A value may be formed by ORing any of the following bit masks or using one of the specified:
Constant
NCC_CPSTOP_ON_RINGTONE
Value
0x000
Event
ring tone
NCC_CPSTOP_ON_RINGQUIT
0x0002
ring end
NCC_CPSTOP_ON_VOICE_BEGIN
0x0004
ring end
NCC_CPSTOP_ON_VOICE_MEDIUM
0x0008
medium voice duration
NCC_CPSTOP_ON_VOICE_LONG
0x0010
long voice duration
NCC_CPSTOP_ON_VOICE_EXT
0x0020
extended voice duration
NCC_CPSTOP_ON_VOICE_END
0x0040
voice end
timeout
DWORD
10000
ms
The maximum time that can elapse with no stimulus from the network before call progress will stop with reason of timeout. If the value is set to zero, the timer is disabled.
voicextended
DWORD
9000
ms
The minimum length of time voice must be detected before call progress reports an extended-voice event.
voicelong
DWORD
6000
ms
The minimum length of time voice must be detected before call progress reports a long-voice event.
voicemedium
DWORD
3000
ms
The minimum length of time voice must be detected before call progress reports a medium-voice event.
voicetoneratio
DWORD
0x30000
IDU
Do not modify.
Version
Want to send us feedback on our documentation? Email:
Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.
Version
Version