boss-web-player-sdk 2.0.1 → 2.0.3

package/dist/index.d.ts

@@ -53,7 +53,7 @@ declare interface AnalyticsSessionSnapshot {
     milestonesHit: string[];
 }
 
-export declare function BossVideoPlayer({ playerKey, src, subtitles, licenseKey, themeColor, proxyDomains, apiBaseUrl, adTrackingUrl, overlayAdUrl, videoId: videoIdProp, title, artworkUrl, watermark, autoplay, muted, autoFullscreen, enableControls, enableSkipAd, skipAdAfterSeconds, chaptersDisplayMode, keyMoments: propKeyMoments, chapters: propChapters, keyMomentsTray, keyMomentsPosition, defaultKeyMomentsOpen, enableKeyMoments, onKeyMomentsToggle, volumeControlType, subtitleStyle, drmConfig, onAnalyticsEvent, delegate, onKeyMomentsLoaded, initialTime, onTimeUpdate, skipMarkers, introStartTime, introEndTime, hasNextEpisode, outroStartTime, nextEpisodeLabel, onNextEpisode, nextEpisodeAutoAdvanceSeconds, nextEpisodeThumbnailUrl, featureOverrides, enableQuality, enableSources, }: BossVideoPlayerProps): JSX.Element;
+export declare function BossVideoPlayer({ playerKey, src, subtitles, licenseKey, themeColor, adAccentColor: adAccentColorProp, playerThemeColor: playerThemeColorProp, chapterTitle: chapterTitleProp, enableFullscreen: enableFullscreenProp, enableThumbnailPreview: enableThumbnailPreviewProp, proxyDomains, apiBaseUrl, adTrackingUrl, overlayAdUrl, videoId: videoIdProp, title, artworkUrl, watermark, autoplay, muted, autoFullscreen, enableControls, enableSkipAd, skipAdAfterSeconds, chaptersDisplayMode, keyMoments: propKeyMoments, chapters: propChapters, keyMomentsTray, keyMomentsPosition, defaultKeyMomentsOpen, enableKeyMoments, onKeyMomentsToggle, volumeControlType, subtitleStyle, drmConfig, onAnalyticsEvent, delegate, onKeyMomentsLoaded, initialTime, onTimeUpdate, skipMarkers, introStartTime, introEndTime, hasNextEpisode, outroStartTime, nextEpisodeLabel, onNextEpisode, nextEpisodeAutoAdvanceSeconds, nextEpisodeThumbnailUrl, featureOverrides, enableQuality, enableSources, }: BossVideoPlayerProps): JSX.Element;
 
 export declare interface BossVideoPlayerProps {
     playerKey: string;
@@ -62,6 +62,11 @@ export declare interface BossVideoPlayerProps {
     subtitles?: SubtitleTrack[];
     licenseKey?: string;
     themeColor?: string;
+    adAccentColor?: string | null;
+    playerThemeColor?: string | null;
+    chapterTitle?: string;
+    enableFullscreen?: boolean;
+    enableThumbnailPreview?: boolean;
     proxyDomains?: string;
     apiBaseUrl?: string;
     adTrackingUrl?: string;
@@ -76,15 +81,15 @@ export declare interface BossVideoPlayerProps {
     enableControls?: boolean;
     enableSkipAd?: boolean;
     skipAdAfterSeconds?: number;
-    chaptersDisplayMode?: 'strip' | 'panel';
+    chaptersDisplayMode?: "strip" | "panel";
     keyMoments?: KeyMoment[];
     chapters?: Chapter[];
-    keyMomentsTray?: 'bottom' | 'right' | 'strip' | 'panel' | 'none' | boolean;
-    keyMomentsPosition?: 'bottom' | 'right';
+    keyMomentsTray?: "bottom" | "right" | "strip" | "panel" | "none" | boolean;
+    keyMomentsPosition?: "bottom" | "right";
     defaultKeyMomentsOpen?: boolean;
     enableKeyMoments?: boolean;
     onKeyMomentsToggle?: (isOpen: boolean) => void;
-    volumeControlType?: 'slider' | 'button';
+    volumeControlType?: "slider" | "button";
     subtitleStyle?: SubtitleStyle;
     drmConfig?: DRMConfig;
     onAnalyticsEvent?: (event: AnalyticsEvent) => void;
@@ -107,14 +112,16 @@ export declare interface BossVideoPlayerProps {
 
 declare interface CastCustomData {
     headers?: Record<string, string>;
-    watermark?: string;
     externalSubtitles?: Array<{
         id: string;
         label: string;
         language: string;
         src: string;
     }>;
+    selectedSubtitle?: CastTrackRef | null;
     adTrackingUrl?: string;
+    themeColor?: string;
+    adAccentColor?: string;
 }
 
 declare interface CastTrackRef {
@@ -135,6 +142,12 @@ export declare interface Chapter {
 
 export declare function createPlayer(container: HTMLElement, props: PlayerProps): PlayerInstance;
 
+export declare const DEFAULT_AD_ACCENT_COLOR = "#ead81a";
+
+export declare const DEFAULT_CHAPTER_TITLE = "Key Moments";
+
+export declare const DEFAULT_PLAYER_THEME_COLOR = "#ffffff";
+
 export declare interface DRMConfig {
     widevineLicenseUrl?: string;
     playreadyLicenseUrl?: string;
@@ -171,6 +184,7 @@ export declare type FeatureFlags = {
     screen_recording_prevention: boolean;
     signal_strength: boolean;
     ad_support: boolean;
+    skip_segments: boolean;
 };
 
 declare interface IAnalyticsModule {
@@ -370,17 +384,47 @@ declare interface RemoteCastState {
     isMuted: boolean;
 }
 
+export declare function resolveThemeColor(value: string | null | undefined, fallback: string): string;
+
+export declare type SdkInitChapterMarkersConfig = {
+    title?: string | null;
+    trayPosition?: string | null;
+};
+
+export declare type SdkInitConfig = {
+    chapterMarkers?: SdkInitChapterMarkersConfig;
+    adAccentColor?: string | null;
+    playerThemeColor?: string | null;
+    aspectRatio?: boolean;
+    fullscreen?: boolean;
+    orientation?: boolean;
+    thumbnailPreview?: boolean;
+};
+
 export declare type SdkInitData = {
     tenantId: string;
     features: SdkInitFeatures;
+    config?: SdkInitConfig;
     heartbeatIntervalSeconds?: number;
+    expiresAt?: string;
+    validForSeconds?: number;
 };
 
 export declare type SdkInitFeatures = {
     subtitles: boolean;
     ads: boolean;
     chapterMarkers: boolean;
-    [key: string]: boolean;
+    skipSegments?: boolean;
+    playbackSpeed?: boolean;
+    chromecast?: boolean;
+    airplay?: boolean;
+    pictureInPicture?: boolean;
+    multipleResolution?: boolean;
+    multipleAudio?: boolean;
+    drmProtection?: boolean;
+    screenRecordingPrevention?: boolean;
+    signalStrength?: boolean;
+    [key: string]: boolean | undefined;
 };
 
 export declare interface SdkInitOptions {
@@ -429,8 +473,8 @@ export declare interface StartSessionOptions {
 }
 
 export declare interface SubtitleStyle {
-    size?: 'small' | 'medium' | 'large';
-    background?: 'none' | 'dim' | 'solid';
+    size?: "small" | "medium" | "large";
+    background?: "none" | "dim" | "solid";
     color?: string;
 }
 
@@ -481,6 +525,9 @@ export declare class VideoPlayerSDK {
     private dashInstance;
     private activeQuality;
     private qualityLevels;
+    private nativeMasterSrc;
+    private nativeVariantUris;
+    private nativeQualityGeneration;
     analytics: IAnalyticsModule;
     keyMoments: IKeyMomentsModule;
     chapters: IChaptersModule;
@@ -502,17 +549,21 @@ export declare class VideoPlayerSDK {
     private static readonly MAX_NETWORK_RETRIES;
     private static readonly TERMINAL_HTTP_STATUSES;
     private static readonly STALL_TIMEOUT_MS;
+    private static readonly MEDIA_ERROR_RECOVERY_TIMEOUT_MS;
     private static readonly BUFFER_RESOLVE_MIN_ADVANCE_S;
     private stallTimer;
+    private mediaErrorTimer;
     private isBuffering;
     private progressTick;
     private hasFailed;
     private mediaEventsAbort;
     private keyMomentsGeneration;
+    private thumbnailBlobUrls;
     private lastPlaybackPos;
     private pendingSeekAttribution;
     private eventListeners;
     private static readonly AIRPLAY_POLL_INTERVAL_MS;
+    private static readonly PRE_ROLL_HEAD_TOLERANCE_S;
     private airPlayPollTimer;
     private airPlayTargetChangeHandler?;
     private airPlaySeekPin;
@@ -561,6 +612,7 @@ export declare class VideoPlayerSDK {
     on(event: string, callback: (...args: any[]) => void): void;
     off(event: string, callback: (...args: any[]) => void): void;
     private emit;
+    private extractNativeQualityLevelsFromManifest;
     private extractSubtitlesFromManifest;
     private findManifestThumbnailUri;
     private parseThumbnailVtt;
@@ -568,7 +620,11 @@ export declare class VideoPlayerSDK {
     private bareThumbnailFilenameBesideVtt;
     private resolveThumbnailCueBase;
     private loadManifestThumbnailCues;
+    private revokeThumbnailBlobs;
+    private hydrateAuthenticatedThumbnails;
+    private fetchThumbnailBlobUrl;
     private thumbnailCueAtTime;
+    private applyThumbnailCuesToMoments;
     private extractKeyMomentsFromManifest;
     hasAdBreakDiscoverySettled(): boolean;
     private buildManifestUrl;
@@ -604,6 +660,7 @@ export declare class VideoPlayerSDK {
     setAudioTrack(id: number): void;
     private armStallWatchdog;
     private clearStallWatchdog;
+    private clearMediaErrorTimer;
     private fail;
     destroy(options?: {
         releaseVideoElement?: boolean;
@@ -630,6 +687,9 @@ declare interface WebVideoPlayerProps {
     thumbnails?: ThumbnailConfig;
     watermark?: string;
     themeColor?: string;
+    adAccentColor?: string;
+    playerThemeColor?: string;
+    chapterTitle?: string;
     drmConfig?: any;
     onAnalyticsEvent?: (event: AnalyticsEvent) => void;
     onAdBreakChange?: (active: boolean) => void;
@@ -643,6 +703,7 @@ declare interface WebVideoPlayerProps {
     enablePlaybackSpeed?: boolean;
     enablePiP?: boolean;
     enableFullscreen?: boolean;
+    enableThumbnailPreview?: boolean;
     autoFullscreen?: boolean;
     watchProgressInterval?: number;
     subtitleStyle?: SubtitleStyle_2;