@tivio/sdk-react 5.0.3-alpha-5 → 5.0.3-alpha-3

Sign up to get free protection for your applications and to get access to all the features.
package/dist/index.d.ts CHANGED
@@ -90,13 +90,13 @@ declare type AdSegment = {
90
90
  * @public
91
91
  */
92
92
  export declare type AdSource = {
93
- new (url: string, name: string, description: string, skipDelayMs: number | null, adDurationMs: number, trackingContext?: any, // internal Tivio types
93
+ new (uri: string, name: string, description: string, skipDelayMs: number | null, adDurationMs: number, trackingContext?: any, // internal Tivio types
94
94
  adMarker?: any, // internal Tivio types
95
95
  packInfo?: any, // internal Tivio types
96
96
  provider?: any): AdSource;
97
97
  description: string;
98
98
  name: string;
99
- url: string;
99
+ uri: string;
100
100
  durationMs: number;
101
101
  skipDelayMs: number | null;
102
102
  type: 'ad';
@@ -140,14 +140,6 @@ export declare interface Advertisement extends RowItem {
140
140
  type?: string | null;
141
141
  }
142
142
 
143
- export declare type AdvertisementAnalyticParams = {
144
- adFramework?: string;
145
- adOrder: number;
146
- adProvider?: string;
147
- adTitle?: string;
148
- videoId: string;
149
- };
150
-
151
143
  /**
152
144
  * @public
153
145
  */
@@ -206,22 +198,14 @@ export declare enum AnalyticsConversionTargetBase {
206
198
  }
207
199
 
208
200
  export declare interface AnalyticsInterface {
209
- reportAdvertisementPlay: (params: AdvertisementAnalyticParams) => void;
201
+ reportAdvertisementPlay: () => void;
210
202
  reportAdvertisementProgress: () => void;
211
203
  reportElementClick: (elementId: string) => void;
212
204
  reportLocationChange: (path: string, pathParam?: string) => void;
213
205
  createMonetizationPurchase: () => void;
214
206
  completeMonetizationPurchase: (status: AnalyticsConversionStatus, monetizationId?: string) => void;
215
207
  reportVideoPlay: (status: AnalyticsConversionStatus, videoId: string) => void;
216
- reportVideoProgress: (data: {
217
- checkpoint: number;
218
- organizationId?: string;
219
- seriesId?: string;
220
- videoDuration: string;
221
- videoId: string;
222
- videoMonetizationId?: string;
223
- videoType?: VideoType;
224
- }) => void;
208
+ reportVideoProgress: (videoId: string, videoDuration: number, checkpoint: number) => void;
225
209
  }
226
210
 
227
211
  /**
@@ -316,22 +300,6 @@ export declare type BetOffer = {
316
300
  time: Date;
317
301
  };
318
302
 
319
- /**
320
- * @public
321
- */
322
- export declare interface BufferChunk {
323
- startMs: number;
324
- endMs: number;
325
- }
326
-
327
- /**
328
- * @public
329
- */
330
- export declare interface BufferPercentChunk extends BufferChunk {
331
- startPercent: number;
332
- endPercent: number;
333
- }
334
-
335
303
  /**
336
304
  * rejects when bundle is not available
337
305
  * @public
@@ -354,14 +322,11 @@ export declare interface Channel {
354
322
  recentVideos: Video[];
355
323
  }
356
324
 
357
- /**
358
- * @public
359
- */
360
325
  export declare type ChannelSource = {
361
- new (url: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
326
+ new (uri: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
362
327
  description: string;
363
328
  name: string;
364
- url: string;
329
+ uri: string;
365
330
  from: Date;
366
331
  channelName: string;
367
332
  to: Date;
@@ -376,7 +341,7 @@ export declare type ChannelSource = {
376
341
  */
377
342
  export declare interface ChannelSourcePojo {
378
343
  type: 'ChannelSource';
379
- url: string;
344
+ uri: string;
380
345
  originalOptions: any;
381
346
  channelName: string;
382
347
  programName: string;
@@ -434,7 +399,6 @@ export declare interface ConfirmationOverlayPayloadBase {
434
399
 
435
400
  /**
436
401
  * Entity aggregate conversion statistics per day
437
- * TODO in future change structure, new used like array item
438
402
  */
439
403
  export declare interface ConversionAnalytic {
440
404
  /**
@@ -624,41 +588,6 @@ export declare type DocumentOptions = Partial<{
624
588
  subscribeOnChanges: boolean;
625
589
  }>;
626
590
 
627
- export declare interface Drm {
628
- encryption: VideoSourceEncryption;
629
- /**
630
- * Url to retrieve fairplay from.
631
- */
632
- certificateUrl?: string;
633
- /**
634
- * Url to send license to.
635
- */
636
- licenseUrl: string;
637
- /**
638
- * Headers with corresponding values to send to license server.
639
- */
640
- licenseRequestHeaders: {
641
- [key: string]: string;
642
- };
643
- }
644
-
645
- export declare enum DrmProvider {
646
- /**
647
- * Original oktagon stream provider.
648
- *
649
- * https://streamonline.pl
650
- */
651
- STREAMONLINE = "streamonline",
652
- /**
653
- * New stream provider for tivio. Also known as insys video technologies.
654
- *
655
- * https://insysvideotechnologies.com
656
- * https://www.drm.cloud
657
- * https://videokit.cloud
658
- */
659
- INSYS = "insys"
660
- }
661
-
662
591
  /**
663
592
  * @public
664
593
  */
@@ -675,76 +604,6 @@ export declare enum DurationUnits {
675
604
  MONTH = "month"
676
605
  }
677
606
 
678
- /**
679
- * Represents a SendGrid transactional template.
680
- */
681
- export declare interface EmailTemplate {
682
- /**
683
- * The ID of the transactional template.
684
- */
685
- id: string;
686
- /**
687
- * The name of the transactional template.
688
- * @maxLength 100
689
- */
690
- name: string;
691
- /**
692
- * Defines the generation of the template.
693
- * @format 'dynamic' | 'legacy'
694
- */
695
- generation: 'dynamic' | 'legacy';
696
- /**
697
- * The date and time the template was last updated.
698
- */
699
- updated_at: string;
700
- /**
701
- * An array of versions associated with the template.
702
- */
703
- versions: EmailTemplateVersion[];
704
- }
705
-
706
- export declare interface EmailTemplateVersion {
707
- /**
708
- * ID of the transactional template version.
709
- */
710
- id: string;
711
- /**
712
- * ID of the transactional template.
713
- */
714
- template_id: string;
715
- /**
716
- * Set the version as the active version associated with the template.
717
- * Only one version of a template can be active.
718
- * The first version created for a template will automatically be set to Active.
719
- */
720
- active: boolean;
721
- /**
722
- * Name of the transactional template version.
723
- */
724
- name: string;
725
- /**
726
- * Subject of the new transactional template version.
727
- * @maxLength 255
728
- */
729
- subject: string;
730
- /**
731
- * The date and time that this transactional template version was updated.
732
- */
733
- updated_at: string;
734
- /**
735
- * If true, plain_content is always generated from html_content. If false, plain_content is not altered.
736
- */
737
- generate_plain_content: boolean;
738
- /**
739
- * The editor used in the UI.
740
- */
741
- editor: string;
742
- /**
743
- * A Thumbnail preview of the template's html content.
744
- */
745
- thumbnail_url: string;
746
- }
747
-
748
607
  /**
749
608
  * @public
750
609
  */
@@ -812,31 +671,6 @@ export declare interface GenericOnCallError extends Error {
812
671
  details?: Record<string, string>;
813
672
  }
814
673
 
815
- export declare interface GetBaseAnalyticsRequest {
816
- /**
817
- * Id of organization to return analytics data.
818
- */
819
- organizationId: string;
820
- /**
821
- * Date in string with format e.g. '2023-04-19'.
822
- */
823
- startDate: string;
824
- /**
825
- * Date in string with format e.g. '2023-04-26'.
826
- */
827
- endDate: string;
828
- }
829
-
830
- export declare interface GetConversionAnalyticsRequest extends GetBaseAnalyticsRequest {
831
- }
832
-
833
- export declare interface GetMonetizationsAnalyticsRequest extends GetBaseAnalyticsRequest {
834
- }
835
-
836
- export declare interface GetMonetizationsAnalyticsResponse {
837
- monetizationsAnalytics: MonetizationSummaryItem[];
838
- }
839
-
840
674
  /**
841
675
  * Share singleton instance
842
676
  * @public
@@ -914,18 +748,6 @@ export declare interface GetSourceUrlResponse {
914
748
  * Which sources did client (or cloud function) has already tried out.
915
749
  */
916
750
  sourceHistory: string[];
917
- /**
918
- * DRM configuration to {@link url} if source is encrypted.
919
- */
920
- drm?: Drm;
921
- }
922
-
923
- export declare interface GetViewAnalyticsResponse {
924
- viewCountAnalytics: ViewCountItem[];
925
- topWatched: TopWatchItem[];
926
- }
927
-
928
- export declare interface GetViewsAnalyticsRequest extends GetBaseAnalyticsRequest {
929
751
  }
930
752
 
931
753
  /**
@@ -1299,51 +1121,11 @@ export declare type MonetizationsSelectOverlayState = {
1299
1121
  closeMonetizationsSelectOverlay: () => void;
1300
1122
  };
1301
1123
 
1302
- export declare interface MonetizationSummaryItem {
1303
- /**
1304
- * Unix timestamp at which the data is aggregated
1305
- */
1306
- date: number;
1307
- /**
1308
- * Monetization under the videos played, if not filled it is free
1309
- */
1310
- monetizationId: string;
1311
- /**
1312
- * Sum of successful (new and regular) payment price in current period
1313
- */
1314
- totalPrice: number;
1315
- /**
1316
- * Count of new payments in the current period
1317
- */
1318
- newPaymentCount: number;
1319
- /**
1320
- * Count of payments cancelled in in the current period
1321
- */
1322
- cancelledPaymentCount: number;
1323
- /**
1324
- * Count of payments made regularly like in the previous period
1325
- */
1326
- regularPaymentCount: number;
1327
- /**
1328
- * Price which was charged independent on price list (full and discounted)
1329
- */
1330
- paymentPrice: number;
1331
- /**
1332
- * Monetization type frequency
1333
- */
1334
- monetizationFrequency: MONETIZATION_FREQUENCY;
1335
- /**
1336
- * For PPV payments there will be videoId for which payment charged
1337
- * If not filled it is not PPV
1338
- */
1339
- videoId?: string;
1340
- }
1341
-
1342
1124
  /**
1343
1125
  * @public
1344
1126
  * @TODO change to enum
1345
1127
  */
1346
- export declare type MonetizationType = 'advertisement' | 'transaction' | 'subscription' | 'display';
1128
+ export declare type MonetizationType = 'advertisement' | 'transaction' | 'subscription';
1347
1129
 
1348
1130
  /**
1349
1131
  * TODO: Duplicate, because we can't import types from core-js.
@@ -1355,22 +1137,6 @@ export declare type NewVoucher = {
1355
1137
  expirationDate: Date | number;
1356
1138
  };
1357
1139
 
1358
- declare interface Notification_2 {
1359
- id: string;
1360
- name: string;
1361
- targeting: UserGroup;
1362
- templateId: string;
1363
- thumbnailUrl?: string;
1364
- triggerType: TriggerType;
1365
- status?: NotificationStatus;
1366
- }
1367
- export { Notification_2 as Notification }
1368
-
1369
- export declare enum NotificationStatus {
1370
- PLANNED = "planned",
1371
- SENT = "sent"
1372
- }
1373
-
1374
1140
  /**
1375
1141
  * @public
1376
1142
  */
@@ -1455,11 +1221,7 @@ export declare enum PLATFORM {
1455
1221
  */
1456
1222
  MOBILE = "MOBILE",
1457
1223
  WEB = "WEB",
1458
- TV = "TV",
1459
- /**
1460
- * @deprecated Used only in big query. In the future we'll migrate to undefined value and delete this.
1461
- */
1462
- UNKNOWN = "unknown"
1224
+ TV = "TV"
1463
1225
  }
1464
1226
 
1465
1227
  /**
@@ -1490,9 +1252,9 @@ export declare type Player = {
1490
1252
  * @public
1491
1253
  */
1492
1254
  export declare interface PlayerCapability {
1493
- codec: VideoSourceCodec;
1494
- encryption: VideoSourceEncryption;
1495
- protocol: VideoSourceProtocol;
1255
+ codec: 'h264' | 'h265';
1256
+ encryption: 'fairplay' | 'none' | 'playready' | 'widevine';
1257
+ protocol: 'dash' | 'hls' | 'mp4';
1496
1258
  }
1497
1259
 
1498
1260
  /**
@@ -1554,135 +1316,6 @@ export declare type PlayerConfig = {
1554
1316
  };
1555
1317
  };
1556
1318
 
1557
- /**
1558
- * @public
1559
- */
1560
- export declare interface PlayerEngineConfig {
1561
- getDrmConfiguration?: () => Promise<Drm | undefined>;
1562
- encryption?: string;
1563
- isAd?: boolean;
1564
- positionMs?: number;
1565
- url: string;
1566
- }
1567
-
1568
- /**
1569
- * @public
1570
- */
1571
- export declare type PlayerEngineEvent = 'bufferingchange' | 'bufferedinfochange' | 'statechange' | 'loaded' | 'loadfailed' | 'togglefullscreen' | 'durationchange' | 'busychange' | 'trackschanged' | 'abort' | 'canplay' | 'canplaythrough' | 'emptied' | 'ended' | 'error' | 'loadeddata' | 'loadedmetadata' | 'loadstart' | 'pause' | 'play' | 'playing' | 'progress' | 'ratechange' | 'seeked' | 'seeking' | 'stalled' | 'suspend' | 'timeupdate' | 'volumechange' | 'waiting' | 'click' | 'fullscreenchange';
1572
-
1573
- /**
1574
- * @public
1575
- */
1576
- export declare type PlayerEngineFactory = (videoElement: HTMLVideoElement) => PlayerEngineInterface;
1577
-
1578
- /**
1579
- * @public
1580
- */
1581
- export declare interface PlayerEngineInterface {
1582
- /**
1583
- * Loads video but keeps it paused
1584
- */
1585
- load(config: PlayerEngineConfig): Promise<void>;
1586
- /**
1587
- * Loads and starts playing video
1588
- * @throws
1589
- */
1590
- play(config: PlayerEngineConfig): Promise<void>;
1591
- pause(): Promise<void>;
1592
- unpause(): Promise<void>;
1593
- isPaused(): boolean;
1594
- stop(): Promise<void>;
1595
- addEventListener<T>(event: PlayerEngineEvent, callback: PlayerEngineListener<T>): void;
1596
- addEventListener(event: 'statechange', callback: PlayerEngineListener<PlayerState>): void;
1597
- addEventListener(event: 'bufferingchange', callback: PlayerEngineListener<boolean>): void;
1598
- addEventListener(event: 'bufferedinfochange', callback: PlayerEngineListener<BufferPercentChunk[]>): void;
1599
- addEventListener(event: 'togglefullscreen', callback: PlayerEngineListener<boolean>): void;
1600
- removeEventListener<T>(event: PlayerEngineEvent, listener: PlayerEngineListener<T>): void;
1601
- /**
1602
- * @returns currently playing audio track in ISO 639-1 format ('cs', 'en' etc.) or null if not available
1603
- */
1604
- getActiveAudioTrack?: () => LangCode | null;
1605
- /**
1606
- * @returns currently selected subtitles in ISO 639-1 format ('cs', 'en' etc.)
1607
- */
1608
- getActiveSubtitles?: () => LangCode | null;
1609
- /**
1610
- * Returns currently available audio tracks of currently playing video.
1611
- *
1612
- * @returns array of available audio tracks in ISO 639-1 format ('cs', 'en' etc.)
1613
- */
1614
- getAudioTracks?: () => LangCode[];
1615
- /**
1616
- * @returns array of available subtitles in ISO 639-1 format ('cs', 'en' etc.)
1617
- */
1618
- getSubtitles?: () => LangCode[];
1619
- getCurrentQuality?: (lang?: LangCode) => Track | null;
1620
- getQualities?: () => Track[];
1621
- /**
1622
- * options.force to change quality immediately, otherwise it takes some time
1623
- * (because previously loaded higher or lower quality chunks are not discarded)
1624
- */
1625
- selectQuality?: (track: Track, options?: {
1626
- force: boolean;
1627
- }) => void;
1628
- /**
1629
- * Is automatic selection of video quality based on network bandwidth (aka ABR) enabled?
1630
- */
1631
- isAdaptationEnabled?: () => boolean;
1632
- /**
1633
- * Turn on automatic selection of video quality based on network bandwidth (aka ABR).
1634
- * It is enabled by default.
1635
- * It automatically becomes disabled when selectQuality() is called.
1636
- */
1637
- enableAdaptation?: (enable: boolean) => void;
1638
- goFullScreen(): Promise<void>;
1639
- /**
1640
- * @param {number} value 0-1
1641
- */
1642
- changeVolume(value: number): void;
1643
- getState(): PlayerState;
1644
- isIdle(): boolean;
1645
- mute(): void;
1646
- unmute(): void;
1647
- /**
1648
- * @returns {number} duration in seconds
1649
- */
1650
- getDuration(): number;
1651
- seekTo(ms: number): void;
1652
- /**
1653
- * Changes audio track of currently playing video.
1654
- *
1655
- * @param {LangCode} audioTrack - audio track to select in ISO 639-1 format ('cs', 'en' etc.)
1656
- */
1657
- selectAudioTrack?: (audioTrack: LangCode) => void;
1658
- /**
1659
- * Changes audio track of currently playing video.
1660
- * @param {LangCode} langCode - subtitles to select in ISO 639-1 format ('cs', 'en' etc.) or null to disable subtitles
1661
- */
1662
- selectSubtitles?: (langCode: LangCode | null) => void;
1663
- /**
1664
- * Changes audio track of currently playing video.
1665
- *
1666
- * @param {number} playbackSpeed - playback speed to select (1 = normal speed, 2 = twice as fast, etc.)
1667
- */
1668
- selectPlaybackSpeed?: (playbackSpeed: number) => void;
1669
- destroy(): Promise<void>;
1670
- getBufferedInfo?(): BufferChunk[];
1671
- lastQuality: number | null;
1672
- }
1673
-
1674
- /**
1675
- * @public
1676
- */
1677
- export declare type PlayerEngineListener<T> = (value: T) => any;
1678
-
1679
- /**
1680
- * @public
1681
- */
1682
- export declare interface PlayerEngineOptions {
1683
- seekDebounceMs?: number;
1684
- }
1685
-
1686
1319
  /**
1687
1320
  * @public
1688
1321
  */
@@ -1740,10 +1373,7 @@ export declare type PlayerProviderProps = {
1740
1373
  playerWrapperId?: string;
1741
1374
  };
1742
1375
 
1743
- /**
1744
- * @public
1745
- */
1746
- export declare type PlayerState = 'idle' | 'playing' | 'paused';
1376
+ declare type PlayerState = 'playing' | 'paused' | 'idle';
1747
1377
 
1748
1378
  /**
1749
1379
  * @public
@@ -1890,10 +1520,6 @@ export declare interface PurchasableMonetization extends Monetization {
1890
1520
  * If not set or set to false, users cannot buy it as a voucher.
1891
1521
  */
1892
1522
  isPurchasableAsVoucher?: boolean;
1893
- /**
1894
- * Returns array of tag ids of monetization placements
1895
- */
1896
- tagIds: string[];
1897
1523
  }
1898
1524
 
1899
1525
  /**
@@ -1956,11 +1582,6 @@ export declare type PurchaseEndpointPayload = {
1956
1582
  * Two-letter upper-case country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
1957
1583
  */
1958
1584
  countryIsoCode?: LocationField['countryIsoCode'];
1959
- /**
1960
- * Purchase expiration timestamp. Only present for "subscription" monetization type. This timestamp does not mean it will
1961
- * really expire at this timestamp - additional payment of this subscription can occur so expiration timestamp may be increased.
1962
- */
1963
- expiration?: number;
1964
1585
  /**
1965
1586
  * Gateway name or "voucher".
1966
1587
  */
@@ -1970,21 +1591,21 @@ export declare type PurchaseEndpointPayload = {
1970
1591
  */
1971
1592
  id: string;
1972
1593
  /**
1973
- * True if delayed payment is confirmed but not charged yet, undefined in all other cases.
1594
+ * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
1974
1595
  */
1975
- isDelayedPayment?: boolean;
1596
+ updated: number;
1976
1597
  /**
1977
- * Purchase status after change.
1598
+ * True if delayed payment is confirmed but not charged yet, undefined in all other cases.
1978
1599
  */
1979
- newStatus: PurchaseStatus;
1600
+ isDelayedPayment?: boolean;
1980
1601
  /**
1981
1602
  * Purchase status before change.
1982
1603
  */
1983
1604
  previousStatus: PurchaseStatus;
1984
1605
  /**
1985
- * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
1606
+ * Purchase status after change.
1986
1607
  */
1987
- updated: number;
1608
+ newStatus: PurchaseStatus;
1988
1609
  };
1989
1610
  /**
1990
1611
  * Information about the monetization which has been bought by this purchase. Monetization definition may change in time so information provided here
@@ -2298,9 +1919,6 @@ declare interface RowBase {
2298
1919
  type: ScreenRowType;
2299
1920
  isLiveRow: boolean;
2300
1921
  numberOfLines?: number;
2301
- monetizations?: {
2302
- monetizationRef: any;
2303
- }[];
2304
1922
  }
2305
1923
 
2306
1924
  /**
@@ -2339,7 +1957,8 @@ export declare interface RowItemAssets {
2339
1957
  export declare enum RowItemComponent {
2340
1958
  ROW_ITEM_PORTRAIT = "ROW_ITEM_PORTRAIT",
2341
1959
  ROW_ITEM_LANDSCAPE = "ROW_ITEM_LANDSCAPE",
2342
- ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED"
1960
+ ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED",
1961
+ ROW_ITEM_BANNER = "ROW_ITEM_BANNER"
2343
1962
  }
2344
1963
 
2345
1964
  /**
@@ -2733,7 +2352,6 @@ export declare type TivioComponents = {
2733
2352
  WebTile: React_2.ComponentType<{
2734
2353
  item?: ItemsInRow;
2735
2354
  } & TilePropsPartial>;
2736
- ChannelContext: React_2.Context<TvChannel | undefined>;
2737
2355
  };
2738
2356
 
2739
2357
  /**
@@ -2860,7 +2478,6 @@ export declare type TivioHooks = {
2860
2478
  inviteCodeReset: () => void;
2861
2479
  };
2862
2480
  useChannelSource: UseChannelSource;
2863
- useTvChannel: UseTvChannel;
2864
2481
  };
2865
2482
 
2866
2483
  /**
@@ -2902,7 +2519,7 @@ export declare type TivioInternalHooks = {
2902
2519
  usePurchasesWithVideos: () => {
2903
2520
  purchases: Purchase[];
2904
2521
  };
2905
- useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean, videoId?: string) => {
2522
+ useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean) => {
2906
2523
  subscriptions: PurchasableMonetization[];
2907
2524
  };
2908
2525
  useIsMonetizationPurchased: () => {
@@ -2970,7 +2587,7 @@ export declare type TivioJsBundleExposedApi = {
2970
2587
  * @param id - player wrapper id
2971
2588
  * @returns {Player} player wrapper instance
2972
2589
  */
2973
- getPlayerWrapper: (id: string) => Player;
2590
+ getPlayer: (id: string) => Player;
2974
2591
  /**
2975
2592
  * Get tv channel by its id.
2976
2593
  * @param tvChannelId - tv channel id
@@ -3140,7 +2757,6 @@ export declare interface TivioWidgetProps {
3140
2757
  x: number;
3141
2758
  }) => any;
3142
2759
  navigateFunction?: any;
3143
- isFocused?: boolean;
3144
2760
  }
3145
2761
 
3146
2762
  /**
@@ -3159,40 +2775,6 @@ export declare interface TivioWidgetRef {
3159
2775
  });
3160
2776
  }
3161
2777
 
3162
- export declare interface TopWatchItem {
3163
- videoId: string;
3164
- /**
3165
- * If video is part of series we get a tagId to series
3166
- */
3167
- seriesId?: string;
3168
- /**
3169
- * Video type {@link VideoType}
3170
- */
3171
- videoType: VideoType;
3172
- /**
3173
- * Uniq users count
3174
- */
3175
- userCount: number;
3176
- /**
3177
- * Count of video view events
3178
- */
3179
- viewCount: number;
3180
- }
3181
-
3182
- /**
3183
- * @public
3184
- * Video track
3185
- */
3186
- declare interface Track {
3187
- id: number;
3188
- /**
3189
- * e.g. 480, 720, 1080
3190
- */
3191
- height: number;
3192
- active: boolean;
3193
- language: LangCode;
3194
- }
3195
-
3196
2778
  declare type TransactionInfo = {
3197
2779
  type: 'transaction';
3198
2780
  name: string;
@@ -3209,14 +2791,11 @@ export declare type Translation = {
3209
2791
  [key in LangCode]?: string;
3210
2792
  };
3211
2793
 
3212
- export declare type TriggerType = 'scheduled' | 'manual';
3213
-
3214
2794
  /**
3215
2795
  * @public
3216
2796
  */
3217
2797
  export declare type TvAppProps = {
3218
2798
  customer: CustomerId;
3219
- navigateFunction: (url: string) => void;
3220
2799
  };
3221
2800
 
3222
2801
  /**
@@ -3225,13 +2804,11 @@ export declare type TvAppProps = {
3225
2804
  export declare interface TvChannel extends RowItem {
3226
2805
  id: string;
3227
2806
  itemType: ROW_ITEM_TYPES.TV_CHANNEL;
3228
- type?: TvChannelType;
3229
2807
  name: string;
3230
2808
  path: string;
3231
2809
  country?: string;
3232
2810
  filters: string[];
3233
2811
  logo?: string;
3234
- logoPendingOverlayWidth?: string;
3235
2812
  hls: string;
3236
2813
  dash: string;
3237
2814
  /**
@@ -3239,37 +2816,12 @@ export declare interface TvChannel extends RowItem {
3239
2816
  * Transactions before subscriptions, sorted by price ascending.
3240
2817
  */
3241
2818
  getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
3242
- getSourceUrl(options?: {
3243
- language?: LangCode;
3244
- }): Promise<GetSourceUrlResponse & {
3245
- language?: LangCode;
3246
- }>;
2819
+ getSourceUrl(fallbackUrl?: string): Promise<GetSourceUrlResponse>;
3247
2820
  purchasableMonetization: any | null;
3248
2821
  price: number;
3249
2822
  cover: string;
3250
2823
  isPlayable: boolean;
3251
- url: string;
3252
- }
3253
-
3254
- export declare enum TvChannelType {
3255
- /**
3256
- * Classic live tv channel
3257
- */
3258
- CLASSIC = "CLASSIC",
3259
- /**
3260
- * "Virtual" tv channel constructed from separate videos
3261
- */
3262
- VIRTUAL = "VIRTUAL"
3263
- }
3264
-
3265
- export declare interface TvProgram {
3266
- from: Date | null;
3267
- to: Date | null;
3268
- name: string;
3269
- description: string;
3270
- url: string;
3271
- image: string;
3272
- video: Video | null;
2824
+ uri: string;
3273
2825
  }
3274
2826
 
3275
2827
  /**
@@ -3376,7 +2928,7 @@ export declare interface UseCancelSubscriptionsResult {
3376
2928
  * @public
3377
2929
  */
3378
2930
  export declare type UseChannelSource = (tvChannelId: string) => {
3379
- source: ChannelSourcePojo | VirtualChannelSourcePojo | null;
2931
+ source: ChannelSourcePojo | null;
3380
2932
  error: Error | null;
3381
2933
  };
3382
2934
 
@@ -3386,7 +2938,7 @@ export declare type UseChannelSource = (tvChannelId: string) => {
3386
2938
  * @public
3387
2939
  */
3388
2940
  export declare const useChannelSource: (tvChannelId: string) => {
3389
- source: ChannelSourcePojo | VirtualChannelSourcePojo | null;
2941
+ source: ChannelSourcePojo | null;
3390
2942
  error: Error | null;
3391
2943
  };
3392
2944
 
@@ -3437,6 +2989,16 @@ export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions
3437
2989
  subscriptions: PurchasableMonetization[];
3438
2990
  };
3439
2991
 
2992
+ /**
2993
+ * @public
2994
+ */
2995
+ export declare type UsePlayerEvent = <T = any>(eventName: string) => T | null;
2996
+
2997
+ /**
2998
+ * @public
2999
+ */
3000
+ export declare const usePlayerEvent: UsePlayerEvent;
3001
+
3440
3002
  /**
3441
3003
  * Is used to mark purchase in recovery state as PAID.
3442
3004
  *
@@ -3509,12 +3071,6 @@ export declare type User = {
3509
3071
  setActiveUserProfileId: (id: string) => void;
3510
3072
  };
3511
3073
 
3512
- export declare enum UserGroup {
3513
- ALL = "all",
3514
- FREE = "free",
3515
- PREMIUM = "premium"
3516
- }
3517
-
3518
3074
  /**
3519
3075
  * @public
3520
3076
  */
@@ -3726,11 +3282,7 @@ export declare interface Video extends RowItem {
3726
3282
  * Transactions before subscriptions, sorted by price ascending.
3727
3283
  */
3728
3284
  getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
3729
- getSourceUrl(options?: {
3730
- language?: LangCode;
3731
- }): Promise<GetSourceUrlResponse & {
3732
- language?: LangCode;
3733
- }>;
3285
+ getSourceUrl(fallbackUrl?: string): Promise<GetSourceUrlResponse>;
3734
3286
  purchasableMonetization: any | null;
3735
3287
  transaction: PurchasableMonetization | undefined;
3736
3288
  subscriptions: PurchasableMonetization[];
@@ -3741,6 +3293,7 @@ export declare interface Video extends RowItem {
3741
3293
  urlName?: string;
3742
3294
  price: number | null;
3743
3295
  detailedPrice: DetailedPrice | null;
3296
+ uri: string;
3744
3297
  url: string;
3745
3298
  adMonetizationId?: string;
3746
3299
  from?: Date;
@@ -3762,7 +3315,7 @@ export declare interface Video extends RowItem {
3762
3315
  removeFromFavorites: () => void;
3763
3316
  availability: VideoAvailability | null;
3764
3317
  sourceLanguages: LangCode[];
3765
- urlByLanguage: (lang: LangCode) => string | undefined;
3318
+ uriByLanguage: (lang: LangCode) => string | undefined;
3766
3319
  }
3767
3320
 
3768
3321
  /**
@@ -3793,29 +3346,6 @@ export declare type VideoExternals = JojExternals | MallTvExternals | OktagonExt
3793
3346
 
3794
3347
  declare type VideoPath = string;
3795
3348
 
3796
- export declare enum VideoSourceCodec {
3797
- H264 = "h264",
3798
- H265 = "h265"
3799
- }
3800
-
3801
- export declare enum VideoSourceEncryption {
3802
- NONE = "none",
3803
- WIDEVINE = "widevine",
3804
- FAIRPLAY = "fairplay",
3805
- PLAYREADY = "playready"
3806
- }
3807
-
3808
- /**
3809
- * Lower number = higher priority.
3810
- */
3811
- export declare type VideoSourcePriority = 1 | 2 | 3 | 4 | 5;
3812
-
3813
- export declare enum VideoSourceProtocol {
3814
- HLS = "hls",
3815
- DASH = "dash",
3816
- MP4 = "mp4"
3817
- }
3818
-
3819
3349
  /**
3820
3350
  * Video type.
3821
3351
  * @public
@@ -3847,58 +3377,30 @@ export declare enum VideoType {
3847
3377
  /**
3848
3378
  * @public
3849
3379
  */
3850
- export declare type VideoUrlNames = {
3380
+ export declare type VideoUrlName = {
3851
3381
  [key in LangCode]?: string[];
3852
3382
  };
3853
3383
 
3854
- export declare interface ViewCountItem {
3855
- /**
3856
- * Unix timestamp
3857
- */
3858
- date: number;
3859
- /**
3860
- * Monetization under the videos played, if not filled it is free
3861
- */
3862
- monetizationId?: string;
3863
- /**
3864
- * Device where the video played
3865
- */
3866
- deviceType: PLATFORM;
3867
- /**
3868
- * Count of video view events in group
3869
- */
3870
- totalCount: number;
3871
- }
3872
-
3873
- /**
3874
- * @public
3875
- */
3876
- export declare interface VirtualChannelSourcePojo {
3877
- type: 'VirtualChannelSource';
3878
- tvChannel: TvChannel;
3879
- epg: TvProgram[];
3880
- }
3881
-
3882
3384
  /**
3883
3385
  * @public
3884
3386
  */
3885
3387
  export declare type VodExternalSource = {
3886
- new (url: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
3388
+ new (uri: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
3887
3389
  type: 'vod_external';
3888
3390
  description: string;
3889
3391
  name: string;
3890
- url: string;
3392
+ uri: string;
3891
3393
  };
3892
3394
 
3893
3395
  /**
3894
3396
  * @public
3895
3397
  */
3896
3398
  export declare type VodTivioSource = {
3897
- new (url: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
3399
+ new (uri: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
3898
3400
  type: 'vod_tivio';
3899
3401
  description: string;
3900
3402
  name: string;
3901
- url: string;
3403
+ uri: string;
3902
3404
  };
3903
3405
 
3904
3406
  declare interface VodTivioSourcePojo {
@@ -3906,7 +3408,7 @@ declare interface VodTivioSourcePojo {
3906
3408
  description: string;
3907
3409
  path: string;
3908
3410
  name: string;
3909
- url: string;
3411
+ uri: string;
3910
3412
  poster?: string;
3911
3413
  adMonetizationId?: string;
3912
3414
  availability: VideoAvailability | null;
@@ -3937,7 +3439,7 @@ export declare interface WarningConfirmationOverlayPayload extends ConfirmationO
3937
3439
  */
3938
3440
  export declare interface WebPlayerProps {
3939
3441
  id: string;
3940
- source?: VodTivioSourcePojo | ChannelSourcePojo | VirtualChannelSourcePojo | VideoPath | null;
3442
+ source?: VodTivioSourcePojo | ChannelSourcePojo | VideoPath | null;
3941
3443
  onEnded?: () => any;
3942
3444
  /**
3943
3445
  * If this function is specified, then "Back" button is shown in top right corner.