NAME
IrSTATES - IRAPI channel library states
SYNOPSIS
#include <irapi.h>
DESCRIPTION
Following is the list of possible library states in which a
channel may be. Note that library states are independent of
the channel service state, which may be IRD_ACTIVE,
IRD_INACTIVE, IRD_RINGING, etc. By properly responding to
events as they occur, an application rarely needs to check
the value of the library state. Note that some of the fol-
lowing pending states can be represented as the oring of the
IRS_PENDING bit with another bit which may not represent a
legitimate state. For example, the IRS_CCA_PENDING state
can occur, but the IRS_CCA pseudo-state is never really
used.
IRS_ANSWERING The channel is in the process of answering a
call. (For Tip/Ring, this means taking the
channel off-hook.)
IRS_CALLING The channel is in the process of making an
outbound call.
IRS_CALL_PENDING
The channel has made a request to make an
outbound call but the outbound calling
resources are not available. For
irCall(3IRAPI), this state is possible only
if Full Call Classification Analysis (CCA) is
being used and Full CCA resources are not yet
available. This state may also be expressed
as (IRS_CALLING|IRS_PENDING).
IRS_CCA_PENDING
The channel has requested CCA resources but
CCA resources are not yet available. This
state may also be expressed as
(IRS_CCA|IRS_PENDING).
IRS_DEINITING The channel is being deinitialized and the
channel identifier must no longer be used.
IRS_DIALING The channel is dialing one or more digits.
IRS_DISCONNECTING
The channel is disconnecting a call. (This
means placing the channel on-hook for T/R
type channels.)
IRS_ECHO_PENDING
The channel has requested echo cancellation
resources but echo cancellation resources are
not yet available. This state may also be
expressed as (IRS_ECHO_STARTING|IRS_PENDING).
IRS_ECHO_STARTING
The channel is starting echo cancellation.
IRS_ECHO_STOPPING
The channel is stopping echo cancellation.
IRS_FAXPRINTING
The channel is attempting to send a fax.
IRS_FAXPRINT_PENDING
The channel is waiting for fax provider
resources so that a fax can be sent. This
state may also be expressed as
(IRS_FAXPRINTING|IRS_PENDING).
IRS_FAXPRINT_PENDING|IRS_QUEUED
The channel is waiting for fax RTU or SSP
resources so that the queued image can be
delivered. This state may also be expressed
as (IRS_FAXPRINTING|IRS_QUEUED|IRS_PENDING).
Someday this state might also be expressed as
IRS_FAXPRINT_PENDING_QUEUED.
IRS_FAXPRINT_QUEUED
A fax image has been queued to go out on the
channel but has not yet been directed to be
sent.
IRS_FAXRECORDING
The channel is attempting to receive a fax.
IRS_FAXRECORD_PENDING
The channel is waiting for fax RTU or SSP
resources so that a fax can be received.
This state may also be expressed as
(IRS_FAXRECORDING|IRS_PENDING).
IRS_FLASHING The channel is performing a flash.
IRS_GOING_IS The channel is in the process of going in-
service.
IRS_GOING_OOS The channel is in the process of going out-
of-service.
IRS_IDLE The channel is idle. In this state the
channel may be waiting for input from
telephony hardware or other processes.
IRS_INIT_PENDING
The channel ownership is pending from another
process. This state may also be expressed as
(IRS_INIT|IRS_PENDING).
IRS_PLAYING The channel currently is playing speech.
IRS_PLAY_PENDING
A play request has been initiated via irEnd
for the channel but has not yet been started
due to insufficient play resources. This
state may also be expressed as
(IRS_PLAYING|IRS_PENDING).
IRS_PLAY_QUEUED
The channel has queued up play requests but
the play requests have not yet been ini-
tiated. This state may also be expressed as
(IRS_PLAYING|IRS_QUEUED).
IRS_RECOG_PENDING
The channel has requested speech recognition
resources but speech recognition resources
are not yet available. This state may also
be expressed as (IRS_RECOG|IRS_PENDING).
IRS_RECORDING The channel currently is recording voice.
IRS_RECORD_PENDING
The channel is waiting for resources to do
voice recording. This state may also be
expressed as (IRS_RECORDING|IRS_PENDING).
IRS_RESERVING The channel currently is reserving space for
voice code activities.
IRS_RESOURCE_PENDING
The channel has requested resources that are
not yet available. This state may also be
expressed as (IRS_RESOURCE|IRS_PENDING).
IRS_SAYING The channel currently is saying text via
Text-to-Speech (TTS).
IRS_SAY_PENDING
The channel has executed irEnd after queuing
text and is waiting to do TTS. This state
may also be expressed as
(IRS_SAYING|IRS_PENDING).
IRS_SAY_QUEUED The channel has queued one or more requests
to say text via TTS. This state may also be
expressed as (IRS_SAYING|IRS_QUEUED).
SEE ALSO
IrPARAMETERS(4IRAPI)
VERSION
This is version 8/31/00 of this man page.