Filter
Top Products
512 Voice API for Windows Operating Systems Library Reference — November 2003
DX_STREAMSTAT — status of stream buffer
DX_STREAMSTAT
status of stream buffer
typedef struct streamStat
{
unsigned int version; // version of the structure
unsigned int bytesIn; // total number of bytes put into stream buffer
unsigned int bytesOut; // total number of bytes sent to board
unsigned int headPointer; // internal pointer to position in stream buffer
unsigned int tailPointer; // internal pointer to position in stream buffer
unsigned int currentState; // idle, streaming etc.
unsigned int numberOfBufferUnderruns;
unsigned int numberOfBufferOverruns;
unsigned int BufferSize; // buffer size
unsigned int spaceAvailable; // space in bytes available in stream buffer
unsigned int highWaterMark; // high water mark for stream buffer
unsigned int lowWaterMark; // low water mark for stream buffer
} DX_STREAMSTAT;
!
!!
! Description
The DX_STREAMSTAT data structure contains the current status of the circular stream buffer for
a voice device. This structure is used by the streaming to board feature and returned by the
dx_GetStreamInfo( ) function. This structure is defined in dxxxlib.h.
!
!!
! Field Descriptions
The fields of the DX_STREAMSTAT data structure are described as follows:
version
Contains the version of the data structure. The value is currently hardcoded to 1. This field is
reserved for future use.
bytesIn
Contains the total number of bytes put into the circular stream buffer.
bytesOut
Contains the total number of bytes sent to the board.
headPointer
Contains an internal pointer to the head position in the circular stream buffer.
tailPointer
Contains an internal pointer to the tail position in the circular stream buffer.
currentState
Contains the current state of the circular stream buffer.
• ASSIGNED_STREAM_BUFFER – stream buffer is in use by a play operation and
therefore is not available to any other play operation at this time
• UNASSIGNED_STREAM_BUFFER – stream buffer is free to be used by a play
operation at this time
numberOfBufferUnderruns
Represents the number of times the host library tries to read from the circular stream buffer
and finds that there is not enough data to satisfy that read request to send the data to the
firmware. The size of the read request for the host library is determined by the transfer buffer
size of the player.