stormcloud-video-player 0.7.3 → 0.7.5

package/lib/index.d.cts

@@ -1,6 +1,5 @@
 import React, { CSSProperties, lazy as lazy$1 } from 'react';
 import * as csstype from 'csstype';
-import Hls from 'hls.js';
 
 type LateJoinPolicy = "play_remaining" | "skip_to_content";
 interface AdBreak {
@@ -37,6 +36,32 @@ interface StormcloudVideoPlayerConfig {
     adTransitionGapMs?: number;
     singlePipelineMode?: boolean;
 }
+interface Scte35Marker {
+    type: "start" | "end" | "progress";
+    ptsSeconds?: number;
+    durationSeconds?: number;
+    raw?: unknown;
+}
+interface AdController {
+    initialize: () => void;
+    requestAds: () => Promise<void>;
+    play: () => Promise<void>;
+    pause: () => void;
+    resume: () => void;
+    stop: () => Promise<void>;
+    destroy: () => void;
+    isAdPlaying: () => boolean;
+    resize: (width: number, height: number) => void;
+    on: (event: string, listener: (payload?: any) => void) => void;
+    off: (event: string, listener: (payload?: any) => void) => void;
+    updateOriginalMutedState: (muted: boolean, volume?: number) => void;
+    getOriginalMutedState: () => boolean;
+    getOriginalVolume: () => number;
+    setAdVolume: (volume: number) => void;
+    getAdVolume: () => number;
+    showPlaceholder: () => void;
+    hidePlaceholder: () => void;
+}
 interface ClientInfo {
     brand: string;
     os: string;
@@ -91,24 +116,12 @@ interface VastBidResponse {
     adomain?: string[];
     durationSec?: number;
 }
-interface AdBreakContext {
-    breakDurationSec?: number;
-    remainingBreakSec?: number;
-    adIndex?: number;
-}
-interface VastManager {
-    initialize: () => Promise<void>;
-    requestBids: (context?: AdBreakContext) => Promise<VastBidResponse[]>;
-    requestBidsUntilResponse: (context?: AdBreakContext) => Promise<VastBidResponse[]>;
-    destroy: () => void;
-    readonly isInitialized: boolean;
-}
 
+type DebugLogLevel = "info" | "warn" | "error";
 declare class StormcloudVideoPlayer {
     private readonly video;
     private readonly config;
     private hls?;
-    private vastManager;
     private adLayer;
     private pendingNextAdBids;
     private continuousFetchLoopPromise;
@@ -155,9 +168,14 @@ declare class StormcloudVideoPlayer {
     private readonly maxBackoffMs;
     private readonly adTransitionGapMs;
     private readonly MIN_AD_REMAINING_MS;
+    private readonly adRequestTimeoutMs;
+    private readonly adRequestMaxRetries;
+    private readonly adRequestRetryBackoffMs;
     private preloadedTokens;
     private fillerVideo;
     private fillerBreakTimerId;
+    private debugLogEntries;
+    private scteMarkerHistory;
     constructor(config: StormcloudVideoPlayerConfig);
     private adRequest;
     load(): Promise<void>;
@@ -184,6 +202,7 @@ declare class StormcloudVideoPlayer {
     private sendHeartbeatIfNeeded;
     getCurrentAdIndex(): number;
     getTotalAdsInBreak(): number;
+    getRemainingAdSeconds(): number;
     isAdPlaying(): boolean;
     isShowingAds(): boolean;
     private syncMainContentAudioWhenVisible;
@@ -216,6 +235,22 @@ declare class StormcloudVideoPlayer {
     private clearAdFailsafeTimer;
     private logAdState;
     private getRemainingAdMs;
+    private pushScteMarker;
+    private pushDebugLog;
+    getRecentScteMarkers(): ReadonlyArray<{
+        timestampMs: number;
+        type: Scte35Marker["type"];
+        ptsSeconds?: number;
+        durationSeconds?: number;
+        raw?: unknown;
+    }>;
+    getDebugLogs(): ReadonlyArray<{
+        timestampMs: number;
+        level: DebugLogLevel;
+        category: string;
+        message: string;
+        details?: Record<string, unknown>;
+    }>;
     toggleMute(): void;
     toggleFullscreen(): Promise<void>;
     isMuted(): boolean;
@@ -4063,47 +4098,23 @@ declare function getBrowserConfigOverrides(): {
 };
 declare function supportsFeature(feature: string): boolean;
 
-interface VastManagerOptions {
-    debug?: boolean;
-}
-declare function createVastManager(options?: VastManagerOptions): VastManager;
-
-interface VastAdLayerOptions {
-    continueLiveStreamDuringAds?: boolean;
-    mainHlsInstance?: Hls;
-    smartTVMode?: boolean;
-    singleElementMode?: boolean;
-    forceMP4Ads?: boolean;
+interface AdStormPlayerOptions {
+    licenseKey: string;
     debug?: boolean;
 }
-interface VastAdLayerOptionsUpdate {
+interface AdStormLayerOptionsUpdate {
     continueLiveStreamDuringAds?: boolean;
-    mainHlsInstance?: Hls | null;
+    mainHlsInstance?: unknown;
 }
-interface VastAdLayer {
-    initialize: () => void;
-    updateOptions: (opts: VastAdLayerOptionsUpdate) => void;
-    playAd: (bids: VastBidResponse[]) => Promise<void>;
-    preloadAd: (bids: VastBidResponse[], token: string) => Promise<void>;
+interface AdStormAdLayer extends AdController {
+    requestAds: (duration?: string) => Promise<void>;
+    updateOptions: (opts: AdStormLayerOptionsUpdate) => void;
+    playAd: (requestContext?: unknown) => Promise<void>;
+    preloadAd: (arg1: unknown, arg2?: unknown) => Promise<void>;
     playPreloaded: (token: string) => Promise<void>;
     hasPreloaded: (token: string) => boolean;
     cancelPreload: (token: string) => void;
-    pause: () => void;
-    resume: () => void;
-    stop: () => Promise<void>;
-    destroy: () => void;
-    isAdPlaying: () => boolean;
-    resize: (width: number, height: number) => void;
-    on: (event: string, listener: (payload?: any) => void) => void;
-    off: (event: string, listener: (payload?: any) => void) => void;
-    updateOriginalMutedState: (muted: boolean, volume?: number) => void;
-    getOriginalMutedState: () => boolean;
-    getOriginalVolume: () => number;
-    setAdVolume: (volume: number) => void;
-    getAdVolume: () => number;
-    showPlaceholder: () => void;
-    hidePlaceholder: () => void;
 }
-declare function createVastAdLayer(contentVideo: HTMLVideoElement, options?: VastAdLayerOptions): VastAdLayer;
+declare function createAdStormPlayer(contentVideo: HTMLVideoElement, options: AdStormPlayerOptions): AdStormAdLayer;
 
-export { type AdBreak, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type LateJoinPolicy, type OnProgressProps, type OverlayCoordinateSpace, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type SwirlOverlay, type SwirlOverlayType, type SwirlScrollerConfig, type TrackingData, type VastAdLayer, type VastAdLayerOptions, type VastAdLayerOptionsUpdate, type VastBidResponse, type VastManager, type VastManagerOptions, canPlay, createStormcloudPlayer, createVastAdLayer, createVastManager, StormcloudVideoPlayerComponent as default, detectBrowser, fetchProjectOverlays, getBrowserConfigOverrides, getBrowserID, getClientInfo, initializePolyfills, isMediaStream, isOverlayActive, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, resolveImageUrl, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, timeStringToSeconds };
+export { type AdBreak, type AdSchedule, type AdStormAdLayer, type AdStormLayerOptionsUpdate, type AdStormPlayerOptions, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type LateJoinPolicy, type OnProgressProps, type OverlayCoordinateSpace, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type SwirlOverlay, type SwirlOverlayType, type SwirlScrollerConfig, type TrackingData, type VastBidResponse, canPlay, createAdStormPlayer, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, fetchProjectOverlays, getBrowserConfigOverrides, getBrowserID, getClientInfo, initializePolyfills, isMediaStream, isOverlayActive, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, resolveImageUrl, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, timeStringToSeconds };

package/lib/index.d.ts

@@ -1,6 +1,5 @@
 import React, { CSSProperties, lazy as lazy$1 } from 'react';
 import * as csstype from 'csstype';
-import Hls from 'hls.js';
 
 type LateJoinPolicy = "play_remaining" | "skip_to_content";
 interface AdBreak {
@@ -37,6 +36,32 @@ interface StormcloudVideoPlayerConfig {
     adTransitionGapMs?: number;
     singlePipelineMode?: boolean;
 }
+interface Scte35Marker {
+    type: "start" | "end" | "progress";
+    ptsSeconds?: number;
+    durationSeconds?: number;
+    raw?: unknown;
+}
+interface AdController {
+    initialize: () => void;
+    requestAds: () => Promise<void>;
+    play: () => Promise<void>;
+    pause: () => void;
+    resume: () => void;
+    stop: () => Promise<void>;
+    destroy: () => void;
+    isAdPlaying: () => boolean;
+    resize: (width: number, height: number) => void;
+    on: (event: string, listener: (payload?: any) => void) => void;
+    off: (event: string, listener: (payload?: any) => void) => void;
+    updateOriginalMutedState: (muted: boolean, volume?: number) => void;
+    getOriginalMutedState: () => boolean;
+    getOriginalVolume: () => number;
+    setAdVolume: (volume: number) => void;
+    getAdVolume: () => number;
+    showPlaceholder: () => void;
+    hidePlaceholder: () => void;
+}
 interface ClientInfo {
     brand: string;
     os: string;
@@ -91,24 +116,12 @@ interface VastBidResponse {
     adomain?: string[];
     durationSec?: number;
 }
-interface AdBreakContext {
-    breakDurationSec?: number;
-    remainingBreakSec?: number;
-    adIndex?: number;
-}
-interface VastManager {
-    initialize: () => Promise<void>;
-    requestBids: (context?: AdBreakContext) => Promise<VastBidResponse[]>;
-    requestBidsUntilResponse: (context?: AdBreakContext) => Promise<VastBidResponse[]>;
-    destroy: () => void;
-    readonly isInitialized: boolean;
-}
 
+type DebugLogLevel = "info" | "warn" | "error";
 declare class StormcloudVideoPlayer {
     private readonly video;
     private readonly config;
     private hls?;
-    private vastManager;
     private adLayer;
     private pendingNextAdBids;
     private continuousFetchLoopPromise;
@@ -155,9 +168,14 @@ declare class StormcloudVideoPlayer {
     private readonly maxBackoffMs;
     private readonly adTransitionGapMs;
     private readonly MIN_AD_REMAINING_MS;
+    private readonly adRequestTimeoutMs;
+    private readonly adRequestMaxRetries;
+    private readonly adRequestRetryBackoffMs;
     private preloadedTokens;
     private fillerVideo;
     private fillerBreakTimerId;
+    private debugLogEntries;
+    private scteMarkerHistory;
     constructor(config: StormcloudVideoPlayerConfig);
     private adRequest;
     load(): Promise<void>;
@@ -184,6 +202,7 @@ declare class StormcloudVideoPlayer {
     private sendHeartbeatIfNeeded;
     getCurrentAdIndex(): number;
     getTotalAdsInBreak(): number;
+    getRemainingAdSeconds(): number;
     isAdPlaying(): boolean;
     isShowingAds(): boolean;
     private syncMainContentAudioWhenVisible;
@@ -216,6 +235,22 @@ declare class StormcloudVideoPlayer {
     private clearAdFailsafeTimer;
     private logAdState;
     private getRemainingAdMs;
+    private pushScteMarker;
+    private pushDebugLog;
+    getRecentScteMarkers(): ReadonlyArray<{
+        timestampMs: number;
+        type: Scte35Marker["type"];
+        ptsSeconds?: number;
+        durationSeconds?: number;
+        raw?: unknown;
+    }>;
+    getDebugLogs(): ReadonlyArray<{
+        timestampMs: number;
+        level: DebugLogLevel;
+        category: string;
+        message: string;
+        details?: Record<string, unknown>;
+    }>;
     toggleMute(): void;
     toggleFullscreen(): Promise<void>;
     isMuted(): boolean;
@@ -4063,47 +4098,23 @@ declare function getBrowserConfigOverrides(): {
 };
 declare function supportsFeature(feature: string): boolean;
 
-interface VastManagerOptions {
-    debug?: boolean;
-}
-declare function createVastManager(options?: VastManagerOptions): VastManager;
-
-interface VastAdLayerOptions {
-    continueLiveStreamDuringAds?: boolean;
-    mainHlsInstance?: Hls;
-    smartTVMode?: boolean;
-    singleElementMode?: boolean;
-    forceMP4Ads?: boolean;
+interface AdStormPlayerOptions {
+    licenseKey: string;
     debug?: boolean;
 }
-interface VastAdLayerOptionsUpdate {
+interface AdStormLayerOptionsUpdate {
     continueLiveStreamDuringAds?: boolean;
-    mainHlsInstance?: Hls | null;
+    mainHlsInstance?: unknown;
 }
-interface VastAdLayer {
-    initialize: () => void;
-    updateOptions: (opts: VastAdLayerOptionsUpdate) => void;
-    playAd: (bids: VastBidResponse[]) => Promise<void>;
-    preloadAd: (bids: VastBidResponse[], token: string) => Promise<void>;
+interface AdStormAdLayer extends AdController {
+    requestAds: (duration?: string) => Promise<void>;
+    updateOptions: (opts: AdStormLayerOptionsUpdate) => void;
+    playAd: (requestContext?: unknown) => Promise<void>;
+    preloadAd: (arg1: unknown, arg2?: unknown) => Promise<void>;
     playPreloaded: (token: string) => Promise<void>;
     hasPreloaded: (token: string) => boolean;
     cancelPreload: (token: string) => void;
-    pause: () => void;
-    resume: () => void;
-    stop: () => Promise<void>;
-    destroy: () => void;
-    isAdPlaying: () => boolean;
-    resize: (width: number, height: number) => void;
-    on: (event: string, listener: (payload?: any) => void) => void;
-    off: (event: string, listener: (payload?: any) => void) => void;
-    updateOriginalMutedState: (muted: boolean, volume?: number) => void;
-    getOriginalMutedState: () => boolean;
-    getOriginalVolume: () => number;
-    setAdVolume: (volume: number) => void;
-    getAdVolume: () => number;
-    showPlaceholder: () => void;
-    hidePlaceholder: () => void;
 }
-declare function createVastAdLayer(contentVideo: HTMLVideoElement, options?: VastAdLayerOptions): VastAdLayer;
+declare function createAdStormPlayer(contentVideo: HTMLVideoElement, options: AdStormPlayerOptions): AdStormAdLayer;
 
-export { type AdBreak, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type LateJoinPolicy, type OnProgressProps, type OverlayCoordinateSpace, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type SwirlOverlay, type SwirlOverlayType, type SwirlScrollerConfig, type TrackingData, type VastAdLayer, type VastAdLayerOptions, type VastAdLayerOptionsUpdate, type VastBidResponse, type VastManager, type VastManagerOptions, canPlay, createStormcloudPlayer, createVastAdLayer, createVastManager, StormcloudVideoPlayerComponent as default, detectBrowser, fetchProjectOverlays, getBrowserConfigOverrides, getBrowserID, getClientInfo, initializePolyfills, isMediaStream, isOverlayActive, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, resolveImageUrl, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, timeStringToSeconds };
+export { type AdBreak, type AdSchedule, type AdStormAdLayer, type AdStormLayerOptionsUpdate, type AdStormPlayerOptions, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type LateJoinPolicy, type OnProgressProps, type OverlayCoordinateSpace, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type SwirlOverlay, type SwirlOverlayType, type SwirlScrollerConfig, type TrackingData, type VastBidResponse, canPlay, createAdStormPlayer, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, fetchProjectOverlays, getBrowserConfigOverrides, getBrowserID, getClientInfo, initializePolyfills, isMediaStream, isOverlayActive, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, resolveImageUrl, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, timeStringToSeconds };