@tivio/sdk-react 9.7.0 → 9.8.0

package/dist/sdk-react.d.ts

@@ -104,6 +104,7 @@ export declare type AdMetadata = {
     isSkippable: boolean;
     order: number | null;
     totalCount: number | null;
+    adPlacementStrategy: AdPlacementStrategy;
     customAdMetadata?: Record<string, unknown>;
     skip: () => void;
 } | null;
@@ -118,7 +119,10 @@ export declare interface AdPackInfo {
     total: number;
 }
 
+export declare type AdPlacementStrategy = 'preroll' | 'midroll' | 'postroll' | 'replacement';
+
 export declare interface AdSegment {
+    adPlacementStrategy: AdPlacementStrategy;
     id: string;
     /**
      * @deprecated alias to secondsToEnd * 1000
@@ -183,6 +187,7 @@ export declare interface AdSourceActions {
  */
 export declare interface AdSourceInterface extends CommonSourceInterface<SourceType.ADVERTISEMENT> {
     adType: AdType;
+    adPlacementStrategy: AdPlacementStrategy;
     durationMs: number;
     skipDelayMs: number | null;
     /**
@@ -233,6 +238,7 @@ export declare interface AdSourceInterface extends CommonSourceInterface<SourceT
  */
 export declare interface AdSourceParams extends CommonSourceParams<SourceType.ADVERTISEMENT> {
     id: string;
+    adPlacementStrategy: AdPlacementStrategy;
     adType?: AdType;
     actions?: AdSourceActions | null;
     apiFramework?: VastApiFramework | null;
@@ -761,6 +767,7 @@ export declare interface ChannelSourceInterface extends PlayerSourceInterface<So
     to: Date;
     poster: string | null;
     tvMode: TvMode | 'live' | null;
+    clone: (params?: Partial<ChannelSourceParams>) => ChannelSourceInterface;
 }
 
 /**
@@ -1603,6 +1610,9 @@ export declare interface DidomiWindow {
      * https://developers.didomi.io/cmp/web-sdk/reference/api
      */
     didomiOnReady: (() => void)[];
+    Didomi?: {
+        getUserConsentStatusForPurpose: (category: string) => boolean;
+    };
 }
 
 /**
@@ -1927,7 +1937,8 @@ export declare enum ForbiddenReason {
     NAME_CONTAINS_INVALID_CHAR = "NAME_CONTAINS_INVALID_CHAR",
     USER_ACCOUNT_LOCKED = "USER_ACCOUNT_LOCKED",
     USER_NOT_FOUND = "USER_NOT_FOUND",
-    UNSUPPORTED_BROWSER = "UNSUPPORTED_BROWSER"
+    UNSUPPORTED_BROWSER = "UNSUPPORTED_BROWSER",
+    ANONYMOUS_USER = "ANONYMOUS_USER"
 }
 
 /**
@@ -2153,6 +2164,10 @@ export declare interface GetSourceUrlResponse {
      * Determines session type generated for source. If no provided it will be considered 'ondemand' session type.
      */
     sessionType?: VideoSourceField['sessionType'];
+    /**
+     * Language of the source.
+     */
+    language?: LangCode;
 }
 
 export declare type GetTilesInRowResponse<U extends NextPageParamType = NextPageParamType> = PaginatedResponse<TileData, U>;
@@ -3581,6 +3596,11 @@ export declare type PlayerConfig = {
          */
         name: 'IMA SDK' | 'TIVIO AD SERVICE';
     };
+    /**
+     * If true, then TV channels are not available for anonymous users and they will be shown an overlay to sign in.
+     * @default false
+     */
+    disableTvChannelsForAnonymousUsers?: boolean;
 };
 
 /**
@@ -3704,6 +3724,11 @@ export declare interface PlayerEngineInterface {
      */
     setPlaysInline(value: boolean): void;
     setControlsList(value: string[]): void;
+    /** Gets resolution of the video element in pixels - container size, not the actual source quality resolution */
+    getVideoResolution(): {
+        width: number;
+        height: number;
+    };
 }
 
 /**
@@ -3799,6 +3824,11 @@ export declare interface PlayerInterface {
      */
     setPlaysInline?: (value: boolean) => void;
     setControlsList?: (value: string[]) => void;
+    /** Gets resolution of the video element in pixels - container size, not the actual source quality resolution */
+    getVideoResolution(): {
+        width: number;
+        height: number;
+    };
 }
 
 /**
@@ -3901,6 +3931,13 @@ export declare type PlayerState = 'idle' | 'playing' | 'paused';
  * @public
  */
 export declare interface PlayerWrapper {
+    /**
+     * Unique id of the player wrapper instance, set at construction time
+     * (e.g. by `tivio.getPlayerWrapper(id)`). Used to scope DOM ids of
+     * player-owned elements (IMA ad containers, content video element, …)
+     * so multiple players on the same page don't collide.
+     */
+    readonly id: string;
     /**
      * Report that playback of video has finished
      */
@@ -4005,6 +4042,10 @@ export declare interface PlayerWrapper {
     setCanPlay: (canPlay: boolean) => void;
     toggleMuted: () => void;
     getQualities: () => Track[];
+    getVideoResolution: () => {
+        width: number;
+        height: number;
+    };
     playNativeImaAd: (url: string) => void;
     playSourceAfterAdsRun: () => void;
     putAd: (ad: AdSourceInterface) => void;
@@ -5798,6 +5839,18 @@ export declare interface SimplifiedVideoController {
      */
     setSource(source: WebPlayerProps['source']): void;
     setAdsConfig(adsConfig: StaticAdsBreak[]): void;
+    /**
+     * Toggle the minimal OSD mode.
+     *
+     * When enabled, the player shows only a minimal set of controls (play/pause,
+     * volume and fullscreen) and a small center play/pause icon that briefly
+     * flashes when the state changes. Intended for small/pinned containers such
+     * as a scroll-fixed mini player in the corner of the page or a full-width
+     * mobile player pinned to the top of the viewport.
+     *
+     * @param isMinimal - Whether the minimal OSD should be used
+     */
+    setIsMinimal(isMinimal: boolean): void;
     /**
      * Destroy the player and clean up all resources
      */
@@ -5917,7 +5970,7 @@ export declare interface StartLiveStreamResponse {
     error?: string;
 }
 
-export declare type StaticAdsBreak = StaticAdsBreakPostrollPreroll | StaticAdsBreakMidroll;
+export declare type StaticAdsBreak = StaticAdsBreakPostrollPreroll | StaticAdsBreakMidroll | StaticAdsBreakReplacement;
 
 export declare interface StaticAdsBreakMidroll {
     type: 'midroll';
@@ -5930,6 +5983,11 @@ declare interface StaticAdsBreakPostrollPreroll {
     url: string;
 }
 
+export declare interface StaticAdsBreakReplacement {
+    type: 'replacement';
+    url: string;
+}
+
 /**
  * @public
  */
@@ -6828,6 +6886,8 @@ export declare type TivioReactBundle = {
      */
     internal: TivioInternalBundle;
     analytics: TivioAnalytics;
+    addToFavoritesByPath: (path: string) => Promise<void>;
+    removeFromFavoritesByPath: (path: string) => Promise<void>;
     destroy: () => Promise<void>;
 } & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'> & Omit<Partial<TivioJsBundleExposedApi>, 'createPlayerWrapper'>;
 
@@ -8227,7 +8287,7 @@ export declare interface ViewCountItem {
 /**
  * @public
  */
-export declare interface VirtualChannelSourceInterface extends ChannelSourceInterface {
+export declare interface VirtualChannelSourceInterface extends Omit<ChannelSourceInterface, 'clone'> {
     tvChannelType: TvChannelType.VIRTUAL;
     program?: TvProgram | null;
     video?: Video | null;
@@ -8737,6 +8797,14 @@ export declare interface WebPlayerProps {
      * If true then OSD is shown based on condition resolved in HidableOsdContainer, e.g. on pause, on mouse move etc.
      */
     showOsd?: boolean;
+    /**
+     * If true, then only a minimal set of OSD controls is shown (play/pause, volume, fullscreen)
+     * and the big center play/pause button only flashes briefly on state change.
+     *
+     * Intended for small fixed containers (e.g. a scroll-pinned mini player in the corner
+     * of the page, or a full-width mobile player pinned to the top of the viewport).
+     */
+    isMinimal?: boolean;
     /**
      * If false, then buffering spinner is never shown.
      * If true then buffering spinner is shown while buffering.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "9.7.0",
+    "version": "9.8.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -38,7 +38,7 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.138",
+        "@tivio/common": "1.1.144",
         "dayjs": "^1.11.0",
         "es7-object-polyfill": "^1.0.1",
         "firebase": "8.10.1",