Manuals
/
Brands
/
Communications
/
IP Phone
/
Intel
/
Communications
/
IP Phone
Intel
05-1832-002
- page 484
1
484
564
564
Download
564 pages, 3.79 Mb
484
Voice API for Wind
ows Opera
ting Systems Libr
ary Refer
ence — Novem
ber 2003
D
V_DIGIT — user digit
buffer
!
!
!
!
Example
For an e
xample of ho
w to use this data s
tructure, see the Examp
le section for
d
x_getdig( )
.
Contents
Main
Voice API for Windows Operating Systems Library Reference November 2003
Contents
Page
Page
Page
Page
Page
Tables
Revision History
This revision history summarizes the changes made in each published version of this document.
Revision History
Page
About This Publication
Purpose
Intended Audience
How to Use This Publication
Related Information
1.1 Device Management Functions
1.2 Configuration Functions
1.3 I/O Functions
Page
1.4 I/O Convenience Functions
1.5 Streaming to Board Functions
1.6 Analog Display Services Interface (ADSI) Functions
1.7 Audio Input Functions
1.8 Transaction Record Functions
1.9 Cached Prompt Management Functions
1.10 Call Status Transition (CST) Event Functions
1.11 TDM Routing Functions
Page
1.12 Global Tone Detection (GTD) Functions
1.13 Global Tone Generation (GTG) Functions
1.14 R2/MF Convenience Functions
1.15 Speed and Volume Functions
1.16 Call Progress Analysis Functions
1.17 Caller ID Functions
1.18 File Manipulation Functions
1.19 Echo Cancellation Resource Functions
1.20 Structure Clearance Functions
1.21 Syntellect License Automated Attendant Functions
1.22 Extended Attribute Functions
Page
1.23 Voice Function Support by Platform
Page
Page
Page
Page
Page
2.1 Function Syntax Conventions
ag_getctinfo( )
Page
ag_getxmitslot( )
Page
Page
ag_listen( )
Page
Page
ag_unlisten( )
Page
ai_close( )
Page
ai_getxmitslot( )
Page
ai_open( )
Page
ATDX_ANSRSIZ( )
return the duration of the answer ATDX_ANSRSIZ( )
ATDX_BDNAMEP( )
Page
ATDX_BDTYPE( )
Page
ATDX_BUFDIGS( )
return the number of uncollected digits ATDX_BUFDIGS( )
dx_getdig( ) dx_clrdigbuf( )
ATDX_CHNAMES( )
Page
ATDX_CHNUM( )
Page
ATDX_CONNTYPE( )
Page
ATDX_CONNTYPE( ) return the connection type for a completed call
dx_dial( ) ATDX_CPTERM ( ) DX_CAP data structure
ATDX_CPERROR( )
Page
Page
ATDX_CPTERM( )
Page
Page
ATDX_CRTNID( )
Page
return the last call progress analysis termination ATDX_CRTNID( )
None.
ATDX_DEVTYPE( )
Page
ATDX_DTNFAIL( )
return character for dial tone ATDX_DTNFAIL( )
Page
ATDX_FRQDUR( )
Page
ATDX_FRQDUR2( )
Page
ATDX_FRQDUR3( )
Page
ATDX_FRQHZ( )
Page
ATDX_FRQHZ2( )
Page
ATDX_FRQHZ3( )
Page
ATDX_FRQOUT( )
ATDX_FRQOUT( ) return percentage of time SIT tone was out of bounds
ATDX_FWVER( )
Page
ATDX_HOOKST( )
Page
ATDX_LINEST( )
Page
ATDX_LONGLOW( )
Page
ATDX_PHYADDR( )
Page
ATDX_SHORTLOW( )
Page
ATDX_SIZEHI( )
Page
ATDX_STATE( )
Page
ATDX_TERMMSK( )
Page
Page
Page
ATDX_TONEID( )
ATDX_TONEID( ) return user-defined tone ID that terminated I/O function
Page
ATDX_TRCOUNT( )
return the byte count for the last I/O transfer ATDX_TRCOUNT( )
None.
dx_addspddig( )
Page
Page
Page
dx_addtone( )
Page
Page
add a user-defined tone dx_addtone( )
Page
dx_addvoldig( )
Page
Page
Page
dx_adjsv( )
Page
Page
dx_blddt( )
Page
Page
dx_blddtcad( )
Page
Page
dx_bldst( )
Page
Page
dx_bldstcad( )
Page
Page
dx_bldtngen( )
Page
Page
dx_cacheprompt( )
Page
Page
dx_chgdur( )
Page
dx_chgdur( ) change the duration definition for a tone
Page
dx_chgfreq( )
Page
dx_chgfreq( ) change the frequency definition for a tone
Page
dx_chgrepcnt( )
Page
dx_chgrepcnt( ) change the repetition definition for a tone
dx_chgdur( )
Page
dx_close( )
Page
Page
dx_CloseStreamBuffer( )
dx_CloseStreamBuffer( ) delete a circular stream buffer
dx_OpenStreamBuffer( ) dx_GetStreamInfo( )
dx_clrcap( )
Page
dx_clrdigbuf( )
Page
dx_clrsvcond( )
Page
dx_clrtpt( )
Page
dx_createtone( )
Page
Page
Page
dx_deletetone( )
Page
Page
dx_deltones( )
Page
dx_dial( )
Valid Dial String Characters
Page
Asynchronous Operation
Synchronous Operation
Call Progress Analysis
Page
Page
Page
dial an ASCIIZ string dx_dial( )
analysis)
progress analysis)
ATDX_TERMMSK( ) (to retrieve termination reason for dx_dial( ) without call progress
Page
dx_distone( )
Page
Page
dx_enbtone( )
Page
Page
dx_fileclose( )
dx_fileclose( ) close a file
dx_fileopen( ) dx_fileseek( ) dx_fileread( ) dx_filewrite( )
dx_fileerrno( )
Page
Page
dx_fileopen( )
open a file dx_fileopen( )
dx_fileclose( ) dx_fileseek( ) dx_fileread( ) dx_filewrite( )
dx_fileread( )
read data from a file dx_fileread( )
Page
dx_fileseek( )
dx_fileseek( ) move a file pointer
move a file pointer dx_fileseek( )
dx_fileopen( ) dx_fileclose( ) dx_fileread( ) dx_filewrite( )
dx_filewrite( )
write data from a buffer into a file dx_filewrite( )
Page
dx_getcachesize( )
Page
dx_getctinfo( )
Page
dx_getcursv( )
Page
Page
dx_getdig( )
Page
Page
collect digits from a channel digit buffer dx_getdig( )
This example illustrates how to use dx_getdig( ) in asynchronous mode.
dx_getdig( ) collect digits from a channel digit buffer
dx_addtone( ) dx_setdigtyp( ) DV_DIGIT data structure
Page
dx_GetDllVersion( )
Page
dx_getevt( )
Page
Page
dx_getfeaturelist( )
Page
retrieve feature support information for the device dx_getfeaturelist( )
dx_getfeaturelist( ) retrieve feature support information for the device
Page
dx_getparm( )
Page
Page
dx_GetRscStatus( )
Page
dx_GetStreamInfo( )
dx_GetStreamInfo( ) retrieve information about the circular stream buffer
dx_OpenStreamBuffer( )
dx_getsvmt( )
Page
Page
dx_getxmitslot( )
Page
Page
dx_getxmitslotecr( )
Page
Page
dx_gtcallid( )
Page
dx_gtcallid( ) return the calling line Directory Number
Page
dx_gtextcallid( )
Page
dx_gtextcallid( ) retrieve a caller ID message
ACLIP (Single Data Message) ACLIP (Multiple Data Message) CLIP JCLIP
b
All returns are NULL terminated.
Figure 1. Format of General Caller ID Information
Page
Page
Page
dx_gtextcallid( ) retrieve a caller ID message
Page
dx_gtsernum( )
Page
dx_initcallp( )
Page
Page
dx_libinit( )
dx_libinit( ) initialize the voice library DLL
dx_listen( )
Page
Page
dx_listenecr( )
Page
Page
dx_listenecrex( )
Page
modify characteristics of the echo canceller dx_listenecrex( )
dx_listenecr( )
dx_mreciottdata( )
Page
Page
Error from operating system; use dx_fileerrno( ) to obtain error value
dx_mreciottdata( ) record voice data from two TDM bus time slots
dx_rec( )
Page
dx_open( )
Page
Page
dx_OpenStreamBuffer( )
dx_OpenStreamBuffer( ) create and initialize a circular stream buffer
dx_CloseStreamBuffer( ) dx_SetWaterMark( )
dx_pause( )
Page
dx_play( )
Page
Page
Page
play recorded voice data dx_play( )
This example illustrates how to use dx_play( ) in asynchronous mode.
dx_play( ) play recorded voice data
play recorded voice data dx_play( )
Page
dx_playf( )
Page
Page
dx_playiottdata( )
Page
Page
play back recorded voice data from multiple sources dx_playiottdata( )
dx_playiottdata( ) play back recorded voice data from multiple sources
dx_playf( ) dx_playwav( ) dx_playvox( ) dx_setuio( )
dx_playtone( )
Page
play tone defined by TN_GEN structure dx_playtone( )
Page
dx_playtoneEx( )
Page
Page
dx_playtoneEx( ) play the cadenced tone defined by TN_GENCAD
Page
dx_playvox( )
Page
Page
dx_playwav( )
Page
Page
dx_PutStreamData( )
Page
Page
dx_querytone( )
Page
Page
dx_rec( )
Page
Page
Page
dx_rec( ) record voice data from a single channel
This example illustrates how to use dx_rec( ) in asynchronous mode.
record voice data from a single channel dx_rec( )
Page
dx_recf( )
Page
record voice data to a single file dx_recf( )
Page
dx_reciottdata( )
Page
Page
Page
dx_recvox( )
Page
Page
dx_recwav( )
Page
Page
dx_ResetStreamBuffer( )
Page
dx_resume( )
Page
dx_RxIottData( )
Page
This example illustrates how to use dx_RxIottData( ) in synchronous mode.
Page
dx_sendevt( )
Page
dx_setchxfercnt( )
Page
dx_setdevuio( )
Page
install and retrieve user-defined I/O functions dx_setdevuio( )
dx_setuio( )
dx_setdigbuf( )
Page
dx_setdigtyp( )
Page
dx_setdigtyp( ) control the types of digits detected by the voice channel
dx_setevtmsk( )
Page
Page
dx_setevtmsk( ) enable detection of call status transition (CST) events
enable detection of call status transition (CST) events dx_setevtmsk( )
dx_setgtdamp( )
Page
dx_sethook( )
Page
dx_sethook( ) provide control of the hook switch status
This example illustrates how to use dx_sethook( ) in asynchronous mode.
Page
dx_setparm( )
Page
For Springware boards, the supported board parameter defines are shown in Table 13.
Table 12. Voice Board Parameters (DM3)
Table 13. Voice Board Parameters (Springware)
Table 13. Voice Board Parameters (Springware) (Continued)
Table 14. Voice Channel Parameters (DM3)
Table 14. Voice Channel Parameters (DM3) (Continued)
Table 14. Voice Channel Parameters (DM3) (Continued)
Table 15. Voice Channel Parameters (Springware)
Table 15. Voice Channel Parameters (Springware) (Continued)
!Cautions
A constant cannot be used in place of valuep. The value of the parameter to be set must be
placed in a variable and the address of the variable cast as void * must be passed to the function.
Table 15. Voice Channel Parameters (Springware) (Continued)
Page
Page
dx_SetRecordNotifyBeepTone( )
Page
dx_setsvcond( )
Page
set conditions that adjust speed or volume of play dx_setsvcond( )
Page
dx_setsvmt( )
Page
change default values of the speed or volume modification table dx_setsvmt( )
Page
dx_settonelen( )
dx_settonelen( ) change the duration of the built-in beep tone
dx_playiottdata( )
Page
dx_setuio( )
install user-defined I/O functions dx_setuio( )
dx_setuio( ) install user-defined I/O functions
dx_cacheprompt( )
dx_playiottdata( ) dx_rec( ) dx_reciottdata( )
dx_SetWaterMark( )
Page
dx_stopch( )
Page
Page
Page
dx_TSFStatus( )
Page
dx_TxIottData( )
Page
Voice API for Windows Operating Systems Library Reference 425
transmit data on a specified channel dx_TxIottData( )
dx_RxIottData( ) dx_TxRxIottData( )
dx_TxRxIottData( )
Page
Page
start a transmit-initiated reception of data dx_TxRxIottData( )
Page
dx_unlisten( )
Page
dx_unlistenecr( )
Page
Page
dx_wink( )
Page
dx_wink( ) generate an outbound wink
This example illustrates how to use dx_wink( ) in asynchronous mode.
Page
dx_wtcallid( )
Page
Page
dx_wtring( )
Page
Page
li_attendant( )
Page
li_attendant( ) perform the actions of an automated attendant
perform the actions of an automated attendant li_attendant( )
li_islicensed_syntellect( )
li_islicensed_syntellect( )
nr_scroute( )
Page
make a full or half-duplex connection nr_scroute( )
nr_scroute( ) make a full or half-duplex connection
make a full or half-duplex connection nr_scroute( )
nr_scroute( ) make a full or half-duplex connection
nr_scunroute( )
nr_scunroute( )
Page
break a full or half-duplex connection nr_scunroute( )
nr_scunroute( ) break a full or half-duplex connection
Page
r2_creatfsig( )
Page
Page
Page
r2_playbsig( )
Page
Page
play R2/MF backward signal tone r2_playbsig( )
r2_creatfsig( ) dx_blddt( ) dx_playtone( ) R2/MF Signaling in Voice API Programming Guide
Page
3.1 Overview of Events
3.2 Termination Events
Page
3.3 Unsolicited Events
3.4 Call Status Transition (CST) Events
Call Status Transition Events on DM3 Boards
Call Status Transition Events on Springware Boards
Page
Page
Page
ADSI_XFERSTRUC
CT_DEVINFO
DM3 Boards
Page
Springware Boards
Page
DV_DIGIT
Page
DV_TPT
Page
Page
Page
Page
DV_TPT termination parameter table
event.
If tp_termno contains DX_TONEON, tp_data can specify termination after a tone-on
termination parameter table DV_TPT
Table 16. DV_TPT Field Settings Summary (Continued)
Page
DX_ATTENDANT
Page
Page
DX_CAP call progress analysis parameters
DX_CAP
call progress analysis parameters
DM3 Boards
Springware Boards
Page
Page
Page
Page
Page
DX_CST
Page
DX_EBLK
Page
DX_ECRCT
DX_IOTT
Page
input/output transfer table DX_IOTT
DX_STREAMSTAT
Page
DX_SVCB
Page
Page
DX_SVMT
Page
DX_UIO
DX_XPB
Page
DX_XPB input/output transfer parameter block Table 18. G.721 Voice Coder Support Fields (DM3)
Table 19. Linear PCM Voice Coder Support Fields (DM3)
Table 20. OKI ADPCM Voice Coder Support Fields (DM3)
Table 21. G.726 Voice Coder Support Fields (DM3)
Page
Page
FEATURE_TABLE
Page
Page
Page
SC_TSINFO
TN_GEN
TN_GENCAD
Page
TONE_DATA
Page
Page
Page
Page
Page
Information
6.1 DTMF and MF Tone Specifications
6.2 DTMF and MF Detection Errors
Supplementary Reference Information Table 29. Detecting MF Digits
Table 30. Detecting DTMF Digits
Supplementary Reference Information
Table 30. Detecting DTMF Digits (Continued)
Glossary
Page
Page
Page
Page
Page
Page
Page
Index
A
B
C
Page
D
Page
Page
E
F
G
H
I
J
L
M
N
O
P
R
S
T
U
V
W
Z
