post_decode_audio_sink_stream::set_processed_format
Specifies the format of the processed audio that is submitted to Game Chat 2 for rendering through post_decode_audio_sink_stream::submit_mixed_buffer.
Syntax
void set_processed_format(
game_chat_audio_format format
)
Parameters
format _In_
Type: game_chat_audio_format
The format of the audio submitted for Game Chat 2 to render. Interleaved formats are preferred. Non-interleaved formats are interleaved for rendering, which incurs a performance penalty.
Return value
Type: void
None.
Remarks
This method specifies the format of the audio submitted for Game Chat 2 to render, by calling post_decode_audio_sink_stream::submit_mixed_buffer. This method must be called before post_decode_audio_sink_stream::submit_mixed_buffer is called for the first time, and cannot be called after that.
Note
This method can be called only while the stream is open; otherwise, an error occurs. You can call the post_decode_audio_sink_stream::is_open method to confirm that the stream is open before calling this method.
For more information about manipulating post-decode chat audio data, see Real-time audio manipulation.
Requirements
Header: GameChat2.h
Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles