UnmuteNotification

This addon displays an indication for to user to interact with a tap/click to unlock the audio if it’s locked

Props

showUnmuteNotification {boolean} - Should the unmute notification be displayed (based on whether the audio is locked)
location {string} - The location of the unmute notification. Default is “topRight” (see schema below)
isDesktop {boolean} - Used to change the phrasing of the indication (“tap” or “click”)

API

No API.

Events

No events.

parentContainer

root

Schema

"unmutenotification": {
    "type": "object",
    "properties": {
        "location":  { "enum": [null, "topRight", "topLeft", "bottomRight", "bottomLeft", "center"] }
    }
}

Notes

This addon is disabled by default. It needs to explicitly enabled by supplying an object in the plugin options. IE:

{ 
"plugins": {
  "ekoshell": {
    "addons": {
      "unmutenotification": {
        "location": "center"
      }
    }
  }
}
}

While the indication does look like a button visually, it is in fact not intractable. Instead, the tap/click event passes through to the player layer, where in turn the event is caught to enable audio.