stormcloud-video-player 0.3.17 → 0.4.0

package/lib/index.d.cts

@@ -7,7 +7,6 @@ interface AdBreak {
     id?: string;
     startTimeMs: number;
     durationMs?: number;
-    vastTagUrl?: string;
 }
 interface AdSchedule {
     breaks: AdBreak[];
@@ -32,16 +31,11 @@ interface StormcloudVideoPlayerConfig {
     onFullscreenToggle?: () => void;
     onControlClick?: () => void;
     licenseKey?: string;
-    adPlayerType?: 'ima' | 'hls';
-    vastTagUrl?: string;
-    vastMode?: 'adstorm' | 'default';
     minSegmentsBeforePlay?: number;
 }
-interface ImaController {
+interface AdController {
     initialize: () => void;
-    requestAds: (vastTagUrl: string) => Promise<void>;
-    preloadAds: (vastTagUrl: string) => Promise<void>;
-    hasPreloadedAd: (vastTagUrl: string) => boolean;
+    requestAds: (duration: string) => Promise<void>;
     play: () => Promise<void>;
     stop: () => Promise<void>;
     destroy: () => void;
@@ -57,7 +51,7 @@ interface ImaController {
     showPlaceholder: () => void;
     hidePlaceholder: () => void;
 }
-interface ImaControllerOptions {
+interface AdControllerOptions {
     maxRetries?: number;
     backoffBaseMs?: number;
 }
@@ -106,53 +100,21 @@ declare class StormcloudVideoPlayer {
     private readonly video;
     private readonly config;
     private hls?;
-    private ima;
+    private adPlayer;
     private attached;
     private inAdBreak;
-    private currentAdBreakStartWallClockMs;
     private expectedAdBreakDurationMs;
     private adStopTimerId;
-    private adStartTimerId;
-    private adFailsafeTimerId;
     private ptsDriftEmaMs;
-    private adPodQueue;
-    private apiVastTagUrl;
-    private apiNumberAds;
-    private lastHeartbeatTime;
-    private heartbeatInterval;
-    private currentAdIndex;
-    private totalAdsInBreak;
-    private showAds;
     private isLiveStream;
     private nativeHlsMode;
     private videoSrcProtection;
     private bufferedSegmentsCount;
     private shouldAutoplayAfterBuffering;
     private hasInitialBufferCompleted;
-    private adPodAllUrls;
-    private preloadingAdUrls;
-    private vastToMediaUrlMap;
-    private preloadedMediaUrls;
-    private preloadingMediaUrls;
-    private adRequestTokenCounter;
-    private activeAdRequestToken;
-    private adRequestWatchdogId;
-    private adRequestWatchdogToken;
-    private adFailsafeToken;
-    private fetchedAdDurations;
-    private targetAdBreakDurationMs;
-    private isAdaptiveMode;
-    private failedVastUrls;
-    private continuousFetchingActive;
-    private adRequestQueue;
-    private successfulAdRequests;
-    private maxPlaceholderDurationMs;
-    private placeholderStartTimeMs;
-    private isShowingPlaceholder;
     private timeUpdateHandler?;
     private emptiedHandler?;
     constructor(config: StormcloudVideoPlayerConfig);
-    private createAdPlayer;
     load(): Promise<void>;
     private attach;
     private shouldUseNativeHls;
@@ -160,58 +122,19 @@ declare class StormcloudVideoPlayer {
     private parseScte35FromId3;
     private decodeId3ValueToText;
     private onScte35Marker;
+    private handleAdStart;
     private parseCueOutDuration;
     private parseCueOutCont;
     private parseAttributeList;
     private toNumber;
-    private isManifestBasedMarker;
-    private parseScte35Binary;
-    private initializeTracking;
-    private sendHeartbeatIfNeeded;
-    private fetchAdConfiguration;
-    getCurrentAdIndex(): number;
-    getTotalAdsInBreak(): number;
-    private generateVastUrlsWithCorrelators;
-    isAdPlaying(): boolean;
-    isShowingAds(): boolean;
-    getStreamType(): "hls" | "other";
-    shouldShowNativeControls(): boolean;
-    private shouldContinueLiveStreamDuringAds;
-    private handleAdStart;
-    private startContinuousFetching;
-    private continuousFetchLoop;
-    private stopContinuousFetching;
-    private tryNextAvailableAd;
-    private showPlaceholderAndWaitForAds;
-    private findCurrentOrNextBreak;
-    private onTimeUpdate;
-    private handleMidAdJoin;
     private scheduleAdStopCountdown;
     private clearAdStopTimer;
-    private ensureAdStoppedByTimer;
-    private scheduleAdStartIn;
-    private clearAdStartTimer;
     private updatePtsDrift;
-    private playSingleAd;
     private handleAdPodComplete;
-    private handleAdFailure;
-    private startAdRequestWatchdog;
-    private clearAdRequestWatchdog;
-    private startAdFailsafeTimer;
-    private clearAdFailsafeTimer;
-    private selectVastTagsForBreak;
-    private logAdState;
-    private fetchAndParseVastXml;
-    private extractMediaUrlsFromVast;
-    private fetchVastDuration;
-    private calculateAdditionalAdsNeeded;
-    private addAdaptiveAdsToQueue;
-    private preloadMediaFile;
-    private preloadAllAdsInBackground;
-    private preloadSingleAd;
-    private findNextPreloadedAd;
-    private getRemainingAdMs;
-    private findBreakForTime;
+    isAdPlaying(): boolean;
+    isShowingAds(): boolean;
+    getStreamType(): "hls" | "other";
+    shouldShowNativeControls(): boolean;
     toggleMute(): void;
     toggleFullscreen(): Promise<void>;
     isMuted(): boolean;
@@ -222,6 +145,8 @@ declare class StormcloudVideoPlayer {
     get videoElement(): HTMLVideoElement;
     resize(): void;
     destroy(): void;
+    getCurrentAdIndex(): number;
+    getTotalAdsInBreak(): number;
 }
 
 type StormcloudVideoPlayerProps = Omit<StormcloudVideoPlayerConfig, "videoElement"> & React.VideoHTMLAttributes<HTMLVideoElement> & {
@@ -3849,34 +3774,26 @@ interface BrowserInfo {
     isSmartTV: boolean;
     isLegacyTV: boolean;
     platform: string;
-    supportsIMA: boolean;
     supportsModernJS: boolean;
-    recommendedAdPlayer: 'ima' | 'hls';
 }
 declare function detectBrowser(): BrowserInfo;
-declare function supportsGoogleIMA(): boolean;
-declare function getRecommendedAdPlayer(): 'ima' | 'hls';
 declare function supportsModernJS(): boolean;
 declare function logBrowserInfo(debug?: boolean): void;
 declare function getBrowserConfigOverrides(): {
-    adPlayerType?: 'ima' | 'hls';
     allowNativeHls?: boolean;
 };
 declare function supportsFeature(feature: string): boolean;
 
-declare global {
-    interface Window {
-        google?: any;
-    }
-}
-declare function createImaController(video: HTMLVideoElement, options?: {
-    continueLiveStreamDuringAds?: boolean;
-}): ImaController;
-
 declare function createHlsAdPlayer(contentVideo: HTMLVideoElement, options?: {
     continueLiveStreamDuringAds?: boolean;
     licenseKey?: string;
     mainHlsInstance?: Hls;
-}): ImaController;
+}): AdController;
+
+interface AdStormPlayerOptions {
+    licenseKey: string;
+    debug?: boolean;
+}
+declare function createAdStormPlayer(contentVideo: HTMLVideoElement, options: AdStormPlayerOptions): AdController;
 
-export { type AdBreak, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createHlsAdPlayer, createImaController, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, getRecommendedAdPlayer, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };
+export { type AdBreak, type AdController, type AdControllerOptions, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type LateJoinPolicy, type OnProgressProps, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createAdStormPlayer, createHlsAdPlayer, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode };

package/lib/index.d.ts

@@ -7,7 +7,6 @@ interface AdBreak {
     id?: string;
     startTimeMs: number;
     durationMs?: number;
-    vastTagUrl?: string;
 }
 interface AdSchedule {
     breaks: AdBreak[];
@@ -32,16 +31,11 @@ interface StormcloudVideoPlayerConfig {
     onFullscreenToggle?: () => void;
     onControlClick?: () => void;
     licenseKey?: string;
-    adPlayerType?: 'ima' | 'hls';
-    vastTagUrl?: string;
-    vastMode?: 'adstorm' | 'default';
     minSegmentsBeforePlay?: number;
 }
-interface ImaController {
+interface AdController {
     initialize: () => void;
-    requestAds: (vastTagUrl: string) => Promise<void>;
-    preloadAds: (vastTagUrl: string) => Promise<void>;
-    hasPreloadedAd: (vastTagUrl: string) => boolean;
+    requestAds: (duration: string) => Promise<void>;
     play: () => Promise<void>;
     stop: () => Promise<void>;
     destroy: () => void;
@@ -57,7 +51,7 @@ interface ImaController {
     showPlaceholder: () => void;
     hidePlaceholder: () => void;
 }
-interface ImaControllerOptions {
+interface AdControllerOptions {
     maxRetries?: number;
     backoffBaseMs?: number;
 }
@@ -106,53 +100,21 @@ declare class StormcloudVideoPlayer {
     private readonly video;
     private readonly config;
     private hls?;
-    private ima;
+    private adPlayer;
     private attached;
     private inAdBreak;
-    private currentAdBreakStartWallClockMs;
     private expectedAdBreakDurationMs;
     private adStopTimerId;
-    private adStartTimerId;
-    private adFailsafeTimerId;
     private ptsDriftEmaMs;
-    private adPodQueue;
-    private apiVastTagUrl;
-    private apiNumberAds;
-    private lastHeartbeatTime;
-    private heartbeatInterval;
-    private currentAdIndex;
-    private totalAdsInBreak;
-    private showAds;
     private isLiveStream;
     private nativeHlsMode;
     private videoSrcProtection;
     private bufferedSegmentsCount;
     private shouldAutoplayAfterBuffering;
     private hasInitialBufferCompleted;
-    private adPodAllUrls;
-    private preloadingAdUrls;
-    private vastToMediaUrlMap;
-    private preloadedMediaUrls;
-    private preloadingMediaUrls;
-    private adRequestTokenCounter;
-    private activeAdRequestToken;
-    private adRequestWatchdogId;
-    private adRequestWatchdogToken;
-    private adFailsafeToken;
-    private fetchedAdDurations;
-    private targetAdBreakDurationMs;
-    private isAdaptiveMode;
-    private failedVastUrls;
-    private continuousFetchingActive;
-    private adRequestQueue;
-    private successfulAdRequests;
-    private maxPlaceholderDurationMs;
-    private placeholderStartTimeMs;
-    private isShowingPlaceholder;
     private timeUpdateHandler?;
     private emptiedHandler?;
     constructor(config: StormcloudVideoPlayerConfig);
-    private createAdPlayer;
     load(): Promise<void>;
     private attach;
     private shouldUseNativeHls;
@@ -160,58 +122,19 @@ declare class StormcloudVideoPlayer {
     private parseScte35FromId3;
     private decodeId3ValueToText;
     private onScte35Marker;
+    private handleAdStart;
     private parseCueOutDuration;
     private parseCueOutCont;
     private parseAttributeList;
     private toNumber;
-    private isManifestBasedMarker;
-    private parseScte35Binary;
-    private initializeTracking;
-    private sendHeartbeatIfNeeded;
-    private fetchAdConfiguration;
-    getCurrentAdIndex(): number;
-    getTotalAdsInBreak(): number;
-    private generateVastUrlsWithCorrelators;
-    isAdPlaying(): boolean;
-    isShowingAds(): boolean;
-    getStreamType(): "hls" | "other";
-    shouldShowNativeControls(): boolean;
-    private shouldContinueLiveStreamDuringAds;
-    private handleAdStart;
-    private startContinuousFetching;
-    private continuousFetchLoop;
-    private stopContinuousFetching;
-    private tryNextAvailableAd;
-    private showPlaceholderAndWaitForAds;
-    private findCurrentOrNextBreak;
-    private onTimeUpdate;
-    private handleMidAdJoin;
     private scheduleAdStopCountdown;
     private clearAdStopTimer;
-    private ensureAdStoppedByTimer;
-    private scheduleAdStartIn;
-    private clearAdStartTimer;
     private updatePtsDrift;
-    private playSingleAd;
     private handleAdPodComplete;
-    private handleAdFailure;
-    private startAdRequestWatchdog;
-    private clearAdRequestWatchdog;
-    private startAdFailsafeTimer;
-    private clearAdFailsafeTimer;
-    private selectVastTagsForBreak;
-    private logAdState;
-    private fetchAndParseVastXml;
-    private extractMediaUrlsFromVast;
-    private fetchVastDuration;
-    private calculateAdditionalAdsNeeded;
-    private addAdaptiveAdsToQueue;
-    private preloadMediaFile;
-    private preloadAllAdsInBackground;
-    private preloadSingleAd;
-    private findNextPreloadedAd;
-    private getRemainingAdMs;
-    private findBreakForTime;
+    isAdPlaying(): boolean;
+    isShowingAds(): boolean;
+    getStreamType(): "hls" | "other";
+    shouldShowNativeControls(): boolean;
     toggleMute(): void;
     toggleFullscreen(): Promise<void>;
     isMuted(): boolean;
@@ -222,6 +145,8 @@ declare class StormcloudVideoPlayer {
     get videoElement(): HTMLVideoElement;
     resize(): void;
     destroy(): void;
+    getCurrentAdIndex(): number;
+    getTotalAdsInBreak(): number;
 }
 
 type StormcloudVideoPlayerProps = Omit<StormcloudVideoPlayerConfig, "videoElement"> & React.VideoHTMLAttributes<HTMLVideoElement> & {
@@ -3849,34 +3774,26 @@ interface BrowserInfo {
     isSmartTV: boolean;
     isLegacyTV: boolean;
     platform: string;
-    supportsIMA: boolean;
     supportsModernJS: boolean;
-    recommendedAdPlayer: 'ima' | 'hls';
 }
 declare function detectBrowser(): BrowserInfo;
-declare function supportsGoogleIMA(): boolean;
-declare function getRecommendedAdPlayer(): 'ima' | 'hls';
 declare function supportsModernJS(): boolean;
 declare function logBrowserInfo(debug?: boolean): void;
 declare function getBrowserConfigOverrides(): {
-    adPlayerType?: 'ima' | 'hls';
     allowNativeHls?: boolean;
 };
 declare function supportsFeature(feature: string): boolean;
 
-declare global {
-    interface Window {
-        google?: any;
-    }
-}
-declare function createImaController(video: HTMLVideoElement, options?: {
-    continueLiveStreamDuringAds?: boolean;
-}): ImaController;
-
 declare function createHlsAdPlayer(contentVideo: HTMLVideoElement, options?: {
     continueLiveStreamDuringAds?: boolean;
     licenseKey?: string;
     mainHlsInstance?: Hls;
-}): ImaController;
+}): AdController;
+
+interface AdStormPlayerOptions {
+    licenseKey: string;
+    debug?: boolean;
+}
+declare function createAdStormPlayer(contentVideo: HTMLVideoElement, options: AdStormPlayerOptions): AdController;
 
-export { type AdBreak, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createHlsAdPlayer, createImaController, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, getRecommendedAdPlayer, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };
+export { type AdBreak, type AdController, type AdControllerOptions, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type LateJoinPolicy, type OnProgressProps, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createAdStormPlayer, createHlsAdPlayer, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode };