NAME
IrRESOURCES - system capabilities
SYNOPSIS
#include <irapi.h>
DESCRIPTION
The reserve structure is used by various IRAPI resource con-
trol routines, it is defined as:
typedef struct ir_reserve {
int capability; /* Resource capability type */
int implementation; /* Implementation specific function */
} ir_reserve_t;
capability is a high level classification of resources.
implementation is the implementation specific type which
provides the resource. The following tables lists each
capability and the currently supported implementations.
Also included is the switch which irReserveResource or
implicit allocation functions use to allocate resources of
the appropriate type. The switch is a channel specific
parameter.
IRC_BRIDGE Channel bridging and conferencing. This
capability is used only for error reporting
when a bridging operation fails.
IRC_CCA Call progress detection. This capability is
required by the irStartCCA(3IRAPI) and
irCall(3IRAPI) functions. This capability
switches on the IRP_OUTCALL_CCA parameter
whose value/resource pairs are defined as
follows:
IRD_FULL_CCA Intuity CONVERSANT SP resident
call classification analysis
IRC_ECHOCAN Echo cancellation. This capability is
required by the irStartEcho(3IRAPI). This
capability switches on the IRP_ECHOCAN_TYPE
parameter whose value/resource pairs are
defined as follows:
IRD_SP_ECHO Intuity CONVERSANT SP resident
echo cancellation
IRD_LSPS_ECHO Intuity CONVERSANT LSPS
resident echo cancellation
IRC_RECOG Speech recognition. This capability is
required by irStartRecog(3IRAPI). This capa-
bility switches on the IRP_RECOG_TYPE parame-
ter whose value/resource pairs are defined as
follows:
IRD_WHOLE_WORD Intuity CONVERSANT SP resident
WholeWord speech recognition
IRD_FLEX_WORD Intuity CONVERSANT SP resident
FlexWord or sub-word speech
recognition
IRD_DIALPULSE Intuity CONVERSANT SP resident
DialPulse recognition
IRC_PLAY Voice play. This capability is required for
any channel doing voice play on a channel
with no bound play resources. It is also
required by any channel doing voice play with
echo cancellation on. See irPlay(3IRAPI) and
irEnd(3IRAPI). This capability switches on
the IRP_VOICE_TYPE parameter whose
value/resource pairs are defined as follows:
IRD_SP_VOICE Intuity CONVERSANT SP resident
voice processing
IRD_LSPS_VOICE Intuity CONVERSANT LSPS
resident voice processing
IRC_RECORD Voice record. This capability is required
for any channel doing voice record on a chan-
nel with no bound record resources. See
irRecord(3IRAPI). This capability switches
on the IRP_VOICE_TYPE parameter whose
value/resource pairs are defined as follows:
IRD_SP_VOICE Intuity CONVERSANT SP resident
voice processing
IRD_LSPS_VOICE Intuity CONVERSANT LSPS
resident voice processing
IRC_TTS Text-to-Speech (TTS). This capability is
required by irEnd(3IRAPI) when TTS requests
have been queued via irSay(3IRAPI). This
capability switches on the IRP_TTS_TYPE
parameter whose value/resource pairs are
defined as follows:
IRD_SPTTS Intuity CONVERSANT SP resident
TTS
IRD_SWTTS Intuity AUDIX Software (CPU
resident) TTS
IRD_LSPSTTS Intuity CONVERSANT LSPS
resident TTS
The parameters listed above that are used as resource allo-
cation types may take on values that are not listed here
[see IrPARAMETERS(4IRAPI)]. When the parameters are set to
the values that are not listed here, resource allocation is
not required to support the capability of that type. This
may mean that the resources to support the capability are
bound to the channel. As an example, when IRP_VOICE_TYPE is
set to IRD_TALK, voice play and record resources are
resident on the T/R circuit card and are bound to the chan-
nel.
Results from resource queries are returned in the arrays of
the following structures:
typedef struct ir_resource_list {
int capability; /* Resource capability type */
int implementation; /* Implementation specific function */
int ids[IRD_MAX_RESOURCES]; /* Resource element ids */
} ir_resource_t;
The capability and implementation fields are the same as
those for the ir_reserve_t structure.
ids is an array of hardware element identifiers which sup-
port the capability. For the case of Intuity CONVERSANT SP
or LSPS resources, the array elements are set to the card
numbers assigned the indicated capability. The array is
terminated with a value of IRD_INVALID.
VERSION
This is version 8/31/00 of this man page.