(Page 1 of 21 in this chapter)
Version
Appendix B
Parameters
Introduction
Parameter Files
NCC Service Parameters
ADI Service Parameters
Loading Parameter Files
QX-Specific Parameter Information
DIAL 150
DTMF 152
DTMFDETECT 153
ENERGY 154
FSKRECEIVE 155
FSKSEND 156
PLACECALL 157
PLACECALL.callprog 158
PLAY 160
RECORD 161
START 162
START.callproggenerate 163
START.callctl 165
START.cleardown 166
START.dial 167
START.dtmfdet 169
START.echocancel 170
TONE 172
TONEDETECT 173
LPS 174
Enabling Caller ID
Enabling Caller ID (NCC Service)
Enabling Caller ID (ADI Service)
Introduction
This appendix:
Summarizes the organization of parameters under the NCC and ADI services
Lists QX-specific attributes for each parameter
Parameter Files
To adapt your configuration to a specific country or installation (for example, special PBXs or network), a default set of parameters is automatically loaded when initializing the ADI or NCC services on a QX board. Depending on the default country selected on your system, the
QXLOAD
environment variable contains the directory path of the country configuration files.
Most of the parameters specified in the parameter files must not be changed. However, you can add or modify some parameters (specifying digit handling, debugging operation, and miscellaneous options) based on the needs of your application.
WARNING:
Changing the default parameters in country-specific parameter files may affect the regulatory approvals in the target country, and can cause the application to malfunction.
NCC Service Parameters
The parameters in NCC service parameter files govern call control. The default NCC parameter file appears under the filename
ncc
xxxx
.par
, where
xxxx
is the the name of the corresponding set of parameters (for example,
nccstart
for
NCC.START
parameters or
nccxlps
for
NCC.X.ADI_LPS
parameters).
Note:
All the configuration files of the selected countries are stored at installation time in the destination directory (for example,
c:\nms\qx\ctry\usa
).
Parameters in these files fall into the following categories:
Category
Description
NCC.START
Used when a protocol is started with
nccStartProtocol
.
NCC.X.ADI_START
Used when a protocol is started with
nccStartProtocol
. (Specific to ADI implementation of NCC.)
NCC.X.ADI_PLACECALL
Used when a call is placed using
nccPlaceCall
or
nccAutomaticTransfer
.
NCC.X.ADI_PLACECALL.callprog
Subset of the
NCC.X.ADI_PLACECALL
parameters that affect call progress.
NCC.X.ADI_LPS
Parameter settings specific to the loop start protocol.
ADI Service Parameters
ADI service parameters govern:
Dialing
Voice playing and recording
DTMF (and other tones) generation and detection
Frequency Shift Key (FSK) data sending and receiving
In addition, there are parameters which govern call control, when performed using ADI service call control functions. ADI call control is deprecated by the NCC service. You should use the NCC service instead of ADI for call control. The parameters in the ADI call control categories have the same names as corresponding NCC service parameters.
The default parameter file appears under the filename
adilps.par
in the destination directories
\nms\qx\ctry\
xxx
, where
xxx
is the three-character ISO 3166 code of the target country (for example,
aut
for Austria,
deu
for Germany,
fra
for France,
gbr
for United Kingdom,
jpn
for Japan,
usa
for United States).
Parameters in these files fall into the categories listed in the following table:
Category
Description
ADI.DIAL
Used when dialing is started with
adiStartDial
.
ADI.DTMF
Used with the
adiStartDTMF
function.
ADI.DTMFDETECT
Used with the
adiStartDTMFDetector
function.
ADI.ENERGY
Used with the
adiStartEnergyDetector
function.
ADI.FSKRECEIVE
Used with the
adiStartReceivingFSK
function.
ADI.FSKSEND
Used with the
adiStartSendingFSK
function.
ADI.PLACECALL
Used with a call is placed with the
adiPlaceCall
,
adiPlaceSecondCall
, or
adiTransferCall
functions
1
.
ADI.PLACECALL.callprog
Subset of the
ADI.PLACECALL
parameters that affect call progress.
ADI.PLAY
Used when audio is played with the
adiStartPlaying
,
adiPlayFromMemory
, or
adiPlayAsync
functions.
ADI.RECORD
Used when audio is recorded with the
adiStartRecording
,
adiRecordToMemory
, or
adiRecordAsync
functions.
ADI.START.callctl
Subset of the
ADI.START
parameters used with
adiStartProtocol
. These parameters govern basic call control.
1
ADI.START.cleardown
Subset of the
ADI.START
parameters used with
adiStartProtocol
. These parameters govern call clearing.
1
ADI.START.dial
Subset of the
ADI.START
parameters used with
adiStartProtocol
. These parameters govern dialing.
1
ADI.START.dtmfdet
Subset of the
ADI.START
parameters used with
adiStartProtocol
. These parameters govern DTMF detection.
1
ADI.START.echocancel
Subset of the
ADI.START
parameters used with
adiStartProtocol
. These parameters govern echo cancellation.
1
ADI.TONE
Subset of the
ADI.START
parameters used with
adiStartProtocol
. These parameters govern tone generation.
1
ADI.TONEDETECT
Subset of the
ADI.START
parameters used with
adiStartProtocol
. These parameters govern tone detection.
1
1
ADI call control functions have been deprecated by NCC service functions. Whenever possible, you should use the NCC service for call control operations, instead of the ADI service call control functions. For details, refer to the
NCC Service Developer's Reference Manual
.
Loading Parameter Files
The country-specific parameters in the file follow the standard NMS API parameter syntax.
Depending on the needs of your application (use of global default parameters or local process parameters), you can load the parameters either with
ctdaemon
or with the
ctaLoadParameterFile
function.
Refer to
Natural Access Developer's Reference Manual
for detailed information.
QX-Specific Parameter Information
Certain parameters operate slightly differently when used in QX applications. The following sections list the parameters in the files shipped with your QX software. Parameters are grouped by category. Listed with each category is:
The complete category name
Functions that depend on the parameter settings
The manual in which the category is documented
The parameters in the category, and any QX-specific information about each parameter
(Page 1 of 21 in this chapter)
Version
Want to send us feedback on our documentation? Email:
Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.