NAME
irPlayKill - stops playing immediately
SYNOPSIS
#include <irapi.h>
int irPlayKill (channel_id cid);
DESCRIPTION
The irPlayKill function immediately stops a play activity on
the channel and forces the channel into the IRS_IDLE state.
irGetVCount(3IRAPI) does not contain valid results after a
play is terminated with irPlayKill.
EVENT
No event results from a call to this function.
RETURN VALUE
IRR_OK is returned if the request is successful. IRR_FAIL
is returned if an error occurs.
ERROR
irError is set as follows if an error occurs:
IRER_INVALID if the cid is invalid
IRER_BADSTATE if the channel is not in the IRS_PLAYING state
IRER_SYSERROR if a driver call or system call failure occurs
(check errno for additional information)
SEE ALSO
irPlay(3IRAPI), IrSTATES(4IRAPI).
CAVEAT
This function is provided to support old voice system
behavior and is not intended for use by well designed IRAPI
applications. Since this function immediately forces the
library into the idle state, despite the fact that voice
output may still be active for a short period of time,
undesirable side effects may be produced on the channel such
as mixing of voice and touch-tone output. Multitasking on
some telephony cards may produce unrecoverable errors.
VERSION
This is version 8/31/00 of this man page.