post_decode_audio_sink_stream

Represents the outbound-data side of the remote audio manipulation pipeline.

Syntax

class post_decode_audio_sink_stream  

Methods

Method Description
can_receive_audio_from_source_stream Determine whether Game Chat will allow audio communication from the users associated with a post-decode source stream to the users associated with this post-decode sink stream based on communication relationships and platform requirements such as system-level mutes.
custom_stream_context method Retrieves the app's optional, private, custom pointer-sized context value previously associated with this stream object.
get_device_id Retrieves the ID of this stream's render device.
get_users method Retrieves the users associated with this stream's render device.
is_open method Indicates whether the stream is open.
set_custom_stream_context method Configures an optional, custom pointer-sized context value with this stream object.
set_processed_format method 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.
submit_mixed_buffer Submits audio to the render device represented by this sink.

Remarks

The post_decode_audio_sink_stream class represents the stream to which decoded audio from remote users, retrieved from a post_decode_audio_source_stream object and optionally manipulated by audio middleware, is sent for rendering to the stream's users.

Only audio from a post_decode_audio_source_stream with a set of users who have the appropriate privileges to talk with this stream's users should submit audio to this stream. For more information about submitting audio, see post_decode_audio_sink_stream::submit_mixed_buffer.

For more information about manipulating audio, see Real-time audio manipulation.

### post_decode_audio_sink_stream_array The `post_decode_audio_sink_stream_array` type is a constant array of `post_decode_audio_sink_stream` pointers. This type is provided for convenience, and is used with [chat_manager::get_post_decode_audio_sink_streams](../chat_manager/methods/chat_manager_get_post_decode_audio_sink_streams.md). ```cpp typedef class post_decode_audio_sink_stream * const * post_decode_audio_sink_stream_array; ``` ## Requirements **Header:** GameChat2.h **Supported platforms:** Windows, Xbox One family consoles and Xbox Series consoles ## See also [Intro to Game Chat 2](../../../../../chat/overviews/game-chat2/game-chat-2-intro.md) [pre_encode_audio_stream](../pre_encode_audio_stream/pre_encode_audio_stream.md) [GameChat2 members](../../gamechat2_members.md)