@gcorevideo/player 2.9.0 → 2.10.0

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.
Files changed (93) hide show
  1. package/README.md +39 -0
  2. package/api-extractor.json +454 -0
  3. package/dist/index.js +999 -187
  4. package/dist/player.d.ts +407 -0
  5. package/docs/api/index.md +31 -0
  6. package/docs/api/player.dashsettings.md +16 -0
  7. package/docs/api/player.langtag.md +15 -0
  8. package/docs/api/player.md +295 -0
  9. package/docs/api/player.mediatransport.md +15 -0
  10. package/docs/api/player.playbackmodule.md +15 -0
  11. package/docs/api/player.playbacktype.md +16 -0
  12. package/docs/api/player.player._constructor_.md +50 -0
  13. package/docs/api/player.player.attachto.md +56 -0
  14. package/docs/api/player.player.configure.md +58 -0
  15. package/docs/api/player.player.destroy.md +20 -0
  16. package/docs/api/player.player.getcurrenttime.md +22 -0
  17. package/docs/api/player.player.getduration.md +22 -0
  18. package/docs/api/player.player.md +304 -0
  19. package/docs/api/player.player.mute.md +20 -0
  20. package/docs/api/player.player.off.md +72 -0
  21. package/docs/api/player.player.on.md +72 -0
  22. package/docs/api/player.player.pause.md +20 -0
  23. package/docs/api/player.player.play.md +20 -0
  24. package/docs/api/player.player.registerplugin.md +56 -0
  25. package/docs/api/player.player.resize.md +59 -0
  26. package/docs/api/player.player.seek.md +56 -0
  27. package/docs/api/player.player.stop.md +20 -0
  28. package/docs/api/player.player.unmute.md +20 -0
  29. package/docs/api/player.player.unregisterplugin.md +56 -0
  30. package/docs/api/player.playerconfig.autoplay.md +16 -0
  31. package/docs/api/player.playerconfig.dash.md +16 -0
  32. package/docs/api/player.playerconfig.debug.md +16 -0
  33. package/docs/api/player.playerconfig.language.md +16 -0
  34. package/docs/api/player.playerconfig.loop.md +16 -0
  35. package/docs/api/player.playerconfig.md +266 -0
  36. package/docs/api/player.playerconfig.mute.md +16 -0
  37. package/docs/api/player.playerconfig.playbacktype.md +16 -0
  38. package/docs/api/player.playerconfig.prioritytransport.md +16 -0
  39. package/docs/api/player.playerconfig.sources.md +16 -0
  40. package/docs/api/player.playerconfig.strings.md +16 -0
  41. package/docs/api/player.playerdebugsettings.md +20 -0
  42. package/docs/api/player.playerdebugtag.md +15 -0
  43. package/docs/api/player.playerevent.md +116 -0
  44. package/docs/api/player.playereventhandler.md +17 -0
  45. package/docs/api/player.playermediasource.md +18 -0
  46. package/docs/api/player.playermediasourcedesc.md +83 -0
  47. package/docs/api/player.playermediasourcedesc.mimetype.md +16 -0
  48. package/docs/api/player.playermediasourcedesc.source.md +16 -0
  49. package/docs/api/player.playerplugin.md +17 -0
  50. package/docs/api/player.qualitylevel.md +20 -0
  51. package/docs/api/player.translationkey.md +15 -0
  52. package/docs/api/player.translationsettings.md +35 -0
  53. package/docs/api/player.transportpreference.md +17 -0
  54. package/docs/api/player.version.md +27 -0
  55. package/lib/Player.d.ts +83 -5
  56. package/lib/Player.d.ts.map +1 -1
  57. package/lib/Player.js +99 -25
  58. package/lib/constants.d.ts +0 -18
  59. package/lib/constants.d.ts.map +1 -1
  60. package/lib/constants.js +1 -18
  61. package/lib/gcore.types.d.ts +84 -0
  62. package/lib/gcore.types.d.ts.map +1 -0
  63. package/lib/gcore.types.js +9 -0
  64. package/lib/index.d.ts +10 -1
  65. package/lib/index.d.ts.map +1 -1
  66. package/lib/index.js +10 -1
  67. package/lib/internal.types.d.ts +28 -11
  68. package/lib/internal.types.d.ts.map +1 -1
  69. package/lib/playback.types.d.ts +19 -5
  70. package/lib/playback.types.d.ts.map +1 -1
  71. package/lib/tsdoc-metadata.json +11 -0
  72. package/lib/types.d.ts +179 -62
  73. package/lib/types.d.ts.map +1 -1
  74. package/lib/types.js +19 -0
  75. package/lib/utils/mediaSources.d.ts +1 -3
  76. package/lib/utils/mediaSources.d.ts.map +1 -1
  77. package/lib/utils/mediaSources.js +0 -9
  78. package/lib/version.d.ts +5 -0
  79. package/lib/version.d.ts.map +1 -1
  80. package/lib/version.js +5 -0
  81. package/package.json +5 -1
  82. package/src/Player.ts +113 -32
  83. package/src/index.ts +11 -1
  84. package/src/internal.types.ts +28 -15
  85. package/src/playback.types.ts +20 -6
  86. package/src/types.ts +196 -74
  87. package/src/utils/mediaSources.ts +1 -15
  88. package/src/version.ts +5 -0
  89. package/temp/player.api.json +1950 -0
  90. package/tsconfig.tsbuildinfo +1 -1
  91. package/src/constants.ts +0 -17
  92. package/src/plugins/dash-playback/_DashPlayback.js +0 -688
  93. package/src/typings/@clappr/plugins.d.ts +0 -23
@@ -0,0 +1,1950 @@
1
+ {
2
+ "metadata": {
3
+ "toolPackage": "@microsoft/api-extractor",
4
+ "toolVersion": "7.49.1",
5
+ "schemaVersion": 1011,
6
+ "oldestForwardsCompatibleVersion": 1001,
7
+ "tsdocConfig": {
8
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
9
+ "noStandardTags": true,
10
+ "tagDefinitions": [
11
+ {
12
+ "tagName": "@alpha",
13
+ "syntaxKind": "modifier"
14
+ },
15
+ {
16
+ "tagName": "@beta",
17
+ "syntaxKind": "modifier"
18
+ },
19
+ {
20
+ "tagName": "@defaultValue",
21
+ "syntaxKind": "block"
22
+ },
23
+ {
24
+ "tagName": "@decorator",
25
+ "syntaxKind": "block",
26
+ "allowMultiple": true
27
+ },
28
+ {
29
+ "tagName": "@deprecated",
30
+ "syntaxKind": "block"
31
+ },
32
+ {
33
+ "tagName": "@eventProperty",
34
+ "syntaxKind": "modifier"
35
+ },
36
+ {
37
+ "tagName": "@example",
38
+ "syntaxKind": "block",
39
+ "allowMultiple": true
40
+ },
41
+ {
42
+ "tagName": "@experimental",
43
+ "syntaxKind": "modifier"
44
+ },
45
+ {
46
+ "tagName": "@inheritDoc",
47
+ "syntaxKind": "inline"
48
+ },
49
+ {
50
+ "tagName": "@internal",
51
+ "syntaxKind": "modifier"
52
+ },
53
+ {
54
+ "tagName": "@label",
55
+ "syntaxKind": "inline"
56
+ },
57
+ {
58
+ "tagName": "@link",
59
+ "syntaxKind": "inline",
60
+ "allowMultiple": true
61
+ },
62
+ {
63
+ "tagName": "@override",
64
+ "syntaxKind": "modifier"
65
+ },
66
+ {
67
+ "tagName": "@packageDocumentation",
68
+ "syntaxKind": "modifier"
69
+ },
70
+ {
71
+ "tagName": "@param",
72
+ "syntaxKind": "block",
73
+ "allowMultiple": true
74
+ },
75
+ {
76
+ "tagName": "@privateRemarks",
77
+ "syntaxKind": "block"
78
+ },
79
+ {
80
+ "tagName": "@public",
81
+ "syntaxKind": "modifier"
82
+ },
83
+ {
84
+ "tagName": "@readonly",
85
+ "syntaxKind": "modifier"
86
+ },
87
+ {
88
+ "tagName": "@remarks",
89
+ "syntaxKind": "block"
90
+ },
91
+ {
92
+ "tagName": "@returns",
93
+ "syntaxKind": "block"
94
+ },
95
+ {
96
+ "tagName": "@sealed",
97
+ "syntaxKind": "modifier"
98
+ },
99
+ {
100
+ "tagName": "@see",
101
+ "syntaxKind": "block"
102
+ },
103
+ {
104
+ "tagName": "@throws",
105
+ "syntaxKind": "block",
106
+ "allowMultiple": true
107
+ },
108
+ {
109
+ "tagName": "@typeParam",
110
+ "syntaxKind": "block",
111
+ "allowMultiple": true
112
+ },
113
+ {
114
+ "tagName": "@virtual",
115
+ "syntaxKind": "modifier"
116
+ },
117
+ {
118
+ "tagName": "@betaDocumentation",
119
+ "syntaxKind": "modifier"
120
+ },
121
+ {
122
+ "tagName": "@internalRemarks",
123
+ "syntaxKind": "block"
124
+ },
125
+ {
126
+ "tagName": "@preapproved",
127
+ "syntaxKind": "modifier"
128
+ }
129
+ ],
130
+ "supportForTags": {
131
+ "@alpha": true,
132
+ "@beta": true,
133
+ "@defaultValue": true,
134
+ "@decorator": true,
135
+ "@deprecated": true,
136
+ "@eventProperty": true,
137
+ "@example": true,
138
+ "@experimental": true,
139
+ "@inheritDoc": true,
140
+ "@internal": true,
141
+ "@label": true,
142
+ "@link": true,
143
+ "@override": true,
144
+ "@packageDocumentation": true,
145
+ "@param": true,
146
+ "@privateRemarks": true,
147
+ "@public": true,
148
+ "@readonly": true,
149
+ "@remarks": true,
150
+ "@returns": true,
151
+ "@sealed": true,
152
+ "@see": true,
153
+ "@throws": true,
154
+ "@typeParam": true,
155
+ "@virtual": true,
156
+ "@betaDocumentation": true,
157
+ "@internalRemarks": true,
158
+ "@preapproved": true
159
+ },
160
+ "reportUnsupportedHtmlElements": false
161
+ }
162
+ },
163
+ "kind": "Package",
164
+ "canonicalReference": "@gcorevideo/player!",
165
+ "docComment": "/**\n * Video player for the GCore streaming platform\n *\n * @remarks\n *\n * This package provides a video player for the GCore streaming platform. It is built on top of the Clappr library and provides a framework for building custom integrations.\n *\n * @packageDocumentation\n */\n",
166
+ "name": "@gcorevideo/player",
167
+ "preserveMemberOrder": false,
168
+ "members": [
169
+ {
170
+ "kind": "EntryPoint",
171
+ "canonicalReference": "@gcorevideo/player!",
172
+ "name": "",
173
+ "preserveMemberOrder": false,
174
+ "members": [
175
+ {
176
+ "kind": "TypeAlias",
177
+ "canonicalReference": "@gcorevideo/player!DashSettings:type",
178
+ "docComment": "/**\n * {@link https://cdn.dashjs.org/latest/jsdoc/module-Settings.html | DASH.js settings}\n *\n * @beta\n */\n",
179
+ "excerptTokens": [
180
+ {
181
+ "kind": "Content",
182
+ "text": "export type DashSettings = "
183
+ },
184
+ {
185
+ "kind": "Reference",
186
+ "text": "Record",
187
+ "canonicalReference": "!Record:type"
188
+ },
189
+ {
190
+ "kind": "Content",
191
+ "text": "<string, unknown>"
192
+ },
193
+ {
194
+ "kind": "Content",
195
+ "text": ";"
196
+ }
197
+ ],
198
+ "fileUrlPath": "src/types.ts",
199
+ "releaseTag": "Beta",
200
+ "name": "DashSettings",
201
+ "typeTokenRange": {
202
+ "startIndex": 1,
203
+ "endIndex": 3
204
+ }
205
+ },
206
+ {
207
+ "kind": "TypeAlias",
208
+ "canonicalReference": "@gcorevideo/player!LangTag:type",
209
+ "docComment": "/**\n * @beta\n */\n",
210
+ "excerptTokens": [
211
+ {
212
+ "kind": "Content",
213
+ "text": "export type LangTag = "
214
+ },
215
+ {
216
+ "kind": "Content",
217
+ "text": "string"
218
+ },
219
+ {
220
+ "kind": "Content",
221
+ "text": ";"
222
+ }
223
+ ],
224
+ "fileUrlPath": "src/types.ts",
225
+ "releaseTag": "Beta",
226
+ "name": "LangTag",
227
+ "typeTokenRange": {
228
+ "startIndex": 1,
229
+ "endIndex": 2
230
+ }
231
+ },
232
+ {
233
+ "kind": "TypeAlias",
234
+ "canonicalReference": "@gcorevideo/player!MediaTransport:type",
235
+ "docComment": "/**\n * @beta\n */\n",
236
+ "excerptTokens": [
237
+ {
238
+ "kind": "Content",
239
+ "text": "export type MediaTransport = "
240
+ },
241
+ {
242
+ "kind": "Content",
243
+ "text": "'dash' | 'hls' | 'mpegts'"
244
+ },
245
+ {
246
+ "kind": "Content",
247
+ "text": ";"
248
+ }
249
+ ],
250
+ "fileUrlPath": "src/types.ts",
251
+ "releaseTag": "Beta",
252
+ "name": "MediaTransport",
253
+ "typeTokenRange": {
254
+ "startIndex": 1,
255
+ "endIndex": 2
256
+ }
257
+ },
258
+ {
259
+ "kind": "TypeAlias",
260
+ "canonicalReference": "@gcorevideo/player!PlaybackModule:type",
261
+ "docComment": "/**\n * @beta\n */\n",
262
+ "excerptTokens": [
263
+ {
264
+ "kind": "Content",
265
+ "text": "export type PlaybackModule = "
266
+ },
267
+ {
268
+ "kind": "Content",
269
+ "text": "'dash' | 'hls' | 'native'"
270
+ },
271
+ {
272
+ "kind": "Content",
273
+ "text": ";"
274
+ }
275
+ ],
276
+ "fileUrlPath": "src/Player.ts",
277
+ "releaseTag": "Beta",
278
+ "name": "PlaybackModule",
279
+ "typeTokenRange": {
280
+ "startIndex": 1,
281
+ "endIndex": 2
282
+ }
283
+ },
284
+ {
285
+ "kind": "TypeAlias",
286
+ "canonicalReference": "@gcorevideo/player!PlaybackType:type",
287
+ "docComment": "/**\n * Type of a stream playback\n *\n * @beta\n */\n",
288
+ "excerptTokens": [
289
+ {
290
+ "kind": "Content",
291
+ "text": "export type PlaybackType = "
292
+ },
293
+ {
294
+ "kind": "Content",
295
+ "text": "'live' | 'vod'"
296
+ },
297
+ {
298
+ "kind": "Content",
299
+ "text": ";"
300
+ }
301
+ ],
302
+ "fileUrlPath": "src/types.ts",
303
+ "releaseTag": "Beta",
304
+ "name": "PlaybackType",
305
+ "typeTokenRange": {
306
+ "startIndex": 1,
307
+ "endIndex": 2
308
+ }
309
+ },
310
+ {
311
+ "kind": "Class",
312
+ "canonicalReference": "@gcorevideo/player!Player:class",
313
+ "docComment": "/**\n * The main component to use in the application code.\n *\n * @remarks\n *\n * The Player object provides very basic API to control playback. To build a sophisticated UI, use the plugins framework to tap into the Clappr core. {@link https://github.com/clappr/clappr/wiki/Architecture}\n *\n * @beta\n */\n",
314
+ "excerptTokens": [
315
+ {
316
+ "kind": "Content",
317
+ "text": "export declare class Player "
318
+ }
319
+ ],
320
+ "fileUrlPath": "src/Player.ts",
321
+ "releaseTag": "Beta",
322
+ "isAbstract": false,
323
+ "name": "Player",
324
+ "preserveMemberOrder": false,
325
+ "members": [
326
+ {
327
+ "kind": "Constructor",
328
+ "canonicalReference": "@gcorevideo/player!Player:constructor(1)",
329
+ "docComment": "/**\n * Constructs a new instance of the `Player` class\n */\n",
330
+ "excerptTokens": [
331
+ {
332
+ "kind": "Content",
333
+ "text": "constructor(config: "
334
+ },
335
+ {
336
+ "kind": "Reference",
337
+ "text": "PlayerConfig",
338
+ "canonicalReference": "@gcorevideo/player!PlayerConfig:interface"
339
+ },
340
+ {
341
+ "kind": "Content",
342
+ "text": ");"
343
+ }
344
+ ],
345
+ "releaseTag": "Beta",
346
+ "isProtected": false,
347
+ "overloadIndex": 1,
348
+ "parameters": [
349
+ {
350
+ "parameterName": "config",
351
+ "parameterTypeTokenRange": {
352
+ "startIndex": 1,
353
+ "endIndex": 2
354
+ },
355
+ "isOptional": false
356
+ }
357
+ ]
358
+ },
359
+ {
360
+ "kind": "Method",
361
+ "canonicalReference": "@gcorevideo/player!Player#attachTo:member(1)",
362
+ "docComment": "/**\n * Initializes the player at the given container element.\n *\n * @param playerElement - DOM element to host the player\n */\n",
363
+ "excerptTokens": [
364
+ {
365
+ "kind": "Content",
366
+ "text": "attachTo(playerElement: "
367
+ },
368
+ {
369
+ "kind": "Reference",
370
+ "text": "HTMLElement",
371
+ "canonicalReference": "!HTMLElement:interface"
372
+ },
373
+ {
374
+ "kind": "Content",
375
+ "text": "): "
376
+ },
377
+ {
378
+ "kind": "Content",
379
+ "text": "void"
380
+ },
381
+ {
382
+ "kind": "Content",
383
+ "text": ";"
384
+ }
385
+ ],
386
+ "isStatic": false,
387
+ "returnTypeTokenRange": {
388
+ "startIndex": 3,
389
+ "endIndex": 4
390
+ },
391
+ "releaseTag": "Beta",
392
+ "isProtected": false,
393
+ "overloadIndex": 1,
394
+ "parameters": [
395
+ {
396
+ "parameterName": "playerElement",
397
+ "parameterTypeTokenRange": {
398
+ "startIndex": 1,
399
+ "endIndex": 2
400
+ },
401
+ "isOptional": false
402
+ }
403
+ ],
404
+ "isOptional": false,
405
+ "isAbstract": false,
406
+ "name": "attachTo"
407
+ },
408
+ {
409
+ "kind": "Method",
410
+ "canonicalReference": "@gcorevideo/player!Player#configure:member(1)",
411
+ "docComment": "/**\n * Configures the player.\n *\n * Can be called multiple times. Each consequent call extends the previous configuration. After a reconfiguration, if something significant has changed, the must be reinitialized (i.e, a `.destroy()` followed by an `.init()` call).\n *\n * @param config - complete or partial configuration\n */\n",
412
+ "excerptTokens": [
413
+ {
414
+ "kind": "Content",
415
+ "text": "configure(config: "
416
+ },
417
+ {
418
+ "kind": "Reference",
419
+ "text": "Partial",
420
+ "canonicalReference": "!Partial:type"
421
+ },
422
+ {
423
+ "kind": "Content",
424
+ "text": "<"
425
+ },
426
+ {
427
+ "kind": "Reference",
428
+ "text": "PlayerConfig",
429
+ "canonicalReference": "@gcorevideo/player!PlayerConfig:interface"
430
+ },
431
+ {
432
+ "kind": "Content",
433
+ "text": ">"
434
+ },
435
+ {
436
+ "kind": "Content",
437
+ "text": "): "
438
+ },
439
+ {
440
+ "kind": "Content",
441
+ "text": "void"
442
+ },
443
+ {
444
+ "kind": "Content",
445
+ "text": ";"
446
+ }
447
+ ],
448
+ "isStatic": false,
449
+ "returnTypeTokenRange": {
450
+ "startIndex": 6,
451
+ "endIndex": 7
452
+ },
453
+ "releaseTag": "Beta",
454
+ "isProtected": false,
455
+ "overloadIndex": 1,
456
+ "parameters": [
457
+ {
458
+ "parameterName": "config",
459
+ "parameterTypeTokenRange": {
460
+ "startIndex": 1,
461
+ "endIndex": 5
462
+ },
463
+ "isOptional": false
464
+ }
465
+ ],
466
+ "isOptional": false,
467
+ "isAbstract": false,
468
+ "name": "configure"
469
+ },
470
+ {
471
+ "kind": "Method",
472
+ "canonicalReference": "@gcorevideo/player!Player#destroy:member(1)",
473
+ "docComment": "/**\n * Destroys the player, releasing all resources and removing any DOM elements added.\n */\n",
474
+ "excerptTokens": [
475
+ {
476
+ "kind": "Content",
477
+ "text": "destroy(): "
478
+ },
479
+ {
480
+ "kind": "Content",
481
+ "text": "void"
482
+ },
483
+ {
484
+ "kind": "Content",
485
+ "text": ";"
486
+ }
487
+ ],
488
+ "isStatic": false,
489
+ "returnTypeTokenRange": {
490
+ "startIndex": 1,
491
+ "endIndex": 2
492
+ },
493
+ "releaseTag": "Beta",
494
+ "isProtected": false,
495
+ "overloadIndex": 1,
496
+ "parameters": [],
497
+ "isOptional": false,
498
+ "isAbstract": false,
499
+ "name": "destroy"
500
+ },
501
+ {
502
+ "kind": "Method",
503
+ "canonicalReference": "@gcorevideo/player!Player#getCurrentTime:member(1)",
504
+ "docComment": "/**\n * Current playback time in seconds, if appropriate.\n *\n * @returns For live streams, it returns the current time of the current segment.\n */\n",
505
+ "excerptTokens": [
506
+ {
507
+ "kind": "Content",
508
+ "text": "getCurrentTime(): "
509
+ },
510
+ {
511
+ "kind": "Content",
512
+ "text": "number"
513
+ },
514
+ {
515
+ "kind": "Content",
516
+ "text": ";"
517
+ }
518
+ ],
519
+ "isStatic": false,
520
+ "returnTypeTokenRange": {
521
+ "startIndex": 1,
522
+ "endIndex": 2
523
+ },
524
+ "releaseTag": "Beta",
525
+ "isProtected": false,
526
+ "overloadIndex": 1,
527
+ "parameters": [],
528
+ "isOptional": false,
529
+ "isAbstract": false,
530
+ "name": "getCurrentTime"
531
+ },
532
+ {
533
+ "kind": "Method",
534
+ "canonicalReference": "@gcorevideo/player!Player#getDuration:member(1)",
535
+ "docComment": "/**\n * Duration of the current media in seconds, if appropriate.\n *\n * @returns For live streams, it returns the duration of the current segment.\n */\n",
536
+ "excerptTokens": [
537
+ {
538
+ "kind": "Content",
539
+ "text": "getDuration(): "
540
+ },
541
+ {
542
+ "kind": "Content",
543
+ "text": "number"
544
+ },
545
+ {
546
+ "kind": "Content",
547
+ "text": ";"
548
+ }
549
+ ],
550
+ "isStatic": false,
551
+ "returnTypeTokenRange": {
552
+ "startIndex": 1,
553
+ "endIndex": 2
554
+ },
555
+ "releaseTag": "Beta",
556
+ "isProtected": false,
557
+ "overloadIndex": 1,
558
+ "parameters": [],
559
+ "isOptional": false,
560
+ "isAbstract": false,
561
+ "name": "getDuration"
562
+ },
563
+ {
564
+ "kind": "Method",
565
+ "canonicalReference": "@gcorevideo/player!Player#mute:member(1)",
566
+ "docComment": "/**\n * Mutes the player.\n */\n",
567
+ "excerptTokens": [
568
+ {
569
+ "kind": "Content",
570
+ "text": "mute(): "
571
+ },
572
+ {
573
+ "kind": "Content",
574
+ "text": "void"
575
+ },
576
+ {
577
+ "kind": "Content",
578
+ "text": ";"
579
+ }
580
+ ],
581
+ "isStatic": false,
582
+ "returnTypeTokenRange": {
583
+ "startIndex": 1,
584
+ "endIndex": 2
585
+ },
586
+ "releaseTag": "Beta",
587
+ "isProtected": false,
588
+ "overloadIndex": 1,
589
+ "parameters": [],
590
+ "isOptional": false,
591
+ "isAbstract": false,
592
+ "name": "mute"
593
+ },
594
+ {
595
+ "kind": "Method",
596
+ "canonicalReference": "@gcorevideo/player!Player#off:member(1)",
597
+ "docComment": "/**\n * Removes a listener from a player event\n *\n * @param event - See {@link PlayerEvent}\n *\n * @param handler - See {@link PlayerEventHandler}\n */\n",
598
+ "excerptTokens": [
599
+ {
600
+ "kind": "Content",
601
+ "text": "off<T extends "
602
+ },
603
+ {
604
+ "kind": "Reference",
605
+ "text": "PlayerEvent",
606
+ "canonicalReference": "@gcorevideo/player!PlayerEvent:enum"
607
+ },
608
+ {
609
+ "kind": "Content",
610
+ "text": ">(event: "
611
+ },
612
+ {
613
+ "kind": "Content",
614
+ "text": "T"
615
+ },
616
+ {
617
+ "kind": "Content",
618
+ "text": ", handler: "
619
+ },
620
+ {
621
+ "kind": "Reference",
622
+ "text": "PlayerEventHandler",
623
+ "canonicalReference": "@gcorevideo/player!PlayerEventHandler:type"
624
+ },
625
+ {
626
+ "kind": "Content",
627
+ "text": "<T>"
628
+ },
629
+ {
630
+ "kind": "Content",
631
+ "text": "): "
632
+ },
633
+ {
634
+ "kind": "Content",
635
+ "text": "void"
636
+ },
637
+ {
638
+ "kind": "Content",
639
+ "text": ";"
640
+ }
641
+ ],
642
+ "typeParameters": [
643
+ {
644
+ "typeParameterName": "T",
645
+ "constraintTokenRange": {
646
+ "startIndex": 1,
647
+ "endIndex": 2
648
+ },
649
+ "defaultTypeTokenRange": {
650
+ "startIndex": 0,
651
+ "endIndex": 0
652
+ }
653
+ }
654
+ ],
655
+ "isStatic": false,
656
+ "returnTypeTokenRange": {
657
+ "startIndex": 8,
658
+ "endIndex": 9
659
+ },
660
+ "releaseTag": "Beta",
661
+ "isProtected": false,
662
+ "overloadIndex": 1,
663
+ "parameters": [
664
+ {
665
+ "parameterName": "event",
666
+ "parameterTypeTokenRange": {
667
+ "startIndex": 3,
668
+ "endIndex": 4
669
+ },
670
+ "isOptional": false
671
+ },
672
+ {
673
+ "parameterName": "handler",
674
+ "parameterTypeTokenRange": {
675
+ "startIndex": 5,
676
+ "endIndex": 7
677
+ },
678
+ "isOptional": false
679
+ }
680
+ ],
681
+ "isOptional": false,
682
+ "isAbstract": false,
683
+ "name": "off"
684
+ },
685
+ {
686
+ "kind": "Method",
687
+ "canonicalReference": "@gcorevideo/player!Player#on:member(1)",
688
+ "docComment": "/**\n * Adds a listener to a player event\n *\n * @param event - See {@link PlayerEvent}\n *\n * @param handler - See {@link PlayerEventHandler}\n */\n",
689
+ "excerptTokens": [
690
+ {
691
+ "kind": "Content",
692
+ "text": "on<T extends "
693
+ },
694
+ {
695
+ "kind": "Reference",
696
+ "text": "PlayerEvent",
697
+ "canonicalReference": "@gcorevideo/player!PlayerEvent:enum"
698
+ },
699
+ {
700
+ "kind": "Content",
701
+ "text": ">(event: "
702
+ },
703
+ {
704
+ "kind": "Content",
705
+ "text": "T"
706
+ },
707
+ {
708
+ "kind": "Content",
709
+ "text": ", handler: "
710
+ },
711
+ {
712
+ "kind": "Reference",
713
+ "text": "PlayerEventHandler",
714
+ "canonicalReference": "@gcorevideo/player!PlayerEventHandler:type"
715
+ },
716
+ {
717
+ "kind": "Content",
718
+ "text": "<T>"
719
+ },
720
+ {
721
+ "kind": "Content",
722
+ "text": "): "
723
+ },
724
+ {
725
+ "kind": "Content",
726
+ "text": "void"
727
+ },
728
+ {
729
+ "kind": "Content",
730
+ "text": ";"
731
+ }
732
+ ],
733
+ "typeParameters": [
734
+ {
735
+ "typeParameterName": "T",
736
+ "constraintTokenRange": {
737
+ "startIndex": 1,
738
+ "endIndex": 2
739
+ },
740
+ "defaultTypeTokenRange": {
741
+ "startIndex": 0,
742
+ "endIndex": 0
743
+ }
744
+ }
745
+ ],
746
+ "isStatic": false,
747
+ "returnTypeTokenRange": {
748
+ "startIndex": 8,
749
+ "endIndex": 9
750
+ },
751
+ "releaseTag": "Beta",
752
+ "isProtected": false,
753
+ "overloadIndex": 1,
754
+ "parameters": [
755
+ {
756
+ "parameterName": "event",
757
+ "parameterTypeTokenRange": {
758
+ "startIndex": 3,
759
+ "endIndex": 4
760
+ },
761
+ "isOptional": false
762
+ },
763
+ {
764
+ "parameterName": "handler",
765
+ "parameterTypeTokenRange": {
766
+ "startIndex": 5,
767
+ "endIndex": 7
768
+ },
769
+ "isOptional": false
770
+ }
771
+ ],
772
+ "isOptional": false,
773
+ "isAbstract": false,
774
+ "name": "on"
775
+ },
776
+ {
777
+ "kind": "Method",
778
+ "canonicalReference": "@gcorevideo/player!Player#pause:member(1)",
779
+ "docComment": "/**\n * Pauses playback.\n */\n",
780
+ "excerptTokens": [
781
+ {
782
+ "kind": "Content",
783
+ "text": "pause(): "
784
+ },
785
+ {
786
+ "kind": "Content",
787
+ "text": "void"
788
+ },
789
+ {
790
+ "kind": "Content",
791
+ "text": ";"
792
+ }
793
+ ],
794
+ "isStatic": false,
795
+ "returnTypeTokenRange": {
796
+ "startIndex": 1,
797
+ "endIndex": 2
798
+ },
799
+ "releaseTag": "Beta",
800
+ "isProtected": false,
801
+ "overloadIndex": 1,
802
+ "parameters": [],
803
+ "isOptional": false,
804
+ "isAbstract": false,
805
+ "name": "pause"
806
+ },
807
+ {
808
+ "kind": "Method",
809
+ "canonicalReference": "@gcorevideo/player!Player#play:member(1)",
810
+ "docComment": "/**\n * Starts playback.\n */\n",
811
+ "excerptTokens": [
812
+ {
813
+ "kind": "Content",
814
+ "text": "play(): "
815
+ },
816
+ {
817
+ "kind": "Content",
818
+ "text": "void"
819
+ },
820
+ {
821
+ "kind": "Content",
822
+ "text": ";"
823
+ }
824
+ ],
825
+ "isStatic": false,
826
+ "returnTypeTokenRange": {
827
+ "startIndex": 1,
828
+ "endIndex": 2
829
+ },
830
+ "releaseTag": "Beta",
831
+ "isProtected": false,
832
+ "overloadIndex": 1,
833
+ "parameters": [],
834
+ "isOptional": false,
835
+ "isAbstract": false,
836
+ "name": "play"
837
+ },
838
+ {
839
+ "kind": "Method",
840
+ "canonicalReference": "@gcorevideo/player!Player.registerPlugin:member(1)",
841
+ "docComment": "/**\n * Registers a plugin.\n *\n * @param plugin - plugin to register\n */\n",
842
+ "excerptTokens": [
843
+ {
844
+ "kind": "Content",
845
+ "text": "static registerPlugin(plugin: "
846
+ },
847
+ {
848
+ "kind": "Reference",
849
+ "text": "PlayerPlugin",
850
+ "canonicalReference": "@gcorevideo/player!PlayerPlugin:type"
851
+ },
852
+ {
853
+ "kind": "Content",
854
+ "text": "): "
855
+ },
856
+ {
857
+ "kind": "Content",
858
+ "text": "void"
859
+ },
860
+ {
861
+ "kind": "Content",
862
+ "text": ";"
863
+ }
864
+ ],
865
+ "isStatic": true,
866
+ "returnTypeTokenRange": {
867
+ "startIndex": 3,
868
+ "endIndex": 4
869
+ },
870
+ "releaseTag": "Beta",
871
+ "isProtected": false,
872
+ "overloadIndex": 1,
873
+ "parameters": [
874
+ {
875
+ "parameterName": "plugin",
876
+ "parameterTypeTokenRange": {
877
+ "startIndex": 1,
878
+ "endIndex": 2
879
+ },
880
+ "isOptional": false
881
+ }
882
+ ],
883
+ "isOptional": false,
884
+ "isAbstract": false,
885
+ "name": "registerPlugin"
886
+ },
887
+ {
888
+ "kind": "Method",
889
+ "canonicalReference": "@gcorevideo/player!Player#resize:member(1)",
890
+ "docComment": "/**\n * Resizes the player container element and everything within it.\n *\n * @param newSize - new size of the player\n */\n",
891
+ "excerptTokens": [
892
+ {
893
+ "kind": "Content",
894
+ "text": "resize(newSize: "
895
+ },
896
+ {
897
+ "kind": "Content",
898
+ "text": "{\n width: number;\n height: number;\n }"
899
+ },
900
+ {
901
+ "kind": "Content",
902
+ "text": "): "
903
+ },
904
+ {
905
+ "kind": "Content",
906
+ "text": "void"
907
+ },
908
+ {
909
+ "kind": "Content",
910
+ "text": ";"
911
+ }
912
+ ],
913
+ "isStatic": false,
914
+ "returnTypeTokenRange": {
915
+ "startIndex": 3,
916
+ "endIndex": 4
917
+ },
918
+ "releaseTag": "Beta",
919
+ "isProtected": false,
920
+ "overloadIndex": 1,
921
+ "parameters": [
922
+ {
923
+ "parameterName": "newSize",
924
+ "parameterTypeTokenRange": {
925
+ "startIndex": 1,
926
+ "endIndex": 2
927
+ },
928
+ "isOptional": false
929
+ }
930
+ ],
931
+ "isOptional": false,
932
+ "isAbstract": false,
933
+ "name": "resize"
934
+ },
935
+ {
936
+ "kind": "Method",
937
+ "canonicalReference": "@gcorevideo/player!Player#seek:member(1)",
938
+ "docComment": "/**\n * Seeks to the given time.\n *\n * @param time - time to seek to in seconds\n */\n",
939
+ "excerptTokens": [
940
+ {
941
+ "kind": "Content",
942
+ "text": "seek(time: "
943
+ },
944
+ {
945
+ "kind": "Content",
946
+ "text": "number"
947
+ },
948
+ {
949
+ "kind": "Content",
950
+ "text": "): "
951
+ },
952
+ {
953
+ "kind": "Content",
954
+ "text": "void"
955
+ },
956
+ {
957
+ "kind": "Content",
958
+ "text": ";"
959
+ }
960
+ ],
961
+ "isStatic": false,
962
+ "returnTypeTokenRange": {
963
+ "startIndex": 3,
964
+ "endIndex": 4
965
+ },
966
+ "releaseTag": "Beta",
967
+ "isProtected": false,
968
+ "overloadIndex": 1,
969
+ "parameters": [
970
+ {
971
+ "parameterName": "time",
972
+ "parameterTypeTokenRange": {
973
+ "startIndex": 1,
974
+ "endIndex": 2
975
+ },
976
+ "isOptional": false
977
+ }
978
+ ],
979
+ "isOptional": false,
980
+ "isAbstract": false,
981
+ "name": "seek"
982
+ },
983
+ {
984
+ "kind": "Method",
985
+ "canonicalReference": "@gcorevideo/player!Player#stop:member(1)",
986
+ "docComment": "/**\n * Stops playback.\n */\n",
987
+ "excerptTokens": [
988
+ {
989
+ "kind": "Content",
990
+ "text": "stop(): "
991
+ },
992
+ {
993
+ "kind": "Content",
994
+ "text": "void"
995
+ },
996
+ {
997
+ "kind": "Content",
998
+ "text": ";"
999
+ }
1000
+ ],
1001
+ "isStatic": false,
1002
+ "returnTypeTokenRange": {
1003
+ "startIndex": 1,
1004
+ "endIndex": 2
1005
+ },
1006
+ "releaseTag": "Beta",
1007
+ "isProtected": false,
1008
+ "overloadIndex": 1,
1009
+ "parameters": [],
1010
+ "isOptional": false,
1011
+ "isAbstract": false,
1012
+ "name": "stop"
1013
+ },
1014
+ {
1015
+ "kind": "Method",
1016
+ "canonicalReference": "@gcorevideo/player!Player#unmute:member(1)",
1017
+ "docComment": "/**\n * Unmutes the player.\n */\n",
1018
+ "excerptTokens": [
1019
+ {
1020
+ "kind": "Content",
1021
+ "text": "unmute(): "
1022
+ },
1023
+ {
1024
+ "kind": "Content",
1025
+ "text": "void"
1026
+ },
1027
+ {
1028
+ "kind": "Content",
1029
+ "text": ";"
1030
+ }
1031
+ ],
1032
+ "isStatic": false,
1033
+ "returnTypeTokenRange": {
1034
+ "startIndex": 1,
1035
+ "endIndex": 2
1036
+ },
1037
+ "releaseTag": "Beta",
1038
+ "isProtected": false,
1039
+ "overloadIndex": 1,
1040
+ "parameters": [],
1041
+ "isOptional": false,
1042
+ "isAbstract": false,
1043
+ "name": "unmute"
1044
+ },
1045
+ {
1046
+ "kind": "Method",
1047
+ "canonicalReference": "@gcorevideo/player!Player.unregisterPlugin:member(1)",
1048
+ "docComment": "/**\n * Unregisters a plugin.\n *\n * @param plugin - plugin to unregister\n */\n",
1049
+ "excerptTokens": [
1050
+ {
1051
+ "kind": "Content",
1052
+ "text": "static unregisterPlugin(plugin: "
1053
+ },
1054
+ {
1055
+ "kind": "Reference",
1056
+ "text": "PlayerPlugin",
1057
+ "canonicalReference": "@gcorevideo/player!PlayerPlugin:type"
1058
+ },
1059
+ {
1060
+ "kind": "Content",
1061
+ "text": "): "
1062
+ },
1063
+ {
1064
+ "kind": "Content",
1065
+ "text": "void"
1066
+ },
1067
+ {
1068
+ "kind": "Content",
1069
+ "text": ";"
1070
+ }
1071
+ ],
1072
+ "isStatic": true,
1073
+ "returnTypeTokenRange": {
1074
+ "startIndex": 3,
1075
+ "endIndex": 4
1076
+ },
1077
+ "releaseTag": "Beta",
1078
+ "isProtected": false,
1079
+ "overloadIndex": 1,
1080
+ "parameters": [
1081
+ {
1082
+ "parameterName": "plugin",
1083
+ "parameterTypeTokenRange": {
1084
+ "startIndex": 1,
1085
+ "endIndex": 2
1086
+ },
1087
+ "isOptional": false
1088
+ }
1089
+ ],
1090
+ "isOptional": false,
1091
+ "isAbstract": false,
1092
+ "name": "unregisterPlugin"
1093
+ }
1094
+ ],
1095
+ "implementsTokenRanges": []
1096
+ },
1097
+ {
1098
+ "kind": "Interface",
1099
+ "canonicalReference": "@gcorevideo/player!PlayerConfig:interface",
1100
+ "docComment": "/**\n * Configuration options for the player\n *\n * @remarks\n *\n * You can specify multiple sources, each in two forms: just a plain URL or a full object with `source` and `mimeType` fields {@link PlayerMediaSource}. The player will pick the first viable media source according to the source availability, and either the transport preference or standard transport selection order.\n *\n * `priorityTransport` is used to specify the preferred transport protocol when multiple sources are available. It will first try to use the transport specified if it's supported (by a playback engine) and the source is available. Otherwise it will try the other transports in the regular order (dash, hls, mpegts).\n *\n * The `autoPlay` option should be used together with the {@link PlayerConfig.mute | mute} to avoid issues with the browsers' autoplay policies.\n *\n * Note that the `playbackType` is specified explicitly in the examle below, but a playback engine might be able to detect the type of the stream automatically.\n *\n * A plugin options can be specified in the configuration object under a unique key, typically corresponding to the plugin name. The plugin object will have access to the internal normalized configuration object that contains all the custom options. in the examle below, the `poster` field is the `Poster` plugin configuration options.\n *\n * @example\n * ```ts\n * {\n * autoPlay: true,\n * mute: true,\n * playbackType: 'live',\n * priorityTransport: 'dash',\n * sources: [{\n * source: 'https://example.com/myownair66.mpd',\n * mimeType: 'application/dash+xml',\n * }, {\n * source: 'https://example.com/myownair66.m3u8',\n * mimeType: 'application/x-mpegURL',\n * }],\n * poster: {\n * url: settings.poster,\n * },\n * }\n * ```\n *\n * @beta\n */\n",
1101
+ "excerptTokens": [
1102
+ {
1103
+ "kind": "Content",
1104
+ "text": "export interface PlayerConfig extends "
1105
+ },
1106
+ {
1107
+ "kind": "Reference",
1108
+ "text": "Record",
1109
+ "canonicalReference": "!Record:type"
1110
+ },
1111
+ {
1112
+ "kind": "Content",
1113
+ "text": "<string, unknown>"
1114
+ },
1115
+ {
1116
+ "kind": "Content",
1117
+ "text": " "
1118
+ }
1119
+ ],
1120
+ "fileUrlPath": "src/types.ts",
1121
+ "releaseTag": "Beta",
1122
+ "name": "PlayerConfig",
1123
+ "preserveMemberOrder": false,
1124
+ "members": [
1125
+ {
1126
+ "kind": "PropertySignature",
1127
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#autoPlay:member",
1128
+ "docComment": "/**\n * Start playback automatically when the player is ready\n *\n * @defaultValue\n *\n * false\n */\n",
1129
+ "excerptTokens": [
1130
+ {
1131
+ "kind": "Content",
1132
+ "text": "autoPlay?: "
1133
+ },
1134
+ {
1135
+ "kind": "Content",
1136
+ "text": "boolean"
1137
+ },
1138
+ {
1139
+ "kind": "Content",
1140
+ "text": ";"
1141
+ }
1142
+ ],
1143
+ "isReadonly": false,
1144
+ "isOptional": true,
1145
+ "releaseTag": "Beta",
1146
+ "name": "autoPlay",
1147
+ "propertyTypeTokenRange": {
1148
+ "startIndex": 1,
1149
+ "endIndex": 2
1150
+ }
1151
+ },
1152
+ {
1153
+ "kind": "PropertySignature",
1154
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#dash:member",
1155
+ "docComment": "/**\n * Configuration settings for the DASH playback engine\n *\n * @defaultValue\n *\n * \\{\\} {@link https://cdn.dashjs.org/latest/jsdoc/module-Settings.html}\n */\n",
1156
+ "excerptTokens": [
1157
+ {
1158
+ "kind": "Content",
1159
+ "text": "dash?: "
1160
+ },
1161
+ {
1162
+ "kind": "Reference",
1163
+ "text": "DashSettings",
1164
+ "canonicalReference": "@gcorevideo/player!DashSettings:type"
1165
+ },
1166
+ {
1167
+ "kind": "Content",
1168
+ "text": ";"
1169
+ }
1170
+ ],
1171
+ "isReadonly": false,
1172
+ "isOptional": true,
1173
+ "releaseTag": "Beta",
1174
+ "name": "dash",
1175
+ "propertyTypeTokenRange": {
1176
+ "startIndex": 1,
1177
+ "endIndex": 2
1178
+ }
1179
+ },
1180
+ {
1181
+ "kind": "PropertySignature",
1182
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#debug:member",
1183
+ "docComment": "/**\n * Controls the debug output level\n *\n * @defaultValue\n *\n * 'none'\n */\n",
1184
+ "excerptTokens": [
1185
+ {
1186
+ "kind": "Content",
1187
+ "text": "debug?: "
1188
+ },
1189
+ {
1190
+ "kind": "Reference",
1191
+ "text": "PlayerDebugSettings",
1192
+ "canonicalReference": "@gcorevideo/player!PlayerDebugSettings:type"
1193
+ },
1194
+ {
1195
+ "kind": "Content",
1196
+ "text": ";"
1197
+ }
1198
+ ],
1199
+ "isReadonly": false,
1200
+ "isOptional": true,
1201
+ "releaseTag": "Beta",
1202
+ "name": "debug",
1203
+ "propertyTypeTokenRange": {
1204
+ "startIndex": 1,
1205
+ "endIndex": 2
1206
+ }
1207
+ },
1208
+ {
1209
+ "kind": "PropertySignature",
1210
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#language:member",
1211
+ "docComment": "/**\n * A language code for the player UI, for example, `es`. Must reference a key in the {@link PlayerConfig.strings | strings} record.\n *\n * @defaultValue\n *\n * 'en'\n */\n",
1212
+ "excerptTokens": [
1213
+ {
1214
+ "kind": "Content",
1215
+ "text": "language?: "
1216
+ },
1217
+ {
1218
+ "kind": "Content",
1219
+ "text": "string"
1220
+ },
1221
+ {
1222
+ "kind": "Content",
1223
+ "text": ";"
1224
+ }
1225
+ ],
1226
+ "isReadonly": false,
1227
+ "isOptional": true,
1228
+ "releaseTag": "Beta",
1229
+ "name": "language",
1230
+ "propertyTypeTokenRange": {
1231
+ "startIndex": 1,
1232
+ "endIndex": 2
1233
+ }
1234
+ },
1235
+ {
1236
+ "kind": "PropertySignature",
1237
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#loop:member",
1238
+ "docComment": "/**\n * Repeat playback when the media ends. Is used with the `vod` {@link PlayerConfig.playbackType | playbackType}\n *\n * @defaultValue\n *\n * false\n */\n",
1239
+ "excerptTokens": [
1240
+ {
1241
+ "kind": "Content",
1242
+ "text": "loop?: "
1243
+ },
1244
+ {
1245
+ "kind": "Content",
1246
+ "text": "boolean"
1247
+ },
1248
+ {
1249
+ "kind": "Content",
1250
+ "text": ";"
1251
+ }
1252
+ ],
1253
+ "isReadonly": false,
1254
+ "isOptional": true,
1255
+ "releaseTag": "Beta",
1256
+ "name": "loop",
1257
+ "propertyTypeTokenRange": {
1258
+ "startIndex": 1,
1259
+ "endIndex": 2
1260
+ }
1261
+ },
1262
+ {
1263
+ "kind": "PropertySignature",
1264
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#mute:member",
1265
+ "docComment": "/**\n * Mute the audio output in order to comply with browsers' autoplay policy.\n *\n * @defaultValue\n *\n * false\n */\n",
1266
+ "excerptTokens": [
1267
+ {
1268
+ "kind": "Content",
1269
+ "text": "mute?: "
1270
+ },
1271
+ {
1272
+ "kind": "Content",
1273
+ "text": "boolean"
1274
+ },
1275
+ {
1276
+ "kind": "Content",
1277
+ "text": ";"
1278
+ }
1279
+ ],
1280
+ "isReadonly": false,
1281
+ "isOptional": true,
1282
+ "releaseTag": "Beta",
1283
+ "name": "mute",
1284
+ "propertyTypeTokenRange": {
1285
+ "startIndex": 1,
1286
+ "endIndex": 2
1287
+ }
1288
+ },
1289
+ {
1290
+ "kind": "PropertySignature",
1291
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#playbackType:member",
1292
+ "docComment": "/**\n * The type of playback (live stream or video on demand).\n *\n * @defaultValue\n *\n * 'vod'\n */\n",
1293
+ "excerptTokens": [
1294
+ {
1295
+ "kind": "Content",
1296
+ "text": "playbackType?: "
1297
+ },
1298
+ {
1299
+ "kind": "Reference",
1300
+ "text": "PlaybackType",
1301
+ "canonicalReference": "@gcorevideo/player!PlaybackType:type"
1302
+ },
1303
+ {
1304
+ "kind": "Content",
1305
+ "text": ";"
1306
+ }
1307
+ ],
1308
+ "isReadonly": false,
1309
+ "isOptional": true,
1310
+ "releaseTag": "Beta",
1311
+ "name": "playbackType",
1312
+ "propertyTypeTokenRange": {
1313
+ "startIndex": 1,
1314
+ "endIndex": 2
1315
+ }
1316
+ },
1317
+ {
1318
+ "kind": "PropertySignature",
1319
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#priorityTransport:member",
1320
+ "docComment": "/**\n * Preferred transport protocol when multiple sources are available.\n *\n * @defaultValue\n *\n * 'auto'\n */\n",
1321
+ "excerptTokens": [
1322
+ {
1323
+ "kind": "Content",
1324
+ "text": "priorityTransport?: "
1325
+ },
1326
+ {
1327
+ "kind": "Reference",
1328
+ "text": "TransportPreference",
1329
+ "canonicalReference": "@gcorevideo/player!TransportPreference:type"
1330
+ },
1331
+ {
1332
+ "kind": "Content",
1333
+ "text": ";"
1334
+ }
1335
+ ],
1336
+ "isReadonly": false,
1337
+ "isOptional": true,
1338
+ "releaseTag": "Beta",
1339
+ "name": "priorityTransport",
1340
+ "propertyTypeTokenRange": {
1341
+ "startIndex": 1,
1342
+ "endIndex": 2
1343
+ }
1344
+ },
1345
+ {
1346
+ "kind": "PropertySignature",
1347
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#sources:member",
1348
+ "docComment": "/**\n * List of media sources, at least one is required.\n */\n",
1349
+ "excerptTokens": [
1350
+ {
1351
+ "kind": "Content",
1352
+ "text": "sources: "
1353
+ },
1354
+ {
1355
+ "kind": "Reference",
1356
+ "text": "PlayerMediaSource",
1357
+ "canonicalReference": "@gcorevideo/player!PlayerMediaSource:type"
1358
+ },
1359
+ {
1360
+ "kind": "Content",
1361
+ "text": "[]"
1362
+ },
1363
+ {
1364
+ "kind": "Content",
1365
+ "text": ";"
1366
+ }
1367
+ ],
1368
+ "isReadonly": false,
1369
+ "isOptional": false,
1370
+ "releaseTag": "Beta",
1371
+ "name": "sources",
1372
+ "propertyTypeTokenRange": {
1373
+ "startIndex": 1,
1374
+ "endIndex": 3
1375
+ }
1376
+ },
1377
+ {
1378
+ "kind": "PropertySignature",
1379
+ "canonicalReference": "@gcorevideo/player!PlayerConfig#strings:member",
1380
+ "docComment": "/**\n * Localization strings for the player UI.\n */\n",
1381
+ "excerptTokens": [
1382
+ {
1383
+ "kind": "Content",
1384
+ "text": "strings: "
1385
+ },
1386
+ {
1387
+ "kind": "Reference",
1388
+ "text": "TranslationSettings",
1389
+ "canonicalReference": "@gcorevideo/player!TranslationSettings:type"
1390
+ },
1391
+ {
1392
+ "kind": "Content",
1393
+ "text": ";"
1394
+ }
1395
+ ],
1396
+ "isReadonly": false,
1397
+ "isOptional": false,
1398
+ "releaseTag": "Beta",
1399
+ "name": "strings",
1400
+ "propertyTypeTokenRange": {
1401
+ "startIndex": 1,
1402
+ "endIndex": 2
1403
+ }
1404
+ }
1405
+ ],
1406
+ "extendsTokenRanges": [
1407
+ {
1408
+ "startIndex": 1,
1409
+ "endIndex": 3
1410
+ }
1411
+ ]
1412
+ },
1413
+ {
1414
+ "kind": "TypeAlias",
1415
+ "canonicalReference": "@gcorevideo/player!PlayerDebugSettings:type",
1416
+ "docComment": "/**\n * @remarks\n *\n * true is equivalent to 'all', false is equivalent to 'none'\n *\n * @beta\n */\n",
1417
+ "excerptTokens": [
1418
+ {
1419
+ "kind": "Content",
1420
+ "text": "export type PlayerDebugSettings = "
1421
+ },
1422
+ {
1423
+ "kind": "Reference",
1424
+ "text": "PlayerDebugTag",
1425
+ "canonicalReference": "@gcorevideo/player!PlayerDebugTag:type"
1426
+ },
1427
+ {
1428
+ "kind": "Content",
1429
+ "text": " | boolean"
1430
+ },
1431
+ {
1432
+ "kind": "Content",
1433
+ "text": ";"
1434
+ }
1435
+ ],
1436
+ "fileUrlPath": "src/types.ts",
1437
+ "releaseTag": "Beta",
1438
+ "name": "PlayerDebugSettings",
1439
+ "typeTokenRange": {
1440
+ "startIndex": 1,
1441
+ "endIndex": 3
1442
+ }
1443
+ },
1444
+ {
1445
+ "kind": "TypeAlias",
1446
+ "canonicalReference": "@gcorevideo/player!PlayerDebugTag:type",
1447
+ "docComment": "/**\n * @beta\n */\n",
1448
+ "excerptTokens": [
1449
+ {
1450
+ "kind": "Content",
1451
+ "text": "export type PlayerDebugTag = "
1452
+ },
1453
+ {
1454
+ "kind": "Content",
1455
+ "text": "'all' | 'clappr' | 'dash' | 'hls' | 'none'"
1456
+ },
1457
+ {
1458
+ "kind": "Content",
1459
+ "text": ";"
1460
+ }
1461
+ ],
1462
+ "fileUrlPath": "src/types.ts",
1463
+ "releaseTag": "Beta",
1464
+ "name": "PlayerDebugTag",
1465
+ "typeTokenRange": {
1466
+ "startIndex": 1,
1467
+ "endIndex": 2
1468
+ }
1469
+ },
1470
+ {
1471
+ "kind": "Enum",
1472
+ "canonicalReference": "@gcorevideo/player!PlayerEvent:enum",
1473
+ "docComment": "/**\n * A top-level event on the player object\n *\n * @beta\n */\n",
1474
+ "excerptTokens": [
1475
+ {
1476
+ "kind": "Content",
1477
+ "text": "export declare enum PlayerEvent "
1478
+ }
1479
+ ],
1480
+ "fileUrlPath": "src/types.ts",
1481
+ "releaseTag": "Beta",
1482
+ "name": "PlayerEvent",
1483
+ "preserveMemberOrder": false,
1484
+ "members": [
1485
+ {
1486
+ "kind": "EnumMember",
1487
+ "canonicalReference": "@gcorevideo/player!PlayerEvent.Ended:member",
1488
+ "docComment": "/**\n * Playback has reached the end of the media.\n */\n",
1489
+ "excerptTokens": [
1490
+ {
1491
+ "kind": "Content",
1492
+ "text": "Ended = "
1493
+ },
1494
+ {
1495
+ "kind": "Content",
1496
+ "text": "\"ended\""
1497
+ }
1498
+ ],
1499
+ "initializerTokenRange": {
1500
+ "startIndex": 1,
1501
+ "endIndex": 2
1502
+ },
1503
+ "releaseTag": "Beta",
1504
+ "name": "Ended"
1505
+ },
1506
+ {
1507
+ "kind": "EnumMember",
1508
+ "canonicalReference": "@gcorevideo/player!PlayerEvent.Pause:member",
1509
+ "docComment": "/**\n * Playback has been paused.\n */\n",
1510
+ "excerptTokens": [
1511
+ {
1512
+ "kind": "Content",
1513
+ "text": "Pause = "
1514
+ },
1515
+ {
1516
+ "kind": "Content",
1517
+ "text": "\"pause\""
1518
+ }
1519
+ ],
1520
+ "initializerTokenRange": {
1521
+ "startIndex": 1,
1522
+ "endIndex": 2
1523
+ },
1524
+ "releaseTag": "Beta",
1525
+ "name": "Pause"
1526
+ },
1527
+ {
1528
+ "kind": "EnumMember",
1529
+ "canonicalReference": "@gcorevideo/player!PlayerEvent.Play:member",
1530
+ "docComment": "/**\n * Playback has started.\n */\n",
1531
+ "excerptTokens": [
1532
+ {
1533
+ "kind": "Content",
1534
+ "text": "Play = "
1535
+ },
1536
+ {
1537
+ "kind": "Content",
1538
+ "text": "\"play\""
1539
+ }
1540
+ ],
1541
+ "initializerTokenRange": {
1542
+ "startIndex": 1,
1543
+ "endIndex": 2
1544
+ },
1545
+ "releaseTag": "Beta",
1546
+ "name": "Play"
1547
+ },
1548
+ {
1549
+ "kind": "EnumMember",
1550
+ "canonicalReference": "@gcorevideo/player!PlayerEvent.Ready:member",
1551
+ "docComment": "/**\n * The player is ready to use.\n */\n",
1552
+ "excerptTokens": [
1553
+ {
1554
+ "kind": "Content",
1555
+ "text": "Ready = "
1556
+ },
1557
+ {
1558
+ "kind": "Content",
1559
+ "text": "\"ready\""
1560
+ }
1561
+ ],
1562
+ "initializerTokenRange": {
1563
+ "startIndex": 1,
1564
+ "endIndex": 2
1565
+ },
1566
+ "releaseTag": "Beta",
1567
+ "name": "Ready"
1568
+ },
1569
+ {
1570
+ "kind": "EnumMember",
1571
+ "canonicalReference": "@gcorevideo/player!PlayerEvent.Stop:member",
1572
+ "docComment": "/**\n * Playback has been stopped.\n */\n",
1573
+ "excerptTokens": [
1574
+ {
1575
+ "kind": "Content",
1576
+ "text": "Stop = "
1577
+ },
1578
+ {
1579
+ "kind": "Content",
1580
+ "text": "\"stop\""
1581
+ }
1582
+ ],
1583
+ "initializerTokenRange": {
1584
+ "startIndex": 1,
1585
+ "endIndex": 2
1586
+ },
1587
+ "releaseTag": "Beta",
1588
+ "name": "Stop"
1589
+ }
1590
+ ]
1591
+ },
1592
+ {
1593
+ "kind": "TypeAlias",
1594
+ "canonicalReference": "@gcorevideo/player!PlayerEventHandler:type",
1595
+ "docComment": "/**\n * @beta\n */\n",
1596
+ "excerptTokens": [
1597
+ {
1598
+ "kind": "Content",
1599
+ "text": "export type PlayerEventHandler<T extends "
1600
+ },
1601
+ {
1602
+ "kind": "Reference",
1603
+ "text": "PlayerEvent",
1604
+ "canonicalReference": "@gcorevideo/player!PlayerEvent:enum"
1605
+ },
1606
+ {
1607
+ "kind": "Content",
1608
+ "text": "> = "
1609
+ },
1610
+ {
1611
+ "kind": "Content",
1612
+ "text": "() => void"
1613
+ },
1614
+ {
1615
+ "kind": "Content",
1616
+ "text": ";"
1617
+ }
1618
+ ],
1619
+ "fileUrlPath": "src/Player.ts",
1620
+ "releaseTag": "Beta",
1621
+ "name": "PlayerEventHandler",
1622
+ "typeParameters": [
1623
+ {
1624
+ "typeParameterName": "T",
1625
+ "constraintTokenRange": {
1626
+ "startIndex": 1,
1627
+ "endIndex": 2
1628
+ },
1629
+ "defaultTypeTokenRange": {
1630
+ "startIndex": 0,
1631
+ "endIndex": 0
1632
+ }
1633
+ }
1634
+ ],
1635
+ "typeTokenRange": {
1636
+ "startIndex": 3,
1637
+ "endIndex": 4
1638
+ }
1639
+ },
1640
+ {
1641
+ "kind": "TypeAlias",
1642
+ "canonicalReference": "@gcorevideo/player!PlayerMediaSource:type",
1643
+ "docComment": "/**\n * A media source to fetch the media data from\n *\n * @beta\n */\n",
1644
+ "excerptTokens": [
1645
+ {
1646
+ "kind": "Content",
1647
+ "text": "export type PlayerMediaSource = "
1648
+ },
1649
+ {
1650
+ "kind": "Content",
1651
+ "text": "string | "
1652
+ },
1653
+ {
1654
+ "kind": "Reference",
1655
+ "text": "PlayerMediaSourceDesc",
1656
+ "canonicalReference": "@gcorevideo/player!PlayerMediaSourceDesc:interface"
1657
+ },
1658
+ {
1659
+ "kind": "Content",
1660
+ "text": ";"
1661
+ }
1662
+ ],
1663
+ "fileUrlPath": "src/types.ts",
1664
+ "releaseTag": "Beta",
1665
+ "name": "PlayerMediaSource",
1666
+ "typeTokenRange": {
1667
+ "startIndex": 1,
1668
+ "endIndex": 3
1669
+ }
1670
+ },
1671
+ {
1672
+ "kind": "Interface",
1673
+ "canonicalReference": "@gcorevideo/player!PlayerMediaSourceDesc:interface",
1674
+ "docComment": "/**\n * Describes a media source with its MIME type and URL.\n *\n * @remarks\n *\n * When the MIME type is provided, it helps the player determine the appropriate playback engine. If omitted, the player will attempt to detect the type from the source URL extension.\n *\n * @beta\n */\n",
1675
+ "excerptTokens": [
1676
+ {
1677
+ "kind": "Content",
1678
+ "text": "export interface PlayerMediaSourceDesc "
1679
+ }
1680
+ ],
1681
+ "fileUrlPath": "src/types.ts",
1682
+ "releaseTag": "Beta",
1683
+ "name": "PlayerMediaSourceDesc",
1684
+ "preserveMemberOrder": false,
1685
+ "members": [
1686
+ {
1687
+ "kind": "PropertySignature",
1688
+ "canonicalReference": "@gcorevideo/player!PlayerMediaSourceDesc#mimeType:member",
1689
+ "docComment": "/**\n * The MIME type of the media source (e.g. \"video/mp4\", \"application/x-mpegURL\")\n */\n",
1690
+ "excerptTokens": [
1691
+ {
1692
+ "kind": "Content",
1693
+ "text": "mimeType?: "
1694
+ },
1695
+ {
1696
+ "kind": "Content",
1697
+ "text": "string"
1698
+ },
1699
+ {
1700
+ "kind": "Content",
1701
+ "text": ";"
1702
+ }
1703
+ ],
1704
+ "isReadonly": false,
1705
+ "isOptional": true,
1706
+ "releaseTag": "Beta",
1707
+ "name": "mimeType",
1708
+ "propertyTypeTokenRange": {
1709
+ "startIndex": 1,
1710
+ "endIndex": 2
1711
+ }
1712
+ },
1713
+ {
1714
+ "kind": "PropertySignature",
1715
+ "canonicalReference": "@gcorevideo/player!PlayerMediaSourceDesc#source:member",
1716
+ "docComment": "/**\n * URL of the media source\n */\n",
1717
+ "excerptTokens": [
1718
+ {
1719
+ "kind": "Content",
1720
+ "text": "source: "
1721
+ },
1722
+ {
1723
+ "kind": "Content",
1724
+ "text": "string"
1725
+ },
1726
+ {
1727
+ "kind": "Content",
1728
+ "text": ";"
1729
+ }
1730
+ ],
1731
+ "isReadonly": false,
1732
+ "isOptional": false,
1733
+ "releaseTag": "Beta",
1734
+ "name": "source",
1735
+ "propertyTypeTokenRange": {
1736
+ "startIndex": 1,
1737
+ "endIndex": 2
1738
+ }
1739
+ }
1740
+ ],
1741
+ "extendsTokenRanges": []
1742
+ },
1743
+ {
1744
+ "kind": "TypeAlias",
1745
+ "canonicalReference": "@gcorevideo/player!PlayerPlugin:type",
1746
+ "docComment": "/**\n * @see\n *\n * {@link https://clappr.github.io/classes/UIContainerPlugin.html}, {@link https://clappr.github.io/classes/ContainerPlugin.html}\n *\n * @beta\n */\n",
1747
+ "excerptTokens": [
1748
+ {
1749
+ "kind": "Content",
1750
+ "text": "export type PlayerPlugin = "
1751
+ },
1752
+ {
1753
+ "kind": "Content",
1754
+ "text": "{\n new (...args: any[]): unknown;\n type: 'core' | 'container';\n}"
1755
+ },
1756
+ {
1757
+ "kind": "Content",
1758
+ "text": ";"
1759
+ }
1760
+ ],
1761
+ "fileUrlPath": "src/types.ts",
1762
+ "releaseTag": "Beta",
1763
+ "name": "PlayerPlugin",
1764
+ "typeTokenRange": {
1765
+ "startIndex": 1,
1766
+ "endIndex": 2
1767
+ }
1768
+ },
1769
+ {
1770
+ "kind": "TypeAlias",
1771
+ "canonicalReference": "@gcorevideo/player!QualityLevel:type",
1772
+ "docComment": "/**\n * @beta\n */\n",
1773
+ "excerptTokens": [
1774
+ {
1775
+ "kind": "Content",
1776
+ "text": "export type QualityLevel = "
1777
+ },
1778
+ {
1779
+ "kind": "Content",
1780
+ "text": "{\n level: number;\n width: number;\n height: number;\n bitrate: number;\n}"
1781
+ },
1782
+ {
1783
+ "kind": "Content",
1784
+ "text": ";"
1785
+ }
1786
+ ],
1787
+ "fileUrlPath": "src/playback.types.ts",
1788
+ "releaseTag": "Beta",
1789
+ "name": "QualityLevel",
1790
+ "typeTokenRange": {
1791
+ "startIndex": 1,
1792
+ "endIndex": 2
1793
+ }
1794
+ },
1795
+ {
1796
+ "kind": "TypeAlias",
1797
+ "canonicalReference": "@gcorevideo/player!TranslationKey:type",
1798
+ "docComment": "/**\n * @beta\n */\n",
1799
+ "excerptTokens": [
1800
+ {
1801
+ "kind": "Content",
1802
+ "text": "export type TranslationKey = "
1803
+ },
1804
+ {
1805
+ "kind": "Content",
1806
+ "text": "string"
1807
+ },
1808
+ {
1809
+ "kind": "Content",
1810
+ "text": ";"
1811
+ }
1812
+ ],
1813
+ "fileUrlPath": "src/types.ts",
1814
+ "releaseTag": "Beta",
1815
+ "name": "TranslationKey",
1816
+ "typeTokenRange": {
1817
+ "startIndex": 1,
1818
+ "endIndex": 2
1819
+ }
1820
+ },
1821
+ {
1822
+ "kind": "TypeAlias",
1823
+ "canonicalReference": "@gcorevideo/player!TranslationSettings:type",
1824
+ "docComment": "/**\n * [language][key] =\\> string\n *\n * @example\n * ```\n * {\n * en: {\n * play: 'Play',\n * ...\n * },\n * es: {\n * play: 'Reproducir',\n * ...\n * },\n * ...\n * }\n * ```\n *\n * @beta\n */\n",
1825
+ "excerptTokens": [
1826
+ {
1827
+ "kind": "Content",
1828
+ "text": "export type TranslationSettings = "
1829
+ },
1830
+ {
1831
+ "kind": "Reference",
1832
+ "text": "Partial",
1833
+ "canonicalReference": "!Partial:type"
1834
+ },
1835
+ {
1836
+ "kind": "Content",
1837
+ "text": "<"
1838
+ },
1839
+ {
1840
+ "kind": "Reference",
1841
+ "text": "Record",
1842
+ "canonicalReference": "!Record:type"
1843
+ },
1844
+ {
1845
+ "kind": "Content",
1846
+ "text": "<"
1847
+ },
1848
+ {
1849
+ "kind": "Reference",
1850
+ "text": "LangTag",
1851
+ "canonicalReference": "@gcorevideo/player!LangTag:type"
1852
+ },
1853
+ {
1854
+ "kind": "Content",
1855
+ "text": ", "
1856
+ },
1857
+ {
1858
+ "kind": "Reference",
1859
+ "text": "Record",
1860
+ "canonicalReference": "!Record:type"
1861
+ },
1862
+ {
1863
+ "kind": "Content",
1864
+ "text": "<"
1865
+ },
1866
+ {
1867
+ "kind": "Reference",
1868
+ "text": "TranslationKey",
1869
+ "canonicalReference": "@gcorevideo/player!TranslationKey:type"
1870
+ },
1871
+ {
1872
+ "kind": "Content",
1873
+ "text": ", string>>>"
1874
+ },
1875
+ {
1876
+ "kind": "Content",
1877
+ "text": ";"
1878
+ }
1879
+ ],
1880
+ "fileUrlPath": "src/types.ts",
1881
+ "releaseTag": "Beta",
1882
+ "name": "TranslationSettings",
1883
+ "typeTokenRange": {
1884
+ "startIndex": 1,
1885
+ "endIndex": 11
1886
+ }
1887
+ },
1888
+ {
1889
+ "kind": "TypeAlias",
1890
+ "canonicalReference": "@gcorevideo/player!TransportPreference:type",
1891
+ "docComment": "/**\n * @beta\n */\n",
1892
+ "excerptTokens": [
1893
+ {
1894
+ "kind": "Content",
1895
+ "text": "export type TransportPreference = "
1896
+ },
1897
+ {
1898
+ "kind": "Reference",
1899
+ "text": "MediaTransport",
1900
+ "canonicalReference": "@gcorevideo/player!MediaTransport:type"
1901
+ },
1902
+ {
1903
+ "kind": "Content",
1904
+ "text": " | 'auto'"
1905
+ },
1906
+ {
1907
+ "kind": "Content",
1908
+ "text": ";"
1909
+ }
1910
+ ],
1911
+ "fileUrlPath": "src/types.ts",
1912
+ "releaseTag": "Beta",
1913
+ "name": "TransportPreference",
1914
+ "typeTokenRange": {
1915
+ "startIndex": 1,
1916
+ "endIndex": 3
1917
+ }
1918
+ },
1919
+ {
1920
+ "kind": "Function",
1921
+ "canonicalReference": "@gcorevideo/player!version:function(1)",
1922
+ "docComment": "/**\n * Version information about the gplayer and its main dependencies\n *\n * @returns Version information about the gplayer and its main dependencies\n *\n * @beta\n */\n",
1923
+ "excerptTokens": [
1924
+ {
1925
+ "kind": "Content",
1926
+ "text": "export declare function version(): "
1927
+ },
1928
+ {
1929
+ "kind": "Content",
1930
+ "text": "{\n gplayer: string;\n clappr: string;\n dashjs: string;\n hlsjs: string;\n}"
1931
+ },
1932
+ {
1933
+ "kind": "Content",
1934
+ "text": ";"
1935
+ }
1936
+ ],
1937
+ "fileUrlPath": "src/version.ts",
1938
+ "returnTypeTokenRange": {
1939
+ "startIndex": 1,
1940
+ "endIndex": 2
1941
+ },
1942
+ "releaseTag": "Beta",
1943
+ "overloadIndex": 1,
1944
+ "parameters": [],
1945
+ "name": "version"
1946
+ }
1947
+ ]
1948
+ }
1949
+ ]
1950
+ }