NAME
IrPARAMETERS - IRAPI library parameters
SYNOPSIS
#include <irapi.h>
DESCRIPTION
Each parameter has a set of valid values (including a
default value). Parameters are named according to the fol-
lowing convention:
IRP_<IRAPI Activity>_<Parameter Name>
where <Parameter Name> is the name of the actual parameter
and <IRAPI Activity> is the library activity to which the
parameter applies. For example, recording is an IRAPI
activity and output gain, and recording tone and recording
algorithm are two of the applicable parameters.
Parameters vary in scope. Unless otherwise noted, parame-
ters listed here are channel parameters that pertain to a
specific channel id or cid. Global parameters affect all
channels and applications on the voice system and are
described in irGlobalParam(3IRAPI) and irAPI.rc(4IRAPI).
Channel specific parameters and Global parameters form dis-
jointed sets.
All following parameters include their type, size and save
on irExec status on a single line. Type is either int or
char. Size is the maximum number of bytes the parameter
value may occupy. Note that char type parameters may con-
tain raw (non-ASCII) data; therefore, no assumptions about
NULL character termination apply to char type parameters
when setting and getting parameter values. All data is read
or written according to the size of the parameter. Save on
exec indicates whether the parameter value is saved after
the channel is irExec(3IRAPI)ed to another application.
The next few lines detail the parameters valid values,
default value and description:
Parameter type size save on exec
Valid Values
Describes the values to which this parameter may
be set
Default Value
Describes the default value to which this parame-
ter is set
Channel parameters are returned to defaults when
irDeinit(3IRAPI) is executed for the cid or through the
irInitParam(3IRAPI) or irInitAllParams(3IRAPI).
Global parameters are initialized when the voice system is
started.
Description
Describes how and where the parameter is used
APPLICATION CONTROL PARAMETERS
IRP_SERVICE_NAME char 16 YES
Valid Values
Any character string
Default Value
None. The service name is provided as argument to
irExec, or the application name (as described
below).
Description
This value identifies the service running on a
channel id. The irDeinit function clears this
parameter. The irExec functions set this parame-
ter equal to the service name provided as an argu-
ment. If this parameter is not set when the
irInit functions are called, these functions set
this parameter equal to the application name that
was provided in an earlier call to irRegister.
IRP_REGISTER char 64 YES
Valid Values
Any block of 64 bytes
Default Value
All bytes in buffer are '\0'
Description
This parameter is used to pass register values
between applications through irExec(3IRAPI). In
particular, transaction state machine (TSM) uses
this parameter to pass TAS registers between
applications. Register 0 uses bytes 0, 1, 2 and
3, register 1 uses bytes 4, 5, 6 and 7. This con-
tinues until register 16 which uses bytes 60, 61,
62 and 63. NOTE: 64 and only 64 bytes of data is
always copied, even if the buffer is not 64 bytes
long.
IRP_EXEC_BUF char 2048 YES
Valid Values
Any block of 2048 bytes
Default Value
There is no default for this parameter. If not
explicitly set, it contains unknown values.
Description
This parameter is used to pass an arbitrary data
buffer between calls to irExec(3IRAPI). In par-
ticular, TSM makes this buffer available when a
TAS script is irExec'd from an IRAPI application.
IRP_EXEC_BUF_LEN int 4 YES
Valid Values
Any non-negative integer up to 2048
(IRD_MAXDATABUFFER)
Default Value
0
Description
This value indicates the size of the exec buffer
and is set by the application executing the call
to irExec(3IRAPI).
IRP_RESOURCE_RETURNMODE int 4 NO
Valid Values
IRD_IMMEDIATE, IRD_BLOCKFOREVER, or a positive
integer representing time in milliseconds.
Default Value
IRD_IMMEDIATE
Description
This parameter determines the behavior of any
function which may implicitly allocate resources.
The following settings determine the behavior of
functions which cannot allocate resources to com-
plete or initiate the requested operation:
IRD_IMMEDIATE
Causes the called function to return
with a IRR_FAIL immediately
IRD_BLOCKFOREVER
Causes the called function to return
IRR_PENDING. The applications should
then wait on IRE_GRANT before continu-
ing.
Any positive integer N
Causes the called function to return
IRR_PENDING. The application should
then wait for either IRE_GRANT or
IRE_DENY. IRE_DENY occurs if the
resource could not be granted in N mil-
liseconds.
IRP_CHAN_NEGOTIATION int 4 YES
Valid Values
IRD_ALLOW, IRD_CONDITIONAL
Default Value
IRD_CONDITIONAL
Description
This parameter determines the behavior of a chan-
nel when ownership for it is requested by another
application via irInit(3IRAPI).
If IRP_CHAN_NEGOTIATION is set to IRD_ALLOW and the channel
is requested by another process, the channel immediately is
deallocated from the current owner. The current owner
receives the IRE_CHAN_REMOVED event and must discontinue use
of the channel_id. Any future function calls referencing
the channel_id fail immediately as the cid is marked as
invalid.
If IRP_CHAN_NEGOTIATION is set to IRD_CONDITIONAL, the own-
ing application receives the IRD_CHAN_REQUESTED event when
the channel is requested by some other process. The appli-
cation handles this situation depends on application imple-
mentation. The application may immediately free the channel
via irDeinit(3IRAPI), gracefully terminate the call and
irDeinit(3IRAPI), or choose to ignore the request for the
channel.
Note that an application can never guarantee against having
a channel deallocated, regardless of the value of
IRP_CHAN_NEGOTIATION. The channel may be forcibly requested
by a maintenance process.
IRP_TALKFILE int 4 YES
Valid Values
Integer values from 0 to 65535
Default Value
255
Description
This parameter is used to set the default talkfile
used for irPhReserve(3IRAPI) and irLP(3IRAPI).
IRP_RESOURCE_MASK int 4 YES
Valid Values
Any integer
Default value
IRD_ANY_RESOURCE
Description
This parameter is a 32-bit bit field. Bit N
corresponds to resource card N. If bit N is one
(1) then resource card N is eligible for alloca-
tion by the Resource Manager. If bit N is zero
(0) then resource card N is not eligible for allo-
cation by the Resource Manager. This parameter is
examined only during echo cancellation and recog-
nition resource allocation. When an echo cancel-
lation or recognition resource is successfully
allocated [either via irReserveResource, irStar-
tEcho or irStartRecog] the value of
IRP_RESOURCE_MASK is set by IRAPI to indicate only
that specific resource card will be considered for
any future echo cancellation or recognition
resource allocations. The intent behind this is
to force echo cancellation and recognition
resources to be allocated on the same resource
card. This is necessary for prompt with interrupt
to work. If resource allocation fails, and
IRP_RESOURCE_MASK is set to other than
IRD_ANY_RESOURCE then the value of irError is set
to IRER_NOTCOLLOCATED. The application may choose
to retry resource allocation, however, prompt with
interrupt will be ineffective.
IRP_EXTEND_BUF char 2048 NO
Valid Values
Any block of 2048 bytes
Default Value
There is no default for this parameter. If not
explicitly set, it contains unknown values.
Description
This parameter is used to pass an arbitrary data
buffer between TSM scripts, and add-on C language
functions called in support of the TSM extend
instruction. See irExtend(3IRAPI))
CALLER INPUT PARAMETERS
IRP_INPUT_DISPLAY int 4 NO
Valid Values
IRD_ON or IRD_OFF
Default Value
IRD_ON
Description
This parameter controls the display on the
sysmon(1) monitor of caller input (either via
touch-tone or speech recognition). Its value may
be either IRD_ON or IRD_OFF to turn on or off
respectively the display of caller input. If set
to IRD_OFF, the caller input will be displayed by
sysmon as the character 'X' for each character in
the input stream. If the input queue is being
used (IPR_INPUT_QUEUE is IRD_ON), the entire con-
tents of the queue is displayed as either all X's
or the actual data for settings of IRD_OFF and
IRD_ON respectively. Therefore, it is advisable
that the input queue be flushed (
irFlushInput(3IRAPI)) before the display mode is
toggled.
IRP_INPUT_QUEUE int 4 NO
Valid Values
IRD_ON or IRD_OFF
Default Value
IRD_ON
Description
This parameter controls the on/off status of the
input queue. If set to IRD_ON, all input, as
indicated through the IRE_INPUT and IRE_INPUT_DONE
events will be available from the input queue. If
set to IRD_OFF, the input queue will not be
updated as IRE_INPUT and IRE_INPUT_DONE events are
generated. Note that if this parameter is set to
IRD_OFF, the IRE_INPUT_DONE event will never be
generated for TouchTone input (it will still be
generated for speech recognition) and the parame-
ters effecting the generation of IRE_INPUT_DONE
will be ignored (including timeouts, delimiters,
erase characters and input length).
IRP_INPUT_ERASECHAR1 char 2 NO
Valid Values
Any character string
Default Value
IRD_NULL
Description
This parameter determines which input character
erases the single character preceding it on the
input queue [see irGetInput(3IRAPI) ]. Erase
characters may be one or two characters in length.
IRP_INPUT_ERASECHAR2 char 2 NO
Valid Values
See IRP_INPUT_ERASECHAR1
Default Value
See IRP_INPUT_ERASECHAR1
Description
This parameter determines which input character
erases all the characters preceding it on the
input queue [see irGetInput(3IRAPI) ]. Erase
characters may be one or two characters in length.
IRP_INPUT_LEN int 4 NO
Valid Values
Any positive integer
Default Value
0
Description
This parameter determines the number of input
characters that must be present on the input queue
to cause the IRE_INPUT_DONE event to be generated.
IRP_INPUT_DELIM1 char 2 NO
Valid Values
Any character string
Default Value
IRD_NULL
Description
This parameter determines the 1 or 2 character
input delimiter. When a character sequence exists
on the input queue matching this parameter, the
IRE_INPUT_DONE event is generated. IRD_NULL indi-
cates that the IRAPI does not match character
delimiters.
IRP_INPUT_DELIM2 char 2 NO
Valid Values
See IRP_INPUT_DELIM1
Default Value
See IRP_INPUT_DELIM1
Description
See IRP_INPUT_DELIM1. Note that when either
IRP_INPUT_DELIM1 or IRP_INPUT_DELIM2 exists on the
input queue, IRE_INPUT_DONE is generated.
IRP_TT_PRETIME int 4 NO
Valid Values
Any positive integer
Default Value
5000
Description
This parameter indicates the amount of time to
wait, in milliseconds, for initial touch-tone
input after execution of irStartTTTimer(3IRAPI),
if the input queue is empty.
IRP_TT_INTERTIME int 4 NO
Valid Values
Any positive integer
Default Value
5000
Description
This parameter indicates the amount of time to
wait, in milliseconds, for interdigit touch-tone
input after execution of irStartTTTimer(3IRAPI) if
the input queue is occupied or if input has been
received since executing irStartTTTimer(3IRAPI).
IRP_RECOG_PRETIME int 4 NO
Valid Values
Any positive integer
Default Value
5000
Description
This parameter indicates the amount of time to
wait, in milliseconds, for initial recognition
input after execution of irStartRecogTimer(3IRAPI)
if the input queue is empty.
IRP_RECOG_INTERTIME int 4 NO
Valid Values
Any positive integer
Default Value
5000
Description
This parameter indicates the amount of time to
wait, in milliseconds, for intermediate recogni-
tion input after execution of
irStartRecog(3IRAPI). This parameter applies only
to DialPulse recognition and WholeWord recogni-
tion. Due to the nature of FlexWord recognition
it cannot use this parameter .
IRP_RECOG_EFLOOR int 4 NO
Valid Values
Any positive integer
Default Value
-40
Description
This parameter is the speech energy floor in deci-
bels indicating silence for speech recognition.
This value should typically range from -40 to -45
depending on the telephony network and background
noise. This parameter is available only for LSPS
recognition.
IRP_RECOG_GAPTIME int 4 NO
Valid Values
Any positive integer
Default Value
300
Description
This parameter is number of milliseconds to assume
between speech utterances. The default value is
appropriate only for Isolated Digit and Isolated
Word recognition. A value of 2000 would be
appropriate for Connected Digit recognition. A
value of 1000 to 1500 may be appropriate for Gram-
mar Based ASR, however this strongly depends on
the grammar, the length of pauses and energy lev-
els. This parameter is available only for LSPS
recognition.
IRP_RECOG_MIN_UTIME int 4 NO
Valid Values
Any positive integer
Default Value
100
Description
This parameter is minimum acceptable length in
milliseconds of a speech utterance to be con-
sidered valid speech. This parameter is available
only for LSPS recognition. The default value is
appropriate only for Isolated Digit and Isolated
Word recognition. A value of 100 * number_digits
may be appropriate for Connected Digit recogni-
tion. A value of 100 to 1000 may be appropriate
for Grammar Based ASR, however, this depends on
the length of the smallest phrase.
IRP_RECOG_MAX_UTIME int 4 NO
Valid Values
Any positive integer
Default Value
2000
Description
This parameter is maximum acceptable length in
milliseconds of a speech utterance to be con-
sidered valid speech. This parameter is available
only for LSPS recognition. The default value is
appropriate only for Isolated Digit and Isolated
Word recognition. A value of 1000*(1 +
number_digits) may be appropriate for Connected
Digit recognition. A value of 10000 to 20000 may
be appropriate for Grammar Based ASR, however,
this depends on the length of the response sen-
tence spoken.
IRP_RECOG_MAX_LTIME int 4 NO
Valid Values
Any positive integer
Default Value
9000
Description
This parameter is maximum length in milliseconds
the speech recognizer will listen. This parameter
is available only for LSPS recognition. The
default value is appropriate only for Isolated
Digit and Isolated Word recognition. A value of
(IRP_RECOG_MAX_UTIME+IRP_RECOG_PRETIME+IRP_RECOG_INTERTIME)
may be appropriate for Connected Digit and Grammar
Based ASR. A value of IRP_RECOG_MAX_LTIME less
than this formula will result in an error.
VOICE PLAY PARAMETERS
IRP_PLAY_GAIN int 4 YES
Valid Values
Any integer
Default Value
0
Description
This parameter is specified in decibels (dB).
Modification of this parameter increases or
decreases the volume at which speech is played.
This gain is relative to the OVOL specified
through cvis_menu(1). That is, the resulting out-
put volume is OVOL plus IRP_PLAY_GAIN. The true
gain range is determined by the network interface
or speech processing hardware. The gain is
adjusted as needed to meet the limitations of the
hardware.
IRP_PLAY_SPEED int 4 YES
Valid Values
Any integer
Default Value
100 (no change in speed)
Description
It specifies the speed at which speech is to be
played. This value should be interpreted as a
percentage of normal speed. Normal speed is 100%.
IRP_PLAY_ALGO int 4 YES
Valid Values
accepts any integer values. Speech playback
failures result for unsupported values.
Default Value
IRP_SPEECH_ALGO
Description
This parameter determines the speech playback
algorithm used for calls to the irPlay(3IRAPI)
function.
IRP_OUTPUT_BGGAIN int 4 YES
Valid Values
Any integer
Default Value
0
Description
This parameter specifies the gain applied to back-
ground play. Background speech is played at
IRP_BACKGROUND_OVOL percent of unity gain [see
irAPI.rc(4IRAPI)]. The speech volume then is
adjusted relative to unity gain for the channel
OVOL as set through cvis_menu(1VIS).
IRP_OUTPUT_BGGAIN, whose dimensions are dB, allows
a final adjustment to this gain. The true gain
range is determined by the network interface or
speech processing hardware. The gain is adjusted
as needed to meet the limitations of the hardware.
IRP_VOICE_TYPE int 4 YES
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, IRD_TALK_VOICE, IRD_SP_VOICE, IRD_LSPS_VOICE
and IRD_TDM_TS are the currently supported voice
types. If IRP_VOICE_TYPE is not set to one of
these values, attempts to use voice operations
generate the IRER_SUPPORTED error code.
Default Value
For T1 channels the default value is the value of
IRD_DSP_VOICE. For Tip Ring channels the default
value depends on the system administration for the
channel talk type.
Description
This parameter indicates how voice is to be played
or recorded on a channel. IRD_TALK_VOICE indi-
cates that voice should be played on the card with
the network connection (for example, a T/R card).
IRD_SP_VOICE indicates that voice should be played
on an SP card. IRD_LSPS_VOICE indicates that
voice should be played on an LSPS card.
IRD_TDM_TS may be used by channels wishing to
start a play on an allocated time slot. This
parameter effects voice record as well.
VOICE RECORD PARAMETERS
IRP_RECORD_GAIN int 4 YES
Valid Values
Any integer
Default Value
0
Description
This parameter is specified in decibels (dB).
Modification of this parameter increases or
decreases the volume at which speech is recorded.
This gain is relative to the IVOL specified
through cvis_menu. The true gain range is deter-
mined by the network interface or speech process-
ing hardware. The gain is adjusted as needed to
meet the limitations of the hardware.
IRP_RECORD_GAIN has no affect when recording via
the T/R driver (IRP_VOICE_TYPE is set to
IRD_TALK_VOICE), but has an affect when recording
on an SP over the TDM bus (IRP_VOICE_TYPE is set
to IRD_SP_VOICE).
IRP_RECORD_TYPE int 4 YES
This parameter is reserved for future use.
IRP_RECORD_ALGO int 4 NO
Valid Values
See IrALGORITHMS(4IRAPI). irSetParam(3IRAPI)
accepts any integer values. Coding failures result
for unsupported values.
Default Value
IRP_SPEECH_ALGO
Description
This parameter determines the coding algorithm
used for calls to the irRecord(3IRAPI) function.
IRP_RECORD_TONE int 4 NO
Valid Values
IRD_ON, IRD_OFF
Default Value
IRD_ON
Description
Determines whether a beep tone will be sounded
when the system is ready to record speech
(activated by irRecord(3IRAPI). This parameter is
not supported for speech recording on LSPS cards.
An alternative method is to include a tone file as
the last file in the list of speech files to be
played for a prompt, or to include a beep tone in
the prompt recording itself.
IRP_RECORD_PRETIME int 4 NO
Valid Values
030000 milliseconds
Default Value
5000
Description
This parameter determines the amount of time a
record request waits before timing out due to ini-
tial silence detection. Units are in mil-
liseconds.
When recording more than 5 seconds of silence using the T/R
driver, the IRP_RECORD_PRETIME and IRP_RECORD_INTERTIME
parameters should be set to at least 3 seconds longer than
the desired interval of silence. This interval allows for
the 3 seconds of silence that are stripped by the T/R
silence detection algorithm.
IRP_RECORD_INTERTIME int 4 NO
Valid Values
030000 milliseconds
Default Value
5000
Description
This parameter determines the amount of time a
record request waits before timing out due to
interword word silence detection. Units are in
milliseconds.
When recording more than 5 seconds of silence using the T/R
driver, the IRP_RECORD_PRETIME and IRP_RECORD_INTERTIME
parameters should be set to at least 3 seconds longer than
the desired interval of silence. This interval allows for
the 3 seconds of silence that are stripped by the T/R
silence detection algorithm.
IRP_RECORD_INIT_EFLOOR int 4 NO
Valid Values
any integer
Default Value
-40
Description
This parameter is the initial speech energy floor
in decibels indicating silence for speech record-
ing. This value should typically range from -40
to -45 depending on the telephony network and
background noise. This parameter is available
only for LSPS recognition.
IRP_RECORD_END_EFLOOR int 4 NO
Valid Values
any integer
Default Value
-40
Description
This parameter is the ending speech energy floor
in decibels indicating silence for speech record-
ing. This value should typically range from -40
to -45 depending on the telephony network and
background noise. This parameter is available
only for LSPS recognition.
IRP_CREATE_MODE int 4 NO
Valid Values
Any integer is accepted.
Default Value
0644
Description
This parameter determines the file creation mode
for the irFRecord(3IRAPI)function.
IRP_CREATE_FLAG int 4 NO
Valid Values
Any integer is accepted.
Default Value
O_WRONLY|O_CREAT|O_TRUNC
Description
This parameter determines the action of
irFRecord(3IRAPI) when opening a file to which to
code.
TELEPHONY PARAMETERS
IRP_ANI char 16 YES
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter has the Automatic Number Identifi-
cation (ANI) string representing the Calling Party
Number. This parameter is only available with
certain telephony types and the value depends on
what the switch is configured to provide.
Currently this parameter is only available for SS7
calls, ISDN PRI calls, when the ASAI feature is
used, or the Definity switch integration package
is in use. The value provided may be the billing
number or the station id depending on which the
switch has been configured to provide.
IRP_APP_CTRLS_PRI int 4 YES
Valid Values
IRD_TRUE, IRD_FALSE
Default Value
IRD_FALSE
Description
When this parameter has the default value of
IRD_FALSE, the IRAPI library will handle most of
the PRI call control messages on behalf of the
IRAPI application (as would be the case for other
telephony types). When this parameter has the
value of IRD_TRUE, the IRAPI library will avoid
trying to do call control, and will let a separate
PRI application process (PRI DIP) control the
calls over the PRI interface.
When a PRI application process (PRI DIP) wants to
handle call control, the pri_appl(3PRI) function
takes care of setting this parameter for all B-
channels in the D-Channel group, so few if any
IRAPI applications will need to explicitly set
this parameter value.
IRAPI applications should avoid changing this
parameter value since changes in this parameter
could cause the IRAPI application and/or the PRI
application to get out of sync with the true state
of the channel.
IRP_DISCONNECT_CAUSE int 4 YES
IRP_OUT_DISCONNECT_CAUSE
Valid Values
ISDN PRI or SS7 Cause Values as defined in
/att/include/q931_defs.h
Default Value
CV_NCC (normal call clearing)
Description
IRP_DISCONNECT_CAUSE can be used to provide an
alternative to the default value of CV_NCC (normal
call clearing) when terminating an ISDN PRI or SS7
call with the irDisconnect(3IRAPI) or
irDeinit(3IRAPI) functions.
This parameter will be reset to its default value
upon use of irDeinit(3IRAPI), so applications must
explicitly set this parameter whenever they wish
to initiate a disconnect with a non-default cause
value.
IRP_OUT_DISCONNECT_CAUSE provides the cause value
received by a far end disconnect.
IRP_DNIS char 16 YES
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter has the Dialed Number Identifica-
tion Service (DNIS) string or equivalent value
representing the Called Party Number. This param-
eter is only available with certain telephony
types and the value depends on what the switch is
configured to provide. Currently this parameter
is only available for T1(E&M), E1(CAS), ISDN PRI,
SS7, when the ASAI feature is used, or the when
certain switch integration packages are in use.
IRP_DTMF_MUTING int 4 YES
Valid Values
IRD_ON, IRD_OFF
Default Value
As indicated by the DIGITAL INTERFACES screen for
digital interfaces (see the Intuity CONVERSANT VIS
V5.0 Operations, 585-310-550). Always IRD_ON for
Analog Interfaces (T/R).
Description
This parameter determines whether DTMF muting is
active.
With DTMF muting on, the outgoing speech is sub-
ject to occasional short muting. This prevents
false touch tone detections that might otherwise
result from speech played by the VIS being echoed
back by the network and triggering the VIS touch
tone detectors.
With DTMF muting off, the outgoing speech is not
subject to occasional muting, but speech played by
the VIS might be echoed back by the network and
result in false reports of touch tones. When try-
ing to pass DTMF tones through a bridged connec-
tion, it is generally desirable to turn off DTMF
muting.
Setting IRP_DTMF_MUTING via the function irSet-
Param is unsupported on T/R channels the
IRP_DTMF_MUTING parameter is always IRD_ON for T/R
channels.
IRP_INBOUND_SERVICE int 4 YES
Valid Values
Any non-negative value or IRD_INVALID
Default Value
IRD_INVALID
Description
This parameter has the service type for an incom-
ing ISDN PRI call. Possible service types types
are defined as SVC_* in tas_defs.h. The default
value of IRD_INVALID will be seen if the incoming
call did not have an explicit service type. This
parameter currently only applies to ISDN PRI.
IRP_OUTBOUND_ANI char 16 YES
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter has the Automatic Number Identifi-
cation (ANI) string that should be used for out-
bound ISDN PRI and SS7 calls. This parameter
currently only applies to ISDN PRI and SS7.
IRP_OUTCALL_ANSDET int 4 YES
Valid Values
IRD_DEFAULT, IRD_OFF, IRD_ON
Default Value
IRD_DEFAULT
Description
This parameter determines the type of answer
detection to be used for irCall(3IRAPI) and
irCCA(3IRAPI) when Full CCA is being used. IRD_ON
implies that answer detection is performed by hav-
ing the SP card attempt to detect speech energy.
IRD_OFF implies that answer detection through energy
detection is turned off (generally used on telephony
interfaces when the more reliable answer supervision
is available). IRD_DEFAULT implies that answer
supervision is used when available (T1, PRI, and
SS7 interfaces) and answer detection is used in
the remaining cases (T/R and Line Side T1 inter-
faces).
IRP_OUTCALL_DIALTYPE int 4 YES
Valid Values
IRD_DIALTYPE_TT, IRD_DIALTYPE_MF (in future
release), IRD_DIALTYPE_DP
Default Value
IRD_DIALTYPE_TT for T1 and other Digital Inter-
faces. For TR and other Analog Interfaces, the
Type of Signaling from the Analog Interfaces
screen is used as the default (see Chapter 6,
"Switch Interfaces Administration," of Intuity
CONVERSANT VIS V5.0 Operation, 585-310-550).
Description
This parameter determines the type of dial to be
used for irCall(3IRAPI) and irDial(3IRAPI).
IRP_OUTCALL_CCALEVEL int 4 YES
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, only IRD_BLIND_CCA, IRD_SIMPLE_CCA or
IRD_FULL_CCA are currently supported. If
IRP_OUTCALL_CCALEVEL is not set to one of these
values, attempts to use CCA operations generate
the IRER_SUPPORTED error code.
Default Value
IRD_BLIND_CCA
Description
This parameter determines the level of CCA to be
used with the irCall(3IRAPI) or irCCA(3IRAPI)
functions.
IRP_OUTCALL_MAXRINGS int 4 YES
Valid Values
Any non-negative integer
Default Value
5
Description
This parameter determines how many rings
irCall(3IRAPI) is to wait before reporting
IRE_CALL_DONE with the IREM_NOANSWER modifier (or
IREM_RINGBACK as described below).
Since many digital interfaces (LST1 on AYC11, T1,
SS7 and PRI) do not currently have ring detection
capability, a timer is used for those digital
interfaces rather than counting rings heard on the
channel.
On analog T/R lines, LSE1, or LST1 (on AYC21)
ringback can be detected, but the audible ring
heard by the called party may occur at a different
time than the ringback returned via the network.
Therefore, this parameter value is just an approx-
imation to the number of rings that the called
party hears.
If this parameter is set to 0 on a T/R, LSE1, or
LST1 (on AYC21) channel, the IRE_CALL_DONE has an
IREM_RINGBACK modifier when audible ringing is
detected (rather than the IREM_NOANSWER modifier).
Speech Energy detection will not be enabled when
this parameter is set to 0. WARNING: There is a
possibility that no call classification could
occur if the called party answers before the
network provides ringback. The option of setting
this parameter to 0 is not recommended, but is
provided for backwards compatibility with the TSM
tic('O') instruction.
The IREM_RINGBACK modifier is not expected to
occur on LST1 on the AYC11, T1 E&M, SS7, PRI, or
E1 CAS digital interfaces.
IRP_REDIRECTING char 16 YES
IRP_OUT_REDIRECTING
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter has the Redirecting Number string
representing the number that the caller originally
dialed before the call was intercepted and routed
with a possibly different DNIS, for incoming and
outgoing calls, respectively. This parameter is
currently only available with ISDN PRI and SS7.
IRP_SERVICE_TYPE int 4 YES
Valid Values
Any non-negative value or IRD_INVALID
Default Value
IRD_INVALID
Description
This parameter has the service type that should be
used for outbound ISDN PRI calls. The available
service types are defined as SVC_* in tas_defs.h.
The default value of IRD_INVALID may be used if
there is no need to select a specific service
type. This parameter currently only applies to
ISDN PRI.
IRP_HBRIDGE_CHAN int 4 YES
Valid Values
Any valid channel number
Default Value
IRD_INVALID
Description
This parameter is the value of a channel associ-
ated with the current channel through a half-
bridge. This parameter is set by
irHBridge(3IRAPI). This parameter may be set
explicitly by application software.
IRP_UCID char 20 YES
Valid Values
Any ASCII string of exactly 20 digits, 0 through
9.
Default Value
IRD_INVALID_UCID
Description
This parameter is the Universal Call Identifica-
tion (UCID) number for a telephone call. A value
of IRD_INVALID_UCID indicates an invalid UCID.
This parameter is included in the UCID UUI IE
field of the outbound PRI setup message for PRI
telephone calls. See the Advanced PRI Developers
Guide for further information.
IRP_UUI char 131 YES
Valid Values
Any 131 bytes
Default Value
Null string
Description
This parameter is the value of the User-to-User
Informational Element associated with an ISDN-PRI
call. This parameter is set by IRAPI when an
IRDN-PRI call is answered. This parameter may be
sent out with the PRI setup message as the UUI
Informational Element field when an ISDN-PRI call
is made. If the parameter IRP_UUI_LEN is 0 then
the IRP_UUI will not be sent out with the PRI
setup message when an ISDN-PRI call is made. If
the parameter IRP_UUI_LEN is greater than 0 then
the first IRP_UUI_LEN bytes of the IRP_UUI parame-
ter will be sent out with the PRI setup message
when an ISDN-PRI call is made. If the parameter
IRP_UUI_LEN is greater than 131 then only 131
bytes are used.
IRP_UUI_LEN int 4 YES
Valid Values
Any integer
Default Value
0
Description
This parameter is the length of the User-to-User
Informational Element associated with an ISDN-PRI
call. This parameter is set by IRAPI when an
IRDN-PRI call is answered. If the parameter
IRP_UUI_LEN is 0 then the IRP_UUI will not be sent
out with the PRI setup message when an ISDN-PRI
call is made. If the parameter IRP_UUI_LEN is
greater than 0 then the first IRP_UUI_LEN bytes of
the IRP_UUI parameter will be sent out with the
PRI setup message when an ISDN-PRI call is made.
If IRP_UUI_LEN is greater than 131 then only 131
bytes are used.
IRP_NEWCALL_LBOLT int 4 YES
Valid Values
Any integer
Default Value
0
Description
Conceptually, this parameter gives the time when
the system was first aware of a new inbound new
call, and actual implementations aspire to be
"close" to this goal. An example of its use might
be an application that optionaly delayed playing a
greeting if the call was quite recently answered,
because the network might not have had a chance
yet to set up the voice paths. Note that lbolt
does go negative after a few months and then wrap
around. See irLBolt(3IRAPI).
ADVANCED SPEECH SERVICES PARAMETERS
IRP_RECOG_TYPE int 4 NO
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, only IRD_WHOLE_WORD, IRD_FLEX_WORD and
IRD_DIALPULSE are supported. If a recognition
function is called with some other value set, the
IRER_UNSUPPORTED error is generated.
Default Value
IRD_UNDEFINED
Description
This parameter indicates the type of recognition
to use with irStartRecog(3IRAPI) and
irStopRecog(IRAPI).
IRP_RECOG_GRAMMAR int 4 NO
Valid Values
Any valid integer. The values that actually work
depend on the recognition type in use. See the
recognition header files provided with your recog-
nition package for the accepted values.
Default Value
IRD_UNDEFINED
Description
This parameter determines the grammar used for a
particular recognition type. Grammars are pack-
file dependent. Applications must specify gram-
mars based on the installed packfiles.
IRP_RECOG_GRAMNAME char 30 YES
Valid Values
Any string of up to 30 ascii characters. The
strings that actually work depend on the recogni-
tion type and grammars in use. See the recogni-
tion header files provided with your recognition
package for the accepted values.
Default Value
IRD_INVALID_GRAMNAME
Description
This parameter determines the grammar name used
for a particular recognition type. Applications
must specify grammar names based on the installed
recognition applications. This parameter is
available only for LSPS speech recognition.
IRP_RECOG_PROMPT int 4 NO
Valid Values
Any valid integer
Default Value
IRD_INVALID
Description
This parameter no longer has any effect on IRAPI
or recognizers. It exists only for backwards com-
patibility with IRAPI programs that may reference
this parameter.
IRP_TTS_TYPE int 4 YES
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, only IRD_SPTTS, IRD_LSPSTTS and IRD_SWTTS
are supported. If irEnd is called with queued TTS
requests and some other value set, the
IRER_UNSUPPORTED error is generated.
Default Value
IRP_DSP_TTS
Description
This value indicates the TTS type to be used by
the application. Currently only IRD_SPTTS,
IRD_LSPSTTS and IRD_SWTTS are supported.
IRP_TTS_GAIN int 4 YES
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, the true gain range is determined by the TTS
implementation. Currently only the IRD_SWTTS
implementation supports gain control.
Default Value
0
Description
This parameter is specified in decibels (dB).
Modification of this parameter increases or
decreases the volume at which text is played. A
value of 0 represents normal volume. The true
gain range is determined by the network interface
or speech processing hardware. The gain is
adjusted as needed to meet the limitations of the
hardware.
IRP_TTS_SPEED int 4 YES
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, the true speed range is determined by the
TTS implementation. Currently only the IRD_SWTTS
implementation supports speed control.
Default Value
100
Description
This parameter is specified as a percentage.
Modification of this parameter increases or
decreases the speed at which text is played. A
value of 100 represents normal speed. The true
speed range is determined by the network interface
or speech processing hardware. The speed is
adjusted as needed to meet the limitations of the
hardware.
IRP_TTS_GENDER int 4 YES
Valid Values
IRD_MALE_TTS and IRD_FEMALE_TTS
Default Value
IRD_MALE_TTS
Description
This parameter indicates the gender to be used by
the text to speech algorithm. This parameter is
available only for LSPS text to speech.
IRP_ECHOCAN_TYPE int 4 YES
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, only IRD_SP_ECHO and IRD_LSPS_ECHO is sup-
ported. If an echo cancellation function is
called with some other value set, the
IRER_UNSUPPORTED error will be generated.
Default Value
IRP_DSP_ECHO
Description
This value indicate the echo cancellation type to
be used by the application. Currently only
IRD_SP_ECHO and IRD_LSPS_ECHO is supported.
IRP_LANGUAGE int 4 YES
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, only Microsoft Speech API 4.0 language iden-
tifiers are supported. Note, the IRE_LANGID_DONE
event returns a value in event_mod2 appropriate
for IRP_LANGUAGE.
Default Value
IRD_SAPI_ENGLISH_US
Description
This parameter indicates the language of text to
speak with irSay(3IRAPI)
FAX PARAMETERS
IRP_FAX_TYPE int 4 NO
Valid Values
irSetParam(3IRAPI) accepts any valid integer; how-
ever, only IRD_TRFAX, IRD_SPFAX and IRD_T1FAX are
supported. If a FAX function is called with some
other value set, the IRER_UNSUPPORTED error is
generated.
Default Value
IRD_TRFAX for FAX-capable Tip Ring channels,
IRD_T1FAX for FAX-capable Quad channels,
IRP_DSP_FAX otherwise.
Description
This parameter indicates the type of FAX to use
with irFAXPrint(3IRAPI) and irFAXRecord(IRAPI).
IRP_FAX_GROUP int 4 NO
Valid Values
irSetParam(3IRAPI) accepts any valid integer.
Default Value
IRD_FAX_CHANS
Description
This parameter indicates the group on which
irFAXOutOfCall(3IRAPI) will use to make an
outgoing call. Channels which cannot support FAX
are automatically eliminated before placing the
phone call. The default value is the system-
defined group that includes the group of all chan-
nels capable of supporting FAX. Therefore, this
parameter can be used to prevent FAXes from occu-
pying all channels and thereby preventing incoming
calls from being answered. Another possible use
for this parameter is to provide control in sys-
tems where different cards are connected to dif-
ferent phone networks.
IRP_FAX_TONEDETECT int 4 YES
Valid Values
irSetParam(3IRAPI) accepts 0 or IRF_CNG.
Default Value
0
Description
This value indicates the status of the FAX Tone
detector. If set to 0 then FAX Tone detection is
off. If set to IRF_CNG then FAX Tone detection is
enabled for FAX CNG Tone (incoming FAX Tone).
CALL INFORMATION PARAMETERS
The following parameters are only valid if a switch integra-
tion package is installed and administered on the system.
IRP_CALLINFO_TIME int 4 YES
Valid Values
Any valid integer
Default Value
0
Description
This parameter indicates the time when the call
information was received. This parameter is set
by the switch integration software, if it is
installed.
IRP_CALLINFO_ID int 4 YES
Valid Values
Any valid integer
Default Value
IRD_INVALID_CALLID
Description
This value indicates the call information id
assigned to this call. Each call that has valid
call information is assigned a call information id
to uniquely identify the call. This parameter is
set by the switch integration software, if it is
installed.
IRP_DISPATCH_ID int 4 YES
Valid Values
Any valid integer
Default Value
IRD_INVALID_CALLID
Description
This value indicates the call information id that
was assigned when this call was dispatched by the
system. When a call is dispatched by the Applica-
tion Dispatcher the IRP_DISPATCH_ID parameter is
set to the value of the IRP_CALLINFO_ID. The
IRP_DISPATCH_ID parameter can be compared with the
IRP_CALLINFO_ID parameter to ensure that the call
information hasn't changed (ie. a new call has
arrived) since the call was dispatched.
IRP_COVERAGE_REASON int 4 YES
IRP_OUT_COVERAGE_REASON
Valid Values
Any valid integer, but currently only IRD_COVERAGE
and IRD_DIRECT are defined.
Default Value
IRD_COVERAGE
Description
This value indicates whether the current call is a
direct call or is being routed by a coverage path
for incoming and outgoing calls, respectively.
This parameter is set by the switch integration
software, if it is installed.
IRP_COVERAGE_TYPE int 4 YES
IRP_OUT_COVERAGE_TYPE
Valid Values
Any valid integer, but only IRD_COVERAGE_BUSY,
IRD_COVERAGE_NOANS, and IRD_COVERAGE_FWD are
defined.
Default Value
IRD_COVERAGE_NOANS
Description
This value is only meaningful when the value of
the IRP_COVERAGE_REASON is set to IRD_COVERAGE and
indicates why the call went to the coverage path
for incoming and outgoing calls, respectively.
This parameter is set by the switch integration
software, if it is installed.
IRP_CALLED_EXTENSION char 16 YES
Valid Values
Any character string
Default Value
None
Description
This value indicates the called extension of
incoming call. In other words, this is the exten-
sion number dialed by the originator of the
current call. This parameter is set by the switch
integration software, if it is installed.
IRP_CALLING_EXTENSION char 16 YES
Valid Values
Any character string
Default Value
None
Description
This value indicates the calling extension of
incoming call. In other words, this is the exten-
sion number of the originator of the current call.
This parameter is set by the switch integration
software, if it is installed.
IRP_CHANNEL_EXTENSION char 16 YES
Valid Values
Any character string
Default Value
None
Description
This value indicates the extension that is
assigned to the current channel. The extension
can be set using the assign number command.
IRP_TRANSLATE int 4 YES
Valid Values
IRD_TRUE, IRD_FALSE
Default Value
IRD_TRUE
Description
This value indicates whether number translation is
requested for outgoing calls. When this parameter
is set to IRD_TRUE, the passed number is
translated and used to place the requested outgo-
ing call. When this parameter is set to
IRD_FALSE, the passed number is treated as a
dialable number and is used without any transla-
tion.
IRP_CALLED char 16 YES
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter is a synonym for
IRP_CALLED_EXTENSION.
IRP_CALLED_RAW char 16 YES
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter is a synonym for IRP_DNIS.
IRP_CALLING char 16 YES
IRP_OUT_CALLING
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the translated calling party
number for incoming and outgoing calls, respec-
tively. IRP_CALLING is a synonym for
IRP_CALLING_EXTENSION.
IRP_CALLING_RAW char 16 YES
IRP_OUT_CALLING_RAW
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the untranslated calling
party number for incoming and outgoing calls,
respectively. IRP_CALLING_RAW is a synonym for
IRP_ANI. IRP_OUT_CALLING_RAW is a synonym for
IRP_OUTBOUND_ANI.
IRP_CHARGING char 16 YES
IRP_OUT_CHARGING
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the translated charging
number for incoming and outgoing calls, respec-
tively.
IRP_CHARGING_RAW char 16 YES
IRP_OUT_CHARGING_RAW
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the untranslated charging
number for incoming and outgoing calls, respec-
tively.
IRP_REDIRECTING_RAW char 16 YES
IRP_OUT_REDIRECTING_RAW
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the untranslated redirecting
number for incoming and outgoing calls, respec-
tively.
IRP_CONNECTED char 16 YES
IRP_OUT_CONNECTED
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the translated connected
number for incoming and outgoing calls, respec-
tively.
IRP_CONNECTED_RAW char 16 YES
IRP_OUT_CONNECTED_RAW
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the untranslated connected
number for incoming and outgoing calls, respec-
tively.
IRP_CALLED_NATADDR int 4 YES
IRP_OUT_CALLED_NATADDR
Valid Values
IRD_NATADDR_NONE, IRD_NATADDR_SUB,
IRD_NATADDR_NAT, IRD_NATADDR_INTERNAT
Default Value
IRD_NATADDR_NONE
Description
These parameters store the called party number
nature of address (subscriber, national, interna-
tional) for incoming and outgoing calls, respec-
tively.
IRP_CALLING_RESTRICT int 4 YES
IRP_OUT_CALLING_RESTRICT
Valid Values
IRD_NUMBER_RESTRICTED, IRD_NUMBER_UNRESTRICTED
Default Value
IRD_NUMBER_UNRESTRICTED
Description
These parameters store the calling party number
restriction setting for incoming and outgoing
calls, respectively.
IRP_REDIRECTING_RESTRICT int 4 YES
IRP_OUT_REDIRECTING_RESTRICT
Valid Values
IRD_NUMBER_RESTRICTED, IRD_NUMBER_UNRESTRICTED
Default Value
IRD_NUMBER_UNRESTRICTED
Description
These parameters store the redirecting number res-
triction setting for incoming and outgoing calls,
respectively.
IRP_CARRIER char 4 YES
IRP_OUT_CARRIER
Valid Values
Any character string
Default Value
Null string
Description
These parameters store the carrier code digits for
incoming and outgoing calls, respectively.
IRP_CALL_PROG int 4 YES
IRP_OUT_CALL_PROG
Valid Values
Any valid integer
Default Value
0
Description
These parameters store the call progress event
information for incoming and outgoing calls,
respectively.
IRP_ORIG char 16 YES
IRP_OUT_ORIG
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the translated originally
called number for incoming and outgoing calls,
respectively.
IRP_ORIG_RAW char 16 YES
IRP_OUT_ORIG_RAW
Valid Values
Any string of digits
Default Value
Null string
Description
This parameter stores the untranslated originally
called number for incoming and outgoing calls,
respectively.
IRP_ORIG_RESTRICT int 4 YES
IRP_OUT_ORIG_RESTRICT
Valid Values
IRD_NUMBER_RESTRICTED, IRD_NUMBER_UNRESTRICTED
Default Value
IRD_NUMBER_UNRESTRICTED
Description
These parameters store the originally called
number restriction setting for incoming and outgo-
ing calls, respectively.
SEE ALSO
irParam(3IRAPI), irGlobalParam(3IRAPI), irAPI.rc(4IRAPI).
VERSION
This is version 2/6/01 of this man page.