@tivio/sdk-react 5.0.3-alpha-5 → 5.0.3-alpha
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +0 -6
- package/README.md.bak +0 -6
- package/dist/index.d.ts +47 -545
- package/dist/index.js +1 -1
- package/dist/sdk-react.d.ts +48 -546
- package/package.json +2 -2
package/dist/sdk-react.d.ts
CHANGED
@@ -90,13 +90,13 @@ declare type AdSegment = {
|
|
90
90
|
* @public
|
91
91
|
*/
|
92
92
|
export declare type AdSource = {
|
93
|
-
new (
|
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
|
-
|
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: (
|
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: (
|
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
|
@@ -362,14 +330,11 @@ export declare interface Channel {
|
|
362
330
|
recentVideos: Video[];
|
363
331
|
}
|
364
332
|
|
365
|
-
/**
|
366
|
-
* @public
|
367
|
-
*/
|
368
333
|
export declare type ChannelSource = {
|
369
|
-
new (
|
334
|
+
new (uri: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
|
370
335
|
description: string;
|
371
336
|
name: string;
|
372
|
-
|
337
|
+
uri: string;
|
373
338
|
from: Date;
|
374
339
|
channelName: string;
|
375
340
|
to: Date;
|
@@ -384,7 +349,7 @@ export declare type ChannelSource = {
|
|
384
349
|
*/
|
385
350
|
export declare interface ChannelSourcePojo {
|
386
351
|
type: 'ChannelSource';
|
387
|
-
|
352
|
+
uri: string;
|
388
353
|
originalOptions: any;
|
389
354
|
channelName: string;
|
390
355
|
programName: string;
|
@@ -459,7 +424,6 @@ export declare interface ConfirmationOverlayPayloadBase {
|
|
459
424
|
|
460
425
|
/**
|
461
426
|
* Entity aggregate conversion statistics per day
|
462
|
-
* TODO in future change structure, new used like array item
|
463
427
|
*/
|
464
428
|
export declare interface ConversionAnalytic {
|
465
429
|
/**
|
@@ -770,41 +734,6 @@ export declare type DocumentOptions = Partial<{
|
|
770
734
|
subscribeOnChanges: boolean;
|
771
735
|
}>;
|
772
736
|
|
773
|
-
export declare interface Drm {
|
774
|
-
encryption: VideoSourceEncryption;
|
775
|
-
/**
|
776
|
-
* Url to retrieve fairplay from.
|
777
|
-
*/
|
778
|
-
certificateUrl?: string;
|
779
|
-
/**
|
780
|
-
* Url to send license to.
|
781
|
-
*/
|
782
|
-
licenseUrl: string;
|
783
|
-
/**
|
784
|
-
* Headers with corresponding values to send to license server.
|
785
|
-
*/
|
786
|
-
licenseRequestHeaders: {
|
787
|
-
[key: string]: string;
|
788
|
-
};
|
789
|
-
}
|
790
|
-
|
791
|
-
export declare enum DrmProvider {
|
792
|
-
/**
|
793
|
-
* Original oktagon stream provider.
|
794
|
-
*
|
795
|
-
* https://streamonline.pl
|
796
|
-
*/
|
797
|
-
STREAMONLINE = "streamonline",
|
798
|
-
/**
|
799
|
-
* New stream provider for tivio. Also known as insys video technologies.
|
800
|
-
*
|
801
|
-
* https://insysvideotechnologies.com
|
802
|
-
* https://www.drm.cloud
|
803
|
-
* https://videokit.cloud
|
804
|
-
*/
|
805
|
-
INSYS = "insys"
|
806
|
-
}
|
807
|
-
|
808
737
|
/**
|
809
738
|
* @public
|
810
739
|
*/
|
@@ -821,76 +750,6 @@ export declare enum DurationUnits {
|
|
821
750
|
MONTH = "month"
|
822
751
|
}
|
823
752
|
|
824
|
-
/**
|
825
|
-
* Represents a SendGrid transactional template.
|
826
|
-
*/
|
827
|
-
export declare interface EmailTemplate {
|
828
|
-
/**
|
829
|
-
* The ID of the transactional template.
|
830
|
-
*/
|
831
|
-
id: string;
|
832
|
-
/**
|
833
|
-
* The name of the transactional template.
|
834
|
-
* @maxLength 100
|
835
|
-
*/
|
836
|
-
name: string;
|
837
|
-
/**
|
838
|
-
* Defines the generation of the template.
|
839
|
-
* @format 'dynamic' | 'legacy'
|
840
|
-
*/
|
841
|
-
generation: 'dynamic' | 'legacy';
|
842
|
-
/**
|
843
|
-
* The date and time the template was last updated.
|
844
|
-
*/
|
845
|
-
updated_at: string;
|
846
|
-
/**
|
847
|
-
* An array of versions associated with the template.
|
848
|
-
*/
|
849
|
-
versions: EmailTemplateVersion[];
|
850
|
-
}
|
851
|
-
|
852
|
-
export declare interface EmailTemplateVersion {
|
853
|
-
/**
|
854
|
-
* ID of the transactional template version.
|
855
|
-
*/
|
856
|
-
id: string;
|
857
|
-
/**
|
858
|
-
* ID of the transactional template.
|
859
|
-
*/
|
860
|
-
template_id: string;
|
861
|
-
/**
|
862
|
-
* Set the version as the active version associated with the template.
|
863
|
-
* Only one version of a template can be active.
|
864
|
-
* The first version created for a template will automatically be set to Active.
|
865
|
-
*/
|
866
|
-
active: boolean;
|
867
|
-
/**
|
868
|
-
* Name of the transactional template version.
|
869
|
-
*/
|
870
|
-
name: string;
|
871
|
-
/**
|
872
|
-
* Subject of the new transactional template version.
|
873
|
-
* @maxLength 255
|
874
|
-
*/
|
875
|
-
subject: string;
|
876
|
-
/**
|
877
|
-
* The date and time that this transactional template version was updated.
|
878
|
-
*/
|
879
|
-
updated_at: string;
|
880
|
-
/**
|
881
|
-
* If true, plain_content is always generated from html_content. If false, plain_content is not altered.
|
882
|
-
*/
|
883
|
-
generate_plain_content: boolean;
|
884
|
-
/**
|
885
|
-
* The editor used in the UI.
|
886
|
-
*/
|
887
|
-
editor: string;
|
888
|
-
/**
|
889
|
-
* A Thumbnail preview of the template's html content.
|
890
|
-
*/
|
891
|
-
thumbnail_url: string;
|
892
|
-
}
|
893
|
-
|
894
753
|
/**
|
895
754
|
* @public
|
896
755
|
*/
|
@@ -958,31 +817,6 @@ export declare interface GenericOnCallError extends Error {
|
|
958
817
|
details?: Record<string, string>;
|
959
818
|
}
|
960
819
|
|
961
|
-
export declare interface GetBaseAnalyticsRequest {
|
962
|
-
/**
|
963
|
-
* Id of organization to return analytics data.
|
964
|
-
*/
|
965
|
-
organizationId: string;
|
966
|
-
/**
|
967
|
-
* Date in string with format e.g. '2023-04-19'.
|
968
|
-
*/
|
969
|
-
startDate: string;
|
970
|
-
/**
|
971
|
-
* Date in string with format e.g. '2023-04-26'.
|
972
|
-
*/
|
973
|
-
endDate: string;
|
974
|
-
}
|
975
|
-
|
976
|
-
export declare interface GetConversionAnalyticsRequest extends GetBaseAnalyticsRequest {
|
977
|
-
}
|
978
|
-
|
979
|
-
export declare interface GetMonetizationsAnalyticsRequest extends GetBaseAnalyticsRequest {
|
980
|
-
}
|
981
|
-
|
982
|
-
export declare interface GetMonetizationsAnalyticsResponse {
|
983
|
-
monetizationsAnalytics: MonetizationSummaryItem[];
|
984
|
-
}
|
985
|
-
|
986
820
|
/**
|
987
821
|
* Share singleton instance
|
988
822
|
* @public
|
@@ -1060,18 +894,6 @@ export declare interface GetSourceUrlResponse {
|
|
1060
894
|
* Which sources did client (or cloud function) has already tried out.
|
1061
895
|
*/
|
1062
896
|
sourceHistory: string[];
|
1063
|
-
/**
|
1064
|
-
* DRM configuration to {@link url} if source is encrypted.
|
1065
|
-
*/
|
1066
|
-
drm?: Drm;
|
1067
|
-
}
|
1068
|
-
|
1069
|
-
export declare interface GetViewAnalyticsResponse {
|
1070
|
-
viewCountAnalytics: ViewCountItem[];
|
1071
|
-
topWatched: TopWatchItem[];
|
1072
|
-
}
|
1073
|
-
|
1074
|
-
export declare interface GetViewsAnalyticsRequest extends GetBaseAnalyticsRequest {
|
1075
897
|
}
|
1076
898
|
|
1077
899
|
/**
|
@@ -1452,51 +1274,11 @@ export declare type MonetizationsSelectOverlayState = {
|
|
1452
1274
|
closeMonetizationsSelectOverlay: () => void;
|
1453
1275
|
};
|
1454
1276
|
|
1455
|
-
export declare interface MonetizationSummaryItem {
|
1456
|
-
/**
|
1457
|
-
* Unix timestamp at which the data is aggregated
|
1458
|
-
*/
|
1459
|
-
date: number;
|
1460
|
-
/**
|
1461
|
-
* Monetization under the videos played, if not filled it is free
|
1462
|
-
*/
|
1463
|
-
monetizationId: string;
|
1464
|
-
/**
|
1465
|
-
* Sum of successful (new and regular) payment price in current period
|
1466
|
-
*/
|
1467
|
-
totalPrice: number;
|
1468
|
-
/**
|
1469
|
-
* Count of new payments in the current period
|
1470
|
-
*/
|
1471
|
-
newPaymentCount: number;
|
1472
|
-
/**
|
1473
|
-
* Count of payments cancelled in in the current period
|
1474
|
-
*/
|
1475
|
-
cancelledPaymentCount: number;
|
1476
|
-
/**
|
1477
|
-
* Count of payments made regularly like in the previous period
|
1478
|
-
*/
|
1479
|
-
regularPaymentCount: number;
|
1480
|
-
/**
|
1481
|
-
* Price which was charged independent on price list (full and discounted)
|
1482
|
-
*/
|
1483
|
-
paymentPrice: number;
|
1484
|
-
/**
|
1485
|
-
* Monetization type frequency
|
1486
|
-
*/
|
1487
|
-
monetizationFrequency: MONETIZATION_FREQUENCY;
|
1488
|
-
/**
|
1489
|
-
* For PPV payments there will be videoId for which payment charged
|
1490
|
-
* If not filled it is not PPV
|
1491
|
-
*/
|
1492
|
-
videoId?: string;
|
1493
|
-
}
|
1494
|
-
|
1495
1277
|
/**
|
1496
1278
|
* @public
|
1497
1279
|
* @TODO change to enum
|
1498
1280
|
*/
|
1499
|
-
export declare type MonetizationType = 'advertisement' | 'transaction' | 'subscription'
|
1281
|
+
export declare type MonetizationType = 'advertisement' | 'transaction' | 'subscription';
|
1500
1282
|
|
1501
1283
|
/**
|
1502
1284
|
* TODO: Duplicate, because we can't import types from core-js.
|
@@ -1508,22 +1290,6 @@ export declare type NewVoucher = {
|
|
1508
1290
|
expirationDate: Date | number;
|
1509
1291
|
};
|
1510
1292
|
|
1511
|
-
declare interface Notification_2 {
|
1512
|
-
id: string;
|
1513
|
-
name: string;
|
1514
|
-
targeting: UserGroup;
|
1515
|
-
templateId: string;
|
1516
|
-
thumbnailUrl?: string;
|
1517
|
-
triggerType: TriggerType;
|
1518
|
-
status?: NotificationStatus;
|
1519
|
-
}
|
1520
|
-
export { Notification_2 as Notification }
|
1521
|
-
|
1522
|
-
export declare enum NotificationStatus {
|
1523
|
-
PLANNED = "planned",
|
1524
|
-
SENT = "sent"
|
1525
|
-
}
|
1526
|
-
|
1527
1293
|
/**
|
1528
1294
|
* @public
|
1529
1295
|
*/
|
@@ -1618,11 +1384,7 @@ export declare enum PLATFORM {
|
|
1618
1384
|
*/
|
1619
1385
|
MOBILE = "MOBILE",
|
1620
1386
|
WEB = "WEB",
|
1621
|
-
TV = "TV"
|
1622
|
-
/**
|
1623
|
-
* @deprecated Used only in big query. In the future we'll migrate to undefined value and delete this.
|
1624
|
-
*/
|
1625
|
-
UNKNOWN = "unknown"
|
1387
|
+
TV = "TV"
|
1626
1388
|
}
|
1627
1389
|
|
1628
1390
|
/**
|
@@ -1653,9 +1415,9 @@ export declare type Player = {
|
|
1653
1415
|
* @public
|
1654
1416
|
*/
|
1655
1417
|
export declare interface PlayerCapability {
|
1656
|
-
codec:
|
1657
|
-
encryption:
|
1658
|
-
protocol:
|
1418
|
+
codec: 'h264' | 'h265';
|
1419
|
+
encryption: 'fairplay' | 'none' | 'playready' | 'widevine';
|
1420
|
+
protocol: 'dash' | 'hls' | 'mp4';
|
1659
1421
|
}
|
1660
1422
|
|
1661
1423
|
/**
|
@@ -1717,135 +1479,6 @@ export declare type PlayerConfig = {
|
|
1717
1479
|
};
|
1718
1480
|
};
|
1719
1481
|
|
1720
|
-
/**
|
1721
|
-
* @public
|
1722
|
-
*/
|
1723
|
-
export declare interface PlayerEngineConfig {
|
1724
|
-
getDrmConfiguration?: () => Promise<Drm | undefined>;
|
1725
|
-
encryption?: string;
|
1726
|
-
isAd?: boolean;
|
1727
|
-
positionMs?: number;
|
1728
|
-
url: string;
|
1729
|
-
}
|
1730
|
-
|
1731
|
-
/**
|
1732
|
-
* @public
|
1733
|
-
*/
|
1734
|
-
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';
|
1735
|
-
|
1736
|
-
/**
|
1737
|
-
* @public
|
1738
|
-
*/
|
1739
|
-
export declare type PlayerEngineFactory = (videoElement: HTMLVideoElement) => PlayerEngineInterface;
|
1740
|
-
|
1741
|
-
/**
|
1742
|
-
* @public
|
1743
|
-
*/
|
1744
|
-
export declare interface PlayerEngineInterface {
|
1745
|
-
/**
|
1746
|
-
* Loads video but keeps it paused
|
1747
|
-
*/
|
1748
|
-
load(config: PlayerEngineConfig): Promise<void>;
|
1749
|
-
/**
|
1750
|
-
* Loads and starts playing video
|
1751
|
-
* @throws
|
1752
|
-
*/
|
1753
|
-
play(config: PlayerEngineConfig): Promise<void>;
|
1754
|
-
pause(): Promise<void>;
|
1755
|
-
unpause(): Promise<void>;
|
1756
|
-
isPaused(): boolean;
|
1757
|
-
stop(): Promise<void>;
|
1758
|
-
addEventListener<T>(event: PlayerEngineEvent, callback: PlayerEngineListener<T>): void;
|
1759
|
-
addEventListener(event: 'statechange', callback: PlayerEngineListener<PlayerState>): void;
|
1760
|
-
addEventListener(event: 'bufferingchange', callback: PlayerEngineListener<boolean>): void;
|
1761
|
-
addEventListener(event: 'bufferedinfochange', callback: PlayerEngineListener<BufferPercentChunk[]>): void;
|
1762
|
-
addEventListener(event: 'togglefullscreen', callback: PlayerEngineListener<boolean>): void;
|
1763
|
-
removeEventListener<T>(event: PlayerEngineEvent, listener: PlayerEngineListener<T>): void;
|
1764
|
-
/**
|
1765
|
-
* @returns currently playing audio track in ISO 639-1 format ('cs', 'en' etc.) or null if not available
|
1766
|
-
*/
|
1767
|
-
getActiveAudioTrack?: () => LangCode | null;
|
1768
|
-
/**
|
1769
|
-
* @returns currently selected subtitles in ISO 639-1 format ('cs', 'en' etc.)
|
1770
|
-
*/
|
1771
|
-
getActiveSubtitles?: () => LangCode | null;
|
1772
|
-
/**
|
1773
|
-
* Returns currently available audio tracks of currently playing video.
|
1774
|
-
*
|
1775
|
-
* @returns array of available audio tracks in ISO 639-1 format ('cs', 'en' etc.)
|
1776
|
-
*/
|
1777
|
-
getAudioTracks?: () => LangCode[];
|
1778
|
-
/**
|
1779
|
-
* @returns array of available subtitles in ISO 639-1 format ('cs', 'en' etc.)
|
1780
|
-
*/
|
1781
|
-
getSubtitles?: () => LangCode[];
|
1782
|
-
getCurrentQuality?: (lang?: LangCode) => Track | null;
|
1783
|
-
getQualities?: () => Track[];
|
1784
|
-
/**
|
1785
|
-
* options.force to change quality immediately, otherwise it takes some time
|
1786
|
-
* (because previously loaded higher or lower quality chunks are not discarded)
|
1787
|
-
*/
|
1788
|
-
selectQuality?: (track: Track, options?: {
|
1789
|
-
force: boolean;
|
1790
|
-
}) => void;
|
1791
|
-
/**
|
1792
|
-
* Is automatic selection of video quality based on network bandwidth (aka ABR) enabled?
|
1793
|
-
*/
|
1794
|
-
isAdaptationEnabled?: () => boolean;
|
1795
|
-
/**
|
1796
|
-
* Turn on automatic selection of video quality based on network bandwidth (aka ABR).
|
1797
|
-
* It is enabled by default.
|
1798
|
-
* It automatically becomes disabled when selectQuality() is called.
|
1799
|
-
*/
|
1800
|
-
enableAdaptation?: (enable: boolean) => void;
|
1801
|
-
goFullScreen(): Promise<void>;
|
1802
|
-
/**
|
1803
|
-
* @param {number} value 0-1
|
1804
|
-
*/
|
1805
|
-
changeVolume(value: number): void;
|
1806
|
-
getState(): PlayerState;
|
1807
|
-
isIdle(): boolean;
|
1808
|
-
mute(): void;
|
1809
|
-
unmute(): void;
|
1810
|
-
/**
|
1811
|
-
* @returns {number} duration in seconds
|
1812
|
-
*/
|
1813
|
-
getDuration(): number;
|
1814
|
-
seekTo(ms: number): void;
|
1815
|
-
/**
|
1816
|
-
* Changes audio track of currently playing video.
|
1817
|
-
*
|
1818
|
-
* @param {LangCode} audioTrack - audio track to select in ISO 639-1 format ('cs', 'en' etc.)
|
1819
|
-
*/
|
1820
|
-
selectAudioTrack?: (audioTrack: LangCode) => void;
|
1821
|
-
/**
|
1822
|
-
* Changes audio track of currently playing video.
|
1823
|
-
* @param {LangCode} langCode - subtitles to select in ISO 639-1 format ('cs', 'en' etc.) or null to disable subtitles
|
1824
|
-
*/
|
1825
|
-
selectSubtitles?: (langCode: LangCode | null) => void;
|
1826
|
-
/**
|
1827
|
-
* Changes audio track of currently playing video.
|
1828
|
-
*
|
1829
|
-
* @param {number} playbackSpeed - playback speed to select (1 = normal speed, 2 = twice as fast, etc.)
|
1830
|
-
*/
|
1831
|
-
selectPlaybackSpeed?: (playbackSpeed: number) => void;
|
1832
|
-
destroy(): Promise<void>;
|
1833
|
-
getBufferedInfo?(): BufferChunk[];
|
1834
|
-
lastQuality: number | null;
|
1835
|
-
}
|
1836
|
-
|
1837
|
-
/**
|
1838
|
-
* @public
|
1839
|
-
*/
|
1840
|
-
export declare type PlayerEngineListener<T> = (value: T) => any;
|
1841
|
-
|
1842
|
-
/**
|
1843
|
-
* @public
|
1844
|
-
*/
|
1845
|
-
export declare interface PlayerEngineOptions {
|
1846
|
-
seekDebounceMs?: number;
|
1847
|
-
}
|
1848
|
-
|
1849
1482
|
/**
|
1850
1483
|
* @public
|
1851
1484
|
*/
|
@@ -1903,10 +1536,7 @@ export declare type PlayerProviderProps = {
|
|
1903
1536
|
playerWrapperId?: string;
|
1904
1537
|
};
|
1905
1538
|
|
1906
|
-
|
1907
|
-
* @public
|
1908
|
-
*/
|
1909
|
-
export declare type PlayerState = 'idle' | 'playing' | 'paused';
|
1539
|
+
declare type PlayerState = 'playing' | 'paused' | 'idle';
|
1910
1540
|
|
1911
1541
|
/**
|
1912
1542
|
* @public
|
@@ -2053,10 +1683,6 @@ export declare interface PurchasableMonetization extends Monetization {
|
|
2053
1683
|
* If not set or set to false, users cannot buy it as a voucher.
|
2054
1684
|
*/
|
2055
1685
|
isPurchasableAsVoucher?: boolean;
|
2056
|
-
/**
|
2057
|
-
* Returns array of tag ids of monetization placements
|
2058
|
-
*/
|
2059
|
-
tagIds: string[];
|
2060
1686
|
}
|
2061
1687
|
|
2062
1688
|
/**
|
@@ -2119,11 +1745,6 @@ export declare type PurchaseEndpointPayload = {
|
|
2119
1745
|
* Two-letter upper-case country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
|
2120
1746
|
*/
|
2121
1747
|
countryIsoCode?: LocationField['countryIsoCode'];
|
2122
|
-
/**
|
2123
|
-
* Purchase expiration timestamp. Only present for "subscription" monetization type. This timestamp does not mean it will
|
2124
|
-
* really expire at this timestamp - additional payment of this subscription can occur so expiration timestamp may be increased.
|
2125
|
-
*/
|
2126
|
-
expiration?: number;
|
2127
1748
|
/**
|
2128
1749
|
* Gateway name or "voucher".
|
2129
1750
|
*/
|
@@ -2133,21 +1754,21 @@ export declare type PurchaseEndpointPayload = {
|
|
2133
1754
|
*/
|
2134
1755
|
id: string;
|
2135
1756
|
/**
|
2136
|
-
*
|
1757
|
+
* Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
|
2137
1758
|
*/
|
2138
|
-
|
1759
|
+
updated: number;
|
2139
1760
|
/**
|
2140
|
-
*
|
1761
|
+
* True if delayed payment is confirmed but not charged yet, undefined in all other cases.
|
2141
1762
|
*/
|
2142
|
-
|
1763
|
+
isDelayedPayment?: boolean;
|
2143
1764
|
/**
|
2144
1765
|
* Purchase status before change.
|
2145
1766
|
*/
|
2146
1767
|
previousStatus: PurchaseStatus;
|
2147
1768
|
/**
|
2148
|
-
*
|
1769
|
+
* Purchase status after change.
|
2149
1770
|
*/
|
2150
|
-
|
1771
|
+
newStatus: PurchaseStatus;
|
2151
1772
|
};
|
2152
1773
|
/**
|
2153
1774
|
* Information about the monetization which has been bought by this purchase. Monetization definition may change in time so information provided here
|
@@ -2470,9 +2091,6 @@ declare interface RowBase {
|
|
2470
2091
|
type: ScreenRowType;
|
2471
2092
|
isLiveRow: boolean;
|
2472
2093
|
numberOfLines?: number;
|
2473
|
-
monetizations?: {
|
2474
|
-
monetizationRef: any;
|
2475
|
-
}[];
|
2476
2094
|
}
|
2477
2095
|
|
2478
2096
|
/**
|
@@ -2511,7 +2129,8 @@ export declare interface RowItemAssets {
|
|
2511
2129
|
export declare enum RowItemComponent {
|
2512
2130
|
ROW_ITEM_PORTRAIT = "ROW_ITEM_PORTRAIT",
|
2513
2131
|
ROW_ITEM_LANDSCAPE = "ROW_ITEM_LANDSCAPE",
|
2514
|
-
ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED"
|
2132
|
+
ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED",
|
2133
|
+
ROW_ITEM_BANNER = "ROW_ITEM_BANNER"
|
2515
2134
|
}
|
2516
2135
|
|
2517
2136
|
/**
|
@@ -2886,7 +2505,7 @@ export declare type TileSizes = {
|
|
2886
2505
|
* @internal
|
2887
2506
|
*/
|
2888
2507
|
export declare type TileSizesMap = {
|
2889
|
-
[item in RowItemComponent
|
2508
|
+
[item in RowItemComponent]: TileSizes;
|
2890
2509
|
};
|
2891
2510
|
|
2892
2511
|
/**
|
@@ -2975,7 +2594,6 @@ export declare type TivioComponents = {
|
|
2975
2594
|
WebTile: React_2.ComponentType<{
|
2976
2595
|
item?: ItemsInRow;
|
2977
2596
|
} & TilePropsPartial>;
|
2978
|
-
ChannelContext: React_2.Context<TvChannel | undefined>;
|
2979
2597
|
};
|
2980
2598
|
|
2981
2599
|
/**
|
@@ -3102,7 +2720,6 @@ export declare type TivioHooks = {
|
|
3102
2720
|
inviteCodeReset: () => void;
|
3103
2721
|
};
|
3104
2722
|
useChannelSource: UseChannelSource;
|
3105
|
-
useTvChannel: UseTvChannel;
|
3106
2723
|
};
|
3107
2724
|
|
3108
2725
|
/**
|
@@ -3144,7 +2761,7 @@ export declare type TivioInternalHooks = {
|
|
3144
2761
|
usePurchasesWithVideos: () => {
|
3145
2762
|
purchases: Purchase[];
|
3146
2763
|
};
|
3147
|
-
useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean
|
2764
|
+
useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean) => {
|
3148
2765
|
subscriptions: PurchasableMonetization[];
|
3149
2766
|
};
|
3150
2767
|
useIsMonetizationPurchased: () => {
|
@@ -3220,7 +2837,7 @@ export declare type TivioJsBundleExposedApi = {
|
|
3220
2837
|
* @param id - player wrapper id
|
3221
2838
|
* @returns {Player} player wrapper instance
|
3222
2839
|
*/
|
3223
|
-
|
2840
|
+
getPlayer: (id: string) => Player;
|
3224
2841
|
/**
|
3225
2842
|
* Get tv channel by its id.
|
3226
2843
|
* @param tvChannelId - tv channel id
|
@@ -3390,7 +3007,6 @@ export declare interface TivioWidgetProps {
|
|
3390
3007
|
x: number;
|
3391
3008
|
}) => any;
|
3392
3009
|
navigateFunction?: any;
|
3393
|
-
isFocused?: boolean;
|
3394
3010
|
}
|
3395
3011
|
|
3396
3012
|
/**
|
@@ -3409,40 +3025,6 @@ export declare interface TivioWidgetRef {
|
|
3409
3025
|
});
|
3410
3026
|
}
|
3411
3027
|
|
3412
|
-
export declare interface TopWatchItem {
|
3413
|
-
videoId: string;
|
3414
|
-
/**
|
3415
|
-
* If video is part of series we get a tagId to series
|
3416
|
-
*/
|
3417
|
-
seriesId?: string;
|
3418
|
-
/**
|
3419
|
-
* Video type {@link VideoType}
|
3420
|
-
*/
|
3421
|
-
videoType: VideoType;
|
3422
|
-
/**
|
3423
|
-
* Uniq users count
|
3424
|
-
*/
|
3425
|
-
userCount: number;
|
3426
|
-
/**
|
3427
|
-
* Count of video view events
|
3428
|
-
*/
|
3429
|
-
viewCount: number;
|
3430
|
-
}
|
3431
|
-
|
3432
|
-
/**
|
3433
|
-
* @public
|
3434
|
-
* Video track
|
3435
|
-
*/
|
3436
|
-
declare interface Track {
|
3437
|
-
id: number;
|
3438
|
-
/**
|
3439
|
-
* e.g. 480, 720, 1080
|
3440
|
-
*/
|
3441
|
-
height: number;
|
3442
|
-
active: boolean;
|
3443
|
-
language: LangCode;
|
3444
|
-
}
|
3445
|
-
|
3446
3028
|
declare type TransactionInfo = {
|
3447
3029
|
type: 'transaction';
|
3448
3030
|
name: string;
|
@@ -3459,14 +3041,11 @@ export declare type Translation = {
|
|
3459
3041
|
[key in LangCode]?: string;
|
3460
3042
|
};
|
3461
3043
|
|
3462
|
-
export declare type TriggerType = 'scheduled' | 'manual';
|
3463
|
-
|
3464
3044
|
/**
|
3465
3045
|
* @public
|
3466
3046
|
*/
|
3467
3047
|
export declare type TvAppProps = {
|
3468
3048
|
customer: CustomerId;
|
3469
|
-
navigateFunction: (url: string) => void;
|
3470
3049
|
};
|
3471
3050
|
|
3472
3051
|
/**
|
@@ -3475,13 +3054,11 @@ export declare type TvAppProps = {
|
|
3475
3054
|
export declare interface TvChannel extends RowItem {
|
3476
3055
|
id: string;
|
3477
3056
|
itemType: ROW_ITEM_TYPES.TV_CHANNEL;
|
3478
|
-
type?: TvChannelType;
|
3479
3057
|
name: string;
|
3480
3058
|
path: string;
|
3481
3059
|
country?: string;
|
3482
3060
|
filters: string[];
|
3483
3061
|
logo?: string;
|
3484
|
-
logoPendingOverlayWidth?: string;
|
3485
3062
|
hls: string;
|
3486
3063
|
dash: string;
|
3487
3064
|
/**
|
@@ -3489,37 +3066,12 @@ export declare interface TvChannel extends RowItem {
|
|
3489
3066
|
* Transactions before subscriptions, sorted by price ascending.
|
3490
3067
|
*/
|
3491
3068
|
getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
|
3492
|
-
getSourceUrl(
|
3493
|
-
language?: LangCode;
|
3494
|
-
}): Promise<GetSourceUrlResponse & {
|
3495
|
-
language?: LangCode;
|
3496
|
-
}>;
|
3069
|
+
getSourceUrl(fallbackUrl?: string): Promise<GetSourceUrlResponse>;
|
3497
3070
|
purchasableMonetization: any | null;
|
3498
3071
|
price: number;
|
3499
3072
|
cover: string;
|
3500
3073
|
isPlayable: boolean;
|
3501
|
-
|
3502
|
-
}
|
3503
|
-
|
3504
|
-
export declare enum TvChannelType {
|
3505
|
-
/**
|
3506
|
-
* Classic live tv channel
|
3507
|
-
*/
|
3508
|
-
CLASSIC = "CLASSIC",
|
3509
|
-
/**
|
3510
|
-
* "Virtual" tv channel constructed from separate videos
|
3511
|
-
*/
|
3512
|
-
VIRTUAL = "VIRTUAL"
|
3513
|
-
}
|
3514
|
-
|
3515
|
-
export declare interface TvProgram {
|
3516
|
-
from: Date | null;
|
3517
|
-
to: Date | null;
|
3518
|
-
name: string;
|
3519
|
-
description: string;
|
3520
|
-
url: string;
|
3521
|
-
image: string;
|
3522
|
-
video: Video | null;
|
3074
|
+
uri: string;
|
3523
3075
|
}
|
3524
3076
|
|
3525
3077
|
/**
|
@@ -3626,7 +3178,7 @@ export declare interface UseCancelSubscriptionsResult {
|
|
3626
3178
|
* @public
|
3627
3179
|
*/
|
3628
3180
|
export declare type UseChannelSource = (tvChannelId: string) => {
|
3629
|
-
source: ChannelSourcePojo |
|
3181
|
+
source: ChannelSourcePojo | null;
|
3630
3182
|
error: Error | null;
|
3631
3183
|
};
|
3632
3184
|
|
@@ -3636,7 +3188,7 @@ export declare type UseChannelSource = (tvChannelId: string) => {
|
|
3636
3188
|
* @public
|
3637
3189
|
*/
|
3638
3190
|
export declare const useChannelSource: (tvChannelId: string) => {
|
3639
|
-
source: ChannelSourcePojo |
|
3191
|
+
source: ChannelSourcePojo | null;
|
3640
3192
|
error: Error | null;
|
3641
3193
|
};
|
3642
3194
|
|
@@ -3687,6 +3239,16 @@ export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions
|
|
3687
3239
|
subscriptions: PurchasableMonetization[];
|
3688
3240
|
};
|
3689
3241
|
|
3242
|
+
/**
|
3243
|
+
* @public
|
3244
|
+
*/
|
3245
|
+
export declare type UsePlayerEvent = <T = any>(eventName: string) => T | null;
|
3246
|
+
|
3247
|
+
/**
|
3248
|
+
* @public
|
3249
|
+
*/
|
3250
|
+
export declare const usePlayerEvent: UsePlayerEvent;
|
3251
|
+
|
3690
3252
|
/**
|
3691
3253
|
* Is used to mark purchase in recovery state as PAID.
|
3692
3254
|
*
|
@@ -3759,12 +3321,6 @@ export declare type User = {
|
|
3759
3321
|
setActiveUserProfileId: (id: string) => void;
|
3760
3322
|
};
|
3761
3323
|
|
3762
|
-
export declare enum UserGroup {
|
3763
|
-
ALL = "all",
|
3764
|
-
FREE = "free",
|
3765
|
-
PREMIUM = "premium"
|
3766
|
-
}
|
3767
|
-
|
3768
3324
|
/**
|
3769
3325
|
* @public
|
3770
3326
|
*/
|
@@ -3976,11 +3532,7 @@ export declare interface Video extends RowItem {
|
|
3976
3532
|
* Transactions before subscriptions, sorted by price ascending.
|
3977
3533
|
*/
|
3978
3534
|
getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
|
3979
|
-
getSourceUrl(
|
3980
|
-
language?: LangCode;
|
3981
|
-
}): Promise<GetSourceUrlResponse & {
|
3982
|
-
language?: LangCode;
|
3983
|
-
}>;
|
3535
|
+
getSourceUrl(fallbackUrl?: string): Promise<GetSourceUrlResponse>;
|
3984
3536
|
purchasableMonetization: any | null;
|
3985
3537
|
transaction: PurchasableMonetization | undefined;
|
3986
3538
|
subscriptions: PurchasableMonetization[];
|
@@ -3991,6 +3543,7 @@ export declare interface Video extends RowItem {
|
|
3991
3543
|
urlName?: string;
|
3992
3544
|
price: number | null;
|
3993
3545
|
detailedPrice: DetailedPrice | null;
|
3546
|
+
uri: string;
|
3994
3547
|
url: string;
|
3995
3548
|
adMonetizationId?: string;
|
3996
3549
|
from?: Date;
|
@@ -4012,7 +3565,7 @@ export declare interface Video extends RowItem {
|
|
4012
3565
|
removeFromFavorites: () => void;
|
4013
3566
|
availability: VideoAvailability | null;
|
4014
3567
|
sourceLanguages: LangCode[];
|
4015
|
-
|
3568
|
+
uriByLanguage: (lang: LangCode) => string | undefined;
|
4016
3569
|
}
|
4017
3570
|
|
4018
3571
|
/**
|
@@ -4043,29 +3596,6 @@ export declare type VideoExternals = JojExternals | MallTvExternals | OktagonExt
|
|
4043
3596
|
|
4044
3597
|
declare type VideoPath = string;
|
4045
3598
|
|
4046
|
-
export declare enum VideoSourceCodec {
|
4047
|
-
H264 = "h264",
|
4048
|
-
H265 = "h265"
|
4049
|
-
}
|
4050
|
-
|
4051
|
-
export declare enum VideoSourceEncryption {
|
4052
|
-
NONE = "none",
|
4053
|
-
WIDEVINE = "widevine",
|
4054
|
-
FAIRPLAY = "fairplay",
|
4055
|
-
PLAYREADY = "playready"
|
4056
|
-
}
|
4057
|
-
|
4058
|
-
/**
|
4059
|
-
* Lower number = higher priority.
|
4060
|
-
*/
|
4061
|
-
export declare type VideoSourcePriority = 1 | 2 | 3 | 4 | 5;
|
4062
|
-
|
4063
|
-
export declare enum VideoSourceProtocol {
|
4064
|
-
HLS = "hls",
|
4065
|
-
DASH = "dash",
|
4066
|
-
MP4 = "mp4"
|
4067
|
-
}
|
4068
|
-
|
4069
3599
|
/**
|
4070
3600
|
* Video type.
|
4071
3601
|
* @public
|
@@ -4097,58 +3627,30 @@ export declare enum VideoType {
|
|
4097
3627
|
/**
|
4098
3628
|
* @public
|
4099
3629
|
*/
|
4100
|
-
export declare type
|
3630
|
+
export declare type VideoUrlName = {
|
4101
3631
|
[key in LangCode]?: string[];
|
4102
3632
|
};
|
4103
3633
|
|
4104
|
-
export declare interface ViewCountItem {
|
4105
|
-
/**
|
4106
|
-
* Unix timestamp
|
4107
|
-
*/
|
4108
|
-
date: number;
|
4109
|
-
/**
|
4110
|
-
* Monetization under the videos played, if not filled it is free
|
4111
|
-
*/
|
4112
|
-
monetizationId?: string;
|
4113
|
-
/**
|
4114
|
-
* Device where the video played
|
4115
|
-
*/
|
4116
|
-
deviceType: PLATFORM;
|
4117
|
-
/**
|
4118
|
-
* Count of video view events in group
|
4119
|
-
*/
|
4120
|
-
totalCount: number;
|
4121
|
-
}
|
4122
|
-
|
4123
|
-
/**
|
4124
|
-
* @public
|
4125
|
-
*/
|
4126
|
-
export declare interface VirtualChannelSourcePojo {
|
4127
|
-
type: 'VirtualChannelSource';
|
4128
|
-
tvChannel: TvChannel;
|
4129
|
-
epg: TvProgram[];
|
4130
|
-
}
|
4131
|
-
|
4132
3634
|
/**
|
4133
3635
|
* @public
|
4134
3636
|
*/
|
4135
3637
|
export declare type VodExternalSource = {
|
4136
|
-
new (
|
3638
|
+
new (uri: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
|
4137
3639
|
type: 'vod_external';
|
4138
3640
|
description: string;
|
4139
3641
|
name: string;
|
4140
|
-
|
3642
|
+
uri: string;
|
4141
3643
|
};
|
4142
3644
|
|
4143
3645
|
/**
|
4144
3646
|
* @public
|
4145
3647
|
*/
|
4146
3648
|
export declare type VodTivioSource = {
|
4147
|
-
new (
|
3649
|
+
new (uri: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
|
4148
3650
|
type: 'vod_tivio';
|
4149
3651
|
description: string;
|
4150
3652
|
name: string;
|
4151
|
-
|
3653
|
+
uri: string;
|
4152
3654
|
};
|
4153
3655
|
|
4154
3656
|
declare interface VodTivioSourcePojo {
|
@@ -4156,7 +3658,7 @@ declare interface VodTivioSourcePojo {
|
|
4156
3658
|
description: string;
|
4157
3659
|
path: string;
|
4158
3660
|
name: string;
|
4159
|
-
|
3661
|
+
uri: string;
|
4160
3662
|
poster?: string;
|
4161
3663
|
adMonetizationId?: string;
|
4162
3664
|
availability: VideoAvailability | null;
|
@@ -4187,7 +3689,7 @@ export declare interface WarningConfirmationOverlayPayload extends ConfirmationO
|
|
4187
3689
|
*/
|
4188
3690
|
export declare interface WebPlayerProps {
|
4189
3691
|
id: string;
|
4190
|
-
source?: VodTivioSourcePojo | ChannelSourcePojo |
|
3692
|
+
source?: VodTivioSourcePojo | ChannelSourcePojo | VideoPath | null;
|
4191
3693
|
onEnded?: () => any;
|
4192
3694
|
/**
|
4193
3695
|
* If this function is specified, then "Back" button is shown in top right corner.
|