Intel 05-1832-002 User Manual

295

create and initialize a circular stream buffer

!

!

!

! Description

The dx_OpenStreamBuffer( ) function allocates and initializes a circular stream buffer for 
streaming to a voice device. 

You can create as many stream buffers as needed on a channel; however, you are limited by the 
amount of memory on the system. You can use more than one stream buffer per play via the 

 structure. In this case, specify that the data ends in one buffer using the STREAM_EOD 

flag so that the play can process the next DX_IOTT structure in the chain. For more information 
about using the streaming to board feature, see the Voice API Programming Guide. 

This function initializes the circular stream buffer to the same initial state as 

!

!

!

! Cautions

The buffer identified by the circular stream buffer handle cannot be used by multiple channels for 
the play operation. 

!

!

!

! Errors

This function fails with -1 error if there is not enough system memory available to process this 
request.

Unlike other voice API library functions, the streaming to board functions do not use SRL device 
handles. Therefore, ATDV_LASTERR( ) and ATDV_ERRMSGP( ) cannot be used to retrieve 
error codes and error descriptions.

int dx_OpenStreamBuffer(BuffSize) 

int BuffSize

size in bytes of circular stream buffer

stream buffer handle if successful
-1 if failure

srllib.h
dxxxlib.h

streaming to board

synchronous

DM3

BuffSize 

specifies the size in bytes of the circular stream buffer to allocate