08.01.2013 Views

Voice API for HMP Library Reference - Dialogic

Voice API for HMP Library Reference - Dialogic

Voice API for HMP Library Reference - Dialogic

SHOW MORE
SHOW LESS

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

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Function Summary by Category<br />

management functions. For more in<strong>for</strong>mation on device mapper functions, see the Standard<br />

Runtime <strong>Library</strong> <strong>API</strong> <strong>Library</strong> <strong>Reference</strong>.<br />

Note: These device management functions are separate and distinct from the Device Management <strong>API</strong><br />

library, which provides run-time control and management of configurable system devices.<br />

The device management functions are:<br />

dx_close( )<br />

closes a board or channel device handle<br />

dx_open( )<br />

opens a board or channel device handle<br />

1.2 Configuration Functions<br />

Configuration functions allow you to alter, examine, and control the physical configuration of an<br />

open device. In general, configuration functions operate on an idle device. Configuration functions<br />

cause a device to be busy and return the device to an idle state when the configuration is complete.<br />

See the <strong>Voice</strong> <strong>API</strong> Programming Guide <strong>for</strong> in<strong>for</strong>mation about busy and idle states.<br />

The configuration functions are:<br />

dx_clrdigbuf( )<br />

clears all digits in the firmware digit buffer<br />

dx_GetDllVersion( ) (Windows only)<br />

returns the voice dynamic link library (DLL) version number<br />

dx_getfeaturelist( )<br />

returns in<strong>for</strong>mation about the features supported on the device<br />

dx_getparm( )<br />

gets the current parameter settings <strong>for</strong> an open device<br />

dx_libinit( ) (Windows only)<br />

initializes the voice dynamic link library (DLL)<br />

dx_setdigtyp( )<br />

controls the types of digits detected by the device<br />

dx_setparm( )<br />

sets physical parameters <strong>for</strong> the device<br />

1.3 I/O Functions<br />

An I/O function transfers data to and from an open, idle channel. All I/O functions cause a channel<br />

to be busy while data transfer is taking place and return the channel to an idle state when data<br />

transfer is complete.<br />

I/O functions can be run synchronously or asynchronously, with some exceptions (<strong>for</strong> example,<br />

dx_setuio( ) can be run synchronously only). When running synchronously, they return after<br />

14 <strong>Voice</strong> <strong>API</strong> <strong>for</strong> <strong>HMP</strong> <strong>Library</strong> <strong>Reference</strong> — September 2004

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!