game_chat_text_conversion_preference_changed_state_change

Represents information specific to the game_chat_state_change_type::text_conversion_preference_changed state change.

Syntax

typedef struct game_chat_text_conversion_preference_changed_state_change {  
    chat_user* chatUser;  
} game_chat_text_conversion_preference_changed_state_change  

Members

chatUser  
Type: chat_user*

A pointer to the local user who has enabled or disabled speech-to-text or text-to-speech conversion.

Your app should call chat_user_local::speech_to_text_conversion_preference_enabled and chat_user_local::text_to_speech_conversion_preference_enabled to get the new preference values.

Remarks

This structure provides additional information for a game_chat_state_change_type::text_conversion_preference_changed state change in Game Chat 2. This state change occurs when a local user has enabled or disabled speech-to-text or text-to-speech conversion.

If this state change occurs, this structure is returned as a game_chat_state_change element in the game_chat_state_change_array array retrieved when chat_manager::start_processing_state_changes is called by your app. After confirming the state change type by checking the value of the state_change_type member for that game_chat_state_change element, you can then cast that element to this structure. You can then use this structure to obtain more information about and process the state change before the array is passed back to Game Chat 2 from your app, by calling chat_manager::finish_processing_state_changes.

For more information about processing state changes, 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
chat_manager
GameChat2 members