Class CastButton

A generic button to start and stop casting.

For a concrete implementation, see ChromecastButton and AirPlayButton.

Hierarchy (View Summary)

Button
- CastButton

Index

Constructors

Accessors

castApi castState disabled observedAttributes

Methods

_onKeyDown _onKeyUp _upgradeProperty attributeChangedCallback connectedCallback disconnectedCallback handleClick

Constructors

constructor

new CastButton(options?: ButtonOptions): CastButton
Parameters
- Optionaloptions: ButtonOptions
Returns CastButton
Overrides Button.constructor
- Defined in components/CastButton.ts:19

Accessors

castApi

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

Returns undefined | VendorCast
- Defined in components/CastButton.ts:36
set castApi(castApi: undefined | VendorCast): void
Parameters
- castApi: undefined | VendorCast
Returns void
- Defined in components/CastButton.ts:40

castState

get castState(): CastState
The current cast state.

Returns 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 Button.disabled
- Defined in components/Button.ts:86
set disabled(disabled: boolean): void
Parameters
- disabled: boolean
Returns void
Inherited from Button.disabled
- Defined in components/Button.ts:90

`Static`observedAttributes

get observedAttributes(): Attribute[]
Returns Attribute[]
Overrides Button.observedAttributes
- Defined in components/CastButton.ts:15

Methods

`Protected` `Readonly`_onKeyDown

_onKeyDown(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
Inherited from Button._onKeyDown
- Defined in components/Button.ts:139

`Protected` `Readonly`_onKeyUp

_onKeyUp(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
Inherited from Button._onKeyUp
- Defined in components/Button.ts:147

`Protected`_upgradeProperty

_upgradeProperty(prop: keyof CastButton): void
Parameters
- prop: keyof CastButton
Returns void
Inherited from Button._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 Button.attributeChangedCallback
- Defined in components/CastButton.ts:75

connectedCallback

connectedCallback(): void
Returns void
Overrides Button.connectedCallback
- Defined in components/CastButton.ts:25

disconnectedCallback

disconnectedCallback(): void
Returns void
Inherited from Button.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 Button.handleClick
- Defined in components/CastButton.ts:58