youtubei.js / YTNodes / PlayerOverlay

Class: PlayerOverlay

Extends

• YTNode

Constructors

new PlayerOverlay()

new PlayerOverlay(data): PlayerOverlay

Parameters

• data: RawNode

Returns

PlayerOverlay

Overrides

YTNode.constructor

Defined in

src/parser/classes/PlayerOverlay.ts:21

Properties

actions

actions: ObservedArray<YTNode>

Defined in

src/parser/classes/PlayerOverlay.ts:17

---

add_to_menu

add_to_menu: null | Menu

Defined in

src/parser/classes/PlayerOverlay.ts:15

---

autoplay

autoplay: null | PlayerOverlayAutoplay

Defined in

src/parser/classes/PlayerOverlay.ts:13

---

browser_media_session

browser_media_session: null | YTNode

Defined in

src/parser/classes/PlayerOverlay.ts:18

---

decorated_player_bar

decorated_player_bar: null | DecoratedPlayerBar

Defined in

src/parser/classes/PlayerOverlay.ts:19

---

end_screen

end_screen: null | WatchNextEndScreen

Defined in

src/parser/classes/PlayerOverlay.ts:12

---

fullscreen_engagement

fullscreen_engagement: null | YTNode

Defined in

src/parser/classes/PlayerOverlay.ts:16

---

share_button

share_button: null | Button

Defined in

src/parser/classes/PlayerOverlay.ts:14

---

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

---

type

static type: string = 'PlayerOverlay'

Overrides

YTNode.type

Defined in

src/parser/classes/PlayerOverlay.ts:10

Methods

as()

as<T, K>(...types): InstanceType<K[number]>

Cast to one of the given types.

Type Parameters

• T extends YTNode

• K extends YTNodeConstructor<T>[]

Parameters

• ...types: K

Returns

InstanceType<K[number]>

Inherited from

YTNode.as

Defined in

src/parser/helpers.ts:35

---

hasKey()

hasKey<T, R>(key): this is PlayerOverlay & { [k in string]: R }

Check for a key without asserting the type.

Type Parameters

• T extends string

• R = any

Parameters

• key: T

The key to check

Returns

this is PlayerOverlay & { [k in string]: R }

Whether the node has the key

Inherited from

YTNode.hasKey

Defined in

src/parser/helpers.ts:47

---

is()

is<T, K>(...types): this is InstanceType<K[number]>

Check if the node is of the given type.

Type Parameters

• T extends YTNode

• K extends YTNodeConstructor<T>[]

Parameters

• ...types: K

The type to check

Returns

this is InstanceType<K[number]>

whether the node is of the given type

Inherited from

YTNode.is

Defined in

src/parser/helpers.ts:28

---

key()

key<T, R>(key): Maybe

Assert that the node has the given key and return it.

Type Parameters

• T extends string

• R = any

Parameters

• key: T

The key to check

Returns

Maybe

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

YTNode.key

Defined in

src/parser/helpers.ts:57