Voice API for HMP Library Reference - Dialogic

More documents

Recommendations

Info

ATDX_DEVTYPE( ) — return the device type } /* Open the board device */ if ((bddev = dx_open("dxxxB1",NULL)) == -1) { /* Process error */ } if((devtype = ATDX_DEVTYPE(bddev)) == AT_FAILURE) { /* Process error */ } if(devtype == DT_DXBD) { printf("Device is a Board\n"); } /* Continue processing */ . . � See Also None. 42 Voice API for HMP Library Reference — September 2004
ATDX_STATE( ) return the current state of the channel Name: long ATDX_STATE(chdev) Inputs: int chdev valid channel device handle Returns: current state of channel if successful AT_FAILURE if error Includes: srllib.h dxxxlib.h Category: Extended Attribute Mode: synchronous � Description return the current state of the channel — ATDX_STATE( ) The ATDX_STATE( ) function returns the current state of the channel chdev. Parameter Description chdev specifies the valid channel device handle obtained when the channel was opened using dx_open( ) Possible return values are the following: CS_DIAL Dial state CS_CALL Call state CS_GTDIG Get Digit state CS_HOOK Hook state CS_IDLE Idle state CS_PLAY Play state CS_RECD Record state CS_STOPD Stopped state CS_TONE Playing tone state Note: A device is idle if there is no I/O function active on it. Voice API for HMP Library Reference — September 2004 43
Page 1 and 2: Voice API for Host Media Processing
Page 3 and 4: Contents Revision History . . . . .
Page 5 and 6: Contents dx_reciottdata( ) - record
Page 7 and 8: Tables Contents 1 Valid Dial String
Page 9 and 10: About This Publication The followin
Page 11 and 12: About This Publication For details
Page 13 and 14: 1.Function Summary by Category This
Page 15 and 16: Function Summary by Category comple
Page 17 and 18: dx_SetWaterMark( ) sets high and lo
Page 19 and 20: dx_enbtone( ) enables detection of
Page 21 and 22: 1.13 Structure Clearance Functions
Page 23 and 24: 2.Function Information This chapter
Page 25 and 26: eturn a pointer to the board device
Page 27 and 28: � Example #include #include #in
Page 29 and 30: } retrieve all channel names for a
Page 31 and 32: } } /* Use chno for application-spe
Page 35 and 36: ATDX_CPERROR( ) return the call pro
Page 37 and 38: } /* * Close the opened Voice Chann
Page 39 and 40: eturn the last result of call progr
Page 41: ATDX_DEVTYPE( ) return the device t
Page 45 and 46: ATDX_TERMMSK( ) return the reason f
Page 47 and 48: } return the reason for the last I/
Page 49 and 50: eturn user-defined tone ID that ter
Page 51 and 52: ATDX_TRCOUNT( ) return the byte cou
Page 53 and 54: dx_addtone( ) add a user-defined to
Page 55 and 56: EDX_SYSTEM Error from operating sys
Page 57 and 58: dx_distone( ) dx_enbtone( ) global
Page 59 and 60: � Cautions � Errors set a DTMF
Page 61 and 62: dx_adjsv( ) adjust volume immediate
Page 63 and 64: main() { int dxxxdev; } /* * Open t
Page 65 and 66: � Cautions � Errors define a us
Page 67 and 68: dx_blddtcad( ) define a user-define
Page 69 and 70: } /* * Continue Processing * . * .
Page 71 and 72: � Cautions � Errors define a us
Page 73 and 74: dx_bldst( ) define a user-defined s
Page 75 and 76: dx_blddt( ) dx_bldstcad( ) dx_addto
Page 77 and 78: � Cautions None. � Errors None.
Page 79 and 80: close a channel or board device han
Page 81 and 82: � Example #include #include mai
Page 83 and 84: } . /* continue with call progress
Page 85 and 86: main() { int chdev; /* channel desc
Page 89 and 90: � Errors clear all fields in a DV
Page 91 and 92: create a new tone definition for a
Page 93 and 94:
} � See Also create a new tone de
Page 95 and 96:
delete a specific call progress ton
Page 97 and 98:
dx_deltones( ) delete all user-defi
Page 99 and 100:
dx_dial( ) dial an ASCIIZ string
Page 101 and 102:
Table 1. Valid Dial String Characte
Page 103 and 104:
} /* * Change call progress analysi
Page 105 and 106:
dx_distone( ) disable detection of
Page 107 and 108:
} disable detection of a user-defin
Page 109 and 110:
� Errors enable detection of a us
Page 111 and 112:
dx_fileclose( ) close a file Name:
Page 113 and 114:
dx_fileerrno( ) return the system e
Page 115 and 116:
� See Also None. return the syste
Page 117 and 118:
} /* Open the device using dx_open(
Page 119 and 120:
* * User defined I/O functions */ i
Page 121 and 122:
dx_fileseek( ) move a file pointer
Page 123 and 124:
*This block uses standard I/O funct
Page 125 and 126:
* * User defined I/O functions */ i
Page 127 and 128:
dx_getctinfo( ) get information abo
Page 129 and 130:
dx_getcursv( ) return the specified
Page 131 and 132:
dx_addvoldig( ) dx_setsvmt( ) dx_ge
Page 133 and 134:
collect digits from a channel digit
Page 135 and 136:
} collect digits from a channel dig
Page 137 and 138:
dx_setdigtyp( ) DV_DIGIT data struc
Page 139 and 140:
} retrieve the voice DLL version nu
Page 141 and 142:
monitor channel events synchronousl
Page 143 and 144:
dx_getfeaturelist( ) retrieve featu
Page 145 and 146:
etrieve feature support information
Page 147 and 148:
dx_getparm( ) get the current param
Page 149 and 150:
} get the current parameter setting
Page 151 and 152:
} retrieve information about the ci
Page 153 and 154:
EDX_SYSTEM Error from operating sys
Page 155 and 156:
dx_getxmitslot( ) get TDM bus time
Page 157 and 158:
get TDM bus time slot number of voi
Page 159 and 160:
} initialize the voice library DLL
Page 161 and 162:
� Errors connect a voice listen c
Page 163 and 164:
dx_open( ) open a voice device and
Page 165 and 166:
� See Also dx_close( ) open a voi
Page 167 and 168:
� Example #include #include cre
Page 169 and 170:
Parameter Description play recorded
Page 171 and 172:
� Errors play recorded voice data
Page 173 and 174:
} /* Set chname to the channel name
Page 175 and 176:
dx_playf( ) synchronously play voic
Page 177 and 178:
} rval = dx_play(devd,&iott,tptp,mo
Page 179 and 180:
� Cautions � Errors play back r
Page 181 and 182:
} play back recorded voice data fro
Page 183 and 184:
play tone defined by TN_GEN structu
Page 185 and 186:
} tpt[0].tp_data = DX_TONEON; tpt[1
Page 187 and 188:
play the cadenced tone defined by T
Page 189 and 190:
} tngencad.cycles = 255; tngencad.n
Page 191 and 192:
� Errors play voice data stored i
Page 193 and 194:
dx_playwav( ) play voice data store
Page 195 and 196:
} � See Also dx_playiottdata( ) d
Page 197 and 198:
place data into a circular stream b
Page 199 and 200:
get tone information for a specific
Page 201 and 202:
dx_rec( ) record voice data from a
Page 203 and 204:
ecord voice data from a single chan
Page 205 and 206:
main() { DV_TPT tpt; DX_IOTT iott[2
Page 207 and 208:
} } record voice data from a single
Page 209 and 210:
� Errors record voice data to a s
Page 211 and 212:
dx_reciottdata( ) dx_recvox( ) dx_s
Page 213 and 214:
Parameter Description � Cautions
Page 215 and 216:
} record voice data to multiple des
Page 217 and 218:
� Errors record voice data to a s
Page 219 and 220:
dx_recwav( ) record voice data to a
Page 221 and 222:
} record voice data to a single WAV
Page 223 and 224:
} � See Also reset internal data
Page 225 and 226:
� Cautions � Errors install and
Page 227 and 228:
dx_setdigtyp( ) control the types o
Page 229 and 230:
} control the types of digits detec
Page 231 and 232:
enable detection of call status tra
Page 233 and 234:
main() { int chdev[MAXCHAN]; char *
Page 235 and 236:
dx_setgtdamp( ) set up the tone det
Page 237 and 238:
dx_setparm( ) set physical paramete
Page 239 and 240:
� Cautions set physical parameter
Page 241 and 242:
dx_setsvcond( ) set conditions that
Page 243 and 244:
set conditions that adjust volume o
Page 245 and 246:
dx_setsvmt( ) change default values
Page 247 and 248:
* * Global Variables */ change defa
Page 249 and 250:
dx_setuio( ) install user-defined I
Page 251 and 252:
} /*This block uses standard I/O fu
Page 253 and 254:
� Errors set water mark for the c
Page 255 and 256:
� Cautions force termination of c
Page 257 and 258:
dx_unlisten( ) disconnect voice rec
Page 259 and 260:
nr_scroute( ) make a full or half-d
Page 261 and 262:
make a full or half-duplex connecti
Page 263 and 264:
make a full or half-duplex connecti
Page 265 and 266:
nr_scunroute( ) break a full or hal
Page 267 and 268:
eak a full or half-duplex connectio
Page 269 and 270:
� See Also nr_scroute( ) break a
Page 271 and 272:
3.Events This chapter provides info
Page 273 and 274:
3.3 Unsolicited Events Events Unsol
Page 275 and 276:
4.Data Structures This chapter prov
Page 277 and 278:
channel/time slot device informatio
Page 279 and 280:
DV_TPT termination parameter table
Page 281 and 282:
Digit Digit Define c DM_C d DM_D te
Page 283 and 284:
termination parameter table — DV_
Page 285 and 286:
DX_CAP call progress analysis param
Page 287 and 288:
call progress analysis parameters
Page 289 and 290:
DX_EBLK call status transition even
Page 291 and 292:
input/output transfer table — DX_
Page 293 and 294:
DX_STREAMSTAT status of stream buff
Page 295 and 296:
DX_SVCB speed and volume adjustment
Page 297 and 298:
speed and volume adjustment conditi
Page 299 and 300:
� Example speed and volume modifi
Page 301 and 302:
DX_XPB input/output transfer parame
Page 303 and 304:
FEATURE_TABLE feature information t
Page 305 and 306:
feature information — FEATURE_TAB
Page 307 and 308:
TN_GEN tone generation template typ
Page 309 and 310:
cadenced tone generation template
Page 311 and 312:
tone information — TONE_DATA TONE
Page 313 and 314:
5.Error Codes This chapter lists th
Page 315 and 316:
Error Codes EDX_SH_BADTYPE Invalid
Page 317 and 318:
6.Supplementary Reference Informati
Page 319 and 320:
Table 14. Detecting MF Digits MF Di
Page 321 and 322:
Glossary A-law: Pulse Code Modulati
Page 323 and 324:
convenience function: A class of fu
Page 325 and 326:
mu-law: (1) Pulse Code Modulation (
Page 327 and 328:
together again at the receiving end
Page 329 and 330:
Index A adjusting speed and volume
Page 331 and 332:
data structures cadenced tone gener
Page 333 and 334:
E enabling detection user-defined t
Page 335 and 336:
play asynchronous 170 convenience f
Page 337 and 338:
terminations asynchronous play 170
show all

Voice API for HMP Library Reference - Dialogic

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?