Skip to content

Interface: YoutubePlayer ​

Common controls of the native YT.Player returned by youtube.embed(). Playback controls become usable when the player's onReady event fires.

See ​

https://developers.google.com/youtube/iframe_api_reference

Methods ​

cueVideoById() ​

Call Signature ​

ts
cueVideoById(videoId, startSeconds?): void;
Parameters ​
videoId ​

string

startSeconds? ​

number

Returns ​

void

Call Signature ​

ts
cueVideoById(options): void;
Parameters ​
options ​
endSeconds? ​

number

startSeconds? ​

number

videoId ​

string

Returns ​

void


destroy() ​

ts
destroy(): void;

Returns ​

void


getCurrentTime() ​

ts
getCurrentTime(): number;

Returns ​

number


getDuration() ​

ts
getDuration(): number;

Returns ​

number


getIframe() ​

ts
getIframe(): HTMLIFrameElement;

Returns ​

HTMLIFrameElement


getPlayerState() ​

ts
getPlayerState(): YoutubePlayerState;

Returns ​

YoutubePlayerState


getVideoUrl() ​

ts
getVideoUrl(): string;

Returns ​

string


getVolume() ​

ts
getVolume(): number;

Returns ​

number


isMuted() ​

ts
isMuted(): boolean;

Returns ​

boolean


loadVideoById() ​

Call Signature ​

ts
loadVideoById(videoId, startSeconds?): void;
Parameters ​
videoId ​

string

startSeconds? ​

number

Returns ​

void

Call Signature ​

ts
loadVideoById(options): void;
Parameters ​
options ​
endSeconds? ​

number

startSeconds? ​

number

videoId ​

string

Returns ​

void


mute() ​

ts
mute(): void;

Returns ​

void


pauseVideo() ​

ts
pauseVideo(): void;

Returns ​

void


playVideo() ​

ts
playVideo(): void;

Returns ​

void


seekTo() ​

ts
seekTo(seconds, allowSeekAhead): void;

Parameters ​

seconds ​

number

allowSeekAhead ​

boolean

Returns ​

void


setVolume() ​

ts
setVolume(volume): void;

Parameters ​

volume ​

number

Returns ​

void


stopVideo() ​

ts
stopVideo(): void;

Returns ​

void


unMute() ​

ts
unMute(): void;

Returns ​

void