Intel 05-1832-002 IP Phone User Manual


 
466 Voice API for Windows Operating Systems Library Reference — November 2003
r2_playbsig( ) — play R2/MF backward signal tone
r2_playbsig( )
play R2/MF backward signal tone
!
!!
! Description
The r2_playbsig( ) function is a convenience function that plays a tone and controls the timing
sequence required by the R2/MF compelled signaling procedure.
Note: R2/MF signaling is typically accomplished through the Global Call API. For more information, see
the Global Call documentation set. The R2/MF function described here is provided for backward
compatibility only and should not be used for R2/MF signaling.
This function plays a specified backward R2/MF signal on the specified channel until a tone-off
event is detected for the specified forward signal.
Compelled signaling sends each signal until it is responded to by a return signal, which in turn is
sent until responded to by the other party. See the Voice API Programming Guide for more
information about R2/MF compelled signaling.
This function calls the dx_playtone( ) function to play the tone.
Name: int r2_playbsig(chdev, backwardsig, forwardsig, mode)
Inputs: int chdev
channel device handle
int backwardsig
group A/B backward signal
int forwardsig
group I/II forward signal
int mode
asynchronous/synchronous
Returns: 0 if success
error return code
Includes: srllib.h
dxxxlib.h
Category: R2/MF Convenience
Mode: asynchronous or synchronous
Platform: Springware
Parameter Description
chdev specifies the valid channel device handle obtained when the channel was
opened using dx_open( )
backwardsig specifies the name of a Group A or Group B backward signal to play
Specify one of the defines in Group A or one of the defines in Group B:
Group A Defines Group B Defines Associated Tone ID
SIGA_1 SIGB_1 101
SIGA_2 SIGB_2 102