@srgssr/pillarbox-web 1.17.0 → 1.18.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.
- package/dist/pillarbox-core.cjs.js +11 -6
- package/dist/pillarbox-core.cjs.js.map +1 -1
- package/dist/pillarbox-core.es.js +11 -6
- package/dist/pillarbox-core.es.js.map +1 -1
- package/dist/pillarbox.cjs.js +143 -111
- package/dist/pillarbox.cjs.js.map +1 -1
- package/dist/pillarbox.es.js +144 -112
- package/dist/pillarbox.es.js.map +1 -1
- package/dist/pillarbox.umd.js +143 -111
- package/dist/pillarbox.umd.js.map +1 -1
- package/dist/pillarbox.umd.min.js +1 -1
- package/dist/pillarbox.umd.min.js.map +1 -1
- package/dist/types/build.es.d.ts +5 -1
- package/dist/types/build.es.d.ts.map +1 -1
- package/dist/types/src/components/player.d.ts +7 -8
- package/dist/types/src/components/player.d.ts.map +1 -1
- package/dist/types/src/dataProvider/model/MediaComposition.d.ts +12 -0
- package/dist/types/src/dataProvider/model/MediaComposition.d.ts.map +1 -1
- package/dist/types/src/dataProvider/services/DataProvider.d.ts +3 -3
- package/dist/types/src/dataProvider/services/DataProvider.d.ts.map +1 -1
- package/dist/types/src/middleware/srgssr.d.ts +76 -73
- package/dist/types/src/middleware/srgssr.d.ts.map +1 -1
- package/dist/types/src/trackers/PillarboxMonitoring.d.ts +15 -8
- package/dist/types/src/trackers/PillarboxMonitoring.d.ts.map +1 -1
- package/dist/types/src/trackers/SRGAnalytics.d.ts +55 -55
- package/dist/types/src/trackers/SRGAnalytics.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/types/src/components/typedef.d.ts +0 -14
- package/dist/types/src/components/typedef.d.ts.map +0 -1
- package/dist/types/src/middleware/typedef.d.ts +0 -67
- package/dist/types/src/middleware/typedef.d.ts.map +0 -1
package/dist/types/build.es.d.ts
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
import Pillarbox from './src/pillarbox.js';
|
|
2
|
+
import DataProvider from './src/dataProvider/services/DataProvider.js';
|
|
3
|
+
import MediaComposition from './src/dataProvider/model/MediaComposition.js';
|
|
4
|
+
import PillarboxMonitoring from './src/trackers/PillarboxMonitoring.js';
|
|
2
5
|
import Player from './src/components/player.js';
|
|
6
|
+
import SRGAnalytics from './src/trackers/SRGAnalytics.js';
|
|
3
7
|
import SrgSsr from './src/middleware/srgssr.js';
|
|
4
|
-
export { Pillarbox as default, Player, SrgSsr };
|
|
8
|
+
export { Pillarbox as default, DataProvider, MediaComposition, PillarboxMonitoring, Player, SRGAnalytics, SrgSsr };
|
|
5
9
|
//# sourceMappingURL=build.es.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"build.es.d.ts","sourceRoot":"","sources":["../../build.es.js"],"names":[],"mappings":"sBAEsB,oBAAoB;
|
|
1
|
+
{"version":3,"file":"build.es.d.ts","sourceRoot":"","sources":["../../build.es.js"],"names":[],"mappings":"sBAEsB,oBAAoB;yBACjB,6CAA6C;6BACzC,8CAA8C;gCAC3C,uCAAuC;mBAJpD,4BAA4B;yBAKtB,gCAAgC;mBANtC,4BAA4B"}
|
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
export default Player;
|
|
2
|
-
declare const Player_base: typeof import("video.js/dist/types/player").default;
|
|
3
2
|
/**
|
|
4
3
|
* This class extends the video.js Player.
|
|
5
4
|
*
|
|
6
5
|
* @class Player
|
|
7
6
|
* @see https://docs.videojs.com/player
|
|
8
7
|
*/
|
|
9
|
-
declare class Player
|
|
8
|
+
declare class Player {
|
|
10
9
|
constructor(tag: any, options: any, ready: any);
|
|
11
10
|
/**
|
|
12
11
|
* A getter/setter for the media's audio track.
|
|
@@ -16,7 +15,7 @@ declare class Player extends Player_base {
|
|
|
16
15
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/kind
|
|
17
16
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/language
|
|
18
17
|
*
|
|
19
|
-
* @param {
|
|
18
|
+
* @param {TrackSelector} [trackSelector]
|
|
20
19
|
*
|
|
21
20
|
* @example
|
|
22
21
|
* // Get the current audio track
|
|
@@ -30,10 +29,10 @@ declare class Player extends Player_base {
|
|
|
30
29
|
* // Activate first audio track found corresponding to language
|
|
31
30
|
* player.audioTrack({language:'fr'});
|
|
32
31
|
*
|
|
33
|
-
* @return {
|
|
32
|
+
* @return {AudioTrack | undefined} The
|
|
34
33
|
* currently enabled audio track. See {@link https://docs.videojs.com/audiotrack}.
|
|
35
34
|
*/
|
|
36
|
-
audioTrack(trackSelector?:
|
|
35
|
+
audioTrack(trackSelector?: TrackSelector): AudioTrack | undefined;
|
|
37
36
|
/**
|
|
38
37
|
* Calculates an array of ranges based on the `buffered()` data.
|
|
39
38
|
*
|
|
@@ -89,7 +88,7 @@ declare class Player extends Player_base {
|
|
|
89
88
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/TextTrack/kind
|
|
90
89
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/textTrack/language
|
|
91
90
|
*
|
|
92
|
-
* @param {
|
|
91
|
+
* @param {TrackSelector} [trackSelector]
|
|
93
92
|
*
|
|
94
93
|
* @example
|
|
95
94
|
* // Get the current text track
|
|
@@ -108,9 +107,9 @@ declare class Player extends Player_base {
|
|
|
108
107
|
* // Activate first text track found corresponding to language
|
|
109
108
|
* player.textTrack({language:'fr'});
|
|
110
109
|
*
|
|
111
|
-
* @return {
|
|
110
|
+
* @return {TextTrack | undefined} The
|
|
112
111
|
* currently enabled text track. See {@link https://docs.videojs.com/texttrack}.
|
|
113
112
|
*/
|
|
114
|
-
textTrack(trackSelector?:
|
|
113
|
+
textTrack(trackSelector?: TrackSelector): TextTrack | undefined;
|
|
115
114
|
}
|
|
116
115
|
//# sourceMappingURL=player.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"player.d.ts","sourceRoot":"","sources":["../../../../src/components/player.js"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"player.d.ts","sourceRoot":"","sources":["../../../../src/components/player.js"],"names":[],"mappings":";AAcA;;;;;GAKG;AACH;IACE,gDAUC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,2CAHY,aAAa,SAAS,CAsBjC;IAED;;;;;;OAMG;IACH,kBAFa,MAAM;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,CAAC,CAa/C;IAED;;;;;;;;;;;OAWG;IACH,iBAJY,MAAM,CAgBjB;IAED;;;;;;OAMG;IACH,gBAFa,MAAM;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,CAAC,CAa/C;IAED;;;;;;OAMG;IACH,kBAFa,MAAM;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,CAAC,CAa/C;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,0CAHY,SAAS,GAAG,SAAS,CAgChC;CACF"}
|
|
@@ -9,6 +9,18 @@ export type Subtitle = import('./typedef').Subtitle;
|
|
|
9
9
|
export type TimeInterval = import('./typedef').TimeInterval;
|
|
10
10
|
export type Topic = import('./typedef').Topic;
|
|
11
11
|
export type MainResource = import('./typedef').MainResource;
|
|
12
|
+
/**
|
|
13
|
+
* @typedef {import('./typedef').Channel} Channel
|
|
14
|
+
* @typedef {import('./typedef').Chapter} Chapter
|
|
15
|
+
* @typedef {import('./typedef').Episode} Episode
|
|
16
|
+
* @typedef {import('./typedef').Resource} Resource
|
|
17
|
+
* @typedef {import('./typedef').Segment} Segment
|
|
18
|
+
* @typedef {import('./typedef').Show} Show
|
|
19
|
+
* @typedef {import('./typedef').Subtitle} Subtitle
|
|
20
|
+
* @typedef {import('./typedef').TimeInterval} TimeInterval
|
|
21
|
+
* @typedef {import('./typedef').Topic} Topic
|
|
22
|
+
* @typedef {import('./typedef').MainResource} MainResource
|
|
23
|
+
*/
|
|
12
24
|
/**
|
|
13
25
|
* Represents the composition of media content.
|
|
14
26
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MediaComposition.d.ts","sourceRoot":"","sources":["../../../../../src/dataProvider/model/MediaComposition.js"],"names":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"MediaComposition.d.ts","sourceRoot":"","sources":["../../../../../src/dataProvider/model/MediaComposition.js"],"names":[],"mappings":";sBACa,OAAO,WAAW,EAAE,OAAO;sBAC3B,OAAO,WAAW,EAAE,OAAO;sBAC3B,OAAO,WAAW,EAAE,OAAO;uBAC3B,OAAO,WAAW,EAAE,QAAQ;sBAC5B,OAAO,WAAW,EAAE,OAAO;mBAC3B,OAAO,WAAW,EAAE,IAAI;uBACxB,OAAO,WAAW,EAAE,QAAQ;2BAC5B,OAAO,WAAW,EAAE,YAAY;oBAChC,OAAO,WAAW,EAAE,KAAK;2BACzB,OAAO,WAAW,EAAE,YAAY;AAV7C;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;;;GAaG;AACH;IACE;;;;;;OAMG;IACH,+BAFa,OAAO,CAYnB;IAED;;;;OAIG;IACH,mBAFa,OAAO,GAAC,SAAS,CAa7B;IAED;;;;;OAKG;IACH,oCAFa,MAAO,QAAQ,CAAC,GAAC,SAAS,CAUtC;IAED;;;;OAIG;IACH,eAFa,MAAO,OAAO,CAAC,CAQ3B;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,gCAFa,MAAO,QAAQ,CAAC,CA+B5B;IAED;;;;;;OAMG;IACH,sBAFa,MAAM,GAAG,SAAS,CAgB9B;IAED;;;;OAIG;IACH,0BAFa,MAAO,OAAO,CAAC,CAI3B;IAED;;;;OAIG;IACH,kBAFa,OAAO,CAYnB;IARG,yCAAyD;IAU7D;;;;OAIG;IACH,0BAFa,SAAO,SAAS,CAU5B;IAED;;;;OAIG;IAEH,oBAHa,MAAO,YAAY,CAAC,CAuChC;IAED;;;;OAIG;IACH,mBAFa,MAAO,OAAO,CAAC,CAU3B;IAJG,4CAA2C;IAM/C;;;;OAIG;IACH,wBAFa,MAAO,YAAY,CAAC,CAQhC;IAED;;;;OAIG;IACH,wBAFa,IAAI,CAchB;IAED;;;;;OAKG;IACH;YAHmB,MAAM,GAAE,MAAM;;YACZ,MAAM,GAAE,MAAM;MAQlC;IAED;;;;;OAKG;IACH;YAHmB,MAAM,GAAE,MAAM;;YACZ,MAAM,GAAE,MAAM;MAQlC;IAED;;;OAGG;IACH,mBAFa,MAAO,QAAQ,CAAC,CAM5B;CACF"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export default DataProvider;
|
|
2
|
+
/** @import MediaComposition from '../model/MediaComposition.js' */
|
|
2
3
|
/**
|
|
3
4
|
* Represents a data provider for constructing URLs and handling requests.
|
|
4
5
|
* @class
|
|
5
|
-
* @ignore
|
|
6
6
|
*/
|
|
7
7
|
declare class DataProvider {
|
|
8
8
|
/**
|
|
@@ -25,9 +25,9 @@ declare class DataProvider {
|
|
|
25
25
|
*
|
|
26
26
|
* @param {Function} urlHandler A function that constructs the URL
|
|
27
27
|
*
|
|
28
|
-
* @returns {Promise<
|
|
28
|
+
* @returns {Promise<MediaComposition>} A promise with the fetched data
|
|
29
29
|
*/
|
|
30
|
-
handleRequest(urlHandler: Function): Promise<
|
|
30
|
+
handleRequest(urlHandler: Function): Promise<MediaComposition>;
|
|
31
31
|
/**
|
|
32
32
|
* Gets the media composition URL by URN.
|
|
33
33
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DataProvider.d.ts","sourceRoot":"","sources":["../../../../../src/dataProvider/services/DataProvider.js"],"names":[],"mappings":";AAAA
|
|
1
|
+
{"version":3,"file":"DataProvider.d.ts","sourceRoot":"","sources":["../../../../../src/dataProvider/services/DataProvider.js"],"names":[],"mappings":";AAAA,mEAAmE;AAEnE;;;GAGG;AACH;IACE;;;;OAIG;IACH,uBAFW,MAAM,EAIhB;IAED;;;;OAIG;IACH,oBAFW,MAAM,QAIhB;IADC,gBAAkD;IAGpD;;;;;;;;OAQG;IACH,qCAFa,yBAAyB,CAgBrC;IAED;;;;;;OAMG;IACH,gCAJW,MAAM,GAEJ,MAAM,CAIlB;CACF"}
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
export default SrgSsr;
|
|
2
|
+
/** @import Player from 'video.js/dist/types/player' */
|
|
3
|
+
/** @import {Chapter, MainResource, Segment, Subtitle, TimeInterval} from '../dataProvider/model/typedef' */
|
|
4
|
+
/** @import {ComposedSrcMediaData, MainResourceWithKeySystems} from './typedef' */
|
|
2
5
|
/**
|
|
3
6
|
* @class SrgSsr
|
|
4
7
|
*/
|
|
@@ -6,88 +9,88 @@ declare class SrgSsr {
|
|
|
6
9
|
/**
|
|
7
10
|
* Adds blocked segments to the player.
|
|
8
11
|
*
|
|
9
|
-
* @param {
|
|
10
|
-
* @param {Array<
|
|
12
|
+
* @param {Player} player
|
|
13
|
+
* @param {Array<Segment>} [segments=[]]
|
|
11
14
|
*/
|
|
12
|
-
static addBlockedSegments(player:
|
|
15
|
+
static addBlockedSegments(player: Player, segments?: Array<Segment>): void;
|
|
13
16
|
/**
|
|
14
17
|
* Adds remote text tracks from an array of subtitles.
|
|
15
18
|
*
|
|
16
|
-
* @param {
|
|
17
|
-
* @param {Array<
|
|
19
|
+
* @param {Player} player
|
|
20
|
+
* @param {Array<Subtitle>} [subtitles=[]]
|
|
18
21
|
*/
|
|
19
|
-
static addRemoteTextTracks(player:
|
|
22
|
+
static addRemoteTextTracks(player: Player, subtitles?: Array<Subtitle>): void;
|
|
20
23
|
/**
|
|
21
24
|
* Add a new cue to a text track with the given data.
|
|
22
25
|
*
|
|
23
26
|
* @param {TextTrack} textTrack
|
|
24
27
|
* @param {
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
+
* Segment |
|
|
29
|
+
* Chapter |
|
|
30
|
+
* TimeInterval
|
|
28
31
|
* } data SRG SSR's cue-like representation
|
|
29
32
|
*/
|
|
30
33
|
static addTextTrackCue(textTrack: TextTrack, data: any): void;
|
|
31
34
|
/**
|
|
32
35
|
* Add multiple text tracks to the player.
|
|
33
36
|
*
|
|
34
|
-
* @param {
|
|
35
|
-
* @param {
|
|
37
|
+
* @param {Player} player
|
|
38
|
+
* @param {ComposedSrcMediaData} srcMediaObj
|
|
36
39
|
*/
|
|
37
|
-
static addTextTracks(player:
|
|
40
|
+
static addTextTracks(player: Player, { mediaData }: ComposedSrcMediaData): void;
|
|
38
41
|
/**
|
|
39
42
|
* Adds chapters to the player.
|
|
40
43
|
*
|
|
41
|
-
* @param {
|
|
44
|
+
* @param {Player} player
|
|
42
45
|
* @param {string} chapterUrn The URN of the main chapter.
|
|
43
|
-
* @param {Array.<
|
|
46
|
+
* @param {Array.<Chapter>} [chapters=[]]
|
|
44
47
|
*/
|
|
45
|
-
static addChapters(player:
|
|
48
|
+
static addChapters(player: Player, chapterUrn: string, chapters?: Array<Chapter>): void;
|
|
46
49
|
/**
|
|
47
50
|
* Adds intervals to the player.
|
|
48
51
|
*
|
|
49
|
-
* @param {
|
|
50
|
-
* @param {Array.<
|
|
52
|
+
* @param {Player} player
|
|
53
|
+
* @param {Array.<TimeInterval>} [intervals=[]]
|
|
51
54
|
*/
|
|
52
|
-
static addIntervals(player:
|
|
55
|
+
static addIntervals(player: Player, intervals?: Array<TimeInterval>): void;
|
|
53
56
|
/**
|
|
54
57
|
* Set a blocking reason according to the block reason returned
|
|
55
58
|
* by mediaData.
|
|
56
59
|
*
|
|
57
|
-
* @param {
|
|
58
|
-
* @param {
|
|
60
|
+
* @param {Player} player
|
|
61
|
+
* @param {ComposedSrcMediaData} srcMediaObj
|
|
59
62
|
*
|
|
60
63
|
* @returns {undefined|Boolean}
|
|
61
64
|
*/
|
|
62
|
-
static blockingReason(player:
|
|
65
|
+
static blockingReason(player: Player, srcMediaObj: ComposedSrcMediaData): undefined | boolean;
|
|
63
66
|
/**
|
|
64
67
|
* Add the Akamai token to all resources
|
|
65
68
|
* if at least one of them has tokenType
|
|
66
69
|
* set to Akamai.
|
|
67
70
|
*
|
|
68
|
-
* @param {Array.<
|
|
71
|
+
* @param {Array.<MainResourceWithKeySystems>} resources
|
|
69
72
|
*
|
|
70
|
-
* @returns {Promise<Array.<
|
|
73
|
+
* @returns {Promise<Array.<MainResourceWithKeySystems>>}
|
|
71
74
|
*/
|
|
72
|
-
static composeAkamaiResources(resources?: Array<
|
|
75
|
+
static composeAkamaiResources(resources?: Array<MainResourceWithKeySystems>): Promise<Array<MainResourceWithKeySystems>>;
|
|
73
76
|
/**
|
|
74
77
|
* Add the keySystems property to all resources
|
|
75
78
|
* if at least one of them has DRM.
|
|
76
79
|
*
|
|
77
|
-
* @param {Array.<
|
|
80
|
+
* @param {Array.<MainResource>} resources
|
|
78
81
|
*
|
|
79
|
-
* @returns {Array.<
|
|
82
|
+
* @returns {Array.<MainResourceWithKeySystems>}
|
|
80
83
|
*/
|
|
81
|
-
static composeKeySystemsResources(resources?: Array<
|
|
84
|
+
static composeKeySystemsResources(resources?: Array<MainResource>): Array<MainResourceWithKeySystems>;
|
|
82
85
|
/**
|
|
83
86
|
* Get the main resources from a mediaComposition.
|
|
84
87
|
* May add an Akamai token or key systems if required by the resource.
|
|
85
88
|
*
|
|
86
89
|
* @param {MediaComposition} mediaComposition
|
|
87
90
|
*
|
|
88
|
-
* @returns {Promise<Array.<
|
|
91
|
+
* @returns {Promise<Array.<MainResourceWithKeySystems>>}
|
|
89
92
|
*/
|
|
90
|
-
static composeMainResources(mediaComposition: MediaComposition): Promise<Array<
|
|
93
|
+
static composeMainResources(mediaComposition: MediaComposition): Promise<Array<MainResourceWithKeySystems>>;
|
|
91
94
|
/**
|
|
92
95
|
* Compose source options with media data.
|
|
93
96
|
* MediaData properties from source options overwrite mediaData from IL.
|
|
@@ -95,75 +98,75 @@ declare class SrgSsr {
|
|
|
95
98
|
* @param {any} srcObj
|
|
96
99
|
* @param {any} srcObj.mediaData overrides or adds metadata to the composed mediaData.
|
|
97
100
|
* @param {boolean} srcObj.disableTrackers
|
|
98
|
-
* @param {
|
|
101
|
+
* @param {MainResourceWithKeySystems} resource
|
|
99
102
|
*
|
|
100
|
-
* @returns {
|
|
103
|
+
* @returns {ComposedSrcMediaData}
|
|
101
104
|
*/
|
|
102
|
-
static composeSrcMediaData({ mediaData: srcMediaData, disableTrackers }: any, resource:
|
|
105
|
+
static composeSrcMediaData({ mediaData: srcMediaData, disableTrackers }: any, resource: MainResourceWithKeySystems): ComposedSrcMediaData;
|
|
103
106
|
/**
|
|
104
107
|
* Create a new metadata text track.
|
|
105
108
|
*
|
|
106
|
-
* @param {
|
|
109
|
+
* @param {Player} player
|
|
107
110
|
* @param {String} trackId Text track unique ID
|
|
108
111
|
*
|
|
109
112
|
* @returns {Promise<TextTrack>}
|
|
110
113
|
*/
|
|
111
|
-
static createTextTrack(player:
|
|
114
|
+
static createTextTrack(player: Player, trackId: string): Promise<TextTrack>;
|
|
112
115
|
/**
|
|
113
116
|
* Proxy SRG SSR chapters and intervals cuechange events at player level.
|
|
114
117
|
*
|
|
115
|
-
* @param {
|
|
118
|
+
* @param {Player} player
|
|
116
119
|
*/
|
|
117
|
-
static cuechangeEventProxy(player:
|
|
120
|
+
static cuechangeEventProxy(player: Player): void;
|
|
118
121
|
/**
|
|
119
122
|
* SRG SSR data provider singleton.
|
|
120
123
|
*
|
|
121
|
-
* @param {
|
|
124
|
+
* @param {Player} player
|
|
122
125
|
*
|
|
123
126
|
* @returns {DataProvider}
|
|
124
127
|
*/
|
|
125
|
-
static dataProvider(player:
|
|
128
|
+
static dataProvider(player: Player): DataProvider;
|
|
126
129
|
/**
|
|
127
130
|
* Set an error if something goes wrong with the data provider.
|
|
128
131
|
*
|
|
129
|
-
* @param {
|
|
132
|
+
* @param {Player} player
|
|
130
133
|
* @param {Object} error
|
|
131
134
|
*
|
|
132
135
|
* @returns {undefined|true}
|
|
133
136
|
*/
|
|
134
|
-
static dataProviderError(player:
|
|
137
|
+
static dataProviderError(player: Player, error: any): undefined | true;
|
|
135
138
|
/**
|
|
136
139
|
* Set player error.
|
|
137
140
|
*
|
|
138
|
-
* @param {
|
|
141
|
+
* @param {Player} player
|
|
139
142
|
* @param {Object} error
|
|
140
143
|
*/
|
|
141
|
-
static error(player:
|
|
144
|
+
static error(player: Player, { code, message, metadata }: any): void;
|
|
142
145
|
/**
|
|
143
146
|
* Filter out incompatible resources such as `RTMP` and `HDS`.
|
|
144
147
|
*
|
|
145
|
-
* @param {Array.<
|
|
148
|
+
* @param {Array.<MainResource>} resources Resources to filter
|
|
146
149
|
*
|
|
147
|
-
* @returns {Array.<
|
|
150
|
+
* @returns {Array.<MainResource>} The filtered resources
|
|
148
151
|
*/
|
|
149
|
-
static filterIncompatibleResources(resources?: Array<
|
|
152
|
+
static filterIncompatibleResources(resources?: Array<MainResource>): Array<MainResource>;
|
|
150
153
|
/**
|
|
151
154
|
* Get the current blocked segment from the player.
|
|
152
155
|
*
|
|
153
|
-
* @param {
|
|
156
|
+
* @param {Player} player
|
|
154
157
|
*
|
|
155
158
|
* @returns {VTTCue|undefined} The blocked segment cue object, or undefined
|
|
156
159
|
*/
|
|
157
|
-
static getBlockedSegment(player:
|
|
160
|
+
static getBlockedSegment(player: Player): VTTCue | undefined;
|
|
158
161
|
/**
|
|
159
162
|
* Get the VTT cue of a blocked segment.
|
|
160
163
|
*
|
|
161
|
-
* @param {
|
|
164
|
+
* @param {Player} player
|
|
162
165
|
* @param {Number} currentTime
|
|
163
166
|
*
|
|
164
167
|
* @returns {VTTCue|undefined} The VTT cue of a blocked segment, or undefined
|
|
165
168
|
*/
|
|
166
|
-
static getBlockedSegmentByTime(player:
|
|
169
|
+
static getBlockedSegmentByTime(player: Player, currentTime: number): VTTCue | undefined;
|
|
167
170
|
/**
|
|
168
171
|
* Get mediaComposition from an URN.
|
|
169
172
|
*
|
|
@@ -176,20 +179,20 @@ declare class SrgSsr {
|
|
|
176
179
|
/**
|
|
177
180
|
* Get the mediaData most likely to be compatible depending on the browser.
|
|
178
181
|
*
|
|
179
|
-
* @param {Array.<
|
|
182
|
+
* @param {Array.<MainResourceWithKeySystems>} resources
|
|
180
183
|
*
|
|
181
|
-
* @returns {
|
|
184
|
+
* @returns {MainResourceWithKeySystems} By default, the first entry is used if none is compatible.
|
|
182
185
|
*/
|
|
183
|
-
static getMediaData(resources?: Array<
|
|
186
|
+
static getMediaData(resources?: Array<MainResourceWithKeySystems>): MainResourceWithKeySystems;
|
|
184
187
|
/**
|
|
185
188
|
* Get the source media object.
|
|
186
189
|
*
|
|
187
|
-
* @param {
|
|
190
|
+
* @param {Player} player
|
|
188
191
|
* @param {any} srcObj
|
|
189
192
|
*
|
|
190
|
-
* @returns {Promise<
|
|
193
|
+
* @returns {Promise<ComposedSrcMediaData>} - The composed source media data.
|
|
191
194
|
*/
|
|
192
|
-
static getSrcMediaObj(player:
|
|
195
|
+
static getSrcMediaObj(player: Player, srcObj: any): Promise<ComposedSrcMediaData>;
|
|
193
196
|
/**
|
|
194
197
|
* Handles the middleware's currentTime function.
|
|
195
198
|
* - If the current time is between the start and end of a blocked segment,
|
|
@@ -198,12 +201,12 @@ declare class SrgSsr {
|
|
|
198
201
|
* _Note_: This function should disappear as soon as this behavior is
|
|
199
202
|
* supported on the packaging side.
|
|
200
203
|
*
|
|
201
|
-
* @param {
|
|
204
|
+
* @param {Player} player
|
|
202
205
|
* @param {number} currentTime
|
|
203
206
|
*
|
|
204
207
|
* @returns {number}
|
|
205
208
|
*/
|
|
206
|
-
static handleCurrentTime(player:
|
|
209
|
+
static handleCurrentTime(player: Player, currentTime: number): number;
|
|
207
210
|
/**
|
|
208
211
|
* Handles the middleware's setCurrentTime function.
|
|
209
212
|
* - Modify the current time if the value is between the start and end of a
|
|
@@ -212,12 +215,12 @@ declare class SrgSsr {
|
|
|
212
215
|
* _Note_: This function should disappear as soon as this behavior is
|
|
213
216
|
* supported on the packaging side.
|
|
214
217
|
*
|
|
215
|
-
* @param {
|
|
218
|
+
* @param {Player} player
|
|
216
219
|
* @param {number} currentTime
|
|
217
220
|
*
|
|
218
221
|
* @returns {number}
|
|
219
222
|
*/
|
|
220
|
-
static handleSetCurrentTime(player:
|
|
223
|
+
static handleSetCurrentTime(player: Player, currentTime: number): number;
|
|
221
224
|
/**
|
|
222
225
|
* Handles the middleware's setSource function.
|
|
223
226
|
*
|
|
@@ -228,50 +231,50 @@ declare class SrgSsr {
|
|
|
228
231
|
* - handle blocking reasons
|
|
229
232
|
* - add remote subtitles
|
|
230
233
|
*
|
|
231
|
-
* @param {
|
|
234
|
+
* @param {Player} player
|
|
232
235
|
* @param {any} srcObj
|
|
233
236
|
* @param {function} next
|
|
234
237
|
*
|
|
235
238
|
* @returns {Promise<any>}
|
|
236
239
|
*/
|
|
237
|
-
static handleSetSource(player:
|
|
240
|
+
static handleSetSource(player: Player, srcObj: any, next: Function): Promise<any>;
|
|
238
241
|
/**
|
|
239
242
|
* SRG SSR analytics singleton.
|
|
240
243
|
*
|
|
241
|
-
* @param {
|
|
244
|
+
* @param {Player} player
|
|
242
245
|
*/
|
|
243
|
-
static srgAnalytics(player:
|
|
246
|
+
static srgAnalytics(player: Player): void;
|
|
244
247
|
/**
|
|
245
248
|
* PillarboxMonitoring monitoring singleton.
|
|
246
249
|
*
|
|
247
|
-
* @param {
|
|
250
|
+
* @param {Player} player
|
|
248
251
|
*
|
|
249
252
|
* @returns {PillarboxMonitoring} instance of PillarboxMonitoring
|
|
250
253
|
*/
|
|
251
|
-
static pillarboxMonitoring(player:
|
|
254
|
+
static pillarboxMonitoring(player: Player): PillarboxMonitoring;
|
|
252
255
|
/**
|
|
253
256
|
* Update player's poster.
|
|
254
257
|
*
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
258
|
+
* @param {Player} player
|
|
259
|
+
* @param {ComposedSrcMediaData} srcMediaObj
|
|
257
260
|
* @param {Image} imageService
|
|
258
261
|
*/
|
|
259
|
-
static updatePoster(player:
|
|
262
|
+
static updatePoster(player: Player, srcMediaObj: ComposedSrcMediaData, imageService?: Image): void;
|
|
260
263
|
/**
|
|
261
264
|
* Update player titleBar with title and description.
|
|
262
265
|
*
|
|
263
|
-
* @param {
|
|
264
|
-
* @param {
|
|
266
|
+
* @param {Player} player
|
|
267
|
+
* @param {ComposedSrcMediaData} srcMediaObj
|
|
265
268
|
*/
|
|
266
|
-
static updateTitleBar(player:
|
|
269
|
+
static updateTitleBar(player: Player, srcMediaObj: ComposedSrcMediaData): void;
|
|
267
270
|
/**
|
|
268
271
|
* Middleware to resolve SRG SSR URNs into playable media.
|
|
269
272
|
*
|
|
270
|
-
* @param {
|
|
273
|
+
* @param {Player} player
|
|
271
274
|
*
|
|
272
275
|
* @returns {Object}
|
|
273
276
|
*/
|
|
274
|
-
static middleware(player:
|
|
277
|
+
static middleware(player: Player): any;
|
|
275
278
|
}
|
|
276
279
|
import MediaComposition from '../dataProvider/model/MediaComposition.js';
|
|
277
280
|
import DataProvider from '../dataProvider/services/DataProvider.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"srgssr.d.ts","sourceRoot":"","sources":["../../../../src/middleware/srgssr.js"],"names":[],"mappings":";AAgBA;;GAEG;AACH;IACE;;;;;OAKG;IACH,
|
|
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,qDAFW,cAAc,QAuBxB;IAED;;;;;OAKG;IACH,uDAFW,eAAe,QAkBzB;IAED;;;;;;;;;OASG;IACH,kCAPW,SAAS,mBAkBnB;IAED;;;;;OAKG;IACH,gFAKC;IAED;;;;;;OAMG;IACH,+CAHW,MAAM,aACN,cAAe,QAqBzB;IAED;;;;;OAKG;IACH,gDAFW,mBAAoB,QAmB9B;IAED;;;;;;;;OAQG;IACH,0EAFa,SAAS,UAAQ,CAiB7B;IAED;;;;;;;;OAQG;IACH,0CAJW,iCAAkC,GAEhC,QAAQ,iCAAkC,CAAC,CASvD;IAED;;;;;;;OAOG;IACH,8CAJW,mBAAoB,GAElB,iCAAkC,CAW9C;IAED;;;;;;;OAOG;IACH,8CAJW,gBAAgB,GAEd,QAAQ,iCAAkC,CAAC,CAQvD;IAED;;;;;;;;;;OAUG;IACH,yEAPW,GAAG,8DAyBb;IAED;;;;;;;OAOG;IACH,yDAFa,QAAQ,SAAS,CAAC,CAc9B;IAED;;;;OAIG;IACH,iDAWC;IAED;;;;;;OAMG;IACH,qCAFa,YAAY,CAoBxB;IAED;;;;;;;OAOG;IACH,sDAFa,SAAS,GAAC,IAAI,CAoB1B;IAED;;;;;OAKG;IACH,qEAQC;IAED;;;;;;OAMG;IACH,+CAJW,mBAAoB,GAElB,mBAAoB,CAMhC;IAED;;;;;;OAMG;IACH,0CAFa,MAAM,GAAC,SAAS,CAY5B;IAED;;;;;;;OAOG;IACH,qEAFa,MAAM,GAAC,SAAS,CAW5B;IAED;;;;;;;OAOG;IACH,oFAFa,QAAQ,gBAAgB,CAAC,CASrC;IAED;;;;;;OAMG;IACH,gCAJW,iCAAkC,8BAW5C;IAED;;;;;;;OAOG;IACH,8CAJW,GAAG,GAED,6BAA6B,CAyBzC;IAED;;;;;;;;;;;;OAYG;IACH,sDAJW,MAAM,GAEJ,MAAM,CAmBlB;IAED;;;;;;;;;;;;OAYG;IACH,yDAJW,MAAM,GAEJ,MAAM,CAQlB;IAED;;;;;;;;;;;;;;;OAeG;IACH,+CALW,GAAG,mBAGD,QAAQ,GAAG,CAAC,CAoBxB;IAED;;;;OAIG;IACH,0CAiBC;IAED;;;;;;OAMG;IACH,4CAFa,mBAAmB,CAoB/B;IAED;;;;;;OAMG;IACH,sFAFW,KAAK,QAQf;IAED;;;;;OAKG;IACH,+EAOC;IAED;;;;;;OAMG;IACH,uCAYC;CACF;6BA/qB4B,2CAA2C;yBAN/C,0CAA0C;gCAKnC,oCAAoC;kBAJlD,mBAAmB"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export default PillarboxMonitoring;
|
|
2
|
+
/** @import Player from 'video.js/dist/types/player' */
|
|
2
3
|
/**
|
|
3
4
|
* The PillarboxMonitoring class retrieves data about media playback.
|
|
4
5
|
*
|
|
@@ -64,14 +65,20 @@ declare class PillarboxMonitoring {
|
|
|
64
65
|
* @returns {string}
|
|
65
66
|
*/
|
|
66
67
|
static userAgent(): string;
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
68
|
+
/**
|
|
69
|
+
* Creates an instance of PillarboxMonitoring.
|
|
70
|
+
*
|
|
71
|
+
* @constructor
|
|
72
|
+
* @param {Player} player The player instance to be monitored
|
|
73
|
+
* @param {PillarboxMonitoringOptions} [options={}] Configuration options for the monitoring
|
|
74
|
+
* @param {string} [options.playerName='none'] The name of the player
|
|
75
|
+
* @param {string} [options.playerVersion='none'] The version of the player
|
|
76
|
+
* @param {string} [options.platform='Web'] The platform on which the player is running
|
|
77
|
+
* @param {number} [options.schemaVersion=1] The version of the schema used for monitoring
|
|
78
|
+
* @param {number} [options.heartbeatInterval=30000] The interval in milliseconds for sending heartbeat signals
|
|
79
|
+
* @param {string} [options.beaconUrl='https://monitoring.pillarbox.ch/api/events'] The URL for the monitoring beacon
|
|
80
|
+
*/
|
|
81
|
+
constructor(player: Player, { playerName, playerVersion, platform, schemaVersion, heartbeatInterval, beaconUrl }?: PillarboxMonitoringOptions);
|
|
75
82
|
/**
|
|
76
83
|
* @type {import('video.js/dist/types/player').default}
|
|
77
84
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PillarboxMonitoring.d.ts","sourceRoot":"","sources":["../../../../src/trackers/PillarboxMonitoring.js"],"names":[],"mappings":";
|
|
1
|
+
{"version":3,"file":"PillarboxMonitoring.d.ts","sourceRoot":"","sources":["../../../../src/trackers/PillarboxMonitoring.js"],"names":[],"mappings":";AAEA,uDAAuD;AAIvD;;;;;;;;;;;;;;GAcG;AACH;IA2yBE;;;;;;;;OAQG;IACH,0BAJW,MAAM,GAEJ,MAAM,CAUlB;IAED;;;;OAIG;IACH,oBAFa,MAAM,CAIlB;IAED;;;;;OAKG;IACH,mBAHa,MAAM,GAAC,SAAS,CAe5B;IAED;;;;OAIG;IACH,qBAFa,MAAM,CAclB;IAED;;;;;;OAMG;IACH,sCAJW,MAAM,GAEJ,MAAM,CAIlB;IAED;;;;OAIG;IACH,oBAFY,MAAM,CAIjB;IAED;;;;OAIG;IACH,oBAFa,MAAM,CAMlB;IA14BD;;;;;;;;;;;;OAYG;IACH,+IAsFC;IA9EC;;OAEG;IACH,QAFU,OAAO,4BAA4B,EAAE,OAAO,CAElC;IACpB;;OAEG;IACH,YAFU,MAAM,CAEY;IAC5B;;OAEG;IACH,eAFU,MAAM,CAEkB;IAClC;;OAEG;IACH,UAFU,MAAM,CAEQ;IACxB;;OAEG;IACH,eAFU,MAAM,CAEkB;IAClC;;OAEG;IACH,0BAA0C;IAC1C;;OAEG;IACH,WAFU,MAAM,CAEU;IAC1B;;OAEG;IACH,kBAFU,MAAM,CAEiB;IACjC;;OAEG;IACH,6BAA6B;IAC7B;;OAEG;IACH,mCAAmC;IACnC;;OAEG;IACH,uBAAuB;IACvB;;OAEG;IACH,0BAA0B;IAC1B;;OAEG;IACH,2BAAmC;IACnC;;OAEG;IACH,4BAA4B;IAC5B;;OAEG;IACH,eAFU,MAAM,CAEc;IAC9B;;OAEG;IACH,SAFU,MAAM,CAEQ;IACxB;;OAEG;IACH,kBAFU,MAAM,CAEiB;IACjC;;OAEG;IACH,aAFU,MAAM,CAEY;IAC5B;;OAEG;IACH,yBAAyB;IAK3B;;OAEG;IACH,qBAYC;IAED;;;;;OAKG;IACH,aAHa,MAAM,GAAC,SAAS,CAQ5B;IAED;;OAEG;IACH,sBAQC;IAiFD;;OAEG;IACH,cAqBC;IAiGD;;;OAGG;IACH,mBAKC;IAED;;;OAGG;IACH,kBAYC;IA2ED;;OAEG;IACH,sBAEC;IAED;;;OAGG;IACH,qBAKC;IAwMD;;;OAGG;IACH,gBA6BC;IA7CD;;;;;;OAMG;IACH,oBAHW,KAAK,QAMf;IApgBD;;;;OAIG;IACH,yBAYC;IAED;;;;;;;;;;;;OAYG;IACH;;;;;mBATc,MAAM,GAAC,SAAS;;;;;yBAEhB,MAAM,GAAC,SAAS;;;;aAEhB,MAAM,GAAC,SAAS;MAY7B;IAED;;;;;;;;OAQG;IACH;;;;iBALc,MAAM,GAAC,SAAS;;;;aAChB,MAAM,GAAC,SAAS;MAmB7B;IAED;;;;;OAKG;IACH,8BAIC;IA4BD;;;;OAIG;IACH,yBAFa,MAAM,GAAC,SAAS,CAgB5B;IAED;;;;;;;;;;;OAWG;IACH,oBALW,MAAM;;;;cAHH,MAAM;;;;kBACN,MAAM;MAoBnB;IAED;;;;OAIG;IACH,yCAFa,MAAM,GAAC,SAAS,CAY5B;IAED;;;OAGG;IACH,kBAIC;IAHC,oCAE0B;IAG5B;;;;OAIG;IACH,6BAaC;IAyBG,8BAA4D;IAMhE;;;;;;;;;;OAUG;IACH;;;;mBAPc,MAAM;;;;YACN,MAAM;;;;sBACN,MAAM;;;;gBACN,MAAM;MAWnB;IAED;;;;OAIG;IACH,oBAFa,MAAM,CAYlB;IAED;;;;;;;;;OASG;IACH;;;;kBANc,MAAM;;;;;4BACN,MAAM,GAAC,SAAS;MA6B7B;IAoBD;;;;;;;;OAQG;IACH;;;;eALc,MAAM;;;;gBACN,MAAM;MAMnB;IAED;;;;;;;;;OASG;IACH;;;;cANc,MAAM;;;;iBACN,MAAM;;;;kBACN,MAAM;MAUnB;IAED;;;;;;;;;;;;OAYG;IACH,6BALW,MAAM,aACN,MAAM;;;;kBALH,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;MAanB;IAED;;;;;;;;;;;;OAYG;IACH,6BAJW,MAAM;;;;eALH,MAAM;;;;aACN,MAAM;;;;kBACN,MAAM;;;;eACN,MAAM;MAanB;IAED;;OAEG;IACH,wBAUC;IAED;;;;;;;OAOG;IACH,kCALW,MAAM,GAEJ,MAAM,GAAC,SAAS,CAe5B;IAED;;;;;OAKG;IACH,aAHW,KAAK,QAuBf;IAED;;;;;;OAMG;IACH,qBAJW,MAAM,oBA0BhB;IAED;;;OAGG;IACH,qBAUC;IAyBC,mBAAqB;IAwBvB;;;;;;;;;OASG;IACH;;;;eANc,MAAM;;;;;kBACN,MAAM;MAUnB;IAED;;;;;;;;;;;;;;;;OAgBG;IACH;;;;mBAbc,MAAM;;;;iBACN,MAAM,GAAC,SAAS;;;;2BAChB,MAAM;;;;qBACN,MAAM;;;;2BACN,MAAM;;;;kBACN,MAAM;;;;4BACN,MAAM;;;;;;;;qBAEN,MAAM;;;;aACN,MAAM,GAAC,SAAS;MA8B7B;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH;;;;iBAXc,MAAM;;;;;;;;gBAHN,MAAM;;;;;;;;;uBAlYN,MAAM;;;;gBACN,MAAM;;;;0BACN,MAAM;;;;oBACN,MAAM;;;;;;;;;kBAqGN,MAAM;;;;qBACN,MAAM;;;;sBACN,MAAM;;;;;;;;;sBAgBN,MAAM;;;;mBACN,MAAM;;;;mBACN,MAAM;;;;;;;;;mBAmBN,MAAM;;;;iBACN,MAAM;;;;sBACN,MAAM;;;;mBACN,MAAM;;;;;;;;;;mBAvDN,MAAM;;;;oBACN,MAAM;;MAmVnB;CAmGF"}
|