NAME
irGetGlobalParam, irGetGlobalParamStr - get the value of an
IRAPI library global parameter
SYNOPSIS
#include <irapi.h>
int irGetGlobalParam ( int identifier, int *value);
int irGetGlobalParamStr ( int identifier, char *value, int
count);
DESCRIPTION
The irGetGlobalParam and irGetGlobalParamStr functions get
the current value of an IRAPI global parameter. Global
parameters are either set automatically and cannot be set by
the customer, or they may be set via the irAPI.rc(4IRAPI)
file. See irAPI.rc(4IRAPI) for a list of valid parameters
and their default and legal values.
irGetGlobalParamStr copies, at most, count bytes into value.
The application developer must verify that value is large
enough; the number of bytes required can be found by calling
irGetGlobalParamStr with count set to 0.
Global parameters are system-wide and are the same for every
application. With few exceptions, they are set at voice
system start up and cannot change until the next voice sys-
tem startup.
Parameter type size
Valid Values
Describes values to which this parameter may be
set
Default Value
Describes the default value to which this parame-
ter will be set
Description
Describes how and where the parameter is used
IRP_DNISWAIT int 4
Valid Values
Any integer between 0 and 60
Default Value
2
Description
This value is the maximum number of seconds the
IRAPI library waits for the DNIS to arrive from
the switch.
IRP_ANALOG_LOSS_COMP int 4
Valid Values
Integers between -18 and +3 in 3 dB increments
Default Value
0
Description
This value is the amount of gain (in dB) to be
added to standard gain adjustment for a bridge
that includes an analog (T/R) channel.
IRP_MAX_EVENT_MONITORS int 4
Valid Values
Any integer between 0 and 1000
Default Value
5
Description
This value is the maximum number of event monitor
processes.
IRP_DIGITAL_LOSS_COMP int 4
Valid Values
Integers between -15 and +6 in 3 dB increments
Default Value
0
Description
This value is the amount of gain (in dB) to be
added to standard gain adjustment for a bridge
that includes only digital channels.
IRP_BACKGROUND_OVOL int 4
Valid Values
Any integer between 0 and 100
Default Value
33
Description
This value is the adjustment to OVOL (output
volume level) in percent for speech being played
in background.
IRP_VCHANS int 4
Valid Values
Any integer between 1 and 96
Default Value
1
Description
This value is the the number of virtual channels
to be allocated on the system.
IRP_IDLE_HUNT int 4
Valid Values
0, 1, 2.
Default Value
0
Description
This value controls the order of hunting for idle
channels. 0 = ascending hunt. 1 = descending
hunt. 2 = random hunt.
IRP_AD_READ_ONLY int 4
Valid Values
Any integer
Default Value
0
Description
A value of zero indicates that processes are
allowed to use the IRAPI Application Dispatch (AD)
library routines to change the AD Tables. The
value of non-zero indicates that processes NOT are
allowed to use the IRAPI-AD library routines to
change the AD Tables.
IRP_TRACE_BUFFER_SIZE int 4
Valid Values
Any integer between 128 and 40000
Default Value
4000
Description
This value is the number of trace messages in the
trace buffer. If trace messages are being lost,
this value can be increased at the expense of sys-
tem memory.
IRP_NON_AD_CHAN_LIST char 256
Valid Values
Comma or colon separated list of channel numbers
or channel ranges
Default Value
null string
Description
This value is a list of channels for which the AD
process should not be the default channel owner.
IRP_AD_CHANNEL_TABLE char 128
Valid Values
Any valid pathname
Default Value
/vs/data/ad_channel_table
Description
This value is the full path file name for the
channel table used by the AD library.
IRP_AD_DNISANI_TABLE char 128
Valid Values
Any valid pathname
Default Value
/vs/data/ad_dnisani_table
Description
This value is the full path file name for the
DNIS/ANI table used by the AD library.
IRP_SPEECHDIR char 128
Valid Values
Any valid pathname
Default Value
/home2/vfs/talkfiles
Description
This value is the full path directory name for the
speech filesystem used by IRAPI library.
IRP_MSGMAX int 4
Valid Values
As specified in the mtune(4) file.
Default Value
As specified in the mtune(4) file.
Description
The value of IRP_MSGMAX is the current setting of
the UNIX MSGMAX tunable. This value may not be
set through the irAPI.rc(4IRAPI) file but rather
must be set via the UNIX idtune(1M) command. The
purpose of this parameter is to allow applications
to send the largest possible messages not knowing
the value of system tunable at compile time.
IRP_PROFILE_SIZE int 4
Valid Values
As specified in the mtune(4) file.
Default Value
As specified in the mtune(4) file.
Description
The value of IRP_PROFILE_SIZE is the current set-
ting of the UNIX PROFILE_SIZE tunable. This value
may not be set through the irAPI.rc(4IRAPI) file
but rather must be set via the UNIX idtune(1M)
command. This parameter must be larger than the
space used by all save_on_exec parameters. If
this check fails then no process may register with
IRAPI.
IRP_RELEASE_TALK_SLOT int 4
Valid Values
IRD_TRUE
Description
Reserved for future use.
IRP_STATIC_TIMESLOTS int 4
Valid Values
IRD_TRUE
Description
Reserved for future use.
IRP_DSP_VOICE int 4
Valid Values
IRD_SP_VOICE, IRD_LSPS_VOICE or IRD_INVALID.
Default Value
IRD_SP_VOICE if SSP cards are used for speech
playback and coding. IRD_LSPS_VOICE if LSPS cards
are used for speech playback and coding.
IRD_INVALID otherwise.
Description
Indicates the default value of the IRAPI channel
parameter IRP_VOICE_TYPE. The value of this glo-
bal parameter can change while the voice system is
running if the type of card speech playback and
coding are assigned to changes.
IRP_DSP_ECHO int 4
Valid Values
IRD_SP_ECHO, IRD_LSPS_ECHO or IRD_INVALID.
Default Value
IRD_SP_ECHO if SSP cards are used for echo cancel-
lation. IRD_LSPS_ECHO if LSPS cards are used for
echo cancellation. IRD_INVALID otherwise.
Description
Indicates the default value of the IRAPI channel
parameter IRP_ECHOCAN_TYPE. The value of this
global parameter can change while the voice system
is running if the type of card echo cancellation
is assigned to changes.
IRP_DSP_TTS int 4
Valid Values
IRD_SPTTS, IRD_LSPSTTS or IRD_INVALID
Default Value
IRD_SPTTS if SSP cards are used for text to
speech. IRD_LSPSTTS if LSPS cards are used for
text to speech. IRD_INVALID otherwise.
Description
Indicates the default value of the IRAPI channel
parameter IRP_TTS_TYPE. The value of this global
parameter can change while the voice system is
running if the type of card text to speech is
assigned to changes.
IRP_DSP_WHOLEWORD int 4
Valid Values
IRD_SSP_WHOLE_WORD, IRD_LSPS_WHOLE_WORD or
IRD_INVALID
Default Value
IRD_SSP_WHOLE_WORD if SSP cards are used for
wholeword recognition. IRD_LSPS_WHOLE_WORD if
LSPS cards are used for wholeword recognition.
IRD_INVALID otherwise.
Description
Used internally by IRAPI to know what type of
speech processing card wholeword recognition is
assigned to. The value of this global parameter
can change while the voice system is running if
the type of card wholeword recognition is assigned
to changes.
IRP_DSP_FLEXWORD int 4
Valid Values
IRD_SSP_FLEX_WORD, IRD_LSPS_FLEX_WORD or
IRD_INVALID
Default Value
IRD_SSP_FLEX_WORD if SSP cards are used for flex-
word recognition. IRD_LSPS_FLEX_WORD if LSPS
cards are used for flexword recognition.
IRD_INVALID otherwise.
Description
Used internally by IRAPI to know what type of
speech processing card flexword recognition is
assigned to. The value of this global parameter
can change while the voice system is running if
the type of card flexword recognition is assigned
to changes.
IRP_DSP_CCA int 4
Valid Values
Any integer
Description
Reserved for future use.
IRP_DSP_FAX int 4
Valid Values
Any integer
Description
Reserved for future use.
IRP_SPEECH_ALGO int 4
Valid Values
Any speech algorithm appropriate for the speech
processing card that has play and code assigned to
it.
Default Value
IRA_A_CS32 if SSP cards are used for speech play-
back and coding. IRA_OKICS32 if LSPS cards are
used for speech playback and coding.
Description
Indicates the default value of the IRAPI channel
parameter IRP_PLAY_ALGO. The value of this global
parameter can change while the voice system is
running if the type of card speech playback and
coding is assigned to changes.
IRP_USE_NTS int 4
Valid Values
IRD_TRUE or IRD_FALSE
Default Value
IRD_TRUE
Description
IRD_FALSE indicates that IRAPI should NOT use the
number translation services (NTS) to translate
incoming/outgoing numbers to/from E.164 format.
IRD_TRUE indicates that IRAPI should use the
number translation services.
IRP_USE_XFER_RETRICT int 4
Valid Values
IRD_TRUE or IRD_FALSE
Default Value
IRD_TRUE
Description
IRD_FALSE indicates that IRAPI should NOT consult
the transfer restriction tables when performing a
transfer operation. IRD_TRUE indicates that IRAPI
should check the transfer restriction tables to
determine whether a requested transfer operation
is allowed.
IRP_IN_RESTRICT int 4
Valid Values
0, 1, 2
Default Value
1
Description
This value controls how IRAPI provides calling
party numbers and redirecting party numbers to
applications for incoming calls only. A value of
0 causes calling and redirecting numbers to be
hidden from applications. A value of 1 causes
calling and redirecting numbers to be hidden from
applications whenever such numbers are marked res-
tricted. A value of 2 causes calling and
redirecting numbers to be disclosed to application
along with indications of which numbers are res-
ticted.
IRP_OUT_RESTRICT int 4
Valid Values
0, 1
Default Value
1
Description
This value controls how IRAPI processes calling
party numbers and redirecting party numbers for
outgoing calls only. A value of 0 marks all cal-
ling and redirecting numbers restricted. A value
of 1 indicates calling and redirecting number res-
triction is set on a call by call basis by the
application
RETURN VALUE
irGetGlobalParamStr returns the number of bytes copied to
value if count is positive. If count is 0, the number of
bytes that would have been copied to value is returned.
irGetGlobalParam returns IRR_OK if successful.
All functions return IRR_FAIL if an error occurs.
ERROR
irError is set as follows if an error occurs:
IRER_INVALID if the identifier is not valid, if the count is
negative, or if the value is not valid for identifier
IRER_SYSERROR if a system or driver call failure occurs (see
irSysError for additional information)
SEE ALSO
irAPI.rc(4IRAPI)
VERSION
This is version 11/11/02 of this man page.