game_chat_speech_to_text_conversion_mode
Defines the speech-to-text conversion modes available to Game Chat 2.
Syntax
enum class game_chat_speech_to_text_conversion_mode
{
automatic,
title_managed,
}
Constants
Constant | Description |
---|---|
automatic | Represents the 'automatic' speech-to-text conversion mode. If a local user has requested speech-to-text, Game Chat 2 automatically transcribes outgoing audio associated with the local user and incoming audio associated with users that are allowed to speak to the local user. Each transcription is provided to the app as a game_chat_transcribed_chat_received_state_change state change. The app should display this message on screen for the user that has requested speech-to-text. |
title_managed | Represents the 'title managed' speech-to-text conversion mode. Game Chat 2 does not automatically transcribe audio when a user has requested speech-to-text. The title is responsible for transcribing audio when a user has the speech-to-text setting enabled, as indicated by chat_user_local::speech_to_text_conversion_preference_enabled. |
Remarks
By default, Game Chat 2 automatically manages most work to support speech-to-text accessibility scenarios. You can allow games to disable this automatic work in favor of an independent speech-to-text solution when initializing Game Chat 2, by specifying title_managed
in the speechToTextConversion
parameter of the chat_manager::initialize method. For more information about initializing Game Chat 2, see Using the Game Chat 2 C++ API.
Requirements
Header: GameChat2.h
Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles