Intel 05-1832-002 IP Phone User Manual


 
Voice API for Windows Operating Systems Library Reference — November 2003 473
Events
TDX_RECORD
Termination event. Returned by record functions such as dx_rec( ) to indicate completion of
record.
TDX_RXDATA
Termination event. Returned by dx_RxIottData( ) and dx_TxRxIottData( ) to indicate
completion of ADSI two-way FSK data reception.
TDX_SETHOOK
Termination event. Returned by dx_sethook( ) to indicate completion of this function in
asynchronous mode. The cst_event field in the DX_CST data structure or the ev_event field in
the DX_EBLK data structure indicates whether the hook switch state has been set to on or off.
TDX_TXDATA
Termination event. Returned by dx_TxIottData( ) and dx_TxRxIottData( ) to indicate
completion of ADSI two-way FSK data transmission.
TDX_WINK
Termination event. Returned by dx_wink( ) to indicate completion of this function in
asynchronous mode.
3.3 Unsolicited Events
Unsolicited events are produced in response to a condition of a given function or as a result of a call
status transition (CST) condition that has been met. They are not generated in response to the
completion of a function. For more information on CST events, see Section 3.4, “Call Status
Transition (CST) Events”, on page 473.
The following non-CST unsolicited events may be returned by the voice library:
TDX_UNDERRUN
Unsolicited event. Generated when an underrun condition occurs during a streaming to board
operation. This event is generated when the firmware (not the stream buffer) runs out of data.
This event will only be generated when dx_setevtmsk( ) is set to DM_UNDERRUN. This
works like a toggle key. If set once, the next call to the function will unset this mask.
TDX_LOWWATER
Unsolicited event. Generated when a low water mark is reached during a streaming to board
operation.
TDX_HIGHWATER
Unsolicited event. Generated when a high water mark is reached during a streaming to board
operation.
3.4 Call Status Transition (CST) Events
Call status transition (CST) events indicate changes in the status of a call, such as rings or a tone
detected, or the line going on-hook or off-hook. A CST event is an unsolicited event that is
produced as a consequence of setting a CST mask.