Intel 05-1832-002 IP Phone User Manual


 
320 Voice API for Windows Operating Systems Library Reference — November 2003
dx_playtoneEx( ) — play the cadenced tone defined by TN_GENCAD
To run this function asynchronously, set the mode parameter to EV_ASYNC. When running
asynchronously, this function will return 0 to indicate that it has initiated successfully, and will
generate a TDX_PLAYTONE termination event to indicate successful termination.
By default, this function will run synchronously, and will return a 0 to indicate successful
termination of synchronous play.
!
!!
! Cautions
The channel must be idle when calling this function.
Parameter Description
chdev specifies the valid channel device handle obtained when the channel was
opened using dx_open( )
tngencadp On DM3 boards, points to a TN_GENCAD structure (which defines a signal
by specifying a cycle and its number of repetitions).
On Springware boards, points to a TN_GENCAD structure (which defines a
signal by specifying a cycle and its number of repetitions), or specifies one of
the following predefined, standard, PBX call progress signals:
CP_DIAL – dial tone
CP_REORDER – reorder tone (paths-busy, all-trunks-busy, fast busy)
CP_BUSY – busy tone (slow busy)
CP_RINGBACK1 – audible ring tone 1 (ringback tone)
CP_RINGBACK2 – audible ring tone 2 (slow ringback tone)
CP_RINGBACK1_CALLWAIT – special audible ring tone 1
CP_RINGBACK2_CALLWAIT – special audible ring tone 2
CP_RECALL_DIAL – recall dial tone
CP_INTERCEPT – intercept tone
CP_CALLWAIT1 – call waiting tone 1
CP_CALLWAIT2 – call waiting tone 2
CP_BUSY_VERIFY_A – busy verification tone (Part A)
CP_BUSY_VERIFY_B – busy verification tone (Part B)
CP_EXEC_OVERRIDE – executive override tone
CP_FEATURE_CONFIRM – confirmation tone
CP_STUTTER_DIAL – Stutter dial tone (same as message waiting dial
tone)
CP_MSG_WAIT_DIAL – message waiting dial tone (same as stutter dial
tone)
tptp points to the DV_TPT data structure, which specifies one or more terminating
conditions for this function. For more information on this structure, see
DV_TPT, on page 485.
mode specifies whether to run this function asynchronously or synchronously. Set to
one of the following:
EV_ASYNC – run the function asynchronously
EV_SYNC – run the function synchronously (default)