Share via


pre_encode_audio_stream::get_available_buffer_count

Gets the total number of buffers available to retrieve from this stream.

Syntax

uint32_t get_available_buffer_count(  
)  

Parameters

None.

Return value

Type: uint32_t

Returns the total number of buffers available to retrieve from this stream.

Remarks

This method returns the total number of buffers available to retrieve from this stream. You can call the pre_encode_audio_stream::get_next_buffer method to retrieve the next available buffer. This method can be useful if you prefer to send audio through your app's audio pipeline in batches of buffers. Because only 10 buffers will be held by the stream at any given time, you should not attempt to collect batches larger than 4 buffers. You should give your app's audio processing pipeline ample time to process the buffers and return them to pre_encode_audio_stream::return_buffer, to prevent overflowing your app's audio stream.

For more information about manipulating pre-encode chat audio data, see Real-time audio manipulation.

Requirements

Header: GameChat2.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Intro to Game Chat 2
pre_encode_audio_stream