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

Index

Constructors

Properties

activeVideoQuality? deviceType? error? fullscreen? playbackRate? previewTime? streamType? targetVideoQualities? theoplayerUiObservedProperties

Accessors

disabled player volumeLevel observedAttributes

Methods

_upgradeProperty attributeChangedCallback connectedCallback disconnectedCallback handleClick

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:82
set disabled(disabled): void
Parameters
- disabled: boolean
Returns void
Inherited from StateReceiverMixin(Button, ['player']).disabled
- Defined in components/Button.ts:86

player

get player(): undefined | ChromelessPlayer
Returns undefined | ChromelessPlayer
Overrides StateReceiverMixin(Button, ['player']).player
- Defined in components/MuteButton.ts:58
set player(player): 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` _upgradeProperty

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

attributeChangedCallback

attributeChangedCallback(attrName, oldValue, newValue): 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:73

`Protected` handleClick

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

Generated using TypeDoc