pre_encode_audio_stream::get_pre_processed_format

Gets the audio format of the buffers that are returned by pre_encode_audio_stream::get_next_buffer.

Syntax

game_chat_audio_format get_pre_processed_format(  
)  

Parameters

None.

Return value

Type: game_chat_audio_format

Returns the audio format of the buffers that are returned by pre_encode_audio_stream::get_next_buffer.

Remarks

This method returns a game_chat_audio_format structure that represents the audio format of the buffers returned by calling the pre_encode_audio_stream::get_next_buffer method for this stream.

Note

The pre-processed audio format returned by this method is always a single-channel (mono) format, with sample types represented by 32-bit floating-point decimal numbers, 16-bit integers, and 32-bit integers.

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