NAME
irMonitor - start/stop monitoring another channel
SYNOPSIS
#include <irapi.h>
int irMonitor (channel_id cid1, int chan2, int flag);
DESCRIPTION
The irMonitor function allows cid1 to start/stop monitoring
another channel (chan2). Monitoring means that all audio
input and output on chan2 is heard by cid1 but chan2 does
not hear any audio input or output from cid1.
The value of flag determines if monitoring should be started
or stopped. Use IRD_ADD [see IrDEFINES(4IRAPI)] as flag to
start monitoring and IRD_DROP to stop monitoring.
Each channel can have at most 7 output timeslots, of which
one is pre-assigned. Therefore, the channel can only add
another 6 output timeslots.
There is currently a restriction that one quad channel can-
not monitor another quad channel on the same quad card. It
is allowable however to monitor a channel on a different
quad card. This restriction may be removed in some future
release but that effort has not yet been scheduled.
EVENT
No event results from the call to irMonitor.
RETURN VALUE
IRR_OK is returned if irMonitor is successful.
IRR_FAIL is returned if an error occurs.
ERROR
irError is set as follows if an error occurs:
IRER_INVALID if the cid1, chan2 or flag are not valid.
IRER_UNSUPPORTED for an attempt to monitor another channel
on the same quad card.
IRER_MAXCHAN_TIMESLOTS if the channel has reached the limit
for output timeslots (7 maximum per channel)
IRER_DRIVER_ERROR if a driver call failure occurs (see
irSysError for additional information)
IRER_SYSERROR if a system or driver call failure occurs (see
irSysError for additional information)
IRER_OVERFLOW if one channel attempts to monitor more than
one other channel
IRER_REDUNDANT if the requested monitor is a duplicate
request in the case where flag is IRD_ADD, or the requested
monitor does not exist in the case where flag is IRD_DROP
SEE ALSO
irHBridge(3IRAPI)
VERSION
This is version 8/31/00 of this man page.