SubtitlesButton

Activates/disables subtitles, or shows the SubtitlesContextMenu addon.

Props

  • icon {string} - The URL for the button icon
  • subtitlesVisible {boolean} - Are subtitles active
  • availableLanguages {object} - A list of available subtitle languages

API

player.ekoshell.SubtitlesButton

Events

  • SUBTITLES_ON: 'ekoshell.button.cc.on'
  • SUBTITLES_OFF: 'ekoshell.button.cc.off

parentContainer

ControlsOverlay_buttonRow

Plugin Options

"volumebutton": {
    "anyOf": [
        {
            "type": "boolean"
        },
        {
            "type": "object",
            "properties": {
                "icon": {
                    "type": "object",
                    "required": [
                        "default",
                        "muted"
                    ],
                    "properties": {
                        "default": {
                            "type": "string",
                            "description": "URL of icon to show for default state"
                        },
                        "muted": {
                            "type": "string",
                            "description": "URL of icon to show for muted state"
                        }
                    }
                },
                "order": {
                    "type": "integer"
                },
                "parentContainer": {
                    "type": "string"
                }
            }
        }
    ]
},

Notes

  • Button should be disabled if overlayed by a different addon (for example, when the ShareScreen addon is visible on top)
Rate this page: X
Tell us more!