NAME
irStartRecogTimer, irStartRecogTimer2 - start the recogni-
tion input string timer
SYNOPSIS
#include <irapi.h>
int irStartRecogTimer (channel_id cid);
int irStartRecogTimer2 (channel_id cid, int recog_type);
DESCRIPTION
The irStartRecogTimer function starts the timer used for a
recognition input string collection based on timer expira-
tion.
IRE_INPUT_DONE event [see IrEVENTS(4IRAPI)] occurs when cer-
tain conditions are satisfied. For instance, this event may
be generated if the recognition input timer expires. The
time interval starts when irStartRecogTimer is called. The
IRAPI library parameter IRP_RECOG_PRETIME [see
IrPARAMETERS(4IRAPI)] specifies the time period to wait
before the initial digit is spoken.
irStartRecogTimer starts a timer for IRP_RECOG_PRETIME mil-
liseconds. If an utterance is detected before the timeout
occurs, the recognition timer is canceled. The IRAPI
automatically manages clock timeouts from the point when
irStartRecogTimer is called until IRE_INPUT_DONE is gen-
erated. Note: IRP_RECOG_PRETIME must be set to the desired
value when irStartRecog(3IRAPI) is executed.
irStartRecogTimer simply informs the recognizer to start
timing with the value previously supplied when the recog-
nizer was started via irStartRecog(3IRAPI).
If a recognition timeout occurs before an utterance is
recognized, an IRE_INPUT_DONE event is generated with the
IREM_RECOG_PRE modifier.
The existing value of the IRP_RECOG_PRETIME parameter can be
retrieved using irGetParam(3IRAPI) while a new value can be
assigned to a parameter using irSetParam(3IRAPI). Defaults
for each are 5000 milliseconds.
These parameters must be set to the desired value before
invoking irStartRecogTimer.
irStartRecogTimer may only be called after the recognizer
has been turned on via irStartRecog(3IRAPI).
Other conditions under which IRE_INPUT_DONE event is gen-
erated are explained in irGetInput(3IRAPI).
Calling irStartRecogTimer with an outstanding recognition
active cancels the outstanding timer for that recognizer and
starts a new timer as defined above.
The irStartRecogTimer applies to only a single recognizer as
specified by the IRP_RECOG_TYPE [see IrPARAMETERS(4IRAPI)]
parameter. A separate timer must be started for each
started recognizer.
The irStartRecogTimer2 function is identical to the irStar-
tRecogTimer function except the recog_type argument deter-
mines the recognizer to start a timer for instead of the
parameter IRP_RECOG_TYPE.
EVENTS
An IRE_INPUT_DONE event is generated after irStartRecogTimer
is called if the conditions explained above are satisfied.
RETURN VALUE
IRR_OK is returned if the request is successful, or if the
request to start a timer has been queued for later execu-
tion.
IRR_FAIL is returned if an error occurs.
ERROR
irError is set as follows if an error occurs:
IRER_INVALID if the cid, IRP_RECOG_TYPE or recog_type is
invalid
IRER_BADSTATE if recognition has not been started
IRER_SYSERROR if a system or driver call failure occurs
(check irSysError for additional information).
SEE ALSO
IrPARAMETERS(4IRAPI), IrEVENTS(4IRAPI), irSetParam(3IRAPI),
irGetParam(3IRAPI), irGetInput(3IRAPI), irStartRecog(3IRAPI)
VERSION
This is version 8/31/00 of this man page.