Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

MuteForcedEvent

Properties Methods 

Defines the muteForced event dispatched by a Session object. The Session object dispatches this event when a moderator forces clients publishing streams to the session to mute audio (the active property of the MuteForcedEvent object is set to true), or when a moderator disables the mute audio state in the session (the active property of the MuteForcedEvent object is set to false).

Properties

Name Type Description
active Boolean Whether the moderator has muted streams in the session (true) or disabled the mute state in the session (false).
See:

Methods

Name Description
isDefaultPrevented() → {Boolean} Whether the default event behavior has been prevented via a call to preventDefault() (true) or not (false).
preventDefault() Prevents the default behavior associated with the event from taking place.

isDefaultPrevented() → {Boolean}

Whether the default event behavior has been prevented via a call to preventDefault() (true) or not (false). See preventDefault().
Returns:

preventDefault()

Prevents the default behavior associated with the event from taking place.

To see whether an event has a default behavior, check the cancelable property of the event object.

Call the preventDefault() method in the callback function for the event.

The following events have default behaviors: