Filter
Top Products
Voice API for Windows Operating Systems Library Reference — November 2003 247
retrieve information about the circular stream buffer — dx_GetStreamInfo( )
dx_GetStreamInfo( )
retrieve information about the circular stream buffer
!
!!
! Description
The dx_GetStreamInfo( ) function populates the stream status structure with the current status
information about the circular stream buffer handle passed into it. The data returned is a snapshot
of the status at the time dx_GetStreamInfo( ) is called.
!
!!
! Cautions
None.
!
!!
! Errors
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.
!
!!
! Example
#include <srllib.h>
#include <dxxxlib.h>
main()
{
int nBuffSize = 32768;
int hBuffer = -1;
DX_STREAMSTAT streamStat;
Name: int dx_GetStreamInfo(hBuffer, &StreamStatStruct)
Inputs: int hBuffer
• stream buffer handle
DX_STREAMSTAT
StreamStatStruct
• pointer to stream status structure
Returns: 0 if successful
-1 if failure
Includes: srllib.h
dxxxlib.h
Category: streaming to board
Mode: synchronous
Platform: DM3
Parameter Description
hBuffer specifies the circular stream buffer handle
StreamStatStruct specifies a pointer to the DX_STREAMSTAT data structure. For more
information on this structure, see DX_STREAMSTAT, on page 512.