NAME
IrDEFINES - IRAPI library defines
SYNOPSIS
#include <irapi.h>
DESCRIPTION
Following is the list of supported defines that can be used
in different IRAPI functions:
- IRD_ACTIVE
- Indicates an active channel service state
- IRD_ADD
- Signifies a flag values to start/add
- IRD_ALLOW
- Indicates that when a channel is requested
from this application, the channel should be
granted if the service state of the channel
is IRD_INACTIVE
- IRD_ANALOG
- Specifies the telephony class that includes
all analog telephony types (for example,
IRD_TR, IRD_ASAI)
- IRD_ANI
- Specifies the information element ANI
(calling number for inbound call)
- IRD_ASAI
- Specifies the telephony type for Tip/Ring
(T/R) lines used with ASAI
- IRD_BEARER_CAP
- Specifies the information element BEARER_CAP
(bearer capability for outbound call)
- IRD_BLIND_CCA
- Indicates outbound calls are to be made
without call classification analysis (CCA)
- IRD_BLOCKFOREVER
-
Indicates that when resources are requested,
the channel blocks indefinitely for resource
availability, if needed
- IRD_CHAN_OOS
- Indicates a service state of channel out-of-
service
- IRD_CONDITIONAL
-
Indicates that when a channel is requested
from this application, the ownership of the
channel is passed to the requester when the
current application irDeinit(3IRAPI)'s the
channel
- IRD_DEFAULT
- Assumes different default values for selected
parameters based on the context. For
example, IRP_OUTCALL_ANSDET can be set to
IRD_DEFAULT to indicate that the most
appropriate form of answer detection should
be used based on the telephony type.
- IRD_DENY
- Indicates that when a channel is requested
from this application, the request is denied
- IRD_DIALPULSE
- Indicates Dial Pulse recognition
- IRD_DIALTYPE_DP
-
Specifies dial pulse dialing
- IRD_DIALTYPE_MF
-
Specifies multi-frequency dialing (not yet
supported)
- IRD_DIALTYPE_TT
-
Specifies touch-tone dialing
- IRD_DIGITAL
- Specifies the telephony class that includes
all digital telephony types (for example,
IRD_T1, IRD_PRI, IRD_LST1*)
- IRD_DISCONNECT_ALWAYS
-
Indicates a specified call progress tone is
always considered a disconnect tone.
- IRD_DISCONNECT_DURING_RECORD
-
Indicates a specified call progress tone is
considered a disconnect tone only during
recording.
- IRD_DISCONNECT_NEVER
-
Indicates a specified call progress tone is
never considered a disconnect tone.
- IRD_DNIS
- Specifies the information element DNIS
(dialed number identification service)
- IRD_DROP
- Specifies a flag value to stop/drop
- IRD_FALSE
- Specifies logical false
- IRD_FLEX_WORD
- Indicates FlexWord recognition
- IRD_FULL_CCA
- Indicates that CCA is to be done using the
CCA facilities of a dedicated SSP circuit
card
- IRD_IMMEDIATE
- Indicates that when resources are requested,
unavailability should be indicated immediately
- IRD_INACTIVE
- Indicates an inactive channel service state
- IRD_INBOUND_SERVICE
-
Specifies the information element
INBOUND_SERVICE (for service type on an
inbound call)
- IRD_INFLECTION_FALLING
-
Indicates falling inflection
- IRD_INFLECTION_NONE
-
Indicates no inflection
- IRD_INFLECTION_RISING
-
Indicates rising inflection
- IRD_INFLECTION_TOTAL
-
Indicates total inflection
- IRD_INVALID
- Indicates an invalid channel number
- IRD_INVALID_UCID
-
Indicates an invalid Universal Call Identifier.
- IRD_IRAPI
- Indicates a message is to be routed by a
channel
- IRD_MAXCHAN
- Indicates the upper limit on the number of
real channels; use irNumChans(IRD_REAL) to
determine the actual number of channels
- IRD_MAXVCHAN
- Indicates the upper limit on the number of
virtual channels; use irNumChans(IRD_VIRTUAL)
to determine the actual number of channels
- IRD_MAXDATABUFFER
-
Indicates the maximum data buffer which may
be passed on irExec(3IRAPI)
- IRD_MAX_ANI_DIGITS
-
Indicates the maximum length of an IRD_ANI
digit string
- IRD_MAX_APP_NAME
-
Indicates the maximum length of an IRAPI
application name
- IRD_MAX_DNIS_DIGITS
-
Indicates the maximum length of an IRD_DNIS
digit string
- IRD_MAX_FILE_LEN
-
Indicates the maximum voice file length
allowed by the irFPlay(3IRAPI),
irFRecord(3IRAPI),
irTF2File(3IRAPI),
irOpen(3IRAPI) and other functions.
- IRD_MAX_REDIRECT_DIGITS
-
Indicates the maximum length of an
IRD_REDIRECTING digit string.
- IRD_MAX_RESERVE_RES
-
Indicates the maximum number of preallocated
resources per cid.
- IRD_NMS
- Telephony type for channels associated with communication channels
carried via Natural Microsystems telephony boards (all protocols
except PRI)
- IRD_NMSPRI
- Telephony type for channels associated with communication channels
carried via Natural Microsystems telelphony boards (PRI protocol only)
- IRD_NULL
- Used as a general purpose null pointer
- IRD_OFF
- Specifies a logical "off"
- IRD_ON
- Specifies a logical "on"
- IRD_OUTBOUND_ANI
-
Specifies the Information element
OUTBOUND_ANI (calling number of an outbound
call)
- IRD_PERMANENT
- Specifies an IRAPI process type which typically
supports multiple channels and continues
running after calling irDeinit(3IRAPI)
- IRD_PRI
- Specifies the ISDN Primary Rate Interface
(PRI) telephony type (all types) (Add-on
packages may change the behavior of this
telephony type)
- IRD_READONLY
- Indicates a read only status of some object
- IRD_READWRITE
- Indicates a read/write status of some object
- IRD_REAL_CHANS
- Specifies an abstract channel equipment
group; typically used as first argument to
irInitGroup(3IRAPI) when requesting any real
channel
- IRD_REAL
- Indicates an abstract channel type that
includes all channels with network interfaces
- IRD_REDIRECTING
-
Indicates an Information element for
redirecting digits
- IRD_REMOTE_CLEAR
-
Indicates a service state where the network
has completely cleared a call, but the application has
not yet disconnected (specific to PRI)
- IRD_REMOTE_DISCON
-
Indicates a service state where remote switch
has disconnected from an active call
(specific to PRI)
- IRD_RINGING
- Indicates a service state of ringing
- IRD_SERVICE_TYPE
-
Specifies the information element
SERVICE_TYPE (for an outbound call)
- IRD_SIMPLE_CCA
- Indicates that CCA for outbound calls is to
be done by the channel telephony hardware
- IRD_SPEECH_BUF_SIZE
-
Indicates the size of a speech buffer used
for buffer recording
- IRD_TALK_VOICE
- The only voice type supported; voice operations no longer need
separate resources.
The notion of voice type will probably be phased out.
- IRD_TRACE_AREA_1
- through IRD_TRACE_AREA_16
Indicates user defined trace areas used with
irTrace(3IRAPI)
- IRD_TRACE_AREA_AS
-
Indicates advanced service operations such as
the TTS and ASR area
- IRD_TRACE_AREA_EM
-
Indicates event management operations area
- IRD_TRACE_AREA_IN
-
Indicates caller input operations area
including touch-tone and speech recognition
input
- IRD_TRACE_AREA_PM
-
Indicates parameter management operations
area
- IRD_TRACE_AREA_RM
-
Indicates resource management operations area
- IRD_TRACE_AREA_SE
-
Indicates script execution area. This
includes trace entries made implicitly by
Script Builder applications and through
tas(1VIS) scripts via the trace(3TSM) command.
- IRD_TRACE_AREA_ST
-
Indicates the call and application initiali-
zation and completion operations area
- IRD_TRACE_AREA_TS
-
Indicates the telephony service operations
area
- IRD_TRACE_AREA_VS
-
Indicates the voice code and play operations
area
- IRD_TRACE_LEVEL_1
-
through IRD_TRACE_LEVEL_8 Indicate tracing
level with irTrace(3IRAPI)
- IRD_TRANSIENT
- Indicates an IRAPI process type which typically supports a single channel and exit's
soon after calling irDeinit(3IRAPI)
- IRD_TRUE
- Indicates a logical true
- IRD_VIRTUAL_CLASS
-
Indicates the telephony class including all
virtual telephony types (for example,
IRD_VIRT_CHAN)
- IRD_VIRTUAL_CHANS
-
Indicates an abstract channel equipment
group. Typically used as first argument to
irInitGroup(3IRAPI) when requesting a virtual
channel.
- IRD_VIRTUAL
- Indicates an abstract channel type that
includes virtual as opposed to real
(IRD_REAL) channels
- IRD_VIRT_CHAN
- Indicates the telephony type for virtual
channels
- IRD_VOIP
- Telephony type for channels associated with communication channels
carried via voice-over-ip
- IRD_UNDEFINED
- Indicates an integer constant denoting some
value as undefined
- IRD_UNKNOWN_CLASS
-
Indicates a telephony class representing an
invalid telephony type
- IRD_WAIT_ALERT
- Indicates a channel service state where the
library is waiting for additional exchange of
information with the switch before entering
the IRD_RINGING state (specific to PRI)
- IRD_WAIT_CLEAR
- Indicates a channel service state where the
library is waiting for the network to clear
the prior call (specific to PRI)
- IRD_WAIT_DNIS
- Indicates a channel service state where the
library is waiting for DNIS and ANI before
going into the IRD_RINGING state (specific to
ASAI)
SEE ALSO
irGetIE(3IRAPI),
irExec(3IRAPI),
IrVARPARAM(3IRAPI)
OBSOLETE
The following definitions are no longer supported, although the actual preprocessor
macros remain defined to limit impact on IRAPI application compilation.
These definitions will be removed in a future release, so eliminate them
from your code whenever it becomes feasible.
- IRD_FLASH_AND_WAIT
-
Indicates irFlash should wait briefly after
generating a flash to allow the switch to get
ready for dialing of digits (currently
applies only to Line Side T1)
- IRD_FLASH_NO_WAIT
-
Indicates irFlash should generate a flash and
immediately generate IRE_FLASH_DONE event
- IRD_LST1_ASAI
- Indicates the telephony type for Line Side T1
(LST1) used with ASAI for DEFINITY switch
- IRD_LST1_DEF
- Indicates the telephony type for LST1 for
DEFINITY switch (without ASAI)
- IRD_LST1_GAL
- Indicates the telephony type for LST1 for
Galaxy ACD
- IRD_SP_ECHO
- Indicates an echo cancellation type where SSP
circuit card provides echo cancellation.
- IRD_LSPS_ECHO
- Indicates an echo cancellation type where
LSPS circuit card provides echo cancellation.
- IRD_SP_VOICE
- Indicates a voice type where SSP circuit card
provides voice operations
- IRD_LSPS_VOICE
- Indicates a voice type where LSPS circuit
card provides voice operations
- IRD_T1_VOICE
- Indicates a voice type where the Quad T1 cir-
cuit card provides voice operations
- IRD_T1_ECHO
- Indicates an echo cancellation type where the
Quad T1 circuit card provides echo cancella-
tion.
- IRD_TDM_TS
- Indicates a voice type where voice operations
are performed on a TDM bus timeslot.
- IRD_TR
- Indicates the T/R telephony type
- IRD_T1
- Indicates the T1 (E&M) telephony type
- IRD_SSP_WHOLE_WORD
-
Indicates WholeWord recognition type provided
by the SSP circuit card.
- IRD_SSP_FLEX_WORD
-
Indicates FlexWord recognition type provided
by the SSP circuit card.
- IRD_SSP_DISPULSE
-
Indicates DialPulse recognition type pro-
voided by the SSP circuit card.
VERSION
This is version 12/12/02 of this man page.