Class MuteButton

<theoplayer-mute-button> - A button that toggles whether audio is muted or not.

Attribute

volume-level (readonly) - The volume level of the player. Can be "off" (muted), "low" (volume < 50%) or "high" (volume >= 50%).

Hierarchy

Button<this> & StateReceiverElement<this>
- MuteButton

Constructors

constructor

new MuteButton(): MuteButton
Returns MuteButton
Overrides StateReceiverMixin(Button, ['player']).constructor
- Defined in components/MuteButton.ts:40

Properties

`Optional`activeVideoQuality

activeVideoQuality?: VideoQuality

`Optional`deviceType

deviceType?: DeviceType

`Optional`error

error?: THEOplayerError

`Optional`fullscreen

fullscreen?: boolean

`Optional`playbackRate

playbackRate?: number

`Optional`previewTime

previewTime?: number

`Optional`streamType

streamType?: StreamType

`Optional`targetVideoQualities

targetVideoQualities?: VideoQuality[]

`Readonly`theoplayerUiObservedProperties

theoplayerUiObservedProperties: (keyof StateReceiverPropertyMap)[]

The names of the properties this element will receive.

Accessors

disabled

get disabled(): boolean
Whether the button is disabled.

When disabled, the button cannot be clicked.

Returns boolean
Inherited from StateReceiverMixin(Button, ['player']).disabled
- Defined in components/Button.ts:86
set disabled(disabled: boolean): void
Parameters
- disabled: boolean
Returns void
Inherited from StateReceiverMixin(Button, ['player']).disabled
- Defined in components/Button.ts:90

player

get player(): undefined | ChromelessPlayer
Returns undefined | ChromelessPlayer
Overrides StateReceiverMixin(Button, ['player']).player
- Defined in components/MuteButton.ts:58
set player(player: undefined | ChromelessPlayer): void
Parameters
- player: undefined | ChromelessPlayer
Returns void
Overrides StateReceiverMixin(Button, ['player']).player
- Defined in components/MuteButton.ts:62

volumeLevel

get volumeLevel(): VolumeLevel
The volume level of the player.

Returns VolumeLevel
- Defined in components/MuteButton.ts:54

`Static`observedAttributes

get observedAttributes(): Attribute[]
Returns Attribute[]
Overrides StateReceiverMixin(Button, ['player']).observedAttributes
- Defined in components/MuteButton.ts:34

Methods

`Protected` `Readonly`_onKeyDown

_onKeyDown(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
Inherited from StateReceiverMixin(Button, ['player'])._onKeyDown
- Defined in components/Button.ts:139

`Protected` `Readonly`_onKeyUp

_onKeyUp(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
Inherited from StateReceiverMixin(Button, ['player'])._onKeyUp
- Defined in components/Button.ts:147

`Protected`_upgradeProperty

_upgradeProperty(prop: keyof MuteButton): void
Parameters
- prop: keyof MuteButton
Returns void
Inherited from StateReceiverMixin(Button, ['player'])._upgradeProperty
- Defined in components/Button.ts:49

attributeChangedCallback

attributeChangedCallback(attrName: string, oldValue: any, newValue: any): void
Parameters
- attrName: string
- oldValue: any
- newValue: any
Returns void
Overrides StateReceiverMixin(Button, ['player']).attributeChangedCallback
- Defined in components/MuteButton.ts:99

connectedCallback

connectedCallback(): void
Returns void
Overrides StateReceiverMixin(Button, ['player']).connectedCallback
- Defined in components/MuteButton.ts:45

disconnectedCallback

disconnectedCallback(): void
Returns void
Inherited from StateReceiverMixin(Button, ['player']).disconnectedCallback
- Defined in components/Button.ts:75

`Protected`handleClick

handleClick(): void
Handle a button click.

By default, this does nothing. Subclasses can override this method to add behavior to the button.

Returns void
Overrides StateReceiverMixin(Button, ['player']).handleClick
- Defined in components/MuteButton.ts:92