@capgo/capacitor-youtube-player 8.2.0 → 8.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +306 -190
- package/dist/docs.json +663 -441
- package/dist/esm/definitions.d.ts +139 -96
- package/dist/esm/web.d.ts +42 -42
- package/dist/esm/web.js +44 -44
- package/dist/esm/web.js.map +1 -1
- package/dist/plugin.cjs.js +44 -44
- package/dist/plugin.cjs.js.map +1 -1
- package/dist/plugin.js +44 -44
- package/dist/plugin.js.map +1 -1
- package/ios/Sources/YoutubePlayerPlugin/YoutubePlayerPlugin.swift +1 -1
- package/package.json +1 -1
package/dist/docs.json
CHANGED
|
@@ -42,19 +42,19 @@
|
|
|
42
42
|
},
|
|
43
43
|
{
|
|
44
44
|
"name": "destroy",
|
|
45
|
-
"signature": "(
|
|
45
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
46
46
|
"parameters": [
|
|
47
47
|
{
|
|
48
|
-
"name": "
|
|
49
|
-
"docs": "-
|
|
50
|
-
"type": "
|
|
48
|
+
"name": "options",
|
|
49
|
+
"docs": "- Player instance options",
|
|
50
|
+
"type": "PlayerIdOptions"
|
|
51
51
|
}
|
|
52
52
|
],
|
|
53
53
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
54
54
|
"tags": [
|
|
55
55
|
{
|
|
56
56
|
"name": "param",
|
|
57
|
-
"text": "
|
|
57
|
+
"text": "options - Player instance options"
|
|
58
58
|
},
|
|
59
59
|
{
|
|
60
60
|
"name": "returns",
|
|
@@ -62,24 +62,26 @@
|
|
|
62
62
|
}
|
|
63
63
|
],
|
|
64
64
|
"docs": "Destroy a player instance and free resources.",
|
|
65
|
-
"complexTypes": [
|
|
65
|
+
"complexTypes": [
|
|
66
|
+
"PlayerIdOptions"
|
|
67
|
+
],
|
|
66
68
|
"slug": "destroy"
|
|
67
69
|
},
|
|
68
70
|
{
|
|
69
71
|
"name": "stopVideo",
|
|
70
|
-
"signature": "(
|
|
72
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
71
73
|
"parameters": [
|
|
72
74
|
{
|
|
73
|
-
"name": "
|
|
74
|
-
"docs": "-
|
|
75
|
-
"type": "
|
|
75
|
+
"name": "options",
|
|
76
|
+
"docs": "- Player instance options",
|
|
77
|
+
"type": "PlayerIdOptions"
|
|
76
78
|
}
|
|
77
79
|
],
|
|
78
80
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
79
81
|
"tags": [
|
|
80
82
|
{
|
|
81
83
|
"name": "param",
|
|
82
|
-
"text": "
|
|
84
|
+
"text": "options - Player instance options"
|
|
83
85
|
},
|
|
84
86
|
{
|
|
85
87
|
"name": "returns",
|
|
@@ -87,24 +89,26 @@
|
|
|
87
89
|
}
|
|
88
90
|
],
|
|
89
91
|
"docs": "Stop video playback and cancel loading.\nUse this sparingly - pauseVideo() is usually preferred.",
|
|
90
|
-
"complexTypes": [
|
|
92
|
+
"complexTypes": [
|
|
93
|
+
"PlayerIdOptions"
|
|
94
|
+
],
|
|
91
95
|
"slug": "stopvideo"
|
|
92
96
|
},
|
|
93
97
|
{
|
|
94
98
|
"name": "playVideo",
|
|
95
|
-
"signature": "(
|
|
99
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
96
100
|
"parameters": [
|
|
97
101
|
{
|
|
98
|
-
"name": "
|
|
99
|
-
"docs": "-
|
|
100
|
-
"type": "
|
|
102
|
+
"name": "options",
|
|
103
|
+
"docs": "- Player instance options",
|
|
104
|
+
"type": "PlayerIdOptions"
|
|
101
105
|
}
|
|
102
106
|
],
|
|
103
107
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
104
108
|
"tags": [
|
|
105
109
|
{
|
|
106
110
|
"name": "param",
|
|
107
|
-
"text": "
|
|
111
|
+
"text": "options - Player instance options"
|
|
108
112
|
},
|
|
109
113
|
{
|
|
110
114
|
"name": "returns",
|
|
@@ -112,24 +116,26 @@
|
|
|
112
116
|
}
|
|
113
117
|
],
|
|
114
118
|
"docs": "Play the currently cued or loaded video.\nFinal player state will be PLAYING (1).",
|
|
115
|
-
"complexTypes": [
|
|
119
|
+
"complexTypes": [
|
|
120
|
+
"PlayerIdOptions"
|
|
121
|
+
],
|
|
116
122
|
"slug": "playvideo"
|
|
117
123
|
},
|
|
118
124
|
{
|
|
119
125
|
"name": "pauseVideo",
|
|
120
|
-
"signature": "(
|
|
126
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
121
127
|
"parameters": [
|
|
122
128
|
{
|
|
123
|
-
"name": "
|
|
124
|
-
"docs": "-
|
|
125
|
-
"type": "
|
|
129
|
+
"name": "options",
|
|
130
|
+
"docs": "- Player instance options",
|
|
131
|
+
"type": "PlayerIdOptions"
|
|
126
132
|
}
|
|
127
133
|
],
|
|
128
134
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
129
135
|
"tags": [
|
|
130
136
|
{
|
|
131
137
|
"name": "param",
|
|
132
|
-
"text": "
|
|
138
|
+
"text": "options - Player instance options"
|
|
133
139
|
},
|
|
134
140
|
{
|
|
135
141
|
"name": "returns",
|
|
@@ -137,42 +143,26 @@
|
|
|
137
143
|
}
|
|
138
144
|
],
|
|
139
145
|
"docs": "Pause the currently playing video.\nFinal player state will be PAUSED (2), unless already ENDED (0).",
|
|
140
|
-
"complexTypes": [
|
|
146
|
+
"complexTypes": [
|
|
147
|
+
"PlayerIdOptions"
|
|
148
|
+
],
|
|
141
149
|
"slug": "pausevideo"
|
|
142
150
|
},
|
|
143
151
|
{
|
|
144
152
|
"name": "seekTo",
|
|
145
|
-
"signature": "(
|
|
153
|
+
"signature": "(options: SeekToOptions) => Promise<{ result: { method: string; value: boolean; seconds: number; allowSeekAhead: boolean; }; }>",
|
|
146
154
|
"parameters": [
|
|
147
155
|
{
|
|
148
|
-
"name": "
|
|
149
|
-
"docs": "-
|
|
150
|
-
"type": "
|
|
151
|
-
},
|
|
152
|
-
{
|
|
153
|
-
"name": "seconds",
|
|
154
|
-
"docs": "- Time to seek to (in seconds)",
|
|
155
|
-
"type": "number"
|
|
156
|
-
},
|
|
157
|
-
{
|
|
158
|
-
"name": "allowSeekAhead",
|
|
159
|
-
"docs": "- Whether to make a new request to server if not buffered",
|
|
160
|
-
"type": "boolean"
|
|
156
|
+
"name": "options",
|
|
157
|
+
"docs": "- Player seek options",
|
|
158
|
+
"type": "SeekToOptions"
|
|
161
159
|
}
|
|
162
160
|
],
|
|
163
161
|
"returns": "Promise<{ result: { method: string; value: boolean; seconds: number; allowSeekAhead: boolean; }; }>",
|
|
164
162
|
"tags": [
|
|
165
163
|
{
|
|
166
164
|
"name": "param",
|
|
167
|
-
"text": "
|
|
168
|
-
},
|
|
169
|
-
{
|
|
170
|
-
"name": "param",
|
|
171
|
-
"text": "seconds - Time to seek to (in seconds)"
|
|
172
|
-
},
|
|
173
|
-
{
|
|
174
|
-
"name": "param",
|
|
175
|
-
"text": "allowSeekAhead - Whether to make a new request to server if not buffered"
|
|
165
|
+
"text": "options - Player seek options"
|
|
176
166
|
},
|
|
177
167
|
{
|
|
178
168
|
"name": "returns",
|
|
@@ -180,30 +170,23 @@
|
|
|
180
170
|
}
|
|
181
171
|
],
|
|
182
172
|
"docs": "Seek to a specific time in the video.\nIf player is paused, it remains paused. If playing, continues playing.",
|
|
183
|
-
"complexTypes": [
|
|
173
|
+
"complexTypes": [
|
|
174
|
+
"SeekToOptions"
|
|
175
|
+
],
|
|
184
176
|
"slug": "seekto"
|
|
185
177
|
},
|
|
186
178
|
{
|
|
187
179
|
"name": "loadVideoById",
|
|
188
|
-
"signature": "(
|
|
180
|
+
"signature": "(options: VideoByIdMethodOptions) => Promise<{ result: { method: string; value: boolean; options: IVideoOptionsById; }; }>",
|
|
189
181
|
"parameters": [
|
|
190
|
-
{
|
|
191
|
-
"name": "playerId",
|
|
192
|
-
"docs": "- ID of the player",
|
|
193
|
-
"type": "string"
|
|
194
|
-
},
|
|
195
182
|
{
|
|
196
183
|
"name": "options",
|
|
197
184
|
"docs": "- Video loading options (ID, start time, quality, etc.)",
|
|
198
|
-
"type": "
|
|
185
|
+
"type": "VideoByIdMethodOptions"
|
|
199
186
|
}
|
|
200
187
|
],
|
|
201
188
|
"returns": "Promise<{ result: { method: string; value: boolean; options: IVideoOptionsById; }; }>",
|
|
202
189
|
"tags": [
|
|
203
|
-
{
|
|
204
|
-
"name": "param",
|
|
205
|
-
"text": "playerId - ID of the player"
|
|
206
|
-
},
|
|
207
190
|
{
|
|
208
191
|
"name": "param",
|
|
209
192
|
"text": "options - Video loading options (ID, start time, quality, etc.)"
|
|
@@ -215,31 +198,23 @@
|
|
|
215
198
|
],
|
|
216
199
|
"docs": "Load and play a video by its YouTube ID.",
|
|
217
200
|
"complexTypes": [
|
|
218
|
-
"IVideoOptionsById"
|
|
201
|
+
"IVideoOptionsById",
|
|
202
|
+
"VideoByIdMethodOptions"
|
|
219
203
|
],
|
|
220
204
|
"slug": "loadvideobyid"
|
|
221
205
|
},
|
|
222
206
|
{
|
|
223
207
|
"name": "cueVideoById",
|
|
224
|
-
"signature": "(
|
|
208
|
+
"signature": "(options: VideoByIdMethodOptions) => Promise<{ result: { method: string; value: boolean; options: IVideoOptionsById; }; }>",
|
|
225
209
|
"parameters": [
|
|
226
|
-
{
|
|
227
|
-
"name": "playerId",
|
|
228
|
-
"docs": "- ID of the player",
|
|
229
|
-
"type": "string"
|
|
230
|
-
},
|
|
231
210
|
{
|
|
232
211
|
"name": "options",
|
|
233
212
|
"docs": "- Video cuing options (ID, start time, quality, etc.)",
|
|
234
|
-
"type": "
|
|
213
|
+
"type": "VideoByIdMethodOptions"
|
|
235
214
|
}
|
|
236
215
|
],
|
|
237
216
|
"returns": "Promise<{ result: { method: string; value: boolean; options: IVideoOptionsById; }; }>",
|
|
238
217
|
"tags": [
|
|
239
|
-
{
|
|
240
|
-
"name": "param",
|
|
241
|
-
"text": "playerId - ID of the player"
|
|
242
|
-
},
|
|
243
218
|
{
|
|
244
219
|
"name": "param",
|
|
245
220
|
"text": "options - Video cuing options (ID, start time, quality, etc.)"
|
|
@@ -251,31 +226,23 @@
|
|
|
251
226
|
],
|
|
252
227
|
"docs": "Cue a video by ID without playing it.\nLoads thumbnail and prepares player, but doesn't request video until playVideo() called.",
|
|
253
228
|
"complexTypes": [
|
|
254
|
-
"IVideoOptionsById"
|
|
229
|
+
"IVideoOptionsById",
|
|
230
|
+
"VideoByIdMethodOptions"
|
|
255
231
|
],
|
|
256
232
|
"slug": "cuevideobyid"
|
|
257
233
|
},
|
|
258
234
|
{
|
|
259
235
|
"name": "loadVideoByUrl",
|
|
260
|
-
"signature": "(
|
|
236
|
+
"signature": "(options: VideoByUrlMethodOptions) => Promise<{ result: { method: string; value: boolean; options: IVideoOptionsByUrl; }; }>",
|
|
261
237
|
"parameters": [
|
|
262
|
-
{
|
|
263
|
-
"name": "playerId",
|
|
264
|
-
"docs": "- ID of the player",
|
|
265
|
-
"type": "string"
|
|
266
|
-
},
|
|
267
238
|
{
|
|
268
239
|
"name": "options",
|
|
269
240
|
"docs": "- Video loading options including media URL",
|
|
270
|
-
"type": "
|
|
241
|
+
"type": "VideoByUrlMethodOptions"
|
|
271
242
|
}
|
|
272
243
|
],
|
|
273
244
|
"returns": "Promise<{ result: { method: string; value: boolean; options: IVideoOptionsByUrl; }; }>",
|
|
274
245
|
"tags": [
|
|
275
|
-
{
|
|
276
|
-
"name": "param",
|
|
277
|
-
"text": "playerId - ID of the player"
|
|
278
|
-
},
|
|
279
246
|
{
|
|
280
247
|
"name": "param",
|
|
281
248
|
"text": "options - Video loading options including media URL"
|
|
@@ -287,31 +254,23 @@
|
|
|
287
254
|
],
|
|
288
255
|
"docs": "Load and play a video by its full URL.",
|
|
289
256
|
"complexTypes": [
|
|
290
|
-
"IVideoOptionsByUrl"
|
|
257
|
+
"IVideoOptionsByUrl",
|
|
258
|
+
"VideoByUrlMethodOptions"
|
|
291
259
|
],
|
|
292
260
|
"slug": "loadvideobyurl"
|
|
293
261
|
},
|
|
294
262
|
{
|
|
295
263
|
"name": "cueVideoByUrl",
|
|
296
|
-
"signature": "(
|
|
264
|
+
"signature": "(options: VideoByUrlMethodOptions) => Promise<{ result: { method: string; value: boolean; options: IVideoOptionsByUrl; }; }>",
|
|
297
265
|
"parameters": [
|
|
298
|
-
{
|
|
299
|
-
"name": "playerId",
|
|
300
|
-
"docs": "- ID of the player",
|
|
301
|
-
"type": "string"
|
|
302
|
-
},
|
|
303
266
|
{
|
|
304
267
|
"name": "options",
|
|
305
268
|
"docs": "- Video cuing options including media URL",
|
|
306
|
-
"type": "
|
|
269
|
+
"type": "VideoByUrlMethodOptions"
|
|
307
270
|
}
|
|
308
271
|
],
|
|
309
272
|
"returns": "Promise<{ result: { method: string; value: boolean; options: IVideoOptionsByUrl; }; }>",
|
|
310
273
|
"tags": [
|
|
311
|
-
{
|
|
312
|
-
"name": "param",
|
|
313
|
-
"text": "playerId - ID of the player"
|
|
314
|
-
},
|
|
315
274
|
{
|
|
316
275
|
"name": "param",
|
|
317
276
|
"text": "options - Video cuing options including media URL"
|
|
@@ -323,31 +282,23 @@
|
|
|
323
282
|
],
|
|
324
283
|
"docs": "Cue a video by URL without playing it.",
|
|
325
284
|
"complexTypes": [
|
|
326
|
-
"IVideoOptionsByUrl"
|
|
285
|
+
"IVideoOptionsByUrl",
|
|
286
|
+
"VideoByUrlMethodOptions"
|
|
327
287
|
],
|
|
328
288
|
"slug": "cuevideobyurl"
|
|
329
289
|
},
|
|
330
290
|
{
|
|
331
291
|
"name": "cuePlaylist",
|
|
332
|
-
"signature": "(
|
|
292
|
+
"signature": "(options: PlaylistMethodOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
333
293
|
"parameters": [
|
|
334
294
|
{
|
|
335
|
-
"name": "
|
|
336
|
-
"docs": "
|
|
337
|
-
"type": "
|
|
338
|
-
},
|
|
339
|
-
{
|
|
340
|
-
"name": "playlistOptions",
|
|
341
|
-
"docs": "- Playlist configuration (type, ID, index, etc.)",
|
|
342
|
-
"type": "IPlaylistOptions"
|
|
295
|
+
"name": "options",
|
|
296
|
+
"docs": "",
|
|
297
|
+
"type": "PlaylistMethodOptions"
|
|
343
298
|
}
|
|
344
299
|
],
|
|
345
300
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
346
301
|
"tags": [
|
|
347
|
-
{
|
|
348
|
-
"name": "param",
|
|
349
|
-
"text": "playerId - ID of the player"
|
|
350
|
-
},
|
|
351
302
|
{
|
|
352
303
|
"name": "param",
|
|
353
304
|
"text": "playlistOptions - Playlist configuration (type, ID, index, etc.)"
|
|
@@ -359,31 +310,22 @@
|
|
|
359
310
|
],
|
|
360
311
|
"docs": "Cue a playlist without playing it.\nLoads playlist and prepares first video.",
|
|
361
312
|
"complexTypes": [
|
|
362
|
-
"
|
|
313
|
+
"PlaylistMethodOptions"
|
|
363
314
|
],
|
|
364
315
|
"slug": "cueplaylist"
|
|
365
316
|
},
|
|
366
317
|
{
|
|
367
318
|
"name": "loadPlaylist",
|
|
368
|
-
"signature": "(
|
|
319
|
+
"signature": "(options: PlaylistMethodOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
369
320
|
"parameters": [
|
|
370
321
|
{
|
|
371
|
-
"name": "
|
|
372
|
-
"docs": "
|
|
373
|
-
"type": "
|
|
374
|
-
},
|
|
375
|
-
{
|
|
376
|
-
"name": "playlistOptions",
|
|
377
|
-
"docs": "- Playlist configuration (type, ID, index, etc.)",
|
|
378
|
-
"type": "IPlaylistOptions"
|
|
322
|
+
"name": "options",
|
|
323
|
+
"docs": "",
|
|
324
|
+
"type": "PlaylistMethodOptions"
|
|
379
325
|
}
|
|
380
326
|
],
|
|
381
327
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
382
328
|
"tags": [
|
|
383
|
-
{
|
|
384
|
-
"name": "param",
|
|
385
|
-
"text": "playerId - ID of the player"
|
|
386
|
-
},
|
|
387
329
|
{
|
|
388
330
|
"name": "param",
|
|
389
331
|
"text": "playlistOptions - Playlist configuration (type, ID, index, etc.)"
|
|
@@ -395,25 +337,25 @@
|
|
|
395
337
|
],
|
|
396
338
|
"docs": "Load and play a playlist.",
|
|
397
339
|
"complexTypes": [
|
|
398
|
-
"
|
|
340
|
+
"PlaylistMethodOptions"
|
|
399
341
|
],
|
|
400
342
|
"slug": "loadplaylist"
|
|
401
343
|
},
|
|
402
344
|
{
|
|
403
345
|
"name": "nextVideo",
|
|
404
|
-
"signature": "(
|
|
346
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
405
347
|
"parameters": [
|
|
406
348
|
{
|
|
407
|
-
"name": "
|
|
408
|
-
"docs": "-
|
|
409
|
-
"type": "
|
|
349
|
+
"name": "options",
|
|
350
|
+
"docs": "- Player instance options",
|
|
351
|
+
"type": "PlayerIdOptions"
|
|
410
352
|
}
|
|
411
353
|
],
|
|
412
354
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
413
355
|
"tags": [
|
|
414
356
|
{
|
|
415
357
|
"name": "param",
|
|
416
|
-
"text": "
|
|
358
|
+
"text": "options - Player instance options"
|
|
417
359
|
},
|
|
418
360
|
{
|
|
419
361
|
"name": "returns",
|
|
@@ -421,24 +363,26 @@
|
|
|
421
363
|
}
|
|
422
364
|
],
|
|
423
365
|
"docs": "Play the next video in the playlist.",
|
|
424
|
-
"complexTypes": [
|
|
366
|
+
"complexTypes": [
|
|
367
|
+
"PlayerIdOptions"
|
|
368
|
+
],
|
|
425
369
|
"slug": "nextvideo"
|
|
426
370
|
},
|
|
427
371
|
{
|
|
428
372
|
"name": "previousVideo",
|
|
429
|
-
"signature": "(
|
|
373
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
430
374
|
"parameters": [
|
|
431
375
|
{
|
|
432
|
-
"name": "
|
|
433
|
-
"docs": "-
|
|
434
|
-
"type": "
|
|
376
|
+
"name": "options",
|
|
377
|
+
"docs": "- Player instance options",
|
|
378
|
+
"type": "PlayerIdOptions"
|
|
435
379
|
}
|
|
436
380
|
],
|
|
437
381
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
438
382
|
"tags": [
|
|
439
383
|
{
|
|
440
384
|
"name": "param",
|
|
441
|
-
"text": "
|
|
385
|
+
"text": "options - Player instance options"
|
|
442
386
|
},
|
|
443
387
|
{
|
|
444
388
|
"name": "returns",
|
|
@@ -446,33 +390,26 @@
|
|
|
446
390
|
}
|
|
447
391
|
],
|
|
448
392
|
"docs": "Play the previous video in the playlist.",
|
|
449
|
-
"complexTypes": [
|
|
393
|
+
"complexTypes": [
|
|
394
|
+
"PlayerIdOptions"
|
|
395
|
+
],
|
|
450
396
|
"slug": "previousvideo"
|
|
451
397
|
},
|
|
452
398
|
{
|
|
453
399
|
"name": "playVideoAt",
|
|
454
|
-
"signature": "(
|
|
400
|
+
"signature": "(options: PlayVideoAtOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
455
401
|
"parameters": [
|
|
456
402
|
{
|
|
457
|
-
"name": "
|
|
458
|
-
"docs": "-
|
|
459
|
-
"type": "
|
|
460
|
-
},
|
|
461
|
-
{
|
|
462
|
-
"name": "index",
|
|
463
|
-
"docs": "- Zero-based index of the video to play",
|
|
464
|
-
"type": "number"
|
|
403
|
+
"name": "options",
|
|
404
|
+
"docs": "- Player playlist navigation options",
|
|
405
|
+
"type": "PlayVideoAtOptions"
|
|
465
406
|
}
|
|
466
407
|
],
|
|
467
408
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
468
409
|
"tags": [
|
|
469
410
|
{
|
|
470
411
|
"name": "param",
|
|
471
|
-
"text": "
|
|
472
|
-
},
|
|
473
|
-
{
|
|
474
|
-
"name": "param",
|
|
475
|
-
"text": "index - Zero-based index of the video to play"
|
|
412
|
+
"text": "options - Player playlist navigation options"
|
|
476
413
|
},
|
|
477
414
|
{
|
|
478
415
|
"name": "returns",
|
|
@@ -480,24 +417,26 @@
|
|
|
480
417
|
}
|
|
481
418
|
],
|
|
482
419
|
"docs": "Play a specific video in the playlist by index.",
|
|
483
|
-
"complexTypes": [
|
|
420
|
+
"complexTypes": [
|
|
421
|
+
"PlayVideoAtOptions"
|
|
422
|
+
],
|
|
484
423
|
"slug": "playvideoat"
|
|
485
424
|
},
|
|
486
425
|
{
|
|
487
426
|
"name": "mute",
|
|
488
|
-
"signature": "(
|
|
427
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
489
428
|
"parameters": [
|
|
490
429
|
{
|
|
491
|
-
"name": "
|
|
492
|
-
"docs": "-
|
|
493
|
-
"type": "
|
|
430
|
+
"name": "options",
|
|
431
|
+
"docs": "- Player instance options",
|
|
432
|
+
"type": "PlayerIdOptions"
|
|
494
433
|
}
|
|
495
434
|
],
|
|
496
435
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
497
436
|
"tags": [
|
|
498
437
|
{
|
|
499
438
|
"name": "param",
|
|
500
|
-
"text": "
|
|
439
|
+
"text": "options - Player instance options"
|
|
501
440
|
},
|
|
502
441
|
{
|
|
503
442
|
"name": "returns",
|
|
@@ -505,24 +444,26 @@
|
|
|
505
444
|
}
|
|
506
445
|
],
|
|
507
446
|
"docs": "Mute the player audio.",
|
|
508
|
-
"complexTypes": [
|
|
447
|
+
"complexTypes": [
|
|
448
|
+
"PlayerIdOptions"
|
|
449
|
+
],
|
|
509
450
|
"slug": "mute"
|
|
510
451
|
},
|
|
511
452
|
{
|
|
512
453
|
"name": "unMute",
|
|
513
|
-
"signature": "(
|
|
454
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
514
455
|
"parameters": [
|
|
515
456
|
{
|
|
516
|
-
"name": "
|
|
517
|
-
"docs": "-
|
|
518
|
-
"type": "
|
|
457
|
+
"name": "options",
|
|
458
|
+
"docs": "- Player instance options",
|
|
459
|
+
"type": "PlayerIdOptions"
|
|
519
460
|
}
|
|
520
461
|
],
|
|
521
462
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
522
463
|
"tags": [
|
|
523
464
|
{
|
|
524
465
|
"name": "param",
|
|
525
|
-
"text": "
|
|
466
|
+
"text": "options - Player instance options"
|
|
526
467
|
},
|
|
527
468
|
{
|
|
528
469
|
"name": "returns",
|
|
@@ -530,24 +471,26 @@
|
|
|
530
471
|
}
|
|
531
472
|
],
|
|
532
473
|
"docs": "Unmute the player audio.",
|
|
533
|
-
"complexTypes": [
|
|
474
|
+
"complexTypes": [
|
|
475
|
+
"PlayerIdOptions"
|
|
476
|
+
],
|
|
534
477
|
"slug": "unmute"
|
|
535
478
|
},
|
|
536
479
|
{
|
|
537
480
|
"name": "isMuted",
|
|
538
|
-
"signature": "(
|
|
481
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
539
482
|
"parameters": [
|
|
540
483
|
{
|
|
541
|
-
"name": "
|
|
542
|
-
"docs": "-
|
|
543
|
-
"type": "
|
|
484
|
+
"name": "options",
|
|
485
|
+
"docs": "- Player instance options",
|
|
486
|
+
"type": "PlayerIdOptions"
|
|
544
487
|
}
|
|
545
488
|
],
|
|
546
489
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
547
490
|
"tags": [
|
|
548
491
|
{
|
|
549
492
|
"name": "param",
|
|
550
|
-
"text": "
|
|
493
|
+
"text": "options - Player instance options"
|
|
551
494
|
},
|
|
552
495
|
{
|
|
553
496
|
"name": "returns",
|
|
@@ -555,33 +498,26 @@
|
|
|
555
498
|
}
|
|
556
499
|
],
|
|
557
500
|
"docs": "Check if the player is currently muted.",
|
|
558
|
-
"complexTypes": [
|
|
501
|
+
"complexTypes": [
|
|
502
|
+
"PlayerIdOptions"
|
|
503
|
+
],
|
|
559
504
|
"slug": "ismuted"
|
|
560
505
|
},
|
|
561
506
|
{
|
|
562
507
|
"name": "setVolume",
|
|
563
|
-
"signature": "(
|
|
508
|
+
"signature": "(options: SetVolumeOptions) => Promise<{ result: { method: string; value: number; }; }>",
|
|
564
509
|
"parameters": [
|
|
565
510
|
{
|
|
566
|
-
"name": "
|
|
567
|
-
"docs": "-
|
|
568
|
-
"type": "
|
|
569
|
-
},
|
|
570
|
-
{
|
|
571
|
-
"name": "volume",
|
|
572
|
-
"docs": "- Volume level from 0 (silent) to 100 (max)",
|
|
573
|
-
"type": "number"
|
|
511
|
+
"name": "options",
|
|
512
|
+
"docs": "- Player volume options",
|
|
513
|
+
"type": "SetVolumeOptions"
|
|
574
514
|
}
|
|
575
515
|
],
|
|
576
516
|
"returns": "Promise<{ result: { method: string; value: number; }; }>",
|
|
577
517
|
"tags": [
|
|
578
518
|
{
|
|
579
519
|
"name": "param",
|
|
580
|
-
"text": "
|
|
581
|
-
},
|
|
582
|
-
{
|
|
583
|
-
"name": "param",
|
|
584
|
-
"text": "volume - Volume level from 0 (silent) to 100 (max)"
|
|
520
|
+
"text": "options - Player volume options"
|
|
585
521
|
},
|
|
586
522
|
{
|
|
587
523
|
"name": "returns",
|
|
@@ -589,24 +525,26 @@
|
|
|
589
525
|
}
|
|
590
526
|
],
|
|
591
527
|
"docs": "Set the player volume level.",
|
|
592
|
-
"complexTypes": [
|
|
528
|
+
"complexTypes": [
|
|
529
|
+
"SetVolumeOptions"
|
|
530
|
+
],
|
|
593
531
|
"slug": "setvolume"
|
|
594
532
|
},
|
|
595
533
|
{
|
|
596
534
|
"name": "getVolume",
|
|
597
|
-
"signature": "(
|
|
535
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: number; }; }>",
|
|
598
536
|
"parameters": [
|
|
599
537
|
{
|
|
600
|
-
"name": "
|
|
601
|
-
"docs": "-
|
|
602
|
-
"type": "
|
|
538
|
+
"name": "options",
|
|
539
|
+
"docs": "- Player instance options",
|
|
540
|
+
"type": "PlayerIdOptions"
|
|
603
541
|
}
|
|
604
542
|
],
|
|
605
543
|
"returns": "Promise<{ result: { method: string; value: number; }; }>",
|
|
606
544
|
"tags": [
|
|
607
545
|
{
|
|
608
546
|
"name": "param",
|
|
609
|
-
"text": "
|
|
547
|
+
"text": "options - Player instance options"
|
|
610
548
|
},
|
|
611
549
|
{
|
|
612
550
|
"name": "returns",
|
|
@@ -614,42 +552,26 @@
|
|
|
614
552
|
}
|
|
615
553
|
],
|
|
616
554
|
"docs": "Get the current player volume level.\nReturns volume even if player is muted.",
|
|
617
|
-
"complexTypes": [
|
|
555
|
+
"complexTypes": [
|
|
556
|
+
"PlayerIdOptions"
|
|
557
|
+
],
|
|
618
558
|
"slug": "getvolume"
|
|
619
559
|
},
|
|
620
560
|
{
|
|
621
561
|
"name": "setSize",
|
|
622
|
-
"signature": "(
|
|
562
|
+
"signature": "(options: SetSizeOptions) => Promise<{ result: { method: string; value: { width: number; height: number; }; }; }>",
|
|
623
563
|
"parameters": [
|
|
624
564
|
{
|
|
625
|
-
"name": "
|
|
626
|
-
"docs": "-
|
|
627
|
-
"type": "
|
|
628
|
-
},
|
|
629
|
-
{
|
|
630
|
-
"name": "width",
|
|
631
|
-
"docs": "- Width in pixels",
|
|
632
|
-
"type": "number"
|
|
633
|
-
},
|
|
634
|
-
{
|
|
635
|
-
"name": "height",
|
|
636
|
-
"docs": "- Height in pixels",
|
|
637
|
-
"type": "number"
|
|
565
|
+
"name": "options",
|
|
566
|
+
"docs": "- Player size options",
|
|
567
|
+
"type": "SetSizeOptions"
|
|
638
568
|
}
|
|
639
569
|
],
|
|
640
570
|
"returns": "Promise<{ result: { method: string; value: { width: number; height: number; }; }; }>",
|
|
641
571
|
"tags": [
|
|
642
572
|
{
|
|
643
573
|
"name": "param",
|
|
644
|
-
"text": "
|
|
645
|
-
},
|
|
646
|
-
{
|
|
647
|
-
"name": "param",
|
|
648
|
-
"text": "width - Width in pixels"
|
|
649
|
-
},
|
|
650
|
-
{
|
|
651
|
-
"name": "param",
|
|
652
|
-
"text": "height - Height in pixels"
|
|
574
|
+
"text": "options - Player size options"
|
|
653
575
|
},
|
|
654
576
|
{
|
|
655
577
|
"name": "returns",
|
|
@@ -657,24 +579,26 @@
|
|
|
657
579
|
}
|
|
658
580
|
],
|
|
659
581
|
"docs": "Set the player dimensions in pixels.",
|
|
660
|
-
"complexTypes": [
|
|
582
|
+
"complexTypes": [
|
|
583
|
+
"SetSizeOptions"
|
|
584
|
+
],
|
|
661
585
|
"slug": "setsize"
|
|
662
586
|
},
|
|
663
587
|
{
|
|
664
588
|
"name": "getPlaybackRate",
|
|
665
|
-
"signature": "(
|
|
589
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: number; }; }>",
|
|
666
590
|
"parameters": [
|
|
667
591
|
{
|
|
668
|
-
"name": "
|
|
669
|
-
"docs": "-
|
|
670
|
-
"type": "
|
|
592
|
+
"name": "options",
|
|
593
|
+
"docs": "- Player instance options",
|
|
594
|
+
"type": "PlayerIdOptions"
|
|
671
595
|
}
|
|
672
596
|
],
|
|
673
597
|
"returns": "Promise<{ result: { method: string; value: number; }; }>",
|
|
674
598
|
"tags": [
|
|
675
599
|
{
|
|
676
600
|
"name": "param",
|
|
677
|
-
"text": "
|
|
601
|
+
"text": "options - Player instance options"
|
|
678
602
|
},
|
|
679
603
|
{
|
|
680
604
|
"name": "returns",
|
|
@@ -682,33 +606,26 @@
|
|
|
682
606
|
}
|
|
683
607
|
],
|
|
684
608
|
"docs": "Get the current playback rate.",
|
|
685
|
-
"complexTypes": [
|
|
609
|
+
"complexTypes": [
|
|
610
|
+
"PlayerIdOptions"
|
|
611
|
+
],
|
|
686
612
|
"slug": "getplaybackrate"
|
|
687
613
|
},
|
|
688
614
|
{
|
|
689
615
|
"name": "setPlaybackRate",
|
|
690
|
-
"signature": "(
|
|
616
|
+
"signature": "(options: SetPlaybackRateOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
691
617
|
"parameters": [
|
|
692
618
|
{
|
|
693
|
-
"name": "
|
|
694
|
-
"docs": "-
|
|
695
|
-
"type": "
|
|
696
|
-
},
|
|
697
|
-
{
|
|
698
|
-
"name": "suggestedRate",
|
|
699
|
-
"docs": "- Desired playback rate (0.25 to 2.0)",
|
|
700
|
-
"type": "number"
|
|
619
|
+
"name": "options",
|
|
620
|
+
"docs": "- Playback rate options",
|
|
621
|
+
"type": "SetPlaybackRateOptions"
|
|
701
622
|
}
|
|
702
623
|
],
|
|
703
624
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
704
625
|
"tags": [
|
|
705
626
|
{
|
|
706
627
|
"name": "param",
|
|
707
|
-
"text": "
|
|
708
|
-
},
|
|
709
|
-
{
|
|
710
|
-
"name": "param",
|
|
711
|
-
"text": "suggestedRate - Desired playback rate (0.25 to 2.0)"
|
|
628
|
+
"text": "options - Playback rate options"
|
|
712
629
|
},
|
|
713
630
|
{
|
|
714
631
|
"name": "returns",
|
|
@@ -716,24 +633,26 @@
|
|
|
716
633
|
}
|
|
717
634
|
],
|
|
718
635
|
"docs": "Set the playback speed.",
|
|
719
|
-
"complexTypes": [
|
|
636
|
+
"complexTypes": [
|
|
637
|
+
"SetPlaybackRateOptions"
|
|
638
|
+
],
|
|
720
639
|
"slug": "setplaybackrate"
|
|
721
640
|
},
|
|
722
641
|
{
|
|
723
642
|
"name": "getAvailablePlaybackRates",
|
|
724
|
-
"signature": "(
|
|
643
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: number[]; }; }>",
|
|
725
644
|
"parameters": [
|
|
726
645
|
{
|
|
727
|
-
"name": "
|
|
728
|
-
"docs": "-
|
|
729
|
-
"type": "
|
|
646
|
+
"name": "options",
|
|
647
|
+
"docs": "- Player instance options",
|
|
648
|
+
"type": "PlayerIdOptions"
|
|
730
649
|
}
|
|
731
650
|
],
|
|
732
651
|
"returns": "Promise<{ result: { method: string; value: number[]; }; }>",
|
|
733
652
|
"tags": [
|
|
734
653
|
{
|
|
735
654
|
"name": "param",
|
|
736
|
-
"text": "
|
|
655
|
+
"text": "options - Player instance options"
|
|
737
656
|
},
|
|
738
657
|
{
|
|
739
658
|
"name": "returns",
|
|
@@ -741,33 +660,26 @@
|
|
|
741
660
|
}
|
|
742
661
|
],
|
|
743
662
|
"docs": "Get list of available playback rates for current video.",
|
|
744
|
-
"complexTypes": [
|
|
663
|
+
"complexTypes": [
|
|
664
|
+
"PlayerIdOptions"
|
|
665
|
+
],
|
|
745
666
|
"slug": "getavailableplaybackrates"
|
|
746
667
|
},
|
|
747
668
|
{
|
|
748
669
|
"name": "setLoop",
|
|
749
|
-
"signature": "(
|
|
670
|
+
"signature": "(options: SetLoopOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
750
671
|
"parameters": [
|
|
751
672
|
{
|
|
752
|
-
"name": "
|
|
753
|
-
"docs": "-
|
|
754
|
-
"type": "
|
|
755
|
-
},
|
|
756
|
-
{
|
|
757
|
-
"name": "loopPlaylists",
|
|
758
|
-
"docs": "- true to loop, false to stop after last video",
|
|
759
|
-
"type": "boolean"
|
|
673
|
+
"name": "options",
|
|
674
|
+
"docs": "- Playlist loop options",
|
|
675
|
+
"type": "SetLoopOptions"
|
|
760
676
|
}
|
|
761
677
|
],
|
|
762
678
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
763
679
|
"tags": [
|
|
764
680
|
{
|
|
765
681
|
"name": "param",
|
|
766
|
-
"text": "
|
|
767
|
-
},
|
|
768
|
-
{
|
|
769
|
-
"name": "param",
|
|
770
|
-
"text": "loopPlaylists - true to loop, false to stop after last video"
|
|
682
|
+
"text": "options - Playlist loop options"
|
|
771
683
|
},
|
|
772
684
|
{
|
|
773
685
|
"name": "returns",
|
|
@@ -775,33 +687,26 @@
|
|
|
775
687
|
}
|
|
776
688
|
],
|
|
777
689
|
"docs": "Enable or disable playlist looping.\nWhen enabled, playlist will restart from beginning after last video.",
|
|
778
|
-
"complexTypes": [
|
|
690
|
+
"complexTypes": [
|
|
691
|
+
"SetLoopOptions"
|
|
692
|
+
],
|
|
779
693
|
"slug": "setloop"
|
|
780
694
|
},
|
|
781
695
|
{
|
|
782
696
|
"name": "setShuffle",
|
|
783
|
-
"signature": "(
|
|
697
|
+
"signature": "(options: SetShuffleOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
784
698
|
"parameters": [
|
|
785
699
|
{
|
|
786
|
-
"name": "
|
|
787
|
-
"docs": "-
|
|
788
|
-
"type": "
|
|
789
|
-
},
|
|
790
|
-
{
|
|
791
|
-
"name": "shufflePlaylist",
|
|
792
|
-
"docs": "- true to shuffle, false for sequential",
|
|
793
|
-
"type": "boolean"
|
|
700
|
+
"name": "options",
|
|
701
|
+
"docs": "- Playlist shuffle options",
|
|
702
|
+
"type": "SetShuffleOptions"
|
|
794
703
|
}
|
|
795
704
|
],
|
|
796
705
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
797
706
|
"tags": [
|
|
798
707
|
{
|
|
799
708
|
"name": "param",
|
|
800
|
-
"text": "
|
|
801
|
-
},
|
|
802
|
-
{
|
|
803
|
-
"name": "param",
|
|
804
|
-
"text": "shufflePlaylist - true to shuffle, false for sequential"
|
|
709
|
+
"text": "options - Playlist shuffle options"
|
|
805
710
|
},
|
|
806
711
|
{
|
|
807
712
|
"name": "returns",
|
|
@@ -809,24 +714,26 @@
|
|
|
809
714
|
}
|
|
810
715
|
],
|
|
811
716
|
"docs": "Enable or disable playlist shuffle.",
|
|
812
|
-
"complexTypes": [
|
|
717
|
+
"complexTypes": [
|
|
718
|
+
"SetShuffleOptions"
|
|
719
|
+
],
|
|
813
720
|
"slug": "setshuffle"
|
|
814
721
|
},
|
|
815
722
|
{
|
|
816
723
|
"name": "getVideoLoadedFraction",
|
|
817
|
-
"signature": "(
|
|
724
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: number; }; }>",
|
|
818
725
|
"parameters": [
|
|
819
726
|
{
|
|
820
|
-
"name": "
|
|
821
|
-
"docs": "-
|
|
822
|
-
"type": "
|
|
727
|
+
"name": "options",
|
|
728
|
+
"docs": "- Player instance options",
|
|
729
|
+
"type": "PlayerIdOptions"
|
|
823
730
|
}
|
|
824
731
|
],
|
|
825
732
|
"returns": "Promise<{ result: { method: string; value: number; }; }>",
|
|
826
733
|
"tags": [
|
|
827
734
|
{
|
|
828
735
|
"name": "param",
|
|
829
|
-
"text": "
|
|
736
|
+
"text": "options - Player instance options"
|
|
830
737
|
},
|
|
831
738
|
{
|
|
832
739
|
"name": "returns",
|
|
@@ -834,24 +741,26 @@
|
|
|
834
741
|
}
|
|
835
742
|
],
|
|
836
743
|
"docs": "Get the fraction of the video that has been buffered.\nMore reliable than deprecated getVideoBytesLoaded/getVideoBytesTotal.",
|
|
837
|
-
"complexTypes": [
|
|
744
|
+
"complexTypes": [
|
|
745
|
+
"PlayerIdOptions"
|
|
746
|
+
],
|
|
838
747
|
"slug": "getvideoloadedfraction"
|
|
839
748
|
},
|
|
840
749
|
{
|
|
841
750
|
"name": "getPlayerState",
|
|
842
|
-
"signature": "(
|
|
751
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: number; }; }>",
|
|
843
752
|
"parameters": [
|
|
844
753
|
{
|
|
845
|
-
"name": "
|
|
846
|
-
"docs": "-
|
|
847
|
-
"type": "
|
|
754
|
+
"name": "options",
|
|
755
|
+
"docs": "- Player instance options",
|
|
756
|
+
"type": "PlayerIdOptions"
|
|
848
757
|
}
|
|
849
758
|
],
|
|
850
759
|
"returns": "Promise<{ result: { method: string; value: number; }; }>",
|
|
851
760
|
"tags": [
|
|
852
761
|
{
|
|
853
762
|
"name": "param",
|
|
854
|
-
"text": "
|
|
763
|
+
"text": "options - Player instance options"
|
|
855
764
|
},
|
|
856
765
|
{
|
|
857
766
|
"name": "returns",
|
|
@@ -859,7 +768,9 @@
|
|
|
859
768
|
}
|
|
860
769
|
],
|
|
861
770
|
"docs": "Get the current state of the player.",
|
|
862
|
-
"complexTypes": [
|
|
771
|
+
"complexTypes": [
|
|
772
|
+
"PlayerIdOptions"
|
|
773
|
+
],
|
|
863
774
|
"slug": "getplayerstate"
|
|
864
775
|
},
|
|
865
776
|
{
|
|
@@ -882,19 +793,19 @@
|
|
|
882
793
|
},
|
|
883
794
|
{
|
|
884
795
|
"name": "getCurrentTime",
|
|
885
|
-
"signature": "(
|
|
796
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: number; }; }>",
|
|
886
797
|
"parameters": [
|
|
887
798
|
{
|
|
888
|
-
"name": "
|
|
889
|
-
"docs": "-
|
|
890
|
-
"type": "
|
|
799
|
+
"name": "options",
|
|
800
|
+
"docs": "- Player instance options",
|
|
801
|
+
"type": "PlayerIdOptions"
|
|
891
802
|
}
|
|
892
803
|
],
|
|
893
804
|
"returns": "Promise<{ result: { method: string; value: number; }; }>",
|
|
894
805
|
"tags": [
|
|
895
806
|
{
|
|
896
807
|
"name": "param",
|
|
897
|
-
"text": "
|
|
808
|
+
"text": "options - Player instance options"
|
|
898
809
|
},
|
|
899
810
|
{
|
|
900
811
|
"name": "returns",
|
|
@@ -902,33 +813,26 @@
|
|
|
902
813
|
}
|
|
903
814
|
],
|
|
904
815
|
"docs": "Get the current playback position in seconds.",
|
|
905
|
-
"complexTypes": [
|
|
816
|
+
"complexTypes": [
|
|
817
|
+
"PlayerIdOptions"
|
|
818
|
+
],
|
|
906
819
|
"slug": "getcurrenttime"
|
|
907
820
|
},
|
|
908
821
|
{
|
|
909
822
|
"name": "toggleFullScreen",
|
|
910
|
-
"signature": "(
|
|
823
|
+
"signature": "(options: ToggleFullScreenOptions) => Promise<{ result: { method: string; value: boolean | null | undefined; }; }>",
|
|
911
824
|
"parameters": [
|
|
912
825
|
{
|
|
913
|
-
"name": "
|
|
914
|
-
"docs": "-
|
|
915
|
-
"type": "
|
|
916
|
-
},
|
|
917
|
-
{
|
|
918
|
-
"name": "isFullScreen",
|
|
919
|
-
"docs": "- true for fullscreen, false for normal, null/undefined to toggle",
|
|
920
|
-
"type": "boolean | null | undefined"
|
|
826
|
+
"name": "options",
|
|
827
|
+
"docs": "- Fullscreen options",
|
|
828
|
+
"type": "ToggleFullScreenOptions"
|
|
921
829
|
}
|
|
922
830
|
],
|
|
923
831
|
"returns": "Promise<{ result: { method: string; value: boolean | null | undefined; }; }>",
|
|
924
832
|
"tags": [
|
|
925
833
|
{
|
|
926
834
|
"name": "param",
|
|
927
|
-
"text": "
|
|
928
|
-
},
|
|
929
|
-
{
|
|
930
|
-
"name": "param",
|
|
931
|
-
"text": "isFullScreen - true for fullscreen, false for normal, null/undefined to toggle"
|
|
835
|
+
"text": "options - Fullscreen options"
|
|
932
836
|
},
|
|
933
837
|
{
|
|
934
838
|
"name": "returns",
|
|
@@ -936,24 +840,26 @@
|
|
|
936
840
|
}
|
|
937
841
|
],
|
|
938
842
|
"docs": "Toggle fullscreen mode on or off.",
|
|
939
|
-
"complexTypes": [
|
|
843
|
+
"complexTypes": [
|
|
844
|
+
"ToggleFullScreenOptions"
|
|
845
|
+
],
|
|
940
846
|
"slug": "togglefullscreen"
|
|
941
847
|
},
|
|
942
848
|
{
|
|
943
849
|
"name": "getPlaybackQuality",
|
|
944
|
-
"signature": "(
|
|
850
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: IPlaybackQuality; }; }>",
|
|
945
851
|
"parameters": [
|
|
946
852
|
{
|
|
947
|
-
"name": "
|
|
948
|
-
"docs": "-
|
|
949
|
-
"type": "
|
|
853
|
+
"name": "options",
|
|
854
|
+
"docs": "- Player instance options",
|
|
855
|
+
"type": "PlayerIdOptions"
|
|
950
856
|
}
|
|
951
857
|
],
|
|
952
858
|
"returns": "Promise<{ result: { method: string; value: IPlaybackQuality; }; }>",
|
|
953
859
|
"tags": [
|
|
954
860
|
{
|
|
955
861
|
"name": "param",
|
|
956
|
-
"text": "
|
|
862
|
+
"text": "options - Player instance options"
|
|
957
863
|
},
|
|
958
864
|
{
|
|
959
865
|
"name": "returns",
|
|
@@ -962,34 +868,26 @@
|
|
|
962
868
|
],
|
|
963
869
|
"docs": "Get the current playback quality.",
|
|
964
870
|
"complexTypes": [
|
|
965
|
-
"IPlaybackQuality"
|
|
871
|
+
"IPlaybackQuality",
|
|
872
|
+
"PlayerIdOptions"
|
|
966
873
|
],
|
|
967
874
|
"slug": "getplaybackquality"
|
|
968
875
|
},
|
|
969
876
|
{
|
|
970
877
|
"name": "setPlaybackQuality",
|
|
971
|
-
"signature": "(
|
|
878
|
+
"signature": "(options: SetPlaybackQualityOptions) => Promise<{ result: { method: string; value: boolean; }; }>",
|
|
972
879
|
"parameters": [
|
|
973
880
|
{
|
|
974
|
-
"name": "
|
|
975
|
-
"docs": "-
|
|
976
|
-
"type": "
|
|
977
|
-
},
|
|
978
|
-
{
|
|
979
|
-
"name": "suggestedQuality",
|
|
980
|
-
"docs": "- Desired quality level",
|
|
981
|
-
"type": "IPlaybackQuality"
|
|
881
|
+
"name": "options",
|
|
882
|
+
"docs": "- Playback quality options",
|
|
883
|
+
"type": "SetPlaybackQualityOptions"
|
|
982
884
|
}
|
|
983
885
|
],
|
|
984
886
|
"returns": "Promise<{ result: { method: string; value: boolean; }; }>",
|
|
985
887
|
"tags": [
|
|
986
888
|
{
|
|
987
889
|
"name": "param",
|
|
988
|
-
"text": "
|
|
989
|
-
},
|
|
990
|
-
{
|
|
991
|
-
"name": "param",
|
|
992
|
-
"text": "suggestedQuality - Desired quality level"
|
|
890
|
+
"text": "options - Playback quality options"
|
|
993
891
|
},
|
|
994
892
|
{
|
|
995
893
|
"name": "returns",
|
|
@@ -998,25 +896,25 @@
|
|
|
998
896
|
],
|
|
999
897
|
"docs": "Set the suggested playback quality.\nActual quality may differ based on network conditions.",
|
|
1000
898
|
"complexTypes": [
|
|
1001
|
-
"
|
|
899
|
+
"SetPlaybackQualityOptions"
|
|
1002
900
|
],
|
|
1003
901
|
"slug": "setplaybackquality"
|
|
1004
902
|
},
|
|
1005
903
|
{
|
|
1006
904
|
"name": "getAvailableQualityLevels",
|
|
1007
|
-
"signature": "(
|
|
905
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: IPlaybackQuality[]; }; }>",
|
|
1008
906
|
"parameters": [
|
|
1009
907
|
{
|
|
1010
|
-
"name": "
|
|
1011
|
-
"docs": "-
|
|
1012
|
-
"type": "
|
|
908
|
+
"name": "options",
|
|
909
|
+
"docs": "- Player instance options",
|
|
910
|
+
"type": "PlayerIdOptions"
|
|
1013
911
|
}
|
|
1014
912
|
],
|
|
1015
913
|
"returns": "Promise<{ result: { method: string; value: IPlaybackQuality[]; }; }>",
|
|
1016
914
|
"tags": [
|
|
1017
915
|
{
|
|
1018
916
|
"name": "param",
|
|
1019
|
-
"text": "
|
|
917
|
+
"text": "options - Player instance options"
|
|
1020
918
|
},
|
|
1021
919
|
{
|
|
1022
920
|
"name": "returns",
|
|
@@ -1025,25 +923,26 @@
|
|
|
1025
923
|
],
|
|
1026
924
|
"docs": "Get list of available quality levels for current video.",
|
|
1027
925
|
"complexTypes": [
|
|
1028
|
-
"IPlaybackQuality"
|
|
926
|
+
"IPlaybackQuality",
|
|
927
|
+
"PlayerIdOptions"
|
|
1029
928
|
],
|
|
1030
929
|
"slug": "getavailablequalitylevels"
|
|
1031
930
|
},
|
|
1032
931
|
{
|
|
1033
932
|
"name": "getDuration",
|
|
1034
|
-
"signature": "(
|
|
933
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: number; }; }>",
|
|
1035
934
|
"parameters": [
|
|
1036
935
|
{
|
|
1037
|
-
"name": "
|
|
1038
|
-
"docs": "-
|
|
1039
|
-
"type": "
|
|
936
|
+
"name": "options",
|
|
937
|
+
"docs": "- Player instance options",
|
|
938
|
+
"type": "PlayerIdOptions"
|
|
1040
939
|
}
|
|
1041
940
|
],
|
|
1042
941
|
"returns": "Promise<{ result: { method: string; value: number; }; }>",
|
|
1043
942
|
"tags": [
|
|
1044
943
|
{
|
|
1045
944
|
"name": "param",
|
|
1046
|
-
"text": "
|
|
945
|
+
"text": "options - Player instance options"
|
|
1047
946
|
},
|
|
1048
947
|
{
|
|
1049
948
|
"name": "returns",
|
|
@@ -1051,24 +950,26 @@
|
|
|
1051
950
|
}
|
|
1052
951
|
],
|
|
1053
952
|
"docs": "Get the duration of the current video in seconds.",
|
|
1054
|
-
"complexTypes": [
|
|
953
|
+
"complexTypes": [
|
|
954
|
+
"PlayerIdOptions"
|
|
955
|
+
],
|
|
1055
956
|
"slug": "getduration"
|
|
1056
957
|
},
|
|
1057
958
|
{
|
|
1058
959
|
"name": "getVideoUrl",
|
|
1059
|
-
"signature": "(
|
|
960
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: string; }; }>",
|
|
1060
961
|
"parameters": [
|
|
1061
962
|
{
|
|
1062
|
-
"name": "
|
|
1063
|
-
"docs": "-
|
|
1064
|
-
"type": "
|
|
963
|
+
"name": "options",
|
|
964
|
+
"docs": "- Player instance options",
|
|
965
|
+
"type": "PlayerIdOptions"
|
|
1065
966
|
}
|
|
1066
967
|
],
|
|
1067
968
|
"returns": "Promise<{ result: { method: string; value: string; }; }>",
|
|
1068
969
|
"tags": [
|
|
1069
970
|
{
|
|
1070
971
|
"name": "param",
|
|
1071
|
-
"text": "
|
|
972
|
+
"text": "options - Player instance options"
|
|
1072
973
|
},
|
|
1073
974
|
{
|
|
1074
975
|
"name": "returns",
|
|
@@ -1076,24 +977,26 @@
|
|
|
1076
977
|
}
|
|
1077
978
|
],
|
|
1078
979
|
"docs": "Get the YouTube.com URL for the current video.",
|
|
1079
|
-
"complexTypes": [
|
|
980
|
+
"complexTypes": [
|
|
981
|
+
"PlayerIdOptions"
|
|
982
|
+
],
|
|
1080
983
|
"slug": "getvideourl"
|
|
1081
984
|
},
|
|
1082
985
|
{
|
|
1083
986
|
"name": "getVideoEmbedCode",
|
|
1084
|
-
"signature": "(
|
|
987
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: string; }; }>",
|
|
1085
988
|
"parameters": [
|
|
1086
989
|
{
|
|
1087
|
-
"name": "
|
|
1088
|
-
"docs": "-
|
|
1089
|
-
"type": "
|
|
990
|
+
"name": "options",
|
|
991
|
+
"docs": "- Player instance options",
|
|
992
|
+
"type": "PlayerIdOptions"
|
|
1090
993
|
}
|
|
1091
994
|
],
|
|
1092
995
|
"returns": "Promise<{ result: { method: string; value: string; }; }>",
|
|
1093
996
|
"tags": [
|
|
1094
997
|
{
|
|
1095
998
|
"name": "param",
|
|
1096
|
-
"text": "
|
|
999
|
+
"text": "options - Player instance options"
|
|
1097
1000
|
},
|
|
1098
1001
|
{
|
|
1099
1002
|
"name": "returns",
|
|
@@ -1101,24 +1004,26 @@
|
|
|
1101
1004
|
}
|
|
1102
1005
|
],
|
|
1103
1006
|
"docs": "Get the embed code for the current video.\nReturns HTML iframe embed code.",
|
|
1104
|
-
"complexTypes": [
|
|
1007
|
+
"complexTypes": [
|
|
1008
|
+
"PlayerIdOptions"
|
|
1009
|
+
],
|
|
1105
1010
|
"slug": "getvideoembedcode"
|
|
1106
1011
|
},
|
|
1107
1012
|
{
|
|
1108
1013
|
"name": "getPlaylist",
|
|
1109
|
-
"signature": "(
|
|
1014
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: string[]; }; }>",
|
|
1110
1015
|
"parameters": [
|
|
1111
1016
|
{
|
|
1112
|
-
"name": "
|
|
1113
|
-
"docs": "-
|
|
1114
|
-
"type": "
|
|
1017
|
+
"name": "options",
|
|
1018
|
+
"docs": "- Player instance options",
|
|
1019
|
+
"type": "PlayerIdOptions"
|
|
1115
1020
|
}
|
|
1116
1021
|
],
|
|
1117
1022
|
"returns": "Promise<{ result: { method: string; value: string[]; }; }>",
|
|
1118
1023
|
"tags": [
|
|
1119
1024
|
{
|
|
1120
1025
|
"name": "param",
|
|
1121
|
-
"text": "
|
|
1026
|
+
"text": "options - Player instance options"
|
|
1122
1027
|
},
|
|
1123
1028
|
{
|
|
1124
1029
|
"name": "returns",
|
|
@@ -1126,24 +1031,26 @@
|
|
|
1126
1031
|
}
|
|
1127
1032
|
],
|
|
1128
1033
|
"docs": "Get array of video IDs in the current playlist.",
|
|
1129
|
-
"complexTypes": [
|
|
1034
|
+
"complexTypes": [
|
|
1035
|
+
"PlayerIdOptions"
|
|
1036
|
+
],
|
|
1130
1037
|
"slug": "getplaylist"
|
|
1131
1038
|
},
|
|
1132
1039
|
{
|
|
1133
1040
|
"name": "getPlaylistIndex",
|
|
1134
|
-
"signature": "(
|
|
1041
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: number; }; }>",
|
|
1135
1042
|
"parameters": [
|
|
1136
1043
|
{
|
|
1137
|
-
"name": "
|
|
1138
|
-
"docs": "-
|
|
1139
|
-
"type": "
|
|
1044
|
+
"name": "options",
|
|
1045
|
+
"docs": "- Player instance options",
|
|
1046
|
+
"type": "PlayerIdOptions"
|
|
1140
1047
|
}
|
|
1141
1048
|
],
|
|
1142
1049
|
"returns": "Promise<{ result: { method: string; value: number; }; }>",
|
|
1143
1050
|
"tags": [
|
|
1144
1051
|
{
|
|
1145
1052
|
"name": "param",
|
|
1146
|
-
"text": "
|
|
1053
|
+
"text": "options - Player instance options"
|
|
1147
1054
|
},
|
|
1148
1055
|
{
|
|
1149
1056
|
"name": "returns",
|
|
@@ -1151,24 +1058,26 @@
|
|
|
1151
1058
|
}
|
|
1152
1059
|
],
|
|
1153
1060
|
"docs": "Get the index of the currently playing video in the playlist.",
|
|
1154
|
-
"complexTypes": [
|
|
1061
|
+
"complexTypes": [
|
|
1062
|
+
"PlayerIdOptions"
|
|
1063
|
+
],
|
|
1155
1064
|
"slug": "getplaylistindex"
|
|
1156
1065
|
},
|
|
1157
1066
|
{
|
|
1158
1067
|
"name": "getIframe",
|
|
1159
|
-
"signature": "(
|
|
1068
|
+
"signature": "(options: PlayerIdOptions) => Promise<{ result: { method: string; value: HTMLIFrameElement; }; }>",
|
|
1160
1069
|
"parameters": [
|
|
1161
1070
|
{
|
|
1162
|
-
"name": "
|
|
1163
|
-
"docs": "-
|
|
1164
|
-
"type": "
|
|
1071
|
+
"name": "options",
|
|
1072
|
+
"docs": "- Player instance options",
|
|
1073
|
+
"type": "PlayerIdOptions"
|
|
1165
1074
|
}
|
|
1166
1075
|
],
|
|
1167
1076
|
"returns": "Promise<{ result: { method: string; value: any; }; }>",
|
|
1168
1077
|
"tags": [
|
|
1169
1078
|
{
|
|
1170
1079
|
"name": "param",
|
|
1171
|
-
"text": "
|
|
1080
|
+
"text": "options - Player instance options"
|
|
1172
1081
|
},
|
|
1173
1082
|
{
|
|
1174
1083
|
"name": "returns",
|
|
@@ -1177,96 +1086,61 @@
|
|
|
1177
1086
|
],
|
|
1178
1087
|
"docs": "Get the iframe DOM element for the player.\nWeb platform only.",
|
|
1179
1088
|
"complexTypes": [
|
|
1180
|
-
"HTMLIFrameElement"
|
|
1089
|
+
"HTMLIFrameElement",
|
|
1090
|
+
"PlayerIdOptions"
|
|
1181
1091
|
],
|
|
1182
1092
|
"slug": "getiframe"
|
|
1183
1093
|
},
|
|
1184
1094
|
{
|
|
1185
1095
|
"name": "addEventListener",
|
|
1186
|
-
"signature": "<TEvent extends PlayerEvent>(
|
|
1096
|
+
"signature": "<TEvent extends PlayerEvent>(options: PlayerEventListenerOptions<TEvent>) => void",
|
|
1187
1097
|
"parameters": [
|
|
1188
1098
|
{
|
|
1189
|
-
"name": "
|
|
1190
|
-
"docs": "-
|
|
1191
|
-
"type": "
|
|
1192
|
-
},
|
|
1193
|
-
{
|
|
1194
|
-
"name": "eventName",
|
|
1195
|
-
"docs": "- Name of the event (onReady, onStateChange, onError, etc.)",
|
|
1196
|
-
"type": "keyof Events"
|
|
1197
|
-
},
|
|
1198
|
-
{
|
|
1199
|
-
"name": "listener",
|
|
1200
|
-
"docs": "- Callback function to handle the event",
|
|
1201
|
-
"type": "(event: TEvent) => void"
|
|
1099
|
+
"name": "options",
|
|
1100
|
+
"docs": "- Event listener options",
|
|
1101
|
+
"type": "PlayerEventListenerOptions<TEvent>"
|
|
1202
1102
|
}
|
|
1203
1103
|
],
|
|
1204
1104
|
"returns": "void",
|
|
1205
1105
|
"tags": [
|
|
1206
1106
|
{
|
|
1207
1107
|
"name": "param",
|
|
1208
|
-
"text": "
|
|
1209
|
-
},
|
|
1210
|
-
{
|
|
1211
|
-
"name": "param",
|
|
1212
|
-
"text": "eventName - Name of the event (onReady, onStateChange, onError, etc.)"
|
|
1213
|
-
},
|
|
1214
|
-
{
|
|
1215
|
-
"name": "param",
|
|
1216
|
-
"text": "listener - Callback function to handle the event"
|
|
1108
|
+
"text": "options - Event listener options"
|
|
1217
1109
|
},
|
|
1218
1110
|
{
|
|
1219
1111
|
"name": "example",
|
|
1220
|
-
"text": "```typescript\nYoutubePlayer.addEventListener('my-player'
|
|
1112
|
+
"text": "```typescript\nYoutubePlayer.addEventListener({\n playerId: 'my-player',\n eventName: 'onStateChange',\n listener: (event) => {\n console.log('Player state:', event.data);\n },\n});\n```"
|
|
1221
1113
|
}
|
|
1222
1114
|
],
|
|
1223
|
-
"docs": "Add an event listener to the player.",
|
|
1115
|
+
"docs": "Add an event listener to the player.\nWeb platform only.",
|
|
1224
1116
|
"complexTypes": [
|
|
1225
1117
|
"PlayerEvent",
|
|
1226
|
-
"
|
|
1118
|
+
"PlayerEventListenerOptions",
|
|
1227
1119
|
"TEvent"
|
|
1228
1120
|
],
|
|
1229
1121
|
"slug": "addeventlistener"
|
|
1230
1122
|
},
|
|
1231
1123
|
{
|
|
1232
1124
|
"name": "removeEventListener",
|
|
1233
|
-
"signature": "<TEvent extends PlayerEvent>(
|
|
1125
|
+
"signature": "<TEvent extends PlayerEvent>(options: PlayerEventListenerOptions<TEvent>) => void",
|
|
1234
1126
|
"parameters": [
|
|
1235
1127
|
{
|
|
1236
|
-
"name": "
|
|
1237
|
-
"docs": "-
|
|
1238
|
-
"type": "
|
|
1239
|
-
},
|
|
1240
|
-
{
|
|
1241
|
-
"name": "eventName",
|
|
1242
|
-
"docs": "- Name of the event to remove listener from",
|
|
1243
|
-
"type": "keyof Events"
|
|
1244
|
-
},
|
|
1245
|
-
{
|
|
1246
|
-
"name": "listener",
|
|
1247
|
-
"docs": "- The callback function to remove",
|
|
1248
|
-
"type": "(event: TEvent) => void"
|
|
1128
|
+
"name": "options",
|
|
1129
|
+
"docs": "- Event listener options",
|
|
1130
|
+
"type": "PlayerEventListenerOptions<TEvent>"
|
|
1249
1131
|
}
|
|
1250
1132
|
],
|
|
1251
1133
|
"returns": "void",
|
|
1252
1134
|
"tags": [
|
|
1253
1135
|
{
|
|
1254
1136
|
"name": "param",
|
|
1255
|
-
"text": "
|
|
1256
|
-
},
|
|
1257
|
-
{
|
|
1258
|
-
"name": "param",
|
|
1259
|
-
"text": "eventName - Name of the event to remove listener from"
|
|
1260
|
-
},
|
|
1261
|
-
{
|
|
1262
|
-
"name": "param",
|
|
1263
|
-
"text": "listener - The callback function to remove"
|
|
1137
|
+
"text": "options - Event listener options"
|
|
1264
1138
|
}
|
|
1265
1139
|
],
|
|
1266
|
-
"docs": "Remove an event listener from the player.",
|
|
1140
|
+
"docs": "Remove an event listener from the player.\nWeb platform only.",
|
|
1267
1141
|
"complexTypes": [
|
|
1268
1142
|
"PlayerEvent",
|
|
1269
|
-
"
|
|
1143
|
+
"PlayerEventListenerOptions",
|
|
1270
1144
|
"TEvent"
|
|
1271
1145
|
],
|
|
1272
1146
|
"slug": "removeeventlistener"
|
|
@@ -1566,45 +1440,166 @@
|
|
|
1566
1440
|
]
|
|
1567
1441
|
},
|
|
1568
1442
|
{
|
|
1569
|
-
"name": "
|
|
1570
|
-
"slug": "
|
|
1571
|
-
"docs": "
|
|
1572
|
-
"tags": [
|
|
1573
|
-
{
|
|
1574
|
-
"text": "IVideoOptions",
|
|
1575
|
-
"name": "extends"
|
|
1576
|
-
}
|
|
1577
|
-
],
|
|
1443
|
+
"name": "PlayerIdOptions",
|
|
1444
|
+
"slug": "playeridoptions",
|
|
1445
|
+
"docs": "",
|
|
1446
|
+
"tags": [],
|
|
1578
1447
|
"methods": [],
|
|
1579
1448
|
"properties": [
|
|
1580
1449
|
{
|
|
1581
|
-
"name": "
|
|
1450
|
+
"name": "playerId",
|
|
1582
1451
|
"tags": [],
|
|
1583
|
-
"docs": "
|
|
1452
|
+
"docs": "",
|
|
1584
1453
|
"complexTypes": [],
|
|
1585
1454
|
"type": "string"
|
|
1586
1455
|
}
|
|
1587
1456
|
]
|
|
1588
1457
|
},
|
|
1589
1458
|
{
|
|
1590
|
-
"name": "
|
|
1591
|
-
"slug": "
|
|
1592
|
-
"docs": "
|
|
1593
|
-
"tags": [
|
|
1594
|
-
{
|
|
1595
|
-
"text": "IVideoOptions",
|
|
1596
|
-
"name": "extends"
|
|
1597
|
-
}
|
|
1598
|
-
],
|
|
1459
|
+
"name": "SeekToOptions",
|
|
1460
|
+
"slug": "seektooptions",
|
|
1461
|
+
"docs": "",
|
|
1462
|
+
"tags": [],
|
|
1599
1463
|
"methods": [],
|
|
1600
1464
|
"properties": [
|
|
1601
1465
|
{
|
|
1602
|
-
"name": "
|
|
1466
|
+
"name": "playerId",
|
|
1603
1467
|
"tags": [],
|
|
1604
|
-
"docs": "
|
|
1468
|
+
"docs": "",
|
|
1605
1469
|
"complexTypes": [],
|
|
1606
1470
|
"type": "string"
|
|
1607
|
-
}
|
|
1471
|
+
},
|
|
1472
|
+
{
|
|
1473
|
+
"name": "seconds",
|
|
1474
|
+
"tags": [],
|
|
1475
|
+
"docs": "",
|
|
1476
|
+
"complexTypes": [],
|
|
1477
|
+
"type": "number"
|
|
1478
|
+
},
|
|
1479
|
+
{
|
|
1480
|
+
"name": "allowSeekAhead",
|
|
1481
|
+
"tags": [],
|
|
1482
|
+
"docs": "",
|
|
1483
|
+
"complexTypes": [],
|
|
1484
|
+
"type": "boolean"
|
|
1485
|
+
}
|
|
1486
|
+
]
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"name": "IVideoOptionsById",
|
|
1490
|
+
"slug": "ivideooptionsbyid",
|
|
1491
|
+
"docs": "Options for loading a video by its YouTube ID.",
|
|
1492
|
+
"tags": [
|
|
1493
|
+
{
|
|
1494
|
+
"text": "IVideoOptions",
|
|
1495
|
+
"name": "extends"
|
|
1496
|
+
}
|
|
1497
|
+
],
|
|
1498
|
+
"methods": [],
|
|
1499
|
+
"properties": [
|
|
1500
|
+
{
|
|
1501
|
+
"name": "videoId",
|
|
1502
|
+
"tags": [],
|
|
1503
|
+
"docs": "YouTube video ID",
|
|
1504
|
+
"complexTypes": [],
|
|
1505
|
+
"type": "string"
|
|
1506
|
+
}
|
|
1507
|
+
]
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"name": "VideoByIdMethodOptions",
|
|
1511
|
+
"slug": "videobyidmethodoptions",
|
|
1512
|
+
"docs": "",
|
|
1513
|
+
"tags": [],
|
|
1514
|
+
"methods": [],
|
|
1515
|
+
"properties": [
|
|
1516
|
+
{
|
|
1517
|
+
"name": "playerId",
|
|
1518
|
+
"tags": [],
|
|
1519
|
+
"docs": "",
|
|
1520
|
+
"complexTypes": [],
|
|
1521
|
+
"type": "string"
|
|
1522
|
+
},
|
|
1523
|
+
{
|
|
1524
|
+
"name": "options",
|
|
1525
|
+
"tags": [],
|
|
1526
|
+
"docs": "",
|
|
1527
|
+
"complexTypes": [
|
|
1528
|
+
"IVideoOptionsById"
|
|
1529
|
+
],
|
|
1530
|
+
"type": "IVideoOptionsById"
|
|
1531
|
+
}
|
|
1532
|
+
]
|
|
1533
|
+
},
|
|
1534
|
+
{
|
|
1535
|
+
"name": "IVideoOptionsByUrl",
|
|
1536
|
+
"slug": "ivideooptionsbyurl",
|
|
1537
|
+
"docs": "Options for loading a video by its media URL.",
|
|
1538
|
+
"tags": [
|
|
1539
|
+
{
|
|
1540
|
+
"text": "IVideoOptions",
|
|
1541
|
+
"name": "extends"
|
|
1542
|
+
}
|
|
1543
|
+
],
|
|
1544
|
+
"methods": [],
|
|
1545
|
+
"properties": [
|
|
1546
|
+
{
|
|
1547
|
+
"name": "mediaContentUrl",
|
|
1548
|
+
"tags": [],
|
|
1549
|
+
"docs": "Full YouTube video URL",
|
|
1550
|
+
"complexTypes": [],
|
|
1551
|
+
"type": "string"
|
|
1552
|
+
}
|
|
1553
|
+
]
|
|
1554
|
+
},
|
|
1555
|
+
{
|
|
1556
|
+
"name": "VideoByUrlMethodOptions",
|
|
1557
|
+
"slug": "videobyurlmethodoptions",
|
|
1558
|
+
"docs": "",
|
|
1559
|
+
"tags": [],
|
|
1560
|
+
"methods": [],
|
|
1561
|
+
"properties": [
|
|
1562
|
+
{
|
|
1563
|
+
"name": "playerId",
|
|
1564
|
+
"tags": [],
|
|
1565
|
+
"docs": "",
|
|
1566
|
+
"complexTypes": [],
|
|
1567
|
+
"type": "string"
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"name": "options",
|
|
1571
|
+
"tags": [],
|
|
1572
|
+
"docs": "",
|
|
1573
|
+
"complexTypes": [
|
|
1574
|
+
"IVideoOptionsByUrl"
|
|
1575
|
+
],
|
|
1576
|
+
"type": "IVideoOptionsByUrl"
|
|
1577
|
+
}
|
|
1578
|
+
]
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
"name": "PlaylistMethodOptions",
|
|
1582
|
+
"slug": "playlistmethodoptions",
|
|
1583
|
+
"docs": "",
|
|
1584
|
+
"tags": [],
|
|
1585
|
+
"methods": [],
|
|
1586
|
+
"properties": [
|
|
1587
|
+
{
|
|
1588
|
+
"name": "playerId",
|
|
1589
|
+
"tags": [],
|
|
1590
|
+
"docs": "",
|
|
1591
|
+
"complexTypes": [],
|
|
1592
|
+
"type": "string"
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
"name": "playlistOptions",
|
|
1596
|
+
"tags": [],
|
|
1597
|
+
"docs": "",
|
|
1598
|
+
"complexTypes": [
|
|
1599
|
+
"IPlaylistOptions"
|
|
1600
|
+
],
|
|
1601
|
+
"type": "IPlaylistOptions"
|
|
1602
|
+
}
|
|
1608
1603
|
]
|
|
1609
1604
|
},
|
|
1610
1605
|
{
|
|
@@ -1658,6 +1653,151 @@
|
|
|
1658
1653
|
}
|
|
1659
1654
|
]
|
|
1660
1655
|
},
|
|
1656
|
+
{
|
|
1657
|
+
"name": "PlayVideoAtOptions",
|
|
1658
|
+
"slug": "playvideoatoptions",
|
|
1659
|
+
"docs": "",
|
|
1660
|
+
"tags": [],
|
|
1661
|
+
"methods": [],
|
|
1662
|
+
"properties": [
|
|
1663
|
+
{
|
|
1664
|
+
"name": "playerId",
|
|
1665
|
+
"tags": [],
|
|
1666
|
+
"docs": "",
|
|
1667
|
+
"complexTypes": [],
|
|
1668
|
+
"type": "string"
|
|
1669
|
+
},
|
|
1670
|
+
{
|
|
1671
|
+
"name": "index",
|
|
1672
|
+
"tags": [],
|
|
1673
|
+
"docs": "",
|
|
1674
|
+
"complexTypes": [],
|
|
1675
|
+
"type": "number"
|
|
1676
|
+
}
|
|
1677
|
+
]
|
|
1678
|
+
},
|
|
1679
|
+
{
|
|
1680
|
+
"name": "SetVolumeOptions",
|
|
1681
|
+
"slug": "setvolumeoptions",
|
|
1682
|
+
"docs": "",
|
|
1683
|
+
"tags": [],
|
|
1684
|
+
"methods": [],
|
|
1685
|
+
"properties": [
|
|
1686
|
+
{
|
|
1687
|
+
"name": "playerId",
|
|
1688
|
+
"tags": [],
|
|
1689
|
+
"docs": "",
|
|
1690
|
+
"complexTypes": [],
|
|
1691
|
+
"type": "string"
|
|
1692
|
+
},
|
|
1693
|
+
{
|
|
1694
|
+
"name": "volume",
|
|
1695
|
+
"tags": [],
|
|
1696
|
+
"docs": "",
|
|
1697
|
+
"complexTypes": [],
|
|
1698
|
+
"type": "number"
|
|
1699
|
+
}
|
|
1700
|
+
]
|
|
1701
|
+
},
|
|
1702
|
+
{
|
|
1703
|
+
"name": "SetSizeOptions",
|
|
1704
|
+
"slug": "setsizeoptions",
|
|
1705
|
+
"docs": "",
|
|
1706
|
+
"tags": [],
|
|
1707
|
+
"methods": [],
|
|
1708
|
+
"properties": [
|
|
1709
|
+
{
|
|
1710
|
+
"name": "playerId",
|
|
1711
|
+
"tags": [],
|
|
1712
|
+
"docs": "",
|
|
1713
|
+
"complexTypes": [],
|
|
1714
|
+
"type": "string"
|
|
1715
|
+
},
|
|
1716
|
+
{
|
|
1717
|
+
"name": "width",
|
|
1718
|
+
"tags": [],
|
|
1719
|
+
"docs": "",
|
|
1720
|
+
"complexTypes": [],
|
|
1721
|
+
"type": "number"
|
|
1722
|
+
},
|
|
1723
|
+
{
|
|
1724
|
+
"name": "height",
|
|
1725
|
+
"tags": [],
|
|
1726
|
+
"docs": "",
|
|
1727
|
+
"complexTypes": [],
|
|
1728
|
+
"type": "number"
|
|
1729
|
+
}
|
|
1730
|
+
]
|
|
1731
|
+
},
|
|
1732
|
+
{
|
|
1733
|
+
"name": "SetPlaybackRateOptions",
|
|
1734
|
+
"slug": "setplaybackrateoptions",
|
|
1735
|
+
"docs": "",
|
|
1736
|
+
"tags": [],
|
|
1737
|
+
"methods": [],
|
|
1738
|
+
"properties": [
|
|
1739
|
+
{
|
|
1740
|
+
"name": "playerId",
|
|
1741
|
+
"tags": [],
|
|
1742
|
+
"docs": "",
|
|
1743
|
+
"complexTypes": [],
|
|
1744
|
+
"type": "string"
|
|
1745
|
+
},
|
|
1746
|
+
{
|
|
1747
|
+
"name": "suggestedRate",
|
|
1748
|
+
"tags": [],
|
|
1749
|
+
"docs": "",
|
|
1750
|
+
"complexTypes": [],
|
|
1751
|
+
"type": "number"
|
|
1752
|
+
}
|
|
1753
|
+
]
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"name": "SetLoopOptions",
|
|
1757
|
+
"slug": "setloopoptions",
|
|
1758
|
+
"docs": "",
|
|
1759
|
+
"tags": [],
|
|
1760
|
+
"methods": [],
|
|
1761
|
+
"properties": [
|
|
1762
|
+
{
|
|
1763
|
+
"name": "playerId",
|
|
1764
|
+
"tags": [],
|
|
1765
|
+
"docs": "",
|
|
1766
|
+
"complexTypes": [],
|
|
1767
|
+
"type": "string"
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
"name": "loopPlaylists",
|
|
1771
|
+
"tags": [],
|
|
1772
|
+
"docs": "",
|
|
1773
|
+
"complexTypes": [],
|
|
1774
|
+
"type": "boolean"
|
|
1775
|
+
}
|
|
1776
|
+
]
|
|
1777
|
+
},
|
|
1778
|
+
{
|
|
1779
|
+
"name": "SetShuffleOptions",
|
|
1780
|
+
"slug": "setshuffleoptions",
|
|
1781
|
+
"docs": "",
|
|
1782
|
+
"tags": [],
|
|
1783
|
+
"methods": [],
|
|
1784
|
+
"properties": [
|
|
1785
|
+
{
|
|
1786
|
+
"name": "playerId",
|
|
1787
|
+
"tags": [],
|
|
1788
|
+
"docs": "",
|
|
1789
|
+
"complexTypes": [],
|
|
1790
|
+
"type": "string"
|
|
1791
|
+
},
|
|
1792
|
+
{
|
|
1793
|
+
"name": "shufflePlaylist",
|
|
1794
|
+
"tags": [],
|
|
1795
|
+
"docs": "",
|
|
1796
|
+
"complexTypes": [],
|
|
1797
|
+
"type": "boolean"
|
|
1798
|
+
}
|
|
1799
|
+
]
|
|
1800
|
+
},
|
|
1661
1801
|
{
|
|
1662
1802
|
"name": "Map",
|
|
1663
1803
|
"slug": "map",
|
|
@@ -1805,6 +1945,54 @@
|
|
|
1805
1945
|
}
|
|
1806
1946
|
]
|
|
1807
1947
|
},
|
|
1948
|
+
{
|
|
1949
|
+
"name": "ToggleFullScreenOptions",
|
|
1950
|
+
"slug": "togglefullscreenoptions",
|
|
1951
|
+
"docs": "",
|
|
1952
|
+
"tags": [],
|
|
1953
|
+
"methods": [],
|
|
1954
|
+
"properties": [
|
|
1955
|
+
{
|
|
1956
|
+
"name": "playerId",
|
|
1957
|
+
"tags": [],
|
|
1958
|
+
"docs": "",
|
|
1959
|
+
"complexTypes": [],
|
|
1960
|
+
"type": "string"
|
|
1961
|
+
},
|
|
1962
|
+
{
|
|
1963
|
+
"name": "isFullScreen",
|
|
1964
|
+
"tags": [],
|
|
1965
|
+
"docs": "",
|
|
1966
|
+
"complexTypes": [],
|
|
1967
|
+
"type": "boolean | null | undefined"
|
|
1968
|
+
}
|
|
1969
|
+
]
|
|
1970
|
+
},
|
|
1971
|
+
{
|
|
1972
|
+
"name": "SetPlaybackQualityOptions",
|
|
1973
|
+
"slug": "setplaybackqualityoptions",
|
|
1974
|
+
"docs": "",
|
|
1975
|
+
"tags": [],
|
|
1976
|
+
"methods": [],
|
|
1977
|
+
"properties": [
|
|
1978
|
+
{
|
|
1979
|
+
"name": "playerId",
|
|
1980
|
+
"tags": [],
|
|
1981
|
+
"docs": "",
|
|
1982
|
+
"complexTypes": [],
|
|
1983
|
+
"type": "string"
|
|
1984
|
+
},
|
|
1985
|
+
{
|
|
1986
|
+
"name": "suggestedQuality",
|
|
1987
|
+
"tags": [],
|
|
1988
|
+
"docs": "",
|
|
1989
|
+
"complexTypes": [
|
|
1990
|
+
"IPlaybackQuality"
|
|
1991
|
+
],
|
|
1992
|
+
"type": "IPlaybackQuality"
|
|
1993
|
+
}
|
|
1994
|
+
]
|
|
1995
|
+
},
|
|
1808
1996
|
{
|
|
1809
1997
|
"name": "PlayerEvent",
|
|
1810
1998
|
"slug": "playerevent",
|
|
@@ -1823,6 +2011,40 @@
|
|
|
1823
2011
|
}
|
|
1824
2012
|
]
|
|
1825
2013
|
},
|
|
2014
|
+
{
|
|
2015
|
+
"name": "PlayerEventListenerOptions",
|
|
2016
|
+
"slug": "playereventlisteneroptions",
|
|
2017
|
+
"docs": "",
|
|
2018
|
+
"tags": [],
|
|
2019
|
+
"methods": [],
|
|
2020
|
+
"properties": [
|
|
2021
|
+
{
|
|
2022
|
+
"name": "playerId",
|
|
2023
|
+
"tags": [],
|
|
2024
|
+
"docs": "",
|
|
2025
|
+
"complexTypes": [],
|
|
2026
|
+
"type": "string"
|
|
2027
|
+
},
|
|
2028
|
+
{
|
|
2029
|
+
"name": "eventName",
|
|
2030
|
+
"tags": [],
|
|
2031
|
+
"docs": "",
|
|
2032
|
+
"complexTypes": [
|
|
2033
|
+
"Events"
|
|
2034
|
+
],
|
|
2035
|
+
"type": "keyof Events"
|
|
2036
|
+
},
|
|
2037
|
+
{
|
|
2038
|
+
"name": "listener",
|
|
2039
|
+
"tags": [],
|
|
2040
|
+
"docs": "",
|
|
2041
|
+
"complexTypes": [
|
|
2042
|
+
"TEvent"
|
|
2043
|
+
],
|
|
2044
|
+
"type": "(event: TEvent) => void"
|
|
2045
|
+
}
|
|
2046
|
+
]
|
|
2047
|
+
},
|
|
1826
2048
|
{
|
|
1827
2049
|
"name": "Events",
|
|
1828
2050
|
"slug": "events",
|