Retrieves status for the active or most recently executed play operation.

DWORD adiGetPlayStatus( CTAHD ctahd,
ADI_PLAY_STATUS *info,
unsigned size )

ctahd Context handle returned by adiOpenPort.

info Pointer to the ADI_PLAY_STATUS structure, as shown:

typedef struct
{
 DWORD size;     /* returned size (GetPlayStatus())         */
 DWORD reason;     /* reason last play ended         */
 DWORD buffercount;     /* counter of buffers submitted         */
 DWORD framecount;     /* number of frames submitted          */
 DWORD totalbytes;     /* total bytes submitted          */
 void *buffer;     /* last buffer pointer submitted         */
 DWORD bytecount;     /* size of last buffer submitted         */
 DWORD bytesplayed;     /* total bytes actually played         */
 DWORD timestarted;     /* actual time started (ms units)         */
 DWORD underrun;     /* counts out-of-frame events         */
} ADI_PLAY_STATUS;

size Amount of memory available at info to receive the ADI_PLAY_STATUS.

• SUCCESS
• CTAERR_BAD_ARGUMENT
  info is NULL.
• CTAERR_BAD_SIZE
  size is smaller than the size of DWORD.
• CTAERR_INVALID_CTAHD
• CTAERR_INVALID_STATE

None.

This function retrieves status information about the active or most recently completed voice play operation for the specified context.

Up to size bytes of the ADI_PLAY_STATUS structure are copied to the address pointed to by info. If size is greater than or equal to sizeof(ADI_PLAY_STATUS), the complete structure is copied. The number of bytes copied is returned in the ADI_PLAY_STATUS size field.

adiGetPlayStatus may be issued while actively playing. If there is no active play operation, the status information pertains to the most recently completed instance.

The ADI_PLAY_STATUS structure contains the following fields:

Field	Description
size	The number of bytes copied to info.
reason	The termination condition for the last ADIEVN_PLAY_DONE. This field is 0 if the play operation is active, or if it has not been started since the context was last opened.
buffercount	The number of buffers submitted.
framecount	The number of voice frames submitted.
totalbytes	The number of bytes submitted by the application.
buffer	The last buffer pointer submitted.
bytecount	The size of the last buffer submitted.
bytesplayed	The total number of bytes actually processed by the DSP and transmitted.
timestarted	The timestamp for when the play operation started (see adiGetTimeStamp).
underrun	The total number of underruns during the play instance (see the AG Access Developer's Manual for more information about underruns).

adiStartPlaying, adiPlayAsync, adiPlayFromMemory, adiStopPlaying

void myShowPlayStatus( CTAHD ctahd )
{
    ADI_PLAY_STATUS playstatus;

    adiGetPlayStatus( ctahd, &playstatus, sizeof playstatus );

    printf( "Termination condition=%x  bytes played=%d\n",
            playstatus.reason, playstatus.bytesplayed );
}