Miles Sound System SDK 7.2a

AIL_sample_buffer_info

The function AIL_sample_buffer_info returns detailed information about the status of the low-level streaming buffers for the specified sound handle.

S32 AIL_sample_buffer_info(
  HSAMPLE S,
  S32 buff_num,
  U32 *pos,
  U32 *len,
  S32 *head,
  S32 *tail
);

In Parameters

S: indicates the sample handle to check.
buff_num: indicates the buffer to check, from 0 to the value returned by AIL_sample_buffer_count.

Out Parameters

pos: will receive the current position of buffer 0.
len: will receive the current size of buffer 0.
head: will receive the head index of the streaming buffer list (i.e., where audio data submitted to AIL_load_sample_buffer will be placed).
tail: will receive the tail index of the streaming buffer list (i.e., the buffer from which data is currently being fetched by the MSS mixer).

Returns

Whether the low-level streaming system has completely starved (all sound buffers have been exhausted).

Discussion

This function is rarely used - see AIL_sample_buffer_available for a more useful status function.

You will probably never need this function. It is needed primarily by video playback engines that need to monitor the low-level streaming state in minute detail.

Do NOT use this function to determine when to load another sample buffer - use the AIL_sample_buffer_available function instead.

Group: Digital Audio Services
Related Functions: AIL_load_sample_buffer, AIL_minimum_sample_buffer_size, AIL_sample_buffer_available
Related Basic Types: HSAMPLE, S32, U32