Skip to main content

Class: YouTubeMediaPlayer

Hierarchy​

  • EventTarget

    ↳ YouTubeMediaPlayer

Constructors​

constructor​

• new YouTubeMediaPlayer(source, metadata, playlist?)

Parameters​

NameType
sourceVideoData
metadataPlayerMetadata
playlist?PlaylistPlayer

Overrides​

EventTarget.constructor

Defined in​

lib/player.ts:28

Properties​

autoPlay​

• Private Optional autoPlay: boolean

Defined in​

lib/player.ts:7

buttons​

• Private Optional buttons: Object

Index signature​

▪ [key: string]: HTMLButtonElement

Defined in​

lib/player.ts:11

changePlayVideo​

• Private Optional changePlayVideo: boolean

Defined in​

lib/player.ts:23

container​

• Private Optional container: HTMLDivElement

Defined in​

lib/player.ts:18

controls​

• Private Optional controls: HTMLDivElement

Defined in​

lib/player.ts:20

duration​

• Private Optional duration: number

Defined in​

lib/player.ts:9

element​

• Private Optional element: HTMLVideoElement

Defined in​

lib/player.ts:5

interval​

• Private Optional interval: Timer

Defined in​

lib/player.ts:16

loop​

• Private Optional loop: boolean

Defined in​

lib/player.ts:6

metadata​

• Private metadata: PlayerMetadata

Defined in​

lib/player.ts:25

playlist​

• Optional playlist: PlaylistPlayer

Defined in​

lib/player.ts:26

poster​

• Private Optional poster: string

Defined in​

lib/player.ts:17

progress​

• Private Optional progress: HTMLInputElement

Defined in​

lib/player.ts:14

showPoster​

• Private Optional showPoster: boolean

Defined in​

lib/player.ts:10

source​

• Private source: VideoData

Defined in​

lib/player.ts:13

sources​

• Private Optional sources: SourceInfo[]

Defined in​

lib/player.ts:8

timer​

• Private Optional timer: Timer

Defined in​

lib/player.ts:15

timerInfo​

• Private Optional timerInfo: HTMLParagraphElement

Defined in​

lib/player.ts:21

title​

• Private Optional title: HTMLParagraphElement

Defined in​

lib/player.ts:22

video​

• Private Optional video: HTMLVideoElement

Defined in​

lib/player.ts:19

Accessors​

isFullscreen​

• get isFullscreen(): boolean

Returns​

boolean

Defined in​

lib/player.ts:722

isPictureInPicture​

• get isPictureInPicture(): boolean

Returns​

boolean

Defined in​

lib/player.ts:726

isPlaying​

• get isPlaying(): boolean

Returns​

boolean

Defined in​

lib/player.ts:730

Methods​

addEventListener​

▸ addEventListener(type, callback, options?): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

Parameters​

NameType
typestring
callbacknull | EventListenerOrEventListenerObject
options?boolean | AddEventListenerOptions

Returns​

void

Inherited from​

EventTarget.addEventListener

Defined in​

docs/node_modules/typescript/lib/lib.dom.d.ts:5154

attachEvents​

▸ Private attachEvents(): void

Returns​

void

Defined in​

lib/player.ts:311

blurTarget​

▸ Private blurTarget(event): void

Parameters​

NameType
eventEvent

Returns​

void

Defined in​

lib/player.ts:522

createControls​

▸ Private createControls(): void

Returns​

void

Defined in​

lib/player.ts:226

createSources​

▸ Private createSources(): HTMLSourceElement[]

Returns​

HTMLSourceElement[]

Defined in​

lib/player.ts:674

createTitle​

▸ Private createTitle(): void

Returns​

void

Defined in​

lib/player.ts:214

createUpdateLoop​

▸ Private createUpdateLoop(): void

Returns​

void

Defined in​

lib/player.ts:664

deleteUpdateLoop​

▸ Private deleteUpdateLoop(): void

Returns​

void

Defined in​

lib/player.ts:670

dispatchEvent​

▸ dispatchEvent(event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters​

NameType
eventEvent

Returns​

boolean

Inherited from​

EventTarget.dispatchEvent

Defined in​

docs/node_modules/typescript/lib/lib.dom.d.ts:5156

dispose​

▸ dispose(): void

Returns​

void

Defined in​

lib/player.ts:734

getFormattedDuration​

▸ Private getFormattedDuration(): string

Returns​

string

Defined in​

lib/player.ts:287

getSourceType​

▸ Private getSourceType(src): string

Parameters​

NameType
srcstring

Returns​

string

Defined in​

lib/player.ts:689

init​

▸ Private init(skip?): Promise<void>

Parameters​

NameType
skip?boolean

Returns​

Promise<void>

Defined in​

lib/player.ts:86

loopEnded​

▸ Private loopEnded(): void

Returns​

void

Defined in​

lib/player.ts:539

noopEvent​

▸ Private noopEvent(event): void

Parameters​

NameType
eventEvent

Returns​

void

Defined in​

lib/player.ts:518

onChangeReady​

▸ Private onChangeReady(): void

Returns​

void

Defined in​

lib/player.ts:78

onFullscreenChange​

▸ Private onFullscreenChange(): void

Returns​

void

Defined in​

lib/player.ts:631

onKeyDown​

▸ Private onKeyDown(event): void

Parameters​

NameType
eventKeyboardEvent

Returns​

void

Defined in​

lib/player.ts:596

onKeyUp​

▸ Private onKeyUp(event): void

Parameters​

NameType
eventKeyboardEvent

Returns​

void

Defined in​

lib/player.ts:624

onPictureInPictureActivate​

▸ Private onPictureInPictureActivate(): void

Returns​

void

Defined in​

lib/player.ts:397

onPictureInPictureDeactivate​

▸ Private onPictureInPictureDeactivate(): void

Returns​

void

Defined in​

lib/player.ts:404

onVideoPause​

▸ Private onVideoPause(): void

Returns​

void

Defined in​

lib/player.ts:504

onVideoPlay​

▸ Private onVideoPlay(): void

Returns​

void

Defined in​

lib/player.ts:497

pause​

▸ pause(): void

Returns​

void

Defined in​

lib/player.ts:592

play​

▸ play(): void

Returns​

void

Defined in​

lib/player.ts:578

removeEventListener​

▸ removeEventListener(type, callback, options?): void

Removes the event listener in target's event listener list with the same type, callback, and options.

Parameters​

NameType
typestring
callbacknull | EventListenerOrEventListenerObject
options?boolean | EventListenerOptions

Returns​

void

Inherited from​

EventTarget.removeEventListener

Defined in​

docs/node_modules/typescript/lib/lib.dom.d.ts:5158

render​

▸ Private render(skip?): void

Parameters​

NameType
skip?boolean

Returns​

void

Defined in​

lib/player.ts:143

resetControlsTimer​

▸ Private resetControlsTimer(): void

Returns​

void

Defined in​

lib/player.ts:408

seekBackward​

▸ Private seekBackward(): void

Returns​

void

Defined in​

lib/player.ts:486

seekForward​

▸ Private seekForward(): void

Returns​

void

Defined in​

lib/player.ts:482

seekTo​

▸ Private seekTo(details): void

Parameters​

NameType
detailsRequired<Pick<MediaSessionActionDetails, "seekTime">> & MediaSessionActionDetails

Returns​

void

Defined in​

lib/player.ts:490

setVideo​

▸ setVideo(data, play?): Promise<void>

Parameters​

NameType
dataVideoData
play?boolean

Returns​

Promise<void>

Defined in​

lib/player.ts:42

setupMetadata​

▸ Private setupMetadata(): void

Returns​

void

Defined in​

lib/player.ts:428

stop​

▸ Private stop(): void

Returns​

void

Defined in​

lib/player.ts:511

timeUpdate​

▸ Private timeUpdate(): void

Returns​

void

Defined in​

lib/player.ts:561

toggleFullscreen​

▸ toggleFullscreen(): void

Returns​

void

Defined in​

lib/player.ts:651

togglePictureInPicture​

▸ togglePictureInPicture(): void

Returns​

void

Defined in​

lib/player.ts:659

togglePlay​

▸ togglePlay(): void

Returns​

void

Defined in​

lib/player.ts:549

triggerAutoPlay​

▸ Private triggerAutoPlay(): void

Returns​

void

Defined in​

lib/player.ts:534

updateGradient​

▸ Private updateGradient(): void

Returns​

void

Defined in​

lib/player.ts:709

updateVideoTime​

▸ Private updateVideoTime(): void

Returns​

void

Defined in​

lib/player.ts:526