game_chat_audio_encoding_bitrate

Defines the audio encoding bit rate that Game Chat 2 uses for generating outgoing audio packets.

Syntax

enum class game_chat_audio_encoding_bitrate  
{  
    kilobits_per_second_12,  
    kilobits_per_second_16,  
    kilobits_per_second_24,  
}  

Constants

Constant Description
kilobits_per_second_12 Represents encoding with a bit rate of 12 kilobits per second.
kilobits_per_second_16 Represents encoding with a bit rate of 16 kilobits per second.
kilobits_per_second_24 Represents encoding with a bit rate of 24 kilobits per second.

Remarks

This enumeration describes the audio encoding bit rate used by Game Chat 2 to encode audio packets for transmission to remote endpoints. You can retrieve the current audio encoding bit rate for the chat instance by calling the chat_manager::audio_encoding_bitrate method. You can change the audio encoding bit rate by calling the chat_manager::set_audio_encoding_bitrate method.

You can change the audio encoding bit rate as needed to respond to network usage. Lower bit rates result in less data transmission but lower audio quality. Higher bit rates result in better audio quality but more data transmission. For more information about audio encoding, see Using the Game Chat 2 C++ API.

Requirements

Header: GameChat2.h

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

See also

Intro to Game Chat 2
GameChat2 members