game_chat_audio_manipulation_mode_flags

Represents the requested audio manipulation feature status.

Syntax

enum class game_chat_audio_manipulation_mode_flags  
{  
    none = 0x0,  
    pre_encode_stream_manipulation = 0x1,  
    post_decode_stream_manipulation = 0x2,  
}  

Constants

Constant Description
none All audio manipulation is disabled.
pre_encode_stream_manipulation Manipulation of locally generated audio is enabled.

Specifying this flag grants access to chat user audio data for processing and manipulation by the sender, by using the pre_encode_audio_stream object.
post_decode_stream_manipulation Manipulation of remotely generated audio is enabled.

Specifying this flag grants access to chat user audio data for processing and manipulation by the receiver, by using the post_decode_audio_source_stream and post_decode_audio_sink_stream objects.

Remarks

This enumeration describes the audio manipulation features that your app can request from Game Chat 2 for a chat instance. You can retrieve the current audio manipulation mode for the chat instance by calling the chat_manager::audio_manipulation_mode method. You can set the audio manipulation mode when you initialize the chat instance, by calling the chat_manager::initialize method.

For more information about manipulating 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
GameChat2 members
chat_manager