chat_user::chat_indicator

  • Artikel

Indicates whether chat is possible and if audio is currently being produced for this user.

Syntax

game_chat_user_chat_indicator chat_indicator(  
)

Parameters

Return value

Type: game_chat_user_chat_indicator

Remarks

This indicator is intended to assist UI iconic representation so that users can determine why they're hearing/ seeing what they are ("who's that talking?"), or why not.

This value changes frequently and is typically polled every graphics frame.

If post-decode audio manipulation is enabled, chat indicators will be set based on which post-decode audio source streams are attempting and allowed to talk to which post-decode audio sink streams. The chat indicator will be set regardless of how the app mixes the post-decode source streams together.

Requirements

Header: GameChat2.h

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

See also

chat_user
game_chat_user_chat_indicator
chat_user::chat_user_local::set_microphone_muted
game_chat_audio_manipulation_mode_flags::post_decode_stream_manipulation