ADI.CALLPROG
Dependent Function(s): adiStartCallProgress
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 to 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.
`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:
`precqualtime`	`DWORD`	150	ms	Precise tone qualification time. All precise tones must be longer than this to qualify.
`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 range is -46 to -34.
`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 values: Value Event 0x0001 Ring tone 0x0002 Ring end 0x0004 Voice begin 0x0008 Medium voice duration 0x0010 Long voice duration 0x0020 Extended voice duration 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. Valid range is 1-65535.
`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.

ADI.COLLECT
Dependent Function(s): 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 to 2**31-1.
`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 to 2**31-1.
`terminators`	`DWORD`	0x0C00	mask	Mask which specifies which digits cause collection to terminate. A value may be formed by ORing any of the values for the `valifDTMFs` field. Use 0 to indicate no terminators.
`validDTMFs`	`DWORD`	0x07FF	mask	Mask which specifies which digits to collect; only specified digits are added to the collected digit string. A value may be formed by ORing any of the following: Specify `ADI_DIGIT_ANY` to accept all digits.
`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.

ADI.DIAL
Dependent Function(s): adiStartDial
Field Name	Type	Default	Units	Description
`breaktime`	`DWORD`	60	ms	The break (on-hook) duration for dial pulses. Valid range is 0-30000.
`dialtonewait`	`DWORD`	5000	ms	The maximum time to wait for dial tone (';' character). Valid range is 0-65535.
`dtmfampl1`	`INT32`	-6	dBm	The amplitude of the low frequency component of the DTMF pair. Valid range is -54 to -3.
`dtmfampl2`	`INT32`	-4	dBm	The amplitude of the high frequency component of the DTMF pair. Valid range is -54 to -3.
`dtmfofftime`	`DWORD`	80	ms	The duration of the silence time between each digit. Valid range is 0-65534.
`dtmfontime`	`DWORD`	80	ms	The duration of each DTMF or MF digit. Valid range is 0-65534.
`flashtime`	`DWORD`	500	ms	The amount of time to assert the on-hook signaling pattern for a flash ('!' character). Valid range is 0-65535.
`interpulse`	`DWORD`	700	ms	The inter-digit time for pulsed dialing. Valid range is 0-30000.
`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 range is 0-30000.
`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 range is 20-800.
`tonebandw2`	`DWORD`	40	Hz	Bandwidth of the second frequency of the dial tone detector. Valid range is 20-800.
`tonefreq1`	`DWORD`	350	Hz	First (or only) dial tone frequency. Valid range is 330-3600.
`tonefreq2`	`DWORD`	440	Hz	Second dial tone frequency. Set this to 0 to detect a single frequency. The valid range is 330-3600.
`tonequalampl`	`INT32`	-28	dBm	Minimum signal amplitude to qualify for dial tone detection. Valid range is -40 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	Detects interrupted dial tones (stuttered dialtone) in certain countries. Defaults to 0 which indicates do not accommodate an interrupted dialtone. If set to a non-zero value, this is the total qualification time for dialtone and the following occurs: · Only precise dialtone detection is used. · If dialtone disappers, requalify until `dialtonewait` expires. · If dialtone lasts for `totaltime`, proceed with dialing.

ADI.DTMF
Dependent Function(s): adiStartDTMF
Field Name	Type	Default	Units	Description
`ampl1`	`INT32`	-6	dBm	The amplitude of the low frequency component of the DTMF pair. Valid range is -54 to -3.
`ampl2`	`INT32`	-4	dBm	The amplitude of the high frequency component of the DTMF pair. Valid range is -54 to -3.
`longpause`	`DWORD`	5000	ms	The amount of delay associated with the '.' (period) character. Valid range is 0-65535.
`offtime`	`DWORD`	80	ms	The duration of the silence time between each DTMF digit. Valid range is 0-65534.
`ontime`	`DWORD`	80	ms	The duration of each DTMF digit. Valid range is 0-65534.
`shortpause`	`DWORD`	2000	ms	The amount of delay associated with the ',' (comma) character. Valid range is 0-65535.

ADI.DTMFDETECT
Dependent Function(s): adiStartDTMFDetector
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. The valid range is -51 to -15.
`offqualtime`	`DWORD`	40	ms	The minimum duration of absence of a recognized DTMF signal before an end-of-digit event will be emitted. The valid range is 5 to 32767.
`offthreshold`	`DWORD`	0x92E0	IDU	Do not modify.
`onqualampl`	`INT32`	-39	dBm	The minimum signal level recognized as a DTMF signal. The valid range is -51 to -15.
`onqualtime`	`DWORD`	50	ms	The minimum duration of a recognized DTMF signal before a digit event will be emitted. The valid range is 22 to 32767.
`onthreshold`	`DWORD`	0xCAB0	IDU	Do not modify.

ADI.ENERGY
Dependent Function(s): adiStartEnergyDetector
Field Name	Type	Default	Units	Description
`autostop`	`DWORD`	1	mask	Controls whether the energy detector continues running after the first event. Set this to 1 to stop after the first event, or 0 to run continuously.
`deglitch`	`DWORD`	100	ms	The minimum time before a transition between silence and energy is recognized. Valid range is 0-32767.
`thresholdampl`	`INT32`	-45	dBm	The minimum signal level that is considered to be energy. Anything below this level is considered to be silence. Valid range is -51 to -15.

ADI.FSKRECEIVE
Dependent Function(s): adiStartReceivingFSK
Field Name	Type	Default	Units	Description
`baudrate`	`DWORD`	1200	integer	Transmission baud rate. 1200 is the only valid value.
`droptime`	`DWORD`	5	ms	Minimum dropout to silence before a packet is considered terminated.
`minlevel`	`INT32`	-35	dBm	Required minimum receive level.
`minmark`	`DWORD`	10	ms	Minimum required initial mark and seizure time.

ADI.FSKSEND
Dependent Function(s): adiStartSendingFSK
Field Name	Type	Default	Units	Description
`baudrate`	`DWORD`	1200	integer	Transmission baud rate. 1200 is the only valid value.
`level`	`INT32`	-14	dBm	Transmit output level.
`marktime`	`DWORD`	500	ms	Length of initial mark signal.
`noseizureflag`	`DWORD`	1	integer	Controls whether channel seizure is omitted. Value Definition 0 Send channel seizure 1 Just send mark
`seizetime`	`DWORD`	1000	ms	Duration of channel seizure; ignored if `noseizureflag` = 1.

ADI.PLACECALL
Dependent Function(s): adiPlaceCall, adiPlaceSecondCall, adiTransferCall
Field Name	Type	Default	Units	Description
`callprog.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.
`callprog.leakagetime`	`DWORD`	8	ms	Do not modify.
`callprog.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.
`callprog.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.
`callprog.maxring`	`DWORD`	3000	ms	The maximum duration of a tone to distinguish a ringing tone from a dial tone. Valid range is 0-32767.
`callprog.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.
`callprog.noiselevel`	`DWORD`	0x14000	IDU	Do not modify.
`callprog.precmask`	`DWORD`	7	mask	Mask to control which precise detectors to run. A value may be formed by ORing any of the following values: Value Detector 0x0001 CED tone (modem) 0x0002 SIT 0x0004 Busy tone
`callprog.precqualtime`	`DWORD`	150	ms	Precise tone qualification time. All precise tones must be longer than this to qualify. Valid range is 0-32767.
`callprog.qualtonetime1`	`DWORD`	60	ms	Do not modify.
`callprog.qualtonetime2`	`DWORD`	80	ms	Do not modify.
`callprog.qualvoicetime1`	`DWORD`	60	ms	Do not modify.
`callprog.qualvoicetime2`	`DWORD`	60	ms	Do not modify.
`callprog.ringcount`	`DWORD`	7	count	The number of ring tones that must occur before `NO_ANSWER` is reported. Valid range is 1-32767.
`callprog.silencelevel`	`INT32`	-40	dBm	The maximum signal level that is considered to be silence. Valid range is -46 to -34.
`callprog.silencetime`	`DWORD`	1500	ms	The minimum length of a silent period after voice is detected before call progress reports a voice-ended event.
`callprog.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: Value Event 0x0001 Ring tone 0x0002 Ring end 0x0004 Voice begin 0x0008 Medium voice duration 0x0010 Long voice duration 0x0020 Extended voice duration 0x0040 Voice end
`callprog.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.
`callprog.voicextended`	`DWORD`	9000	ms	The minimum length of time voice must be detected before call progress reports an extended-voice event.
`callprog.voicelong`	`DWORD`	6000	ms	The minimum length of time voice must be detected before call progress reports a long-voice event.
`callprog.voicemedium`	`DWORD`	3000	ms	The minimum length of time voice must be detected before call progress reports a medium-voice event.
`callprog.voicetoneratio`	`DWORD`	0x30000	IDU	Do not modify.
`connectmask`	`DWORD`	0x0103	mask	Controls which network events will cause an outgoing call to transition to the connected state. A value may be formed by ORing any of the following bit masks: Value Event 0x0001 Out-of-band signal 0x0002 Voice detected 0x0004 Medium length voice 0x0008 Long voice 0x0010 Extended voice 0x0020 Voice ended 0x0080 Ring ended 0x0100 Modem detected 0x0200 Dial tone 0x0400 SIT detected 0x8000 Connect immediately
`disconnectmask`	`DWORD`	0x0040	mask	Controls which network events will cause an outgoing call to disconnect (not complete). A value may be formed by ORing any of the following: Value Event 0x0002 Voice detected 0x0004 Medium length voice 0x0008 Long voice 0x0010 Extended voice 0x0020 Voice ended 0x0040 Call progress timeout 0x0080 Rring ended 0x0100 Modem detected

ADI.PLAY
Dependent Function(s): adiStartPlaying, adiPlayFromMemory, adiPlayAsync
Field Name	Type	Default	Units	Description
`DTMFabort`	`DWORD`	0xFFFF	mask	Mask which allows you to control which DTMFs abort play. A value may be formed by ORing any of the following:
`gain`	`INT32`	0	dB	The gain applied to the encoded audio. Valid range is -54 to 24.
`maxspeed`	`DWORD`	100	percent	The maximum speed that will be used. This value determines how much DSP processing power is allocated to the play function. The valid is range 100-200. This value is ignored for encoding types for which speed modification is not supported.
`speed`	`DWORD`	100	percent	The initial speedup/slowdown factor to apply to the encoded audio. The valid range is 50 - `maxspeed`. This value is ignored for encoding types for which speed modification is not supported.

ADI.RECORD
Dependent Function(s): adiStartRecording, adiRecordToMemory, adiRecordAsync
Field Name	Type	Default	Units	Description
`AGCattacktime`	`DWORD`	14	ms	AGC attack time constant. This affects how quickly the gain is reduced for loud signals. Valid range is 1-30000.
`AGCdecaytime`	`DWORD`	304	ms	AGC decay time constant. This affects how quickly the gain is increased for soft signals. Valid range is 1-30000.
`AGCenable`	`DWORD`	0	integer	Flag to enable Automatic Gain Control (AGC). Set to 1 to enable AGC and 0 to disable it.
`AGCsilenceampl`	`INT32`	-49	dBm	The noise threshold for AGC. Gain adjustment is suspended for signals below this level. Valid range is -72 to 0.
`AGCtargetampl`	`INT32`	-19	dBm	The target amplitude for AGC. Valid range is -72 to 0.
`beepampl`	`INT32`	-20	dBm	The amplitude of the record beep tone. Valid range is -54 to 3.
`beepfreq`	`DWORD`	1000	Hz	The frequency of the record beep tone. 0 disables the beep. Valid range is 200-3600.
`beeptime`	`DWORD`	200	ms	The duration of the record beep tone. 0 disables the beep. Valid range is 0-65535.
`DTMFabort`	`DWORD`	0xFFFF	mask	Mask which allows you to control which DTMFs abort a record. A value may be formed by ORing any of the following values:
`gain`	`INT32`	0	dB	The gain applied to the signal before it is encoded. If AGC is enabled, this is the initial gain when record is started. Valid range is -54 to 24.
`novoicetime`	`DWORD`	5000	ms	The maximum length of silence at the beginning of a recording before record will be stopped with a reason of `CTA_REASON_NO_VOICE`. Use 0 to disable this timer. Valid range is 0-65535.
`silenceampl`	`INT32`	-45	dBm	The maximum signal level that is considered to be silence. Valid range is -51 to -15.
`silencedeglitch`	`DWORD`	100	ms	The maximum non-silent interval that is ignored by the silence detector. Any sounds that last longer than this will reset the silence detector. Valid range is 0-32767.
`silencetime`	`DWORD`	3000	ms	The maximum length of silence after audio energy has been detected before record will be stopped with a reason of `CTA_REASON_VOICE_END`. Use 0 to disable this timer. Valid range is 0-65535.

ADI.START
Dependent Function(s): adiStartProtocol
Field Name	Type	Default	Units	Description
`callctl.blockmode`	`DWORD`	0	mask	Selects method of blocking calls for the adiBlockCalls function. 0=don't answer subsequent calls. 1=assert reverse make-busy (after current call is released).
`callctl.debugmask`	`DWORD`	0x0000	mask	Enables reporting of call control events for debugging. A value may be formed by ORing any of the following: Value Event(s) reported 1 Each incoming digit 2 Each incoming ring begin and end 4 Each ring tone detected 8 All CID errors
`callctl.eventmask`	`DWORD`	0x0000	mask	Controls reporting of informational call control events. A value may be formed by ORing any of the following bit masks: Value Event reported 1 `ADIEVN_SEIZURE_DETECTED`2 `ADIEVN_PROCEEDING`4 `ADIEVN_REMOTE_ALERTING`8 `ADIEVN_REMOTE_ANSWERED`
`callctl.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: Value Definition 0x0001 Reserve DTMF detection 0x0002 Reserve silence detector 0x0004 Reserve cleardown detection 0x0008 Start DTMF detection 0x0010 Start echo canceller
`cleardown.bandw1`	`DWORD`	40	Hz	Bandwidth for first frequency of the cleardown detector. Valid range is 20-800.
`cleardown.bandw2`	`DWORD`	40	Hz	Bandwidth for second frequency. Valid range is 20-800.
`cleardown.freq1`	`DWORD`	350	Hz	First frequency to detect. Valid range is 1-4000.
`cleardown.freq2`	`DWORD`	440	Hz	Second frequency to detect, or 0 if detecting single frequency. Valid range is 1-4000.
`cleardown.qualampl`	`INT32`	-28	dBm	The minimum signal level recognized as a hang-up tone. Valid range is -51 to -15.
`cleardown.qualtime`	`DWORD`	1000	ms	The minimum duration of tone before a hang-up will be recognized. The valid range is 0 to 32767. `cleardown.qualtime` is ignored if `cleardown.tonecount` is non-zero (cadenced tones). Refer to the ADI Service Developer's Manual for more information.
`cleardown.reflevel`	`DWORD`	0xB000	IDU	Do not modify.
`cleardown.reserved`	`DWORD`	0	internal	Do not modify.
`cleardown.tonecount`	`DWORD`	0	integer	Minimum number of cadenced tones detected before reporting the cleardown event. For continuous tones, set this parameter to 0.
`cleardown.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.
`cleardown.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.
`cleardown.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.
`cleardown.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.
`dial.breaktime`	`DWORD`	60	ms	The break (on-hook) duration for dial pulses. Valid range is 0-30000.
`dial.dialtonewait`	`DWORD`	5000	ms	The maximum time to wait for dial tone (applies only to the ';' character). Valid range is 0-65535.
`dial.dtmfampl1`	`INT32`	-6	dBm	The amplitude of the low frequency component of the DTMF pair. Valid range is -54 to -3.
`dial.dtmfampl2`	`INT32`	-4	dBm	The amplitude of the high frequency component of the DTMF pair. Valid range is -54 to -3.
`dial.dtmfofftime`	`DWORD`	80	ms	The duration of the silence time between each digit. Valid range is 0-65534.
`dial.dtmfontime`	`DWORD`	80	ms	The duration of each DTMF or MF digit. Valid range is 0-65534.
`dial.flashtime`	`DWORD`	500	ms	The amount of time to assert the on-hook signaling pattern for a flash ('!' character). Valid range is 0-65535.
`dial.interpulse`	`DWORD`	700	ms	The inter-digit time for pulsed dialing. Valid range is 0-30000.
`dial.longpause`	`DWORD`	5000	ms	The amount of delay associated with the '.' (period) character. Valid range is 0-65535.
`dial.maketime`	`DWORD`	40	ms	The make (off-hook) duration for dial pulses. Valid range is 0-30000.
`dial.method`	`DWORD`	0	mask	Type of signaling: 0=DTMF, 1=Pulse, 2=MF (US).
`dial.reserved`	`DWORD`	0	internal	Do not modify.
`dial.shortpause`	`DWORD`	2000	ms	The amount of delay associated with the ',' (comma) character. Valid range is 0-65535.
`dial.tonebandw1`	`DWORD`	40	Hz	Bandwidth of the first frequency of the dial tone detector. Valid range is 20-800.
`dial.tonebandw2`	`DWORD`	40	Hz	Bandwidth of the second frequency of the dial tone detector. Valid range is 20-800.
`dial.tonefreq1`	`DWORD`	350	Hz	First (or only) dial tone frequency. Valid range is 330-3600.
`dial.tonefreq2`	`DWORD`	440	Hz	Second dial tone frequency. Set this to 0 to detect a single frequency. The valid range is 330-3600.
`dial.tonequalampl`	`INT32`	-28	dBm	Minimum broadband signal amplitude to qualify for dial tone detection. Valid range is -40 to 0.
`dial.tonequaltime`	`DWORD`	50	ms	Minimum duration of a qualified tone to be considered dial tone. Valid range is 0-32767.
`dial.tonereflevel`	`DWORD`	0xB000	IDU	Do not modify.
`dtmfdet.columnfour`	`DWORD`	1		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.
`dtmfdet.offqualampl`	`INT32`	-45	dBm	The minimum signal required to maintain recognition of a DTMF signal once recognition has started. The valid range is -51 to -15.
`dtmfdet.offqualtime`	`DWORD`	40	ms	The minimum duration of absence of a recognized DTMF signal before an end-of-digit event will be emitted. Valid range is 5 to 32767.
`dtmfdet.offthreshold`	`DWORD`	0x92E0	IDU	Do not modify.
`dtmfdet.onqualampl`	`INT32`	-39	dBm	The minimum signal level recognized as a DTMF signal. The valid range is -51 to -15.
`dtmfdet.onqualtime`	`DWORD`	50	ms	The minimum duration of a recognized DTMF signal before a digit event will be emitted. The valid range is 22 to 32767.
`dtmfdet.onthreshold`	`DWORD`	0xCAB0	IDU	Do not modify.
`echocancel.adapttime`	`DWORD`	0	ms	Echo canceller adaptation time for MODE=2. If set to 0, echo cancelling is omitted. Otherwise the valid range is 100-1000. Smaller values require more DSP processing power.
`echocancel.filterlength`	`DWORD`	0	ms	Filter length of echo canceller for MODE=2. Set this to 0 to omit echo cancelling. Otherwise, valid range is 2-20. Greater values require more DSP processing power.
`echocancel.gain`	`INT32`	0	dB	Amount of amplification applied to echo-cancelled output. Valid range is -54 to +24.
`echocancel.mode`	`DWORD`	0	integer	Controls echo canceller operation: 0 = No echo cancellation. 1 = Use internal defaults for filter length and adaptation time based on board type 2= Use specified values.
`echocancel.predelay`	`DWORD`	0	ms	Output sample delay. Valid range is 0-9 (ignored on AG-8 board).

ADI.TONE
Dependent Function(s): adiStartTones
Field Name	Type	Default	Units	Description
`ampl1`	`INT32`	-20	dBm	The amplitude of the first (or only) frequency component. Valid range is -54 to 3.
`ampl2`	`INT32`	0	dBm	The amplitude of the second frequency component, if any. Valid range is -54 to 3.
`freq1`	`DWORD`	1000	Hz	The first (or only) frequency of the generated tone. Valid range is 200-3600.
`freq2`	`DWORD`	0	Hz	The second frequency of the generated tone, or 0 if the tone is a single frequency. If not 0, valid range is 200-3600.
`iterations`	`INT32`	1	integer	The number of times to repeat the alternating tone and silence period. A count of -1 means repeat forever. Otherwise the valid range is 1 to 32767.
`offtime`	`DWORD`	0	ms	The duration of silence between tones. Specify 0 for no off time. Valid range is 0-65535.
`ontime`	`DWORD`	200	ms	The duration of the tone. Valid range is 1-65535.

ADI.TONEDETECT
Dependent Function(s): adiStartToneDetector
Field Name	Type	Default	Units	Description
`qualampl`	`INT32`	-28	dBm	The minimum signal level that will be detected. The valid range is -40 to 0.
`qualtime`	`DWORD`	500	ms	The minimum duration of a detected tone before an event will be emitted. This parameter also specifies the minimum duration of absence of detected tone before a tone-ended event will be emitted. The valid range is 0 to 32767.
`reflevel`	`DWORD`	0xB000	IDU	Do not modify.
`reserved`	`DWORD`	0	internal	Do not modify.

ADI.DID
Dependent Protocol(s): DID0 for AG-8/DID, AG-T1, AG Quad T, AG Dual T, or DTI with AG-24/30/48/60
Field Name	Type	Default	Units	Description
`busyofftime`	`WORD`	500	ms	The length of the silent interval between generated slow busy tones.
`busyontime`	`WORD`	500	ms	The length of each generated slow busy tone.
`defaulttone`	`WORD`	2	integer	The default tone to play if the PC does not respond to an incoming call indication (see `waitforPCtime`). Value Definition 0 Reorder (fast busy) 1 Ringing 2 Busy
`detectmode`	`WORD`	0	integer	Type of incoming address signaling: 0 = DTMF and dial pulse; 2 = MF.
`dtmfmask`	WORD	0	mask	Mask for behavior of # and * tones. 0x1 = on #, send up incoming call 0x2 = * splits CID info 0x4 = ANI precedes * (def = DNIS)
`maxresourcetime`	`WORD`	10000	ms	The maximum time the TCP will wait for a call control resource to be granted.
`mfflags`	`WORD`	3	mask	Mask that controls behavior when using MF signaling. A value may be formed by ORing any of the following: Value Definition 1 Begin with KP tone 2 End with ST tone
`noresourcemode`	`WORD`	0	integer	Mask that controls behavior when no resource is granted on inbound calls. 0 = No signaling; just send error 1 = Generate wink, than send error
`numdigits`	`WORD`	3	count	The expected number of digits for incoming calls.
`prewinktime`	`WORD`	100	ms	The amount of delay after incoming seizure is detected and before the start of the wink.
`qualaddroff`	`WORD`	50	ms	Deglitch time for off-hook to on-hook transitions during call set-up.
`qualaddron`	`WORD`	50	ms	Deglitch time for on-hook to off-hook transitions.
`qualdisconnect`	`WORD`	150	ms	Deglitch time for off-hook to on-hook transitions after address signaling is completed.
`qualpermsignal`	`WORD`	60000	ms	Maximum time for remote end to remain off hook when trunk is not in the conversation state before a permanent signal condition is detected. The valid range is 1-65535.
`reorderofftime`	`WORD`	250	ms	The length of the silent interval between generated reorder tones.
`reorderontime`	`WORD`	250	ms	The length of each generated reorder (fast busy) tone.
`reserved`	`WORD`	0	ms	Reserved.
`ringofftime`	`WORD`	3000	ms	The length of the silent interval between generated ring tones.
`ringontime`	`WORD`	1000	ms	The length of each generated ring tone.
`wait1stdigittime`	`WORD`	7000	ms	The maximum time to wait for the first incoming digit after the completion of the wink.
`waitfordigitstime`	`WORD`	8000	ms	The maximum time to wait for each incoming digit after the first one.
`waitforPCtime`	`WORD`	10000	ms	The maximum time to wait for the PC to respond to an incoming call indication before playing a default tone (see defaulttone).
`winktime`	`WORD`	200	ms	For incoming calls, the duration of the generated wink. Set this to 0 for no wink. Set to 0xFFFF for 350+440 Hz dial tone to be generated.

ADI.FDI
Dependent Protocol(s): FDI0 for AG-8/DID, Feature Group D
Field Name	Type	Default	Units	Description
`busyofftime`	`WORD`	500	ms	Busy tone OFF time.
`busyontime`	`WORD`	500	ms	Busy tone ON time.
`defaulttone`	`WORD`	2	n/a	Default tone if PC does not respond: Value Definition 0 Reorder (fast busy) 1 Ringing 2 Busy
`detectmode`	`WORD`	2	n/a	Method of detection: Value Definition 0 DTMFs (and pulses) 1 Pulses (and DTMFs) 2 MFs (and pulses)
`maxresourcetime`	`WORD`	10000	ms	The maximum time the TCP will wait for a call control resource to be granted.
`mfflags`	`WORD`	3	n/a	Mask for behavior when using MFs: Value Definition 0x1 Begin with KP tone 0x2 End with ST tone (inbound only)
`noresourcemode`	`WORD`	0	integer	Mask that controls behavior when no resource is granted on inbound calls. 0 = No signaling; just send error 1 = Generate wink, than send error
`numdigits`	`WORD`	12	integer	Expected number of digits.
`preanswertime`	`WORD`	100	ms	Duration before answering call.
`predialtime`	`WORD`	70	ms	Post wink/pre-dial delay.
`prewinktime`	`WORD`	100	ms	Pre-wink delay.
`qualaddroff`	`WORD`	50	ms	qual dur. OFF during addressing.
`qualaddron`	`WORD`	50	ms	qual dur. ON during addressing.
`qualdisconnect`	`WORD`	150	ms	qual dur. of disconnect.
`qualpermsignal`	`WORD`	60000	ms	qual dur. of permanent signal.
`releaseguardtime`	`WORD`	1000	ms	Duration before next call.
`reorderontime`	`WORD`	250	ms	Reorder tone ON.
`reorderofftime`	`WORD`	250	ms	Reorder tone OFF.
`reserved`	`WORD`	0	n/a	Do not modify.
`ringofftime`	`WORD`	3000	ms	Ring tone OFF time.
`wait1stdigittime`	`WORD`	7000	ms	Duration to wait for first digit.
`waitfordigitstime`	`WORD`	8000	ms	Duration to wait for nth digit (outbound only).
`waitforPCtime`	`WORD`	10000	ms	Duration to wait for PC to respond.
`winktime`	`WORD`	200	ms	Duration of the wink.

ADI.GST
Dependent Protocol(s): GST8 for AG-T1 or AG Dual T, digital ground-start (OPS-FX) GST9 for AG-T1 or AG Dual T, digital ground-start (OPS-SA)
Field Name	Type	Default	Units	Description
`cidsupport`	`WORD`	0	n/a	Indicates if caller ID is supported: Value Definition 0 CID disabled 1 CID enabled
`dialtonemintime`	`WORD`	1000	ms	For outgoing calls, the minimum duration of non-precise dial tone required before dialing will begin. Set this to 0 to disable non-precise dial tone detection. (Precise dial tone detection is controlled by `ADISTART` parameters).
`dialtonewaittime`	`WORD`	5000	ms	For outgoing calls, the maximum time to wait for initial dial tone.
`interringmaxtime`	`WORD`	8000	ms	The maximum length of an incoming ring period (on time + off time) that can elapse before the call is considered to be abandoned.
`nodialtoneaction`	`WORD`	0	n/a	Selects what to do if no dial tone detected: Value Definition 0 Hang up and abandon the call 1 Proceed to dial anyway 2 Generate an incoming call event
`numrings`	`WORD`	0	count	Number of rings to detect for an incoming call: Value Definition 0 First ring begin 1 First ring end n After n rings Note that if caller ID is enabled (`cidsupport` = 1) then the incoming call is reported after at least one ring.
`qualloopoff`	`WORD`	10	ms	Minimum duration of loop current interruption before a hang-up will be recognized.
`qualringoff`	`WORD`	100	ms	For voltage-sensitive ring detection, the minimum duration of loss of detected voltage to be recognized as the end of a ringing signal.
`qualringon`	`WORD`	6	ms	For voltage-sensitive ring detection, the minimum duration of detected voltage to be recognized as the start of a ringing signal.
`releaseguardtime`	`WORD`	1000	ms	Minimum time between hang up & off hook.
`ringsigmintime`	`WORD`	100	ms	Inbound minimum ring time (+qual).
`ringsigmaxtime`	`WORD`	3000	ms	Inbound maximum ring time (+qual).
`xfersupport`	`WORD`	1	n/a	Flag to select whether PBX transfer is allowed. Value Definition 0 Transfer commands disabled 1 Transfer commands allowed

ADI.LPS
Dependent Protocol(s): LPS0 for AG-8/LS or AG 2000 ¹, QX 2000/100-4L, ATI or T Connect with AG-24/30/48/60 LPS4 for WTI-8 or QX 2000/80-4L LPS8 for AG-T1 or AG Dual T, digital loop-start (OPS-FX). LPS9 for AG-T1 or AG Dual T, digital loop-start (OPS-SA)
Field Name	Type	Default	Units	Description
`cidsupport`	`WORD`	0	mask	Flag to enable caller ID detection: Value Definition 0 No caller ID detection 1 Caller ID detection enabled For AG boards, the AG configuration file must include the DSP file adsir.dsp when caller ID is enabled.
`CIDalertmaxtime`	`WORD`	0	ms	Maximum duration of an alert signal in Caller ID protocol (if CID is enabled).
`CIDmaxwaittime`	`WORD`	0	ms	Maximum time to wait for Caller ID to arrive before concluding the caller has hungup (if CID is enabled).
`CIDtype`	`WORD`	0	integer	Type of Caller ID protocol, if CID is enabled: Value Definition 0 BellCore CID Protocol 1 NTT Japan CID Protocol 2 ETSI Ringing Pulse Alerting Signal CID Protocol
`CIDreserved`	`WORD`	0	ms	Timing for Japan protocol
`cleardownflag`	`WORD`	1	mask	Selects whether to run the cleardown tone detector in the conversation state. Value Definition 1 Cleardown enabled 0 Not enabled
`connstring`	`String`	"!"	String	Dial string for reconnect.
`dialtonemintime`	`WORD`	1000	ms	For outgoing calls, the minimum duration of non-precise dial tone required before dialing will begin. Set this to 0 to disable non-precise dial tone detection. (Precise dial tone detection is controlled by `ADI_START_PARMS`).
`dialtonewaittime`	`WORD`	5000	ms	For outgoing calls, the maximum time to wait for initial dial tone.
`freqdeglitchtime`	`WORD`	26	count	For frequency-selective ring detection, deglitch time in 1/8 ms. Range is 2-80 (.25 to 10 ms).
`freqringhigh`	`WORD`	54	Hz	For frequency-selective ring detection, the maximum frequency recognized.
`freqringlow`	`WORD`	16	Hz	For frequency-selective ring detection, the minimum frequency recognized.
`freqringperiods`	`WORD`	4	count	For frequency-selective ring detection, number of periods of the ring frequency needed to qualify. Range is 1-8.
`freqtolerance`	`WORD`	10	percent	For frequency-selective ring detection, frequency tolerance in percent.
`interringmaxtime`	`WORD`	8000	ms	The maximum length of an incoming ring period (on time + off time) that can elapse before the call is considered to be abandoned.
`nodialtoneaction`	`WORD`	0	integer	Selects what to do if no dial tone detected: Value Definition 0 Hang up and abandon the call 1 Proceed to dial anyway 2 Generate an incoming call event
`numrings`	`WORD`	0	count	Number of rings to detect for an incoming call: Value Definition 0 First ring begin 1 First ring end n After n rings Note that if caller ID is enabled (`cidsupport` = 1) then the incoming call is reported after at least one ring.
`polaranswertime`	`WORD`	0	ms	Wait time after going off-hook answering a call before you start detecting the loop current polarity reversal on far-end disconnect (if reversal mode = 2 or 3).
`polardialtime`	`WORD`	0	ms	Wait time after dialing before starting the loop current polarity reversal detection (if reversal mode = 1 or 3).
`qualloopoff`	`WORD`	10	ms	Minimum duration of loop current interruption before a hang-up will be recognized.
`qualreversal`	`WORD`	200	ms	Qualification time for loop current reversal event on the AG 2000 board.
`qualringoff`	`WORD`	100	ms	For voltage-sensitive ring detection, the minimum duration of loss of detected voltage to be recognized as the end of a ringing signal.
`qualringon`	`WORD`	6	ms	For voltage-sensitive ring detection, the minimum duration of detected voltage to be recognized as the start of a ringing signal.
`relaytype`	`WORD`	0	integer	Defines a type of the special relay on the AG 2000 board: Value Definition 0 Switchable ring 1 Transient limiter 2 Dialshunt
`releaseguardtime`	`WORD`	1000	ms	If the host specifies to place a call immediately after releasing a call, the line is not taken off-hook until this time has elapsed. This ensures that the CO considers the line idle.
`reversalmode`	`WORD`	0	integer	Selects a loop current reversal detection mode for the AG 2000 board: Value Definition 0 Disable detection 1 Reversal indicates remote answer 2 Reversal indicates remote hang up 3 Reversal indicates answer and hang up
`ringdetectmode`	`WORD`	0	mask	Selects whether the ring detector is voltage-sensitive or frequency-selective: Value Definition 0 Voltage-sensitive 1 Frequency-selective
`ringsigmaxtime`	`WORD`	3000	ms	The maximum duration of a detected incoming ringing signal before the ringing is considered to be invalidly long.
`ringsigmintime`	`WORD`	100	ms	The minimum duration of a detected ring signal before the ring signal is considered valid.
`xferstring`	`String[6]`	"!;"	String	Prefix of feature code for transfer operation. The default string "!;" generates a flash hook, then waits for a dialtone.
`xfersupport`	`WORD`	1	mask	Flag to select whether PBX transfer is allowed. Value Definition 0 Transfer commands disabled 1 Transfer commands allowed

ADI.OGT
Dependent Protocol(s): OGT0 for AG-T1, AG Quad T, AG Dual T, or DTI with AG-24/30/48/60, outgoing only wink-start
Field Name	Type	Default	Units	Description
`maxresourcetime`	`WORD`	10000	ms	The maximum time the TCP will wait for a call control resource to be granted.
`maxwinktime`	`WORD`	4900	ms	The maximum duration of a detected wink before a "stuck sender" condition is detected.
`mfflags`	`WORD`	3	mask	Mask that controls behavior when using MF signaling. A value may be formed by ORing any of the following: Value Behavior 1 Begin with KP tone 2 End with ST tone Set `adistart.dial.method` =2 so that adiPlaceCall uses MF digits.
`mfkpstampl`	`WORD`	352	internal	Reserved - do not modify.
`mfkpstofftime`	`WORD`	80	ms	Duration of tone off for MF, KP, and ST.
`mfkpstontime`	`WORD`	80	ms	Duration of tone on for MF, KP, and ST.
`minwinktime`	`WORD`	100	ms	The minimum duration of a detected wink.
`predialtime`	`WORD`	70	ms	The amount of time to delay the start of outgoing address signaling after end of wink is detected.
`qualaddroff`	`WORD`	50	ms	Deglitch time for off-hook to on-hook transitions during call setup.
`qualaddron`	`WORD`	50	ms	Deglitch time for on-hook to off-hook transitions.
`qualdisconnect`	`WORD`	150	ms	Deglitch time for off-hook to on-hook transitions after address signaling is completed.
`qualpermsignal`	`WORD`	60000	ms	Maximum time for remote end to remain off hook when trunk is not in the conversation state before a permanent signal condition is detected. Valid range is 1-65535.
`releaseguardtime`	`WORD`	1000	ms	Minimum on-hook interval between calls.
`reserved`	`WORD`	0	ms	Reserved.
`winkwaittime`	`WORD`	10000	ms	The maximum time to wait for the far end to wink. Set this to 0 if no wink is expected.

ADI.WNK
Dependent Protocol(s): WNK0 for AG-T1, AG Quad T, or AG Dual T, 2-way wink start WNK1 for AG-8 E&M, 2-way wink start
Field Name	Type	Default	Units	Description
`busyofftime`	`WORD`	500	ms	The length of the silent interval between generated slow busy tones.
`busyontime`	`WORD`	500	ms	The length of each generated slow busy tone.
`connstring`	`String`	"!"	String	Dial string for reconnect.
`dtmfmask`	WORD	0	mask	Mask for behavior of # and * tones. 0x1 = on #, send up incoming call 0x2 = * splits CID info 0x4 = ANI precedes * (def = DNIS)
`defaulttone`	`WORD`	2	integer	The default tone to play if the PC does not respond to an incoming call indication (see `waitforPCtime`): Value Definition 0 Reorder (fast busy) 1 Ringing 2 Busy
`detectmode`	`WORD`	0	integer	Type of incoming address signaling: Value Definition 0 DTMF and dial pulse 2 MF
`maxresourcetime`	`WORD`	10000	ms	The maximum time the TCP will wait for a call control resource to be granted.
`maxwinktime`	`WORD`	4900	ms	The maximum duration of a detected wink before a "stuck sender" condition is detected.
`mfflags`	`WORD`	3	mask	Mask that controls behavior when using MF signaling. Set `adistart.dial.method` =2 so that adiPlaceCall uses MF digits. A value may be formed by ORing any of the following: Value Definition 1 Begin with KP tone 2 End with ST tone
`mfkpstampl`	`WORD`	352	internal	Reserved - do not modify.
`mfkpstofftime`	`WORD`	80	ms	Duration of tone off for MF, KP, and ST.
`mfkpstontime`	`WORD`	80	ms	Duration of tone on for MF, KP, and ST.
`minwinktime`	`WORD`	100	ms	The minimum duration of a detected wink.
`noresourcemode`	`WORD`	0	integer	Mask that controls behavior when no resource is granted on inbound calls. 0 = No signaling; just send error 1 = Generate wink, than send error
`numdigits`	`WORD`	3	count	The expected number of digits for incoming calls. If an incoming call is detected with fewer digits than what is specified in this parameter, `ADIEVN_INCOMING_CALL` is sent up to the host after the wait-for-digits timer (`adi.wnk.waitfordigitstime`) has expired. At least one digit must be detected for this to occur. It is up to the application to parse the digit string and to decide whether or not to accept the call. Calls with a number of digits equal to or greater than the number in `adi.wnk.numdigits` behave normally.
`predialtime`	`WORD`	70	ms	The amount of time to delay the start of outgoing address signaling after end of wink is detected.
`prewinktime`	`WORD`	100	ms	The amount of delay after incoming seizure is detected and before the start of the wink.
`qualaddroff`	`WORD`	50	ms	Deglitch time for off-hook to on-hook transitions during call set-up.
`qualaddron`	`WORD`	50	ms	Deglitch time for on-hook to off-hook transitions.
`qualdisconnect`	`WORD`	150	ms	Deglitch time for off-hook to on-hook transitions after address signaling is completed.
`qualpermsignal`	`WORD`	60000	ms	Maximum time for remote end to remain off hook when trunk is not in the conversation state before a permanent signal condition is detected. Valid range is 1-65535.
`releaseguardtime`	`WORD`	1000	ms	Minimum on-hook internal between calls.
`reorderofftime`	`WORD`	250	ms	The length of the silent interval between generated reorder tones.
`reorderontime`	`WORD`	250	ms	The length of each generated reorder (fast busy) tone.
`reserved`	`WORD`	0	ms	Reserved.
`ringofftime`	`WORD`	3000	ms	The length of the silent interval between generated ring tones.
`ringontime`	`WORD`	1000	ms	The length of each generated ring tone.
`wait1stdigittime`	`WORD`	7000	ms	The maximum time to wait for the first incoming digit after the completion of the wink.
`waitfordigitstime`	`WORD`	8000	ms	The maximum time to wait for each incoming digit after the first one. If an incoming call is detected with fewer digits than what is specified in the `adi.wnk.numdigits` parameter, `ADIEVN_INCOMING_CALL` is sent up to the host after this wait-for-digits timer has expired. At least one digit must be detected for this to occur.
`waitforPCtime`	`WORD`	10000	ms	The maximum time to wait for the PC to respond to an incoming call indication before playing a default tone (see `defaulttone`).
`winktime`	`WORD`	200	ms	For incoming calls, the duration of the generated wink. Set this to 0 for no wink. Set to 0xFFFF for 350+440 Hz dial tone to be generated.
`winkwaittime`	`WORD`	10000	ms	The maximum time to wait for the far end to wink for an outgoing call. Set this to 0 if no wink is expected.
`xferstring`	`String[6]`	"!;"	String	Prefix of feature code for transfer operation. The default string "!;" generates a flash hook, then waits for a dialtone.
`xfersupport`	`WORD`	1	mask	Flag to select whether PBX transfer is allowed. Value Definition 0 Transfer commands are disabled 1 Transfer commands are allowed

(Page 1 of 1 in this chapter)

Appendix D

NMS Board Parameters

Introduction

This chapter describes NMS parameters that can be changed with lineDevSpecific. See Section 6.2 for information about using lineDevSpecific.
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 a 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 in 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 CT Access functions, and protocol parameters, which control the behavior of telephony protocols. Within each category, fields are listed alphabetically.

Function Parameters

The following tables contain parameters organized by category. These parameters control the behavior of their associated function calls. For a detailed discussion of parameter management in CT Access, refer to the CT Access Developer's Reference Manual, ADI Service Developer's Manual, or ADI Service Developer's Manual.

ADI.CALLPROG

Dependent Function(s): adiStartCallProgress

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 to 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.

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:

precqualtime

DWORD

150

ms

Precise tone qualification time. All precise tones must be longer than this to qualify.

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 range is -46 to -34.

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 values:
Value Event
0x0001 Ring tone
0x0002 Ring end
0x0004 Voice begin
0x0008 Medium voice duration
0x0010 Long voice duration
0x0020 Extended voice duration
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. Valid range is 1-65535.

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.

ADI.COLLECT

Dependent Function(s): 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 to 2**31-1.

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 to 2**31-1.

terminators

DWORD

0x0C00

mask

Mask which specifies which digits cause collection to terminate. A value may be formed by ORing any of the values for the valifDTMFs field. Use 0 to indicate no terminators.

validDTMFs

DWORD

0x07FF

mask

Mask which specifies which digits to collect; only specified digits are added to the collected digit string. A value may be formed by ORing any of the following:
Specify ADI_DIGIT_ANY to accept all digits.

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.

ADI.DIAL

Dependent Function(s): adiStartDial

Field Name

Type

Default

Units

Description

breaktime

DWORD

60

ms

The break (on-hook) duration for dial pulses. Valid range is 0-30000.

dialtonewait

DWORD

5000

ms

The maximum time to wait for dial tone (';' character). Valid range is 0-65535.

dtmfampl1

INT32

-6

dBm

The amplitude of the low frequency component of the DTMF pair. Valid range is -54 to -3.

dtmfampl2

INT32

-4

dBm

The amplitude of the high frequency component of the DTMF pair. Valid range is -54 to -3.

dtmfofftime

DWORD

80

ms

The duration of the silence time between each digit. Valid range is 0-65534.

dtmfontime

DWORD

80

ms

The duration of each DTMF or MF digit. Valid range is
0-65534.

flashtime

DWORD

500

ms

The amount of time to assert the on-hook signaling pattern for a flash ('!' character). Valid range is 0-65535.

interpulse

DWORD

700

ms

The inter-digit time for pulsed dialing. Valid range is
0-30000.

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 range is 0-30000.

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 range is 20-800.

tonebandw2

DWORD

40

Hz

Bandwidth of the second frequency of the dial tone detector. Valid range is 20-800.

tonefreq1

DWORD

350

Hz

First (or only) dial tone frequency. Valid range is 330-3600.

tonefreq2

DWORD

440

Hz

Second dial tone frequency. Set this to 0 to detect a single frequency. The valid range is 330-3600.

tonequalampl

INT32

-28

dBm

Minimum signal amplitude to qualify for dial tone detection.
Valid range is -40 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

Detects interrupted dial tones (stuttered dialtone) in certain countries. Defaults to 0 which indicates do not accommodate an interrupted dialtone.
If set to a non-zero value, this is the total qualification time for dialtone and the following occurs:
· Only precise dialtone detection is used.
· If dialtone disappers, requalify until dialtonewait expires.
· If dialtone lasts for totaltime, proceed with dialing.

ADI.DTMF

Dependent Function(s): adiStartDTMF

Field Name

Type

Default

Units

Description

ampl1

INT32

-6

dBm

The amplitude of the low frequency component of the DTMF pair. Valid range is -54 to -3.

ampl2

INT32

-4

dBm

The amplitude of the high frequency component of the DTMF pair. Valid range is -54 to -3.

longpause

DWORD

5000

ms

The amount of delay associated with the '.' (period) character. Valid range is 0-65535.

offtime

DWORD

80

ms

The duration of the silence time between each DTMF digit.
Valid range is 0-65534.

ontime

DWORD

80

ms

The duration of each DTMF digit. Valid range is 0-65534.

shortpause

DWORD

2000

ms

The amount of delay associated with the ',' (comma) character. Valid range is 0-65535.

ADI.DTMFDETECT

Dependent Function(s): adiStartDTMFDetector

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. The valid range is -51 to -15.

offqualtime

DWORD

40

ms

The minimum duration of absence of a recognized DTMF signal before an end-of-digit event will be emitted.
The valid range is 5 to 32767.

offthreshold

DWORD

0x92E0

IDU

Do not modify.

onqualampl

INT32

-39

dBm

The minimum signal level recognized as a DTMF signal. The valid range is -51 to -15.

onqualtime

DWORD

50

ms

The minimum duration of a recognized DTMF signal before a digit event will be emitted. The valid range is 22 to 32767.

onthreshold

DWORD

0xCAB0

IDU

Do not modify.

ADI.ENERGY

Dependent Function(s): adiStartEnergyDetector

Field Name

Type

Default

Units

Description

autostop

DWORD

1

mask

Controls whether the energy detector continues running after the first event. Set this to 1 to stop after the first event, or 0 to run continuously.

deglitch

DWORD

100

ms

The minimum time before a transition between silence and energy is recognized. Valid range is 0-32767.

thresholdampl

INT32

-45

dBm

The minimum signal level that is considered to be energy. Anything below this level is considered to be silence.
Valid range is -51 to -15.

ADI.FSKRECEIVE

Dependent Function(s): adiStartReceivingFSK

Field Name

Type

Default

Units

Description

baudrate

DWORD

1200

integer

Transmission baud rate. 1200 is the only valid value.

droptime

DWORD

5

ms

Minimum dropout to silence before a packet is considered terminated.

minlevel

INT32

-35

dBm

Required minimum receive level.

minmark

DWORD

10

ms

Minimum required initial mark and seizure time.

ADI.FSKSEND

Dependent Function(s): adiStartSendingFSK

Field Name

Type

Default

Units

Description

baudrate

DWORD

1200

integer

Transmission baud rate. 1200 is the only valid value.

level

INT32

-14

dBm

Transmit output level.

marktime

DWORD

500

ms

Length of initial mark signal.

noseizureflag

DWORD

1

integer

Controls whether channel seizure is omitted.
Value Definition
0 Send channel seizure
1 Just send mark

seizetime

DWORD

1000

ms

Duration of channel seizure; ignored if noseizureflag = 1.

ADI.PLACECALL

Dependent Function(s): adiPlaceCall, adiPlaceSecondCall, adiTransferCall

Field Name

Type

Default

Units

Description

callprog.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.

callprog.leakagetime

DWORD

8

ms

Do not modify.

callprog.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.

callprog.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.

callprog.maxring

DWORD

3000

ms

The maximum duration of a tone to distinguish a ringing tone from a dial tone.
Valid range is 0-32767.

callprog.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.

callprog.noiselevel

DWORD

0x14000

IDU

Do not modify.

callprog.precmask

DWORD

7

mask

Mask to control which precise detectors to run. A value may be formed by ORing any of the following values:
Value Detector
0x0001 CED tone (modem)
0x0002 SIT
0x0004 Busy tone

callprog.precqualtime

DWORD

150

ms

Precise tone qualification time. All precise tones must be longer than this to qualify.
Valid range is 0-32767.

callprog.qualtonetime1

DWORD

60

ms

Do not modify.

callprog.qualtonetime2

DWORD

80

ms

Do not modify.

callprog.qualvoicetime1

DWORD

60

ms

Do not modify.

callprog.qualvoicetime2

DWORD

60

ms

Do not modify.

callprog.ringcount

DWORD

7

count

The number of ring tones that must occur before NO_ANSWER is reported.
Valid range is 1-32767.

callprog.silencelevel

INT32

-40

dBm

The maximum signal level that is considered to be silence.
Valid range is -46 to -34.

callprog.silencetime

DWORD

1500

ms

The minimum length of a silent period after voice is detected before call progress reports a voice-ended event.

callprog.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:
Value Event
0x0001 Ring tone
0x0002 Ring end
0x0004 Voice begin
0x0008 Medium voice duration
0x0010 Long voice duration
0x0020 Extended voice duration
0x0040 Voice end

callprog.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.

callprog.voicextended

DWORD

9000

ms

The minimum length of time voice must be detected before call progress reports an extended-voice event.

callprog.voicelong

DWORD

6000

ms

The minimum length of time voice must be detected before call progress reports a long-voice event.

callprog.voicemedium

DWORD

3000

ms

The minimum length of time voice must be detected before call progress reports a medium-voice event.

callprog.voicetoneratio

DWORD

0x30000

IDU

Do not modify.

connectmask

DWORD

0x0103

mask

Controls which network events will cause an outgoing call to transition to the connected state. A value may be formed by ORing any of the following bit masks:
Value Event
0x0001 Out-of-band signal
0x0002 Voice detected
0x0004 Medium length voice
0x0008 Long voice
0x0010 Extended voice
0x0020 Voice ended
0x0080 Ring ended
0x0100 Modem detected
0x0200 Dial tone
0x0400 SIT detected
0x8000 Connect immediately

disconnectmask

DWORD

0x0040

mask

Controls which network events will cause an outgoing call to disconnect (not complete). A value may be formed by ORing any of the following:
Value Event
0x0002 Voice detected
0x0004 Medium length voice
0x0008 Long voice
0x0010 Extended voice
0x0020 Voice ended
0x0040 Call progress timeout
0x0080 Rring ended
0x0100 Modem detected

ADI.PLAY

Dependent Function(s): adiStartPlaying, adiPlayFromMemory, adiPlayAsync

Field Name

Type

Default

Units

Description

DTMFabort

DWORD

0xFFFF

mask

Mask which allows you to control which DTMFs abort play. A value may be formed by ORing any of the following:

gain

INT32

0

dB

The gain applied to the encoded audio. Valid range is -54 to 24.

maxspeed

DWORD

100

percent

The maximum speed that will be used. This value determines how much DSP processing power is allocated to the play function. The valid is range 100-200. This value is ignored for encoding types for which speed modification is not supported.

speed

DWORD

100

percent

The initial speedup/slowdown factor to apply to the encoded audio. The valid range is 50 - maxspeed. This value is ignored for encoding types for which speed modification is not supported.

ADI.RECORD

Dependent Function(s): adiStartRecording, adiRecordToMemory, adiRecordAsync

Field Name

Type

Default

Units

Description

AGCattacktime

DWORD

14

ms

AGC attack time constant. This affects how quickly the gain is reduced for loud signals. Valid range is 1-30000.

AGCdecaytime

DWORD

304

ms

AGC decay time constant. This affects how quickly the gain is increased for soft signals. Valid range is 1-30000.

AGCenable

DWORD

0

integer

Flag to enable Automatic Gain Control (AGC). Set to 1 to enable AGC and 0 to disable it.

AGCsilenceampl

INT32

-49

dBm

The noise threshold for AGC. Gain adjustment is suspended for signals below this level. Valid range is -72 to 0.

AGCtargetampl

INT32

-19

dBm

The target amplitude for AGC. Valid range is -72 to 0.

beepampl

INT32

-20

dBm

The amplitude of the record beep tone. Valid range is -54 to 3.

beepfreq

DWORD

1000

Hz

The frequency of the record beep tone. 0 disables the beep. Valid range is 200-3600.

beeptime

DWORD

200

ms

The duration of the record beep tone. 0 disables the beep. Valid range is 0-65535.

DTMFabort

DWORD

0xFFFF

mask

Mask which allows you to control which DTMFs abort a record. A value may be formed by ORing any of the following values:

gain

INT32

0

dB

The gain applied to the signal before it is encoded. If AGC is enabled, this is the initial gain when record is started.
Valid range is -54 to 24.

novoicetime

DWORD

5000

ms

The maximum length of silence at the beginning of a recording before record will be stopped with a reason of CTA_REASON_NO_VOICE. Use 0 to disable this timer. Valid range is 0-65535.

silenceampl

INT32

-45

dBm

The maximum signal level that is considered to be silence. Valid range is -51 to -15.

silencedeglitch

DWORD

100

ms

The maximum non-silent interval that is ignored by the silence detector. Any sounds that last longer than this will reset the silence detector. Valid range is 0-32767.

silencetime

DWORD

3000

ms

The maximum length of silence after audio energy has been detected before record will be stopped with a reason of CTA_REASON_VOICE_END. Use 0 to disable this timer. Valid range is 0-65535.

ADI.START

Dependent Function(s): adiStartProtocol

Field Name

Type

Default

Units

Description

callctl.blockmode

DWORD

0

mask

Selects method of blocking calls for the adiBlockCalls function. 0=don't answer subsequent calls. 1=assert reverse make-busy (after current call is released).

callctl.debugmask

DWORD

0x0000

mask

Enables reporting of call control events for debugging. A value may be formed by ORing any of the following:
Value Event(s) reported
1 Each incoming digit
2 Each incoming ring begin and end
4 Each ring tone detected
8 All CID errors

callctl.eventmask

DWORD

0x0000

mask

Controls reporting of informational call control events. A value may be formed by ORing any of the following bit masks:
Value Event reported
1 ADIEVN_SEIZURE_DETECTED2 ADIEVN_PROCEEDING4 ADIEVN_REMOTE_ALERTING8 ADIEVN_REMOTE_ANSWERED

callctl.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:
Value Definition
0x0001 Reserve DTMF detection
0x0002 Reserve silence detector
0x0004 Reserve cleardown detection
0x0008 Start DTMF detection
0x0010 Start echo canceller

cleardown.bandw1

DWORD

40

Hz

Bandwidth for first frequency of the cleardown detector.
Valid range is 20-800.

cleardown.bandw2

DWORD

40

Hz

Bandwidth for second frequency.
Valid range is 20-800.

cleardown.freq1

DWORD

350

Hz

First frequency to detect.
Valid range is 1-4000.

cleardown.freq2

DWORD

440

Hz

Second frequency to detect, or 0 if detecting single frequency.
Valid range is 1-4000.

cleardown.qualampl

INT32

-28

dBm

The minimum signal level recognized as a hang-up tone.
Valid range is -51 to -15.

cleardown.qualtime

DWORD

1000

ms

The minimum duration of tone before a hang-up will be recognized. The valid range is 0 to 32767. cleardown.qualtime is ignored if cleardown.tonecount is non-zero (cadenced tones). Refer to the ADI Service Developer's Manual for more information.

cleardown.reflevel

DWORD

0xB000

IDU

Do not modify.

cleardown.reserved

DWORD

0

internal

Do not modify.

cleardown.tonecount

DWORD

0

integer

Minimum number of cadenced tones detected before reporting the cleardown event. For continuous tones, set this parameter to 0.

cleardown.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.

cleardown.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.

cleardown.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.

cleardown.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.

dial.breaktime

DWORD

60

ms

The break (on-hook) duration for dial pulses. Valid range is 0-30000.

dial.dialtonewait

DWORD

5000

ms

The maximum time to wait for dial tone (applies only to the ';' character). Valid range is 0-65535.

dial.dtmfampl1

INT32

-6

dBm

The amplitude of the low frequency component of the DTMF pair. Valid range is -54 to -3.

dial.dtmfampl2

INT32

-4

dBm

The amplitude of the high frequency component of the DTMF pair. Valid range is -54 to -3.

dial.dtmfofftime

DWORD

80

ms

The duration of the silence time between each digit. Valid range is 0-65534.

dial.dtmfontime

DWORD

80

ms

The duration of each DTMF or MF digit.
Valid range is 0-65534.

dial.flashtime

DWORD

500

ms

The amount of time to assert the on-hook signaling pattern for a flash ('!' character).
Valid range is 0-65535.

dial.interpulse

DWORD

700

ms

The inter-digit time for pulsed dialing. Valid range is 0-30000.

dial.longpause

DWORD

5000

ms

The amount of delay associated with the '.' (period) character. Valid range is 0-65535.

dial.maketime

DWORD

40

ms

The make (off-hook) duration for dial pulses. Valid range is 0-30000.

dial.method

DWORD

0

mask

Type of signaling: 0=DTMF, 1=Pulse, 2=MF (US).

dial.reserved

DWORD

0

internal

Do not modify.

dial.shortpause

DWORD

2000

ms

The amount of delay associated with the ',' (comma) character. Valid range is 0-65535.

dial.tonebandw1

DWORD

40

Hz

Bandwidth of the first frequency of the dial tone detector. Valid range is 20-800.

dial.tonebandw2

DWORD

40

Hz

Bandwidth of the second frequency of the dial tone detector. Valid range is 20-800.

dial.tonefreq1

DWORD

350

Hz

First (or only) dial tone frequency.
Valid range is 330-3600.

dial.tonefreq2

DWORD

440

Hz

Second dial tone frequency. Set this to 0 to detect a single frequency. The valid range is 330-3600.

dial.tonequalampl

INT32

-28

dBm

Minimum broadband signal amplitude to qualify for dial tone detection. Valid range is -40 to 0.

dial.tonequaltime

DWORD

50

ms

Minimum duration of a qualified tone to be considered dial tone. Valid range is 0-32767.

dial.tonereflevel

DWORD

0xB000

IDU

Do not modify.

dtmfdet.columnfour

DWORD

1

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.

dtmfdet.offqualampl

INT32

-45

dBm

The minimum signal required to maintain recognition of a DTMF signal once recognition has started. The valid range is -51 to -15.

dtmfdet.offqualtime

DWORD

40

ms

The minimum duration of absence of a recognized DTMF signal before an end-of-digit event will be emitted. Valid range is 5 to 32767.

dtmfdet.offthreshold

DWORD

0x92E0

IDU

Do not modify.

dtmfdet.onqualampl

INT32

-39

dBm

The minimum signal level recognized as a DTMF signal.
The valid range is -51 to -15.

dtmfdet.onqualtime

DWORD

50

ms

The minimum duration of a recognized DTMF signal before a digit event will be emitted.
The valid range is 22 to 32767.

dtmfdet.onthreshold

DWORD

0xCAB0

IDU

Do not modify.

echocancel.adapttime

DWORD

0

ms

Echo canceller adaptation time for MODE=2. If set to 0, echo cancelling is omitted. Otherwise the valid range is 100-1000. Smaller values require more DSP processing power.

echocancel.filterlength

DWORD

0

ms

Filter length of echo canceller for MODE=2. Set this to 0 to omit echo cancelling. Otherwise, valid range is 2-20. Greater values require more DSP processing power.

echocancel.gain

INT32

0

dB

Amount of amplification applied to echo-cancelled output. Valid range is -54 to +24.

echocancel.mode

DWORD

0

integer

Controls echo canceller operation:
0 = No echo cancellation.
1 = Use internal defaults for filter length and adaptation time based on board type
2= Use specified values.

echocancel.predelay

DWORD

0

ms

Output sample delay. Valid range is 0-9 (ignored on AG-8 board).

ADI.TONE

Dependent Function(s): adiStartTones

Field Name

Type

Default

Units

Description

ampl1

INT32

-20

dBm

The amplitude of the first (or only) frequency component. Valid range is -54 to 3.

ampl2

INT32

0

dBm

The amplitude of the second frequency component, if any. Valid range is -54 to 3.

freq1

DWORD

1000

Hz

The first (or only) frequency of the generated tone.
Valid range is 200-3600.

freq2

DWORD

0

Hz

The second frequency of the generated tone, or 0 if the tone is a single frequency.
If not 0, valid range is 200-3600.

iterations

INT32

1

integer

The number of times to repeat the alternating tone and silence period. A count of -1 means repeat forever. Otherwise the valid range is 1 to 32767.

offtime

DWORD

0

ms

The duration of silence between tones. Specify 0 for no off time.
Valid range is 0-65535.

ontime

DWORD

200

ms

The duration of the tone. Valid range is 1-65535.

ADI.TONEDETECT

Dependent Function(s): adiStartToneDetector

Field Name

Type

Default

Units

Description

qualampl

INT32

-28

dBm

The minimum signal level that will be detected. The valid range is -40 to 0.

qualtime

DWORD

500

ms

The minimum duration of a detected tone before an event will be emitted. This parameter also specifies the minimum duration of absence of detected tone before a tone-ended event will be emitted. The valid range is 0 to 32767.

reflevel

DWORD

0xB000

IDU

Do not modify.

reserved

DWORD

0

internal

Do not modify.

Trunk Control Program Parameters

The following tables are Trunk Control Program (TCP) parameters. They are used with adiStartProtocol. Their use depends on the first three letters of the TCP selected (e.g., category ADI.DID is used with did0.tcp).

ADI.DID

Dependent Protocol(s): DID0 for AG-8/DID, AG-T1, AG Quad T, AG Dual T,
or DTI with AG-24/30/48/60

Field Name

Type

Default

Units

Description

busyofftime

WORD

500

ms

The length of the silent interval between generated slow busy tones.

busyontime

WORD

500

ms

The length of each generated slow busy tone.

defaulttone

WORD

2

integer

The default tone to play if the PC does not respond to an incoming call indication (see waitforPCtime).
Value Definition
0 Reorder (fast busy)
1 Ringing
2 Busy

detectmode

WORD

0

integer

Type of incoming address signaling: 0 = DTMF and dial pulse; 2 = MF.

dtmfmask

WORD

0

mask

Mask for behavior of # and * tones.
0x1 = on #, send up incoming call
0x2 = * splits CID info
0x4 = ANI precedes * (def = DNIS)

maxresourcetime

WORD

10000

ms

The maximum time the TCP will wait for a call control resource to be granted.

mfflags

WORD

3

mask

Mask that controls behavior when using MF signaling. A value may be formed by ORing any of the following:
Value Definition
1 Begin with KP tone
2 End with ST tone

noresourcemode

WORD

0

integer

Mask that controls behavior when no resource is granted on inbound calls.
0 = No signaling; just send error
1 = Generate wink, than send error

numdigits

WORD

3

count

The expected number of digits for incoming calls.

prewinktime

WORD

100

ms

The amount of delay after incoming seizure is detected and before the start of the wink.

qualaddroff

WORD

50

ms

Deglitch time for off-hook to on-hook transitions during call set-up.

qualaddron

WORD

50

ms

Deglitch time for on-hook to off-hook transitions.

qualdisconnect

WORD

150

ms

Deglitch time for off-hook to on-hook transitions after address signaling is completed.

qualpermsignal

WORD

60000

ms

Maximum time for remote end to remain off hook when trunk is not in the conversation state before a permanent signal condition is detected. The valid range is 1-65535.

reorderofftime

WORD

250

ms

The length of the silent interval between generated reorder tones.

reorderontime

WORD

250

ms

The length of each generated reorder (fast busy) tone.

reserved

WORD

0

ms

Reserved.

ringofftime

WORD

3000

ms

The length of the silent interval between generated ring tones.

ringontime

WORD

1000

ms

The length of each generated ring tone.

wait1stdigittime

WORD

7000

ms

The maximum time to wait for the first incoming digit after the completion of the wink.

waitfordigitstime

WORD

8000

ms

The maximum time to wait for each incoming digit after the first one.

waitforPCtime

WORD

10000

ms

The maximum time to wait for the PC to respond to an incoming call indication before playing a default tone (see defaulttone).

winktime

WORD

200

ms

For incoming calls, the duration of the generated wink. Set this to 0 for no wink. Set to 0xFFFF for 350+440 Hz dial tone to be generated.

ADI.FDI

Dependent Protocol(s): FDI0 for AG-8/DID, Feature Group D

Field Name

Type

Default

Units

Description

busyofftime

WORD

500

ms

Busy tone OFF time.

busyontime

WORD

500

ms

Busy tone ON time.

defaulttone

WORD

2

n/a

Default tone if PC does not respond:
Value Definition
0 Reorder (fast busy)
1 Ringing
2 Busy

detectmode

WORD

2

n/a

Method of detection:
Value Definition
0 DTMFs (and pulses)
1 Pulses (and DTMFs)
2 MFs (and pulses)

maxresourcetime

WORD

10000

ms

The maximum time the TCP will wait for a call control resource to be granted.

mfflags

WORD

3

n/a

Mask for behavior when using MFs:
Value Definition
0x1 Begin with KP tone
0x2 End with ST tone (inbound only)

noresourcemode

WORD

0

integer

Mask that controls behavior when no resource is granted on inbound calls.
0 = No signaling; just send error
1 = Generate wink, than send error

numdigits

WORD

12

integer

Expected number of digits.

preanswertime

WORD

100

ms

Duration before answering call.

predialtime

WORD

70

ms

Post wink/pre-dial delay.

prewinktime

WORD

100

ms

Pre-wink delay.

qualaddroff

WORD

50

ms

qual dur. OFF during addressing.

qualaddron

WORD

50

ms

qual dur. ON during addressing.

qualdisconnect

WORD

150

ms

qual dur. of disconnect.

qualpermsignal

WORD

60000

ms

qual dur. of permanent signal.

releaseguardtime

WORD

1000

ms

Duration before next call.

reorderontime

WORD

250

ms

Reorder tone ON.

reorderofftime

WORD

250

ms

Reorder tone OFF.

reserved

WORD

0

n/a

Do not modify.

ringofftime

WORD

3000

ms

Ring tone OFF time.

wait1stdigittime

WORD

7000

ms

Duration to wait for first digit.

waitfordigitstime

WORD

8000

ms

Duration to wait for nth digit (outbound only).

waitforPCtime

WORD

10000

ms

Duration to wait for PC to respond.

winktime

WORD

200

ms

Duration of the wink.

ADI.GST

Dependent Protocol(s): GST8 for AG-T1 or AG Dual T, digital ground-start (OPS-FX)
GST9 for AG-T1 or AG Dual T, digital ground-start (OPS-SA)

Field Name

Type

Default

Units

Description

cidsupport

WORD

0

n/a

Indicates if caller ID is supported:
Value Definition
0 CID disabled
1 CID enabled

dialtonemintime

WORD

1000

ms

For outgoing calls, the minimum duration of non-precise dial tone required before dialing will begin. Set this to 0 to disable non-precise dial tone detection. (Precise dial tone detection is controlled by ADISTART parameters).

dialtonewaittime

WORD

5000

ms

For outgoing calls, the maximum time to wait for initial dial tone.

interringmaxtime

WORD

8000

ms

The maximum length of an incoming ring period (on time + off time) that can elapse before the call is considered to be abandoned.

nodialtoneaction

WORD

0

n/a

Selects what to do if no dial tone detected:
Value Definition
0 Hang up and abandon the call
1 Proceed to dial anyway
2 Generate an incoming call event

numrings

WORD

0

count

Number of rings to detect for an incoming call:
Value Definition
0 First ring begin
1 First ring end
n After n rings
Note that if caller ID is enabled (cidsupport = 1) then the incoming call is reported after at least one ring.

qualloopoff

WORD

10

ms

Minimum duration of loop current interruption before a hang-up will be recognized.

qualringoff

WORD

100

ms

For voltage-sensitive ring detection, the minimum duration of loss of detected voltage to be recognized as the end of a ringing signal.

qualringon

WORD

6

ms

For voltage-sensitive ring detection, the minimum duration of detected voltage to be recognized as the start of a ringing signal.

releaseguardtime

WORD

1000

ms

Minimum time between hang up & off hook.

ringsigmintime

WORD

100

ms

Inbound minimum ring time (+qual).

ringsigmaxtime

WORD

3000

ms

Inbound maximum ring time (+qual).

xfersupport

WORD

1

n/a

Flag to select whether PBX transfer is allowed.
Value Definition
0 Transfer commands disabled
1 Transfer commands allowed

ADI.LPS

Dependent Protocol(s):
LPS0 for AG-8/LS or AG 2000 ¹, QX 2000/100-4L, ATI or T Connect with AG-24/30/48/60
LPS4 for WTI-8 or QX 2000/80-4L
LPS8 for AG-T1 or AG Dual T, digital loop-start (OPS-FX).
LPS9 for AG-T1 or AG Dual T, digital loop-start (OPS-SA)

Field Name

Type

Default

Units

Description

cidsupport

WORD

0

mask

Flag to enable caller ID detection:
Value Definition
0 No caller ID detection
1 Caller ID detection enabled
For AG boards, the AG configuration file must include the DSP file adsir.dsp when caller ID is enabled.

CIDalertmaxtime

WORD

0

ms

Maximum duration of an alert signal in Caller ID protocol (if CID is enabled).

CIDmaxwaittime

WORD

0

ms

Maximum time to wait for Caller ID to arrive before concluding the caller has hungup (if CID is enabled).

CIDtype

WORD

0

integer

Type of Caller ID protocol, if CID is enabled:
Value Definition
0 BellCore CID Protocol
1 NTT Japan CID Protocol
2 ETSI Ringing Pulse Alerting Signal CID
Protocol

CIDreserved

WORD

0

ms

Timing for Japan protocol

cleardownflag

WORD

1

mask

Selects whether to run the cleardown tone detector in the conversation state.
Value Definition
1 Cleardown enabled
0 Not enabled

connstring

String

"!"

String

Dial string for reconnect.

dialtonemintime

WORD

1000

ms

For outgoing calls, the minimum duration of non-precise dial tone required before dialing will begin.
Set this to 0 to disable non-precise dial tone detection. (Precise dial tone detection is controlled by ADI_START_PARMS).

dialtonewaittime

WORD

5000

ms

For outgoing calls, the maximum time to wait for initial dial tone.

freqdeglitchtime

WORD

26

count

For frequency-selective ring detection, deglitch time in 1/8 ms. Range is 2-80 (.25 to 10 ms).

freqringhigh

WORD

54

Hz

For frequency-selective ring detection, the maximum frequency recognized.

freqringlow

WORD

16

Hz

For frequency-selective ring detection, the minimum frequency recognized.

freqringperiods

WORD

4

count

For frequency-selective ring detection, number of periods of the ring frequency needed to qualify. Range is 1-8.

freqtolerance

WORD

10

percent

For frequency-selective ring detection, frequency tolerance in percent.

interringmaxtime

WORD

8000

ms

The maximum length of an incoming ring period (on time + off time) that can elapse before the call is considered to be abandoned.

nodialtoneaction

WORD

0

integer

Selects what to do if no dial tone detected:
Value Definition
0 Hang up and abandon the call
1 Proceed to dial anyway
2 Generate an incoming call event

numrings

WORD

0

count

Number of rings to detect for an incoming call:
Value Definition
0 First ring begin
1 First ring end
n After n rings
Note that if caller ID is enabled (cidsupport = 1) then the incoming call is reported after at least one ring.

polaranswertime

WORD

0

ms

Wait time after going off-hook answering a call before you start detecting the loop current polarity reversal on far-end disconnect (if reversal mode = 2 or 3).

polardialtime

WORD

0

ms

Wait time after dialing before starting the loop current polarity reversal detection (if reversal mode = 1 or 3).

qualloopoff

WORD

10

ms

Minimum duration of loop current interruption before a hang-up will be recognized.

qualreversal

WORD

200

ms

Qualification time for loop current reversal event on the AG 2000 board.

qualringoff

WORD

100

ms

For voltage-sensitive ring detection, the minimum duration of loss of detected voltage to be recognized as the end of a ringing signal.

qualringon

WORD

6

ms

For voltage-sensitive ring detection, the minimum duration of detected voltage to be recognized as the start of a ringing signal.

relaytype

WORD

0

integer

Defines a type of the special relay on the AG 2000 board:
Value Definition
0 Switchable ring
1 Transient limiter
2 Dialshunt

releaseguardtime

WORD

1000

ms

If the host specifies to place a call immediately after releasing a call, the line is not taken off-hook until this time has elapsed. This ensures that the CO considers the line idle.

reversalmode

WORD

0

integer

Selects a loop current reversal detection mode for the AG 2000 board:
Value Definition
0 Disable detection
1 Reversal indicates remote answer
2 Reversal indicates remote hang up
3 Reversal indicates answer and hang up

ringdetectmode

WORD

0

mask

Selects whether the ring detector is voltage-sensitive or frequency-selective:
Value Definition
0 Voltage-sensitive
1 Frequency-selective

ringsigmaxtime

WORD

3000

ms

The maximum duration of a detected incoming ringing signal before the ringing is considered to be invalidly long.

ringsigmintime

WORD

100

ms

The minimum duration of a detected ring signal before the ring signal is considered valid.

xferstring

String[6]

"!;"

String

Prefix of feature code for transfer operation. The default string "!;" generates a flash hook, then waits for a dialtone.

xfersupport

WORD

1

mask

Flag to select whether PBX transfer is allowed.
Value Definition
0 Transfer commands disabled
1 Transfer commands allowed

¹ For more information about ADI.LPS and the AG 2000 boards, refer to the CAS Protocols Installation and Developer's Manual.

ADI.OGT

Dependent Protocol(s): OGT0 for AG-T1, AG Quad T, AG Dual T, or DTI with AG-24/30/48/60,
outgoing only wink-start

Field Name

Type

Default

Units

Description

maxresourcetime

WORD

10000

ms

The maximum time the TCP will wait for a call control resource to be granted.

maxwinktime

WORD

4900

ms

The maximum duration of a detected wink before a "stuck sender" condition is detected.

mfflags

WORD

3

mask

Mask that controls behavior when using MF signaling. A value may be formed by ORing any of the following:
Value Behavior
1 Begin with KP tone
2 End with ST tone
Set adistart.dial.method =2 so that adiPlaceCall uses MF digits.

mfkpstampl

WORD

352

internal

Reserved - do not modify.

mfkpstofftime

WORD

80

ms

Duration of tone off for MF, KP, and ST.

mfkpstontime

WORD

80

ms

Duration of tone on for MF, KP, and ST.

minwinktime

WORD

100

ms

The minimum duration of a detected wink.

predialtime

WORD

70

ms

The amount of time to delay the start of outgoing address signaling after end of wink is detected.

qualaddroff

WORD

50

ms

Deglitch time for off-hook to on-hook transitions during call setup.

qualaddron

WORD

50

ms

Deglitch time for on-hook to off-hook transitions.

qualdisconnect

WORD

150

ms

Deglitch time for off-hook to on-hook transitions after address signaling is completed.

qualpermsignal

WORD

60000

ms

Maximum time for remote end to remain off hook when trunk is not in the conversation state before a permanent signal condition is detected. Valid range is 1-65535.

releaseguardtime

WORD

1000

ms

Minimum on-hook interval between calls.

reserved

WORD

0

ms

Reserved.

winkwaittime

WORD

10000

ms

The maximum time to wait for the far end to wink. Set this to 0 if no wink is expected.

ADI.WNK

Dependent Protocol(s): WNK0 for AG-T1, AG Quad T, or AG Dual T, 2-way wink start
WNK1 for AG-8 E&M, 2-way wink start

Field Name

Type

Default

Units

Description

busyofftime

WORD

500

ms

The length of the silent interval between generated slow busy tones.

busyontime

WORD

500

ms

The length of each generated slow busy tone.

connstring

String

"!"

String

Dial string for reconnect.

dtmfmask

WORD

0

mask

Mask for behavior of # and * tones.
0x1 = on #, send up incoming call
0x2 = * splits CID info
0x4 = ANI precedes * (def = DNIS)

defaulttone

WORD

2

integer

The default tone to play if the PC does not respond to an incoming call indication (see waitforPCtime):
Value Definition
0 Reorder (fast busy)
1 Ringing
2 Busy

detectmode

WORD

0

integer

Type of incoming address signaling:
Value Definition
0 DTMF and dial pulse
2 MF

maxresourcetime

WORD

10000

ms

The maximum time the TCP will wait for a call control resource to be granted.

maxwinktime

WORD

4900

ms

The maximum duration of a detected wink before a "stuck sender" condition is detected.

mfflags

WORD

3

mask

Mask that controls behavior when using MF signaling. Set adistart.dial.method =2 so that adiPlaceCall uses MF digits. A value may be formed by ORing any of the following:
Value Definition
1 Begin with KP tone
2 End with ST tone

mfkpstampl

WORD

352

internal

Reserved - do not modify.

mfkpstofftime

WORD

80

ms

Duration of tone off for MF, KP, and ST.

mfkpstontime

WORD

80

ms

Duration of tone on for MF, KP, and ST.

minwinktime

WORD

100

ms

The minimum duration of a detected wink.

noresourcemode

WORD

0

integer

Mask that controls behavior when no resource is granted on inbound calls.
0 = No signaling; just send error
1 = Generate wink, than send error

numdigits

WORD

3

count

The expected number of digits for incoming calls. If an incoming call is detected with fewer digits than what is specified in this parameter, ADIEVN_INCOMING_CALL is sent up to the host after the wait-for-digits timer (adi.wnk.waitfordigitstime) has expired. At least one digit must be detected for this to occur.
It is up to the application to parse the digit string and to decide whether or not to accept the call. Calls with a number of digits equal to or greater than the number in adi.wnk.numdigits behave normally.

predialtime

WORD

70

ms

The amount of time to delay the start of outgoing address signaling after end of wink is detected.

prewinktime

WORD

100

ms

The amount of delay after incoming seizure is detected and before the start of the wink.

qualaddroff

WORD

50

ms

Deglitch time for off-hook to on-hook transitions during call set-up.

qualaddron

WORD

50

ms

Deglitch time for on-hook to off-hook transitions.

qualdisconnect

WORD

150

ms

Deglitch time for off-hook to on-hook transitions after address signaling is completed.

qualpermsignal

WORD

60000

ms

Maximum time for remote end to remain off hook when trunk is not in the conversation state before a permanent signal condition is detected. Valid range is 1-65535.

releaseguardtime

WORD

1000

ms

Minimum on-hook internal between calls.

reorderofftime

WORD

250

ms

The length of the silent interval between generated reorder tones.

reorderontime

WORD

250

ms

The length of each generated reorder (fast busy) tone.

reserved

WORD

0

ms

Reserved.

ringofftime

WORD

3000

ms

The length of the silent interval between generated ring tones.

ringontime

WORD

1000

ms

The length of each generated ring tone.

wait1stdigittime

WORD

7000

ms

The maximum time to wait for the first incoming digit after the completion of the wink.

waitfordigitstime

WORD

8000

ms

The maximum time to wait for each incoming digit after the first one.
If an incoming call is detected with fewer digits than what is specified in the adi.wnk.numdigits parameter, ADIEVN_INCOMING_CALL is sent up to the host after this wait-for-digits timer has expired. At least one digit must be detected for this to occur.

waitforPCtime

WORD

10000

ms

The maximum time to wait for the PC to respond to an incoming call indication before playing a default tone (see defaulttone).

winktime

WORD

200

ms

For incoming calls, the duration of the generated wink. Set this to 0 for no wink. Set to 0xFFFF for 350+440 Hz dial tone to be generated.

winkwaittime

WORD

10000

ms

The maximum time to wait for the far end to wink for an outgoing call. Set this to 0 if no wink is expected.

xferstring

String[6]

"!;"

String

Prefix of feature code for transfer operation. The default string "!;" generates a flash hook, then waits for a dialtone.

xfersupport

WORD

1

mask

Flag to select whether PBX transfer is allowed.
Value Definition
0 Transfer commands are disabled
1 Transfer commands are allowed

(Page 1 of 1 in this chapter)

tech_support@nmss.com

Appendix D

NMS Board Parameters

Introduction

Function Parameters

Dependent Function(s): adiStartCallProgress

Dependent Function(s): adiCollectDigits

Dependent Function(s): adiStartDial

Dependent Function(s): adiStartDTMF

Dependent Function(s): adiStartDTMFDetector

Dependent Function(s): adiStartEnergyDetector

Dependent Function(s): adiPlaceCall, adiPlaceSecondCall, adiTransferCall

Dependent Function(s): adiStartRecording, adiRecordToMemory, adiRecordAsync

Trunk Control Program Parameters

Dependent Protocol(s): DID0 for AG-8/DID, AG-T1, AG Quad T, AG Dual T, or DTI with AG-24/30/48/60

Dependent Protocol(s): FDI0 for AG-8/DID, Feature Group D

Dependent Protocol(s): GST8 for AG-T1 or AG Dual T, digital ground-start (OPS-FX) GST9 for AG-T1 or AG Dual T, digital ground-start (OPS-SA)

Dependent Protocol(s):LPS0 for AG-8/LS or AG 20001, QX 2000/100-4L, ATI or T Connect with AG-24/30/48/60 LPS4 for WTI-8 or QX 2000/80-4LLPS8 for AG-T1 or AG Dual T, digital loop-start (OPS-FX).LPS9 for AG-T1 or AG Dual T, digital loop-start (OPS-SA)

Dependent Protocol(s): OGT0 for AG-T1, AG Quad T, AG Dual T, or DTI with AG-24/30/48/60, outgoing only wink-start

Dependent Protocol(s): WNK0 for AG-T1, AG Quad T, or AG Dual T, 2-way wink start WNK1 for AG-8 E&M, 2-way wink start

Dependent Protocol(s): DID0 for AG-8/DID, AG-T1, AG Quad T, AG Dual T,
or DTI with AG-24/30/48/60

Dependent Protocol(s): GST8 for AG-T1 or AG Dual T, digital ground-start (OPS-FX)
GST9 for AG-T1 or AG Dual T, digital ground-start (OPS-SA)

Dependent Protocol(s):
LPS0 for AG-8/LS or AG 2000 ¹, QX 2000/100-4L, ATI or T Connect with AG-24/30/48/60
LPS4 for WTI-8 or QX 2000/80-4L
LPS8 for AG-T1 or AG Dual T, digital loop-start (OPS-FX).
LPS9 for AG-T1 or AG Dual T, digital loop-start (OPS-SA)

Dependent Protocol(s): OGT0 for AG-T1, AG Quad T, AG Dual T, or DTI with AG-24/30/48/60,
outgoing only wink-start

Dependent Protocol(s): WNK0 for AG-T1, AG Quad T, or AG Dual T, 2-way wink start
WNK1 for AG-8 E&M, 2-way wink start