Intel 05-1832-002 User Manual

169

delete a circular stream buffer

!

!

!

! Description

The dx_CloseStreamBuffer( ) function deletes the circular stream buffer identified by the stream 
buffer handle. If the stream buffer is currently in use (playing), this function returns -1 as an error. 

!

!

!

! Cautions

You cannot delete a circular stream buffer while it is in use by a play operation. If you try to delete 
the buffer in this situation, the dx_CloseStreamBuffer( ) function will return -1 as an error. 

!

!

!

! Errors

This function returns -1 on error. The error can occur if you passed the wrong buffer handle to the 
function call or if the buffer is in use by an active play. 

To see if the buffer is in use by an active play, call 

 and check the item  

“currentState” in the 

 structure. A value of ASSIGNED_STREAM_BUFFER 

for this item means that the buffer is currently in use in a play. A value of 
UNASSIGNED_STREAM_BUFFER means that the buffer is not being used currently in any play.

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_CloseStreamBuffer(hBuffer) 

int hBuffer

stream buffer handle

0 if successful
-1 if failure 

srllib.h
dxxxlib.h

streaming to board

synchronous

DM3

hBuffer 

specifies the stream buffer handle obtained from