forked from DefinitelyTyped/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
youtube.d.ts
165 lines (140 loc) · 4.14 KB
/
youtube.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
// Type definitions for YouTube
// Project: https://developers.google.com/youtube/
// Definitions by: Daz Wilkin <https://github.com/DazWilkin/>, Ian Obermiller <http://ianobermiller.com>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
declare module YT {
interface EventArgs {
target: Player;
data: any;
}
interface EventHandler {
(event: EventArgs): void;
}
export interface Events {
onReady?: EventHandler;
onPlayback?: EventHandler;
onStateChange?: EventHandler;
onError?: EventHandler;
}
export enum ListType {
search,
user_uploads,
playlist,
}
export interface PlayerVars {
autohide?: number;
autoplay?: number;
cc_load_policy?: any;
color?: string;
controls?: number;
disablekb?: number;
enablejsapi?: number;
end?: number;
fs?: number;
iv_load_policy?: number;
list?: string;
listType?: ListType;
loop?: number;
modestbranding?: number;
origin?: string;
playerpiid?: string;
playlist?: string[];
playsinline?: number;
rel?: number;
showinfo?: number;
start?: number;
theme?: string;
}
export interface PlayerOptions {
width?: string | number;
height?: string | number;
videoId?: string;
playerVars?: PlayerVars;
events?: Events;
}
interface VideoByIdParams {
videoId: string;
startSeconds?: number;
endSeconds?: number;
suggestedQuality?: string;
}
interface VideoByUrlParams {
mediaContentUrl: string;
startSeconds?: number;
endSeconds?: number;
suggestedQuality?: string;
}
export interface VideoData
{
video_id: string;
author: string;
title: string;
}
export class Player {
// Constructor
constructor(id: string, playerOptions: PlayerOptions);
// Queueing functions
loadVideoById(videoId: string, startSeconds?: number, suggestedQuality?: string): void;
loadVideoById(VideoByIdParams: Object): void;
cueVideoById(videoId: string, startSeconds?: number, suggestedQuality?: string): void;
cueVideoById(VideoByIdParams: Object): void;
loadVideoByUrl(mediaContentUrl: string, startSeconds?: number, suggestedQuality?: string): void;
loadVideoByUrl(VideoByUrlParams: Object): void;
cueVideoByUrl(mediaContentUrl: string, startSeconds?: number, suggestedQuality?: string): void;
cueVideoByUrl(VideoByUrlParams: Object): void;
// Properties
size: any;
// Playing
playVideo(): void;
pauseVideo(): void;
stopVideo(): void;
seekTo(seconds:number, allowSeekAhead:boolean): void;
clearVideo(): void;
// Playlist
nextVideo(): void;
previousVideo(): void;
playVideoAt(index: number): void;
// Volume
mute(): void;
unMute(): void;
isMuted(): boolean;
setVolume(volume: number): void;
getVolume(): number;
// Sizing
setSize(width: number, height: number): any;
// Playback
getPlaybackRate(): number;
setPlaybackRate(suggestedRate:number): void;
getAvailablePlaybackRates(): number[];
// Behavior
setLoop(loopPlaylists: boolean): void;
setShuffle(shufflePlaylist: boolean): void;
// Status
getVideoLoadedFraction(): number;
getPlayerState(): number;
getCurrentTime(): number;
getVideoStartBytes(): number;
getVideoBytesLoaded(): number;
getVideoBytesTotal(): number;
// Information
getDuration(): number;
getVideoUrl(): string;
getVideoEmbedCode(): string;
getVideoData(): VideoData;
// Playlist
getPlaylist(): any[];
getPlaylistIndex(): number;
// Event Listener
addEventListener(event: string, handler: EventHandler): void;
// DOM
destroy(): void;
}
export enum PlayerState {
UNSTARTED,
BUFFERING,
CUED,
ENDED,
PAUSED,
PLAYING
}
}