react-native-theoplayer 7.3.0 → 7.5.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 (134) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/README.md +12 -12
  3. package/android/build.gradle +5 -4
  4. package/android/local/com/theoplayer/theoplayer-sdk-android/ads-wrapper/7.6.0/ads-wrapper-7.6.0.aar +0 -0
  5. package/android/local/com/theoplayer/theoplayer-sdk-android/ads-wrapper/{7.0.0/ads-wrapper-7.0.0.pom → 7.6.0/ads-wrapper-7.6.0.pom} +2 -2
  6. package/android/local/com/theoplayer/theoplayer-sdk-android/ads-wrapper/maven-metadata-local.xml +4 -4
  7. package/android/src/main/java/com/theoplayer/ads/AdAdapter.kt +9 -0
  8. package/android/src/main/java/com/theoplayer/source/GoogleDaiSourceAdapter.kt +34 -0
  9. package/android/src/main/java/com/theoplayer/source/SSAIAdapterRegistry.kt +51 -0
  10. package/android/src/main/java/com/theoplayer/source/SourceAdapter.kt +23 -58
  11. package/ios/THEOplayerRCTPlayerAPI.swift +28 -3
  12. package/ios/THEOplayerRCTView.swift +7 -0
  13. package/ios/backgroundAudio/THEOplayerRCTRemoteCommandsManager.swift +12 -4
  14. package/ios/backgroundAudio/THEOplayerRCTView+MediaControlConfig.swift +23 -0
  15. package/lib/commonjs/api/abr/ABRConfiguration.js.map +1 -1
  16. package/lib/commonjs/api/barrel.js +22 -11
  17. package/lib/commonjs/api/barrel.js.map +1 -1
  18. package/lib/commonjs/api/resolution/Resolution.js +2 -0
  19. package/lib/commonjs/api/resolution/Resolution.js.map +1 -0
  20. package/lib/commonjs/api/resolution/barrel.js +17 -0
  21. package/lib/commonjs/api/resolution/barrel.js.map +1 -0
  22. package/lib/commonjs/api/source/ads/barrel.js +0 -22
  23. package/lib/commonjs/api/source/ads/barrel.js.map +1 -1
  24. package/lib/commonjs/api/source/ads/ssai/barrel.js +0 -22
  25. package/lib/commonjs/api/source/ads/ssai/barrel.js.map +1 -1
  26. package/lib/commonjs/internal/THEOplayerView.js +30 -4
  27. package/lib/commonjs/internal/THEOplayerView.js.map +1 -1
  28. package/lib/commonjs/internal/adapter/THEOplayerAdapter.js +3 -3
  29. package/lib/commonjs/internal/adapter/THEOplayerAdapter.js.map +1 -1
  30. package/lib/commonjs/internal/adapter/abr/AbrAdapter.js +17 -1
  31. package/lib/commonjs/internal/adapter/abr/AbrAdapter.js.map +1 -1
  32. package/lib/commonjs/internal/adapter/cast/THEOplayerNativeCastAdapter.js +3 -3
  33. package/lib/commonjs/internal/adapter/cast/THEOplayerNativeCastAdapter.js.map +1 -1
  34. package/lib/commonjs/internal/poster/Poster.js +31 -0
  35. package/lib/commonjs/internal/poster/Poster.js.map +1 -0
  36. package/lib/module/api/abr/ABRConfiguration.js.map +1 -1
  37. package/lib/module/api/barrel.js +1 -0
  38. package/lib/module/api/barrel.js.map +1 -1
  39. package/lib/module/api/resolution/Resolution.js +2 -0
  40. package/lib/module/api/resolution/Resolution.js.map +1 -0
  41. package/lib/module/api/resolution/barrel.js +2 -0
  42. package/lib/module/api/resolution/barrel.js.map +1 -0
  43. package/lib/module/api/source/ads/barrel.js +0 -2
  44. package/lib/module/api/source/ads/barrel.js.map +1 -1
  45. package/lib/module/api/source/ads/ssai/barrel.js +0 -2
  46. package/lib/module/api/source/ads/ssai/barrel.js.map +1 -1
  47. package/lib/module/internal/THEOplayerView.js +30 -4
  48. package/lib/module/internal/THEOplayerView.js.map +1 -1
  49. package/lib/module/internal/adapter/THEOplayerAdapter.js +3 -3
  50. package/lib/module/internal/adapter/THEOplayerAdapter.js.map +1 -1
  51. package/lib/module/internal/adapter/abr/AbrAdapter.js +17 -1
  52. package/lib/module/internal/adapter/abr/AbrAdapter.js.map +1 -1
  53. package/lib/module/internal/adapter/cast/THEOplayerNativeCastAdapter.js +3 -3
  54. package/lib/module/internal/adapter/cast/THEOplayerNativeCastAdapter.js.map +1 -1
  55. package/lib/module/internal/poster/Poster.js +23 -0
  56. package/lib/module/internal/poster/Poster.js.map +1 -0
  57. package/lib/typescript/api/abr/ABRConfiguration.d.ts +23 -0
  58. package/lib/typescript/api/abr/ABRConfiguration.d.ts.map +1 -1
  59. package/lib/typescript/api/barrel.d.ts +1 -0
  60. package/lib/typescript/api/barrel.d.ts.map +1 -1
  61. package/lib/typescript/api/media/MediaControlConfiguration.d.ts +2 -8
  62. package/lib/typescript/api/media/MediaControlConfiguration.d.ts.map +1 -1
  63. package/lib/typescript/api/player/THEOplayer.d.ts +1 -4
  64. package/lib/typescript/api/player/THEOplayer.d.ts.map +1 -1
  65. package/lib/typescript/api/resolution/Resolution.d.ts +5 -0
  66. package/lib/typescript/api/resolution/Resolution.d.ts.map +1 -0
  67. package/lib/typescript/api/resolution/barrel.d.ts +2 -0
  68. package/lib/typescript/api/resolution/barrel.d.ts.map +1 -0
  69. package/lib/typescript/api/source/SourceDescription.d.ts +0 -1
  70. package/lib/typescript/api/source/SourceDescription.d.ts.map +1 -1
  71. package/lib/typescript/api/source/ads/barrel.d.ts +0 -2
  72. package/lib/typescript/api/source/ads/barrel.d.ts.map +1 -1
  73. package/lib/typescript/api/source/ads/ssai/GoogleDAIConfiguration.d.ts +0 -9
  74. package/lib/typescript/api/source/ads/ssai/GoogleDAIConfiguration.d.ts.map +1 -1
  75. package/lib/typescript/api/source/ads/ssai/ServerSideAdInsertionConfiguration.d.ts +3 -10
  76. package/lib/typescript/api/source/ads/ssai/ServerSideAdInsertionConfiguration.d.ts.map +1 -1
  77. package/lib/typescript/api/source/ads/ssai/barrel.d.ts +0 -2
  78. package/lib/typescript/api/source/ads/ssai/barrel.d.ts.map +1 -1
  79. package/lib/typescript/internal/THEOplayerView.d.ts +5 -0
  80. package/lib/typescript/internal/THEOplayerView.d.ts.map +1 -1
  81. package/lib/typescript/internal/adapter/THEOplayerAdapter.d.ts +1 -1
  82. package/lib/typescript/internal/adapter/THEOplayerAdapter.d.ts.map +1 -1
  83. package/lib/typescript/internal/adapter/abr/AbrAdapter.d.ts +7 -1
  84. package/lib/typescript/internal/adapter/abr/AbrAdapter.d.ts.map +1 -1
  85. package/lib/typescript/internal/adapter/cast/THEOplayerNativeCastAdapter.d.ts +1 -1
  86. package/lib/typescript/internal/adapter/cast/THEOplayerNativeCastAdapter.d.ts.map +1 -1
  87. package/lib/typescript/internal/poster/Poster.d.ts +5 -0
  88. package/lib/typescript/internal/poster/Poster.d.ts.map +1 -0
  89. package/package.json +1 -1
  90. package/src/api/abr/ABRConfiguration.ts +26 -0
  91. package/src/api/barrel.ts +1 -0
  92. package/src/api/media/MediaControlConfiguration.ts +2 -8
  93. package/src/api/player/THEOplayer.ts +1 -4
  94. package/src/api/resolution/Resolution.ts +5 -0
  95. package/src/api/resolution/barrel.ts +1 -0
  96. package/src/api/source/SourceDescription.ts +0 -1
  97. package/src/api/source/ads/barrel.ts +0 -2
  98. package/src/api/source/ads/ssai/GoogleDAIConfiguration.ts +0 -9
  99. package/src/api/source/ads/ssai/ServerSideAdInsertionConfiguration.ts +3 -10
  100. package/src/api/source/ads/ssai/barrel.ts +0 -2
  101. package/src/internal/THEOplayerView.tsx +25 -3
  102. package/src/internal/adapter/THEOplayerAdapter.ts +3 -3
  103. package/src/internal/adapter/abr/AbrAdapter.ts +23 -1
  104. package/src/internal/adapter/cast/THEOplayerNativeCastAdapter.ts +3 -3
  105. package/src/internal/poster/Poster.tsx +14 -0
  106. package/android/local/com/theoplayer/theoplayer-sdk-android/ads-wrapper/7.0.0/ads-wrapper-7.0.0.aar +0 -0
  107. package/lib/commonjs/api/source/ads/FreeWheelAdDescription.js +0 -6
  108. package/lib/commonjs/api/source/ads/FreeWheelAdDescription.js.map +0 -1
  109. package/lib/commonjs/api/source/ads/SpotXAdDescription.js +0 -6
  110. package/lib/commonjs/api/source/ads/SpotXAdDescription.js.map +0 -1
  111. package/lib/commonjs/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.js +0 -6
  112. package/lib/commonjs/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.js.map +0 -1
  113. package/lib/commonjs/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.js +0 -6
  114. package/lib/commonjs/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.js.map +0 -1
  115. package/lib/module/api/source/ads/FreeWheelAdDescription.js +0 -2
  116. package/lib/module/api/source/ads/FreeWheelAdDescription.js.map +0 -1
  117. package/lib/module/api/source/ads/SpotXAdDescription.js +0 -2
  118. package/lib/module/api/source/ads/SpotXAdDescription.js.map +0 -1
  119. package/lib/module/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.js +0 -2
  120. package/lib/module/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.js.map +0 -1
  121. package/lib/module/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.js +0 -2
  122. package/lib/module/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.js.map +0 -1
  123. package/lib/typescript/api/source/ads/FreeWheelAdDescription.d.ts +0 -86
  124. package/lib/typescript/api/source/ads/FreeWheelAdDescription.d.ts.map +0 -1
  125. package/lib/typescript/api/source/ads/SpotXAdDescription.d.ts +0 -116
  126. package/lib/typescript/api/source/ads/SpotXAdDescription.d.ts.map +0 -1
  127. package/lib/typescript/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.d.ts +0 -28
  128. package/lib/typescript/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.d.ts.map +0 -1
  129. package/lib/typescript/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.d.ts +0 -47
  130. package/lib/typescript/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.d.ts.map +0 -1
  131. package/src/api/source/ads/FreeWheelAdDescription.ts +0 -97
  132. package/src/api/source/ads/SpotXAdDescription.ts +0 -126
  133. package/src/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.ts +0 -30
  134. package/src/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.ts +0 -51
@@ -1,86 +0,0 @@
1
- import type { AdDescription, AdIntegrationKind } from "./Ads";
2
- /**
3
- * The possible ad unit types, represented by a value from the following list:
4
- * <br/> - `'preroll'`: The linear ad will play before the content started.
5
- * <br/> - `'midroll'`: The linear ad will play at a time offset during the content.
6
- * <br/> - `'postroll'`: The linear ad will play after the content ended.
7
- * <br/> - `'overlay'`: The non-linear ad.
8
- *
9
- * @public
10
- */
11
- export type FreeWheelAdUnitType = 'preroll' | 'midroll' | 'postroll' | 'overlay';
12
- /**
13
- * Represents a FreeWheel cue.
14
- *
15
- * @public
16
- */
17
- export interface FreeWheelCue {
18
- /**
19
- * The ad unit type.
20
- */
21
- adUnit: FreeWheelAdUnitType;
22
- /**
23
- * Offset after which the ad break will start, in seconds.
24
- */
25
- timeOffset: number;
26
- }
27
- /**
28
- * Describes a FreeWheel ad break request.
29
- *
30
- * @remarks
31
- * <br/> - Available since v2.42.0.
32
- *
33
- * @public
34
- */
35
- export interface FreeWheelAdDescription extends AdDescription {
36
- /**
37
- * The integration of this ad break.
38
- */
39
- integration: AdIntegrationKind.freewheel;
40
- /**
41
- * The FreeWheel ad server URL.
42
- */
43
- adServerUrl: string;
44
- /**
45
- * The duration of the asset, in seconds.
46
- *
47
- * @remarks
48
- * <br/> - Optional for live assets.
49
- */
50
- assetDuration?: number;
51
- /**
52
- * The identifier of the asset.
53
- *
54
- * @remarks
55
- * <br/> - Generated by FreeWheel CMS when an asset is uploaded.
56
- */
57
- assetId?: string;
58
- /**
59
- * The network identifier which is associated with a FreeWheel customer.
60
- */
61
- networkId: number;
62
- /**
63
- * The server side configuration profile.
64
- *
65
- * @remarks
66
- * <br/> - Used to indicate desired player capabilities.
67
- */
68
- profile: string;
69
- /**
70
- * The identifier of the video player's location.
71
- */
72
- siteSectionId?: string;
73
- /**
74
- * List of cue points.
75
- *
76
- * @remarks
77
- * <br/> - Not available in all FreeWheel modes.
78
- */
79
- cuePoints?: FreeWheelCue[];
80
- /**
81
- * A record of query string parameters added to the FreeWheel ad break request.
82
- * Each entry contains the parameter name with associated value.
83
- */
84
- customData?: Record<string, string>;
85
- }
86
- //# sourceMappingURL=FreeWheelAdDescription.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"FreeWheelAdDescription.d.ts","sourceRoot":"","sources":["../../../../../src/api/source/ads/FreeWheelAdDescription.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE9D;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IAC3D;;OAEG;IACH,WAAW,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAEzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;IAE3B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC"}
@@ -1,116 +0,0 @@
1
- import type { AdDescription } from "./Ads";
2
- /**
3
- * Represents a geographical location.
4
- *
5
- * @public
6
- */
7
- export interface Geo {
8
- /**
9
- * The latitude of this location.
10
- */
11
- readonly lat: number;
12
- /**
13
- * The longitude of this location.
14
- */
15
- readonly lon: number;
16
- }
17
- /**
18
- * A record of SpotX query string parameters.
19
- * Each entry contains the parameter name with associated value.
20
- *
21
- * @public
22
- */
23
- export interface SpotxData {
24
- [key: string]: string | number | boolean | string[] | Geo;
25
- }
26
- /**
27
- * A record of SpotX query string parameters which can be a nested structure.
28
- * Each entry contains the parameter name with associated value.
29
- *
30
- * @public
31
- */
32
- export interface SpotxQueryParameter {
33
- [key: string]: string | number | boolean | string[] | Geo | SpotxData | SpotxData[];
34
- }
35
- /**
36
- * Describes a SpotX ad break request.
37
- *
38
- * @remarks
39
- * <br/> - Available since v2.13.0.
40
- *
41
- * @example
42
- * ```
43
- * {
44
- * integration: 'spotx',
45
- * id: 123456,
46
- * cacheBuster: true,
47
- * app: {
48
- * bundle: 'com.exampleapps.example',
49
- * name: 'My CTV App'
50
- * },
51
- * device: {
52
- * ifa: '38400000-8cf0-11bd-b23e-10b96e40000d',
53
- * ua: 'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/56.0.2924.75 Mobile/14E5239e Safari/602.1',
54
- * geo: {
55
- * lat: -24.378528,
56
- * lon: -128.325119
57
- * },
58
- * dnt: 1,
59
- * lmt: 1,
60
- * },
61
- * custom: {
62
- * category: ['category1', 'category2'],
63
- * somekey: 'somevalue'
64
- * }
65
- * user: {
66
- * yob: 1984,
67
- * gender: 'm'
68
- * }
69
- * }
70
- * ```
71
- *
72
- * @public
73
- */
74
- export interface SpotXAdDescription extends AdDescription {
75
- /**
76
- * The identifier of the ad break requested from SpotX.
77
- */
78
- id: number | string;
79
- /**
80
- * The maximum duration of the ad, in seconds.
81
- *
82
- * @defaultValue No maximum duration.
83
- */
84
- maximumAdDuration?: number | string;
85
- /**
86
- * The URL of the content page.
87
- */
88
- contentPageUrl?: string;
89
- /**
90
- * The IP address of the viewer.
91
- */
92
- ipAddress?: string;
93
- /**
94
- * Whether the ad break request should contain a cache buster.
95
- *
96
- * @remarks
97
- * <br/> - A cache buster adds a query parameter 'cb' with a random value to circumvent browser caching mechanisms.
98
- */
99
- cacheBuster?: boolean;
100
- /**
101
- * A source URL which contains the location of ad resources to be scheduled.
102
- *
103
- * @remarks
104
- * <br/> - This will override the generated URL.
105
- */
106
- sources?: string;
107
- /**
108
- * A record of query string parameters added to the SpotX ad break request.
109
- * Each entry contains the parameter name with associated value.
110
- *
111
- * @remarks
112
- * <br/> - Available since v2.38.0.
113
- */
114
- queryParameters?: SpotxQueryParameter;
115
- }
116
- //# sourceMappingURL=SpotXAdDescription.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"SpotXAdDescription.d.ts","sourceRoot":"","sources":["../../../../../src/api/source/ads/SpotXAdDescription.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C;;;;GAIG;AACH,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,GAAG,CAAC;CAC3D;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,GAAG,GAAG,SAAS,GAAG,SAAS,EAAE,CAAC;CACrF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,mBAAmB,CAAC;CACvC"}
@@ -1,28 +0,0 @@
1
- import type { TypedSource } from '../../SourceDescription';
2
- import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertionConfiguration';
3
- /**
4
- * The identifier of the Imagine integration.
5
- *
6
- * @public
7
- */
8
- export type ImagineSSAIIntegrationID = 'imagine';
9
- /**
10
- * Describes the SSAI configuration of the Imagine integration.
11
- *
12
- * @public
13
- */
14
- export interface ImagineServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
15
- /**
16
- * {@inheritDoc ServerSideAdInsertionConfiguration.integration}
17
- */
18
- integration: ImagineSSAIIntegrationID;
19
- }
20
- /**
21
- * Describes a source of the Imagine integration.
22
- *
23
- * @public
24
- */
25
- export interface ImagineTypedSource extends TypedSource {
26
- ssai: ImagineServerSideAdInsertionConfiguration;
27
- }
28
- //# sourceMappingURL=ImagineServerSideAdInsertionConfiguration.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ImagineServerSideAdInsertionConfiguration.d.ts","sourceRoot":"","sources":["../../../../../../src/api/source/ads/ssai/ImagineServerSideAdInsertionConfiguration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAE/F;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAAC;AAEjD;;;;GAIG;AACH,MAAM,WAAW,yCAA0C,SAAQ,kCAAkC;IACjG;;OAEG;IACH,WAAW,EAAE,wBAAwB,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACnD,IAAI,EAAE,yCAAyC,CAAC;CACnD"}
@@ -1,47 +0,0 @@
1
- import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertionConfiguration';
2
- import type { TypedSource } from '../../SourceDescription';
3
- /**
4
- * The identifier of the Yospace integration.
5
- *
6
- * @public
7
- */
8
- export type YospaceSSAIIntegrationID = 'yospace';
9
- /**
10
- * The type of the Yospace stream, represented by a value from the following list:
11
- * <br/> - `'live'`: The stream is a live stream.
12
- * <br/> - `'livepause'`: The stream is a live stream with a large DVR window.
13
- * <br/> - `'nonlinear'`: The stream is a Non-Linear Start-Over stream.
14
- * <br/> - `'vod'`: The stream is a video-on-demand stream.
15
- *
16
- * @public
17
- */
18
- export type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
19
- /**
20
- * Represents a configuration for server-side ad insertion with the Yospace pre-integration.
21
- *
22
- * @remarks
23
- * <br/> - Available since v2.14.7.
24
- *
25
- * @public
26
- */
27
- export interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
28
- /**
29
- * The identifier for the SSAI pre-integration.
30
- */
31
- integration: YospaceSSAIIntegrationID;
32
- /**
33
- * The type of the requested stream.
34
- *
35
- * @defaultValue `'live'`
36
- */
37
- streamType?: YospaceStreamType;
38
- }
39
- /**
40
- * Represents a media resource with a Yospace server-side ad insertion request.
41
- *
42
- * @public
43
- */
44
- export interface YospaceTypedSource extends TypedSource {
45
- ssai: YospaceServerSideAdInsertionConfiguration;
46
- }
47
- //# sourceMappingURL=YospaceServerSideAdInsertionConfiguration.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"YospaceServerSideAdInsertionConfiguration.d.ts","sourceRoot":"","sources":["../../../../../../src/api/source/ads/ssai/YospaceServerSideAdInsertionConfiguration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAC/F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAE3D;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,WAAW,CAAC;AAE3E;;;;;;;GAOG;AACH,MAAM,WAAW,yCAA0C,SAAQ,kCAAkC;IACjG;;OAEG;IACH,WAAW,EAAE,wBAAwB,CAAC;IAEtC;;;;OAIG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACnD,IAAI,EAAE,yCAAyC,CAAC;CACnD"}
@@ -1,97 +0,0 @@
1
- import type { AdDescription, AdIntegrationKind } from "./Ads";
2
-
3
- /**
4
- * The possible ad unit types, represented by a value from the following list:
5
- * <br/> - `'preroll'`: The linear ad will play before the content started.
6
- * <br/> - `'midroll'`: The linear ad will play at a time offset during the content.
7
- * <br/> - `'postroll'`: The linear ad will play after the content ended.
8
- * <br/> - `'overlay'`: The non-linear ad.
9
- *
10
- * @public
11
- */
12
- export type FreeWheelAdUnitType = 'preroll' | 'midroll' | 'postroll' | 'overlay';
13
-
14
- /**
15
- * Represents a FreeWheel cue.
16
- *
17
- * @public
18
- */
19
- export interface FreeWheelCue {
20
- /**
21
- * The ad unit type.
22
- */
23
- adUnit: FreeWheelAdUnitType;
24
-
25
- /**
26
- * Offset after which the ad break will start, in seconds.
27
- */
28
- timeOffset: number;
29
- }
30
-
31
- /**
32
- * Describes a FreeWheel ad break request.
33
- *
34
- * @remarks
35
- * <br/> - Available since v2.42.0.
36
- *
37
- * @public
38
- */
39
- export interface FreeWheelAdDescription extends AdDescription {
40
- /**
41
- * The integration of this ad break.
42
- */
43
- integration: AdIntegrationKind.freewheel;
44
-
45
- /**
46
- * The FreeWheel ad server URL.
47
- */
48
- adServerUrl: string;
49
-
50
- /**
51
- * The duration of the asset, in seconds.
52
- *
53
- * @remarks
54
- * <br/> - Optional for live assets.
55
- */
56
- assetDuration?: number;
57
-
58
- /**
59
- * The identifier of the asset.
60
- *
61
- * @remarks
62
- * <br/> - Generated by FreeWheel CMS when an asset is uploaded.
63
- */
64
- assetId?: string;
65
-
66
- /**
67
- * The network identifier which is associated with a FreeWheel customer.
68
- */
69
- networkId: number;
70
-
71
- /**
72
- * The server side configuration profile.
73
- *
74
- * @remarks
75
- * <br/> - Used to indicate desired player capabilities.
76
- */
77
- profile: string;
78
-
79
- /**
80
- * The identifier of the video player's location.
81
- */
82
- siteSectionId?: string;
83
-
84
- /**
85
- * List of cue points.
86
- *
87
- * @remarks
88
- * <br/> - Not available in all FreeWheel modes.
89
- */
90
- cuePoints?: FreeWheelCue[];
91
-
92
- /**
93
- * A record of query string parameters added to the FreeWheel ad break request.
94
- * Each entry contains the parameter name with associated value.
95
- */
96
- customData?: Record<string, string>;
97
- }
@@ -1,126 +0,0 @@
1
- import type { AdDescription } from "./Ads";
2
-
3
- /**
4
- * Represents a geographical location.
5
- *
6
- * @public
7
- */
8
- export interface Geo {
9
- /**
10
- * The latitude of this location.
11
- */
12
- readonly lat: number;
13
-
14
- /**
15
- * The longitude of this location.
16
- */
17
- readonly lon: number;
18
- }
19
-
20
- /**
21
- * A record of SpotX query string parameters.
22
- * Each entry contains the parameter name with associated value.
23
- *
24
- * @public
25
- */
26
- export interface SpotxData {
27
- [key: string]: string | number | boolean | string[] | Geo;
28
- }
29
-
30
- /**
31
- * A record of SpotX query string parameters which can be a nested structure.
32
- * Each entry contains the parameter name with associated value.
33
- *
34
- * @public
35
- */
36
- export interface SpotxQueryParameter {
37
- [key: string]: string | number | boolean | string[] | Geo | SpotxData | SpotxData[];
38
- }
39
-
40
- /**
41
- * Describes a SpotX ad break request.
42
- *
43
- * @remarks
44
- * <br/> - Available since v2.13.0.
45
- *
46
- * @example
47
- * ```
48
- * {
49
- * integration: 'spotx',
50
- * id: 123456,
51
- * cacheBuster: true,
52
- * app: {
53
- * bundle: 'com.exampleapps.example',
54
- * name: 'My CTV App'
55
- * },
56
- * device: {
57
- * ifa: '38400000-8cf0-11bd-b23e-10b96e40000d',
58
- * ua: 'Mozilla/5.0 (iPhone; CPU iPhone OS 10_3 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/56.0.2924.75 Mobile/14E5239e Safari/602.1',
59
- * geo: {
60
- * lat: -24.378528,
61
- * lon: -128.325119
62
- * },
63
- * dnt: 1,
64
- * lmt: 1,
65
- * },
66
- * custom: {
67
- * category: ['category1', 'category2'],
68
- * somekey: 'somevalue'
69
- * }
70
- * user: {
71
- * yob: 1984,
72
- * gender: 'm'
73
- * }
74
- * }
75
- * ```
76
- *
77
- * @public
78
- */
79
- export interface SpotXAdDescription extends AdDescription {
80
- /**
81
- * The identifier of the ad break requested from SpotX.
82
- */
83
- id: number | string;
84
-
85
- /**
86
- * The maximum duration of the ad, in seconds.
87
- *
88
- * @defaultValue No maximum duration.
89
- */
90
- maximumAdDuration?: number | string;
91
-
92
- /**
93
- * The URL of the content page.
94
- */
95
- contentPageUrl?: string;
96
-
97
- /**
98
- * The IP address of the viewer.
99
- */
100
- ipAddress?: string;
101
-
102
- /**
103
- * Whether the ad break request should contain a cache buster.
104
- *
105
- * @remarks
106
- * <br/> - A cache buster adds a query parameter 'cb' with a random value to circumvent browser caching mechanisms.
107
- */
108
- cacheBuster?: boolean;
109
-
110
- /**
111
- * A source URL which contains the location of ad resources to be scheduled.
112
- *
113
- * @remarks
114
- * <br/> - This will override the generated URL.
115
- */
116
- sources?: string;
117
-
118
- /**
119
- * A record of query string parameters added to the SpotX ad break request.
120
- * Each entry contains the parameter name with associated value.
121
- *
122
- * @remarks
123
- * <br/> - Available since v2.38.0.
124
- */
125
- queryParameters?: SpotxQueryParameter;
126
- }
@@ -1,30 +0,0 @@
1
- import type { TypedSource } from '../../SourceDescription';
2
- import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertionConfiguration';
3
-
4
- /**
5
- * The identifier of the Imagine integration.
6
- *
7
- * @public
8
- */
9
- export type ImagineSSAIIntegrationID = 'imagine';
10
-
11
- /**
12
- * Describes the SSAI configuration of the Imagine integration.
13
- *
14
- * @public
15
- */
16
- export interface ImagineServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
17
- /**
18
- * {@inheritDoc ServerSideAdInsertionConfiguration.integration}
19
- */
20
- integration: ImagineSSAIIntegrationID;
21
- }
22
-
23
- /**
24
- * Describes a source of the Imagine integration.
25
- *
26
- * @public
27
- */
28
- export interface ImagineTypedSource extends TypedSource {
29
- ssai: ImagineServerSideAdInsertionConfiguration;
30
- }
@@ -1,51 +0,0 @@
1
- import type { ServerSideAdInsertionConfiguration } from './ServerSideAdInsertionConfiguration';
2
- import type { TypedSource } from '../../SourceDescription';
3
-
4
- /**
5
- * The identifier of the Yospace integration.
6
- *
7
- * @public
8
- */
9
- export type YospaceSSAIIntegrationID = 'yospace';
10
-
11
- /**
12
- * The type of the Yospace stream, represented by a value from the following list:
13
- * <br/> - `'live'`: The stream is a live stream.
14
- * <br/> - `'livepause'`: The stream is a live stream with a large DVR window.
15
- * <br/> - `'nonlinear'`: The stream is a Non-Linear Start-Over stream.
16
- * <br/> - `'vod'`: The stream is a video-on-demand stream.
17
- *
18
- * @public
19
- */
20
- export type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
21
-
22
- /**
23
- * Represents a configuration for server-side ad insertion with the Yospace pre-integration.
24
- *
25
- * @remarks
26
- * <br/> - Available since v2.14.7.
27
- *
28
- * @public
29
- */
30
- export interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
31
- /**
32
- * The identifier for the SSAI pre-integration.
33
- */
34
- integration: YospaceSSAIIntegrationID;
35
-
36
- /**
37
- * The type of the requested stream.
38
- *
39
- * @defaultValue `'live'`
40
- */
41
- streamType?: YospaceStreamType;
42
- }
43
-
44
- /**
45
- * Represents a media resource with a Yospace server-side ad insertion request.
46
- *
47
- * @public
48
- */
49
- export interface YospaceTypedSource extends TypedSource {
50
- ssai: YospaceServerSideAdInsertionConfiguration;
51
- }