Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Crossmute functions

Understand the different actions that occur when you call various crossmuting functions.
Read time 1 minuteLast updated 2 days ago
The following list details the actions that occur when you call various crossmuting functions. 
  • ILoginSession::CrossMutedCommunications()
    - Returns a TSet of all AccountIds that are crossmuted for the current ILoginSession.     
  • ILoginSession::BeginSetCrossMutedCommunications(AccountId &account, bool &muted, FOnBeginSetCrossMutedCommunicationsDelegate theDelegate)
    - Sets the crossmuting status of a single AccountId for the 
    ILoginSession
    .
    • When run with an AccountId and a muted value of true, this action prevents the AccountId from sending or receiving voice or text communications.
    • When run with an AccountId and a muted value of false, this action allows AccountIds that were previously crossmuted to communicate normally.
  • ILoginSession::BeginSetCrossMutedCommunications(TSet<AccountId> &accountIdSet, bool &muted, FOnBeginSetCrossMutedCommunicationsDelegate theDelegate)
    - Sets the crossmuting status of a TSet of AccountIds.
    • When run with a TSet of AccountIds and a muted value of true, this action prevents the TSet of AccountIds from sending or receiving voice or text communications.
    • When run with a TSet of AccountIds and a muted value of false, this action removes the TSet of AccountIds from the 
      CrossMutedCommunications
      list, which allows the AccountIds to send or receive voice and text communications in any channels where they are not muted.
  • ILoginSession::ClearCrossMutedCommuncations(FOnBeginClearCrossMutedCommunicationsCompletedDelegate theDelegate)
    - Clears any crossmuted communications in the 
    ILoginSession
    , which allows for the sending or receiving of text and voice communications that are not prevented by some other method.