Class AirPlayButton

<theoplayer-airplay-button> - A button to start and stop casting using AirPlay.

Hierarchy

CastButton<this> & StateReceiverElement<this>
- AirPlayButton

Constructors

constructor

new AirPlayButton(): AirPlayButton
Returns AirPlayButton
Overrides StateReceiverMixin(CastButton, ['player']).constructor
- Defined in components/AirPlayButton.ts:20

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

castApi

get castApi(): undefined | VendorCast
The cast API for this cast button.

Returns undefined | VendorCast
Inherited from StateReceiverMixin(CastButton, ['player']).castApi
- Defined in components/CastButton.ts:36
set castApi(castApi): void
Parameters
- castApi: undefined | VendorCast
Returns void
Inherited from StateReceiverMixin(CastButton, ['player']).castApi
- Defined in components/CastButton.ts:40

castState

get castState(): CastState
The current cast state.

Returns CastState
Inherited from StateReceiverMixin(CastButton, ['player']).castState
- Defined in components/CastButton.ts:54

disabled

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

When disabled, the button cannot be clicked.

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

player

get player(): undefined | ChromelessPlayer
Returns undefined | ChromelessPlayer
Overrides StateReceiverMixin(CastButton, ['player']).player
- Defined in components/AirPlayButton.ts:30
set player(player): void
Parameters
- player: undefined | ChromelessPlayer
Returns void
Overrides StateReceiverMixin(CastButton, ['player']).player
- Defined in components/AirPlayButton.ts:34

`Static` observedAttributes

get observedAttributes(): Attribute[]
Returns Attribute[]
Inherited from StateReceiverMixin(CastButton, ['player']).observedAttributes
- Defined in components/CastButton.ts:15

Methods

`Protected` `Readonly` _onKeyDown

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

`Protected` `Readonly` _onKeyUp

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

`Protected` _upgradeProperty

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

attributeChangedCallback

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

connectedCallback

connectedCallback(): void
Returns void
Overrides StateReceiverMixin(CastButton, ['player']).connectedCallback
- Defined in components/AirPlayButton.ts:25

disconnectedCallback

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

`Protected` handleClick

handleClick(): void
Returns void
Inherited from StateReceiverMixin(CastButton, ['player']).handleClick
- Defined in components/CastButton.ts:58

Generated using TypeDoc