PartyLocalChatControl::GetChatIndicator
Provides a chat indicator specifying the audio state of a target chat control in relation to the local chat control.
Syntax
PartyError GetChatIndicator(
const PartyChatControl* targetChatControl,
PartyChatControlChatIndicator* chatIndicator
)
Parameters
targetChatControl PartyChatControl*
The target chat control.
chatIndicator PartyChatControlChatIndicator*
output
The chat indicator.
Return value
PartyError
c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().
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.
Requirements
Header: Party.h