Freigeben über


chat_manager::set_legacy_era_uwp_compat_mode_enabled

Indicates whether the legacy ERA and Windows Platform (UWP) compatibility mode for Game Chat 2 should be enabled.

Syntax

void set_legacy_era_uwp_compat_mode_enabled(  
    bool enabled
)  

Parameters

enabled   _In_
Type: bool

Indicates whether the legacy ERA and UWP compatibility mode should be enabled.

Return value

Type: void

None.

Remarks

This method indicates whether the legacy ERA and UWP compatibility mode for Game Chat 2 should be enabled. Enabling legacy ERA and UWP compatibility mode allows interoperability between Microsoft Game Development Kit (GDK) versions of Game Chat 2 and console ERA and Windows Platform (UWP) versions of Game Chat 2.

This method may be called at any time before or after chat_manager::initialize is called, and takes effect on the following call to chat_manager::initialize. The legacy ERA and UWP compatibility mode setting is persisted across subsequent calls to chat_manager::cleanup and chat_manager::initialize.

Game Chat 2 uses a legacy codec when legacy ERA and UWP compatibility mode is enabled, so audio quality and performance may be reduced. New titles should not use the legacy ERA and UWP compatibility mode unless interoperability with legacy clients is required. This mode may be deprecated and removed in future versions of Game Chat 2.

Requirements

Header: GameChat2.h

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

See also

Intro to Game Chat 2
chat_manager