Class PlayButton

<theoplayer-play-button> - A button that toggles whether the player is playing or paused.

Attribute

paused (readonly) - Whether the player is paused. Reflects ui.player.paused.

Attribute

ended (readonly) - Whether the player is ended. Reflects ui.player.ended.

Hierarchy

Button<this> & StateReceiverElement<this>
- PlayButton

Constructors

constructor

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

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

ended

get ended(): boolean
Returns boolean
- Defined in components/PlayButton.ts:60
set ended(ended: boolean): void
Parameters
- ended: boolean
Returns void
- Defined in components/PlayButton.ts:64

paused

get paused(): boolean
Returns boolean
- Defined in components/PlayButton.ts:52
set paused(paused: boolean): void
Parameters
- paused: boolean
Returns void
- Defined in components/PlayButton.ts:56

player

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

`Static`observedAttributes

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

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 PlayButton): void
Parameters
- prop: keyof PlayButton
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/PlayButton.ts:128

connectedCallback

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

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/PlayButton.ts:114