Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MuteChangedEvent

This event object describes how and why the mute state of the client has changed. It is passed in as a parameter to OnMuteChangedCallback.

Hierarchy

  • MuteChangedEvent

Index

Constructors

constructor

  • new MuteChangedEvent(__namedParameters: { adminPreventsInputAudioUnmuting: boolean; currentInputAudioMutedValue: boolean; muteReason: MuteReason; success: boolean; targetInputAudioMutedValue: boolean }): MuteChangedEvent
  • Parameters

    • __namedParameters: { adminPreventsInputAudioUnmuting: boolean; currentInputAudioMutedValue: boolean; muteReason: MuteReason; success: boolean; targetInputAudioMutedValue: boolean }
      • adminPreventsInputAudioUnmuting: boolean
      • currentInputAudioMutedValue: boolean
      • muteReason: MuteReason
      • success: boolean
      • targetInputAudioMutedValue: boolean

    Returns MuteChangedEvent

Properties

adminPreventsInputAudioUnmuting

adminPreventsInputAudioUnmuting: boolean

Indicates whether the client is currently prevented from unmuting using HiFiCommunicator.setInputAudioMuted.

currentInputAudioMutedValue

currentInputAudioMutedValue: boolean

Indicates the current muted value after attempting to set mute state. true means muted, false means unmuted.

muteReason

muteReason: MuteReason

Indicates the reason the mute state has changed.

success

success: boolean

Indicates whether the the mute state was set successfully. This may be false if the client is trying to unmute themselves when muted by an admin, or if there was a failure setting the mute state of the input device.

targetInputAudioMutedValue

targetInputAudioMutedValue: boolean

Indicates the muted value that would have been set if the mute state was set succesfully. true means muted, false means unmuted.