@srgssr/pillarbox-web 1.29.0 → 1.30.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.
@@ -31,6 +31,17 @@ declare class SrgSsr {
31
31
  * } data SRG SSR's cue-like representation
32
32
  */
33
33
  static addTextTrackCue(textTrack: TextTrack, data: any): void;
34
+ /**
35
+ * Add a new cues to a text track with the given array.
36
+ *
37
+ * @param {TextTrack} textTrack
38
+ * @param {Array.<
39
+ * Segment |
40
+ * Chapter |
41
+ * TimeInterval>
42
+ * } cues SRG SSR's cues-like representation
43
+ */
44
+ static addTextTrackCues(textTrack: TextTrack, cues?: Array<Segment | Chapter | TimeInterval>): void;
34
45
  /**
35
46
  * Add multiple text tracks to the player.
36
47
  *
@@ -110,10 +121,15 @@ declare class SrgSsr {
110
121
  *
111
122
  * @param {Player} player
112
123
  * @param {String} trackId Text track unique ID
124
+ * @param {Array.<
125
+ * Segment |
126
+ * Chapter |
127
+ * TimeInterval>
128
+ * } cues SRG SSR's cues-like representation
113
129
  *
114
130
  * @returns {Promise<TextTrack>}
115
131
  */
116
- static createTextTrack(player: Player, trackId: string): Promise<TextTrack>;
132
+ static createTextTrack(player: Player, trackId: string, cues?: Array<Segment | Chapter | TimeInterval>): Promise<TextTrack>;
117
133
  /**
118
134
  * Proxy SRG SSR chapters and intervals cuechange events at player level.
119
135
  *
@@ -169,6 +185,32 @@ declare class SrgSsr {
169
185
  * @returns {VTTCue|undefined} The VTT cue of a blocked segment, or undefined
170
186
  */
171
187
  static getBlockedSegmentByTime(player: Player, currentTime: number): VTTCue | undefined;
188
+ /**
189
+ * Get blocked segments.
190
+ *
191
+ * @param {Player} player
192
+ * @param {Array<Segment>} [segments=[]]
193
+ *
194
+ * @returns {Array<Segment>}
195
+ */
196
+ static getBlockedSegments(segments?: Array<Segment>): Array<Segment>;
197
+ /**
198
+ * Get chapters related to the main chapter.
199
+ *
200
+ * @param {string} chapterUrn The URN of the main chapter.
201
+ * @param {Array.<Chapter>} [chapters=[]]
202
+ *
203
+ * @returns {Array.<Chapter>}
204
+ */
205
+ static getChapters(chapterUrn: string, chapters?: Array<Chapter>): Array<Chapter>;
206
+ /**
207
+ * Get intervals.
208
+ *
209
+ * @param {Array<TimeInterval>} [segments=[]]
210
+ *
211
+ * @returns {Array<TimeInterval>}
212
+ */
213
+ static getIntervals(intervals?: any[]): Array<TimeInterval>;
172
214
  /**
173
215
  * Get mediaComposition from an URN.
174
216
  *
@@ -281,9 +323,9 @@ declare class SrgSsr {
281
323
  import type Player from 'video.js/dist/types/player';
282
324
  import type { Segment } from '../dataProvider/model/typedef';
283
325
  import type { Subtitle } from '../dataProvider/model/typedef';
284
- import type { ComposedSrcMediaData } from './typedef';
285
326
  import type { Chapter } from '../dataProvider/model/typedef';
286
327
  import type { TimeInterval } from '../dataProvider/model/typedef';
328
+ import type { ComposedSrcMediaData } from './typedef';
287
329
  import type { MainResourceWithKeySystems } from './typedef';
288
330
  import type { MainResource } from '../dataProvider/model/typedef';
289
331
  import MediaComposition from '../dataProvider/model/MediaComposition.js';
@@ -1 +1 @@
1
- {"version":3,"file":"srgssr.d.ts","sourceRoot":"","sources":["../../../../src/middleware/srgssr.js"],"names":[],"mappings":";AAgBA,uDAAuD;AACvD,4GAA4G;AAC5G,kFAAkF;AAElF;;GAEG;AACH;IACE;;;;;OAKG;IACH,kCAHW,MAAM,aACN,KAAK,CAAC,OAAO,CAAC,iBAexB;IAED;;;;;OAKG;IACH,mCAHW,MAAM,cACN,KAAK,CAAC,QAAQ,CAAC,QAkBzB;IAED;;;;;;;;;OASG;IACH,kCAPW,SAAS,mBAkBnB;IAED;;;;;OAKG;IACH,6BAHW,MAAM,iBACN,oBAAoB,QAO9B;IAED;;;;;;OAMG;IACH,2BAJW,MAAM,cACN,MAAM,aACN,KAAK,CAAE,OAAO,CAAC,iBAazB;IAED;;;;;OAKG;IACH,4BAHW,MAAM,cACN,KAAK,CAAE,YAAY,CAAC,iBAW9B;IAED;;;;;;;;OAQG;IACH,8BALW,MAAM,eACN,oBAAoB,GAElB,SAAS,UAAQ,CAiB7B;IAED;;;;;;;;OAQG;IACH,0CAJW,KAAK,CAAE,0BAA0B,CAAC,GAEhC,OAAO,CAAC,KAAK,CAAE,0BAA0B,CAAC,CAAC,CASvD;IAED;;;;;;;OAOG;IACH,8CAJW,KAAK,CAAE,YAAY,CAAC,GAElB,KAAK,CAAE,0BAA0B,CAAC,CAW9C;IAED;;;;;;;OAOG;IACH,8CAJW,gBAAgB,GAEd,OAAO,CAAC,KAAK,CAAE,0BAA0B,CAAC,CAAC,CAQvD;IAED;;;;;;;;;;OAUG;IACH,yEAPW,GAAG,YAGH,0BAA0B,GAExB,oBAAoB,CAoBhC;IAED;;;;;;;;;OASG;IACH,+BALW,MAAM,oBAGJ,OAAO,CAAC,SAAS,CAAC,CAwB9B;IAED;;;;OAIG;IACH,mCAFW,MAAM,QAahB;IAED;;;;;;OAMG;IACH,4BAJW,MAAM,GAEJ,YAAY,CAoBxB;IAED;;;;;;;OAOG;IACH,iCALW,MAAM,eAGJ,SAAS,GAAC,IAAI,CAoB1B;IAED;;;;;OAKG;IACH,qBAHW,MAAM,0CAWhB;IAED;;;;;;OAMG;IACH,+CAJW,KAAK,CAAE,YAAY,CAAC,GAElB,KAAK,CAAE,YAAY,CAAC,CAMhC;IAED;;;;;;OAMG;IACH,iCAJW,MAAM,GAEJ,MAAM,GAAC,SAAS,CAY5B;IAED;;;;;;;OAOG;IACH,uCALW,MAAM,wBAGJ,MAAM,GAAC,SAAS,CAW5B;IAED;;;;;;;OAOG;IACH,oFAFa,OAAO,CAAC,gBAAgB,CAAC,CASrC;IAED;;;;;;OAMG;IACH,gCAJW,KAAK,CAAE,0BAA0B,CAAC,GAEhC,0BAA0B,CAStC;IAED;;;;;;;OAOG;IACH,8BALW,MAAM,UACN,GAAG,GAED,OAAO,CAAC,oBAAoB,CAAC,CAyBzC;IAED;;;;;;;;;;;;OAYG;IACH,iCALW,MAAM,eACN,MAAM,GAEJ,MAAM,CAmBlB;IAED;;;;;;;;;;;;OAYG;IACH,oCALW,MAAM,eACN,MAAM,GAEJ,MAAM,CAQlB;IAED;;;;;;;;;;;;;;;OAeG;IACH,+BANW,MAAM,UACN,GAAG,mBAGD,OAAO,CAAC,GAAG,CAAC,CAoBxB;IAED;;;;OAIG;IACH,4BAFW,MAAM,QAmBhB;IAED;;;;;;OAMG;IACH,mCAJW,MAAM,GAEJ,mBAAmB,CAoB/B;IAED;;;;;;OAMG;IACH,4BAJW,MAAM,eACN,oBAAoB,iBACpB,KAAK,QAQf;IAED;;;;;OAKG;IACH,8BAHW,MAAM,eACN,oBAAoB,QAS9B;IAED;;;;;;OAMG;IACH,0BAJW,MAAM,OAgBhB;CACF;wBA1pBuB,4BAA4B;6BACsB,+BAA+B;8BAA/B,+BAA+B;0CACrC,WAAW;6BADL,+BAA+B;kCAA/B,+BAA+B;gDACrC,WAAW;kCADL,+BAA+B;6BAV5E,2CAA2C;yBAN/C,0CAA0C;gCAKnC,oCAAoC;kBAJlD,mBAAmB"}
1
+ {"version":3,"file":"srgssr.d.ts","sourceRoot":"","sources":["../../../../src/middleware/srgssr.js"],"names":[],"mappings":";AAgBA,uDAAuD;AACvD,4GAA4G;AAC5G,kFAAkF;AAElF;;GAEG;AACH;IACE;;;;;OAKG;IACH,kCAHW,MAAM,aACN,KAAK,CAAC,OAAO,CAAC,iBAOxB;IAED;;;;;OAKG;IACH,mCAHW,MAAM,cACN,KAAK,CAAC,QAAQ,CAAC,QAkBzB;IAED;;;;;;;;;OASG;IACH,kCAPW,SAAS,mBAkBnB;IAED;;;;;;;;;OASG;IACH,mCAPW,SAAS,SACT,KAAK,CACf,OAAW,GACX,OAAW,GACX,YAAgB,CAAC,QASjB;IAED;;;;;OAKG;IACH,6BAHW,MAAM,iBACN,oBAAoB,QAO9B;IAED;;;;;;OAMG;IACH,2BAJW,MAAM,cACN,MAAM,aACN,KAAK,CAAE,OAAO,CAAC,iBAOzB;IAED;;;;;OAKG;IACH,4BAHW,MAAM,cACN,KAAK,CAAE,YAAY,CAAC,iBAO9B;IAED;;;;;;;;OAQG;IACH,8BALW,MAAM,eACN,oBAAoB,GAElB,SAAS,UAAQ,CAiB7B;IAED;;;;;;;;OAQG;IACH,0CAJW,KAAK,CAAE,0BAA0B,CAAC,GAEhC,OAAO,CAAC,KAAK,CAAE,0BAA0B,CAAC,CAAC,CASvD;IAED;;;;;;;OAOG;IACH,8CAJW,KAAK,CAAE,YAAY,CAAC,GAElB,KAAK,CAAE,0BAA0B,CAAC,CAW9C;IAED;;;;;;;OAOG;IACH,8CAJW,gBAAgB,GAEd,OAAO,CAAC,KAAK,CAAE,0BAA0B,CAAC,CAAC,CAQvD;IAED;;;;;;;;;;OAUG;IACH,yEAPW,GAAG,YAGH,0BAA0B,GAExB,oBAAoB,CAoBhC;IAED;;;;;;;;;;;;;;OAcG;IACH,+BAVW,MAAM,0BAEN,KAAK,CACf,OAAW,GACX,OAAW,GACX,YAAgB,CAAC,GAGL,OAAO,CAAC,SAAS,CAAC,CA0B9B;IAED;;;;OAIG;IACH,mCAFW,MAAM,QAahB;IAED;;;;;;OAMG;IACH,4BAJW,MAAM,GAEJ,YAAY,CAoBxB;IAED;;;;;;;OAOG;IACH,iCALW,MAAM,eAGJ,SAAS,GAAC,IAAI,CAoB1B;IAED;;;;;OAKG;IACH,qBAHW,MAAM,0CAWhB;IAED;;;;;;OAMG;IACH,+CAJW,KAAK,CAAE,YAAY,CAAC,GAElB,KAAK,CAAE,YAAY,CAAC,CAMhC;IAED;;;;;;OAMG;IACH,iCAJW,MAAM,GAEJ,MAAM,GAAC,SAAS,CAY5B;IAED;;;;;;;OAOG;IACH,uCALW,MAAM,wBAGJ,MAAM,GAAC,SAAS,CAW5B;IAED;;;;;;;OAOG;IACH,qCAJW,KAAK,CAAC,OAAO,CAAC,GAEZ,KAAK,CAAC,OAAO,CAAC,CAM1B;IAED;;;;;;;OAOG;IACH,+BALW,MAAM,aACN,KAAK,CAAE,OAAO,CAAC,GAEb,KAAK,CAAE,OAAO,CAAC,CAM3B;IAED;;;;;;OAMG;IACH,wCAFa,KAAK,CAAC,YAAY,CAAC,CAM/B;IAED;;;;;;;OAOG;IACH,oFAFa,OAAO,CAAC,gBAAgB,CAAC,CASrC;IAED;;;;;;OAMG;IACH,gCAJW,KAAK,CAAE,0BAA0B,CAAC,GAEhC,0BAA0B,CAStC;IAED;;;;;;;OAOG;IACH,8BALW,MAAM,UACN,GAAG,GAED,OAAO,CAAC,oBAAoB,CAAC,CAyBzC;IAED;;;;;;;;;;;;OAYG;IACH,iCALW,MAAM,eACN,MAAM,GAEJ,MAAM,CAmBlB;IAED;;;;;;;;;;;;OAYG;IACH,oCALW,MAAM,eACN,MAAM,GAEJ,MAAM,CAQlB;IAED;;;;;;;;;;;;;;;OAeG;IACH,+BANW,MAAM,UACN,GAAG,mBAGD,OAAO,CAAC,GAAG,CAAC,CAoBxB;IAED;;;;OAIG;IACH,4BAFW,MAAM,QAmBhB;IAED;;;;;;OAMG;IACH,mCAJW,MAAM,GAEJ,mBAAmB,CAoB/B;IAED;;;;;;OAMG;IACH,4BAJW,MAAM,eACN,oBAAoB,iBACpB,KAAK,QAQf;IAED;;;;;OAKG;IACH,8BAHW,MAAM,eACN,oBAAoB,QAS9B;IAED;;;;;;OAMG;IACH,0BAJW,MAAM,OAgBhB;CACF;wBA1sBuB,4BAA4B;6BACsB,+BAA+B;8BAA/B,+BAA+B;6BAA/B,+BAA+B;kCAA/B,+BAA+B;0CACrC,WAAW;gDAAX,WAAW;kCADL,+BAA+B;6BAV5E,2CAA2C;yBAN/C,0CAA0C;gCAKnC,oCAAoC;kBAJlD,mBAAmB"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@srgssr/pillarbox-web",
3
3
  "description": "Pillarbox is the modern SRG SSR player",
4
- "version": "1.29.0",
4
+ "version": "1.30.0",
5
5
  "type": "module",
6
6
  "module": "dist/pillarbox.es.js",
7
7
  "main": "dist/pillarbox.cjs",