PartyLocalChatControl::GetLocalChatIndicator
Provides a chat indicator specifying the audio state of the local chat control.
Syntax
PartyError GetLocalChatIndicator(
PartyLocalChatControlChatIndicator* chatIndicator
)
Parameters
chatIndicator PartyLocalChatControlChatIndicator*
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 whether their voice audio is being captured and, if not, then why not.
This value changes frequently and is typically polled every graphics frame.
Requirements
Header: Party.h