chat_user_local::text_to_speech_conversion_preference_enabled

Returns true if this user has enabled text-to-speech conversion.

Syntax

bool text_to_speech_conversion_preference_enabled(  
)  

Parameters

Return value

Type: bool

Remarks

If this user has enabled text-to-speech conversion, this method returns true. Apps may listen for a game_chat_chat_text_conversion_preference_changed_state_change to know when a local player enables or disables this preference.

If this preference is enabled, when chat_user::chat_user_local::synthesize_text_to_speech() is called for this user, remote users will hear synthesized audio representing the contents of the message.

Apps can use the value of this preference to customize the user interface to support sending synthesized text-to-speech messages, for example by enabling a dedicated button to bring up the text input keyboard.

Requirements

Header: GameChat2.h

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

See also

chat_user_local
chat_user::chat_user_local::speech_to_text_conversion_preference_enabled
chat_user::chat_user_local::send_chat_text