stormcloud-video-player 0.7.49 → 0.8.0

package/lib/index.d.ts

@@ -1,11 +1,13 @@
 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 {
     id?: string;
     startTimeMs: number;
     durationMs?: number;
+    vastTagUrl?: string;
 }
 interface AdSchedule {
     breaks: AdBreak[];
@@ -30,17 +32,14 @@ interface StormcloudVideoPlayerConfig {
     onFullscreenToggle?: () => void;
     onControlClick?: () => void;
     licenseKey?: string;
+    vastTagUrl?: string;
+    vmapUrl?: string;
+    vastMode?: 'adstorm' | 'default';
     minSegmentsBeforePlay?: number;
-    disableAds?: boolean;
-    disableFiller?: boolean;
-    adTransitionGapMs?: number;
-    singlePipelineMode?: boolean;
-    projectId?: string;
-    channelId?: number;
 }
 interface AdController {
     initialize: () => void;
-    requestAds: () => Promise<void>;
+    requestAds: (vastTagUrl: string) => Promise<void>;
     play: () => Promise<void>;
     pause: () => void;
     resume: () => void;
@@ -58,6 +57,12 @@ interface AdController {
     showPlaceholder: () => void;
     hidePlaceholder: () => void;
 }
+type ImaController = AdController;
+interface AdControllerOptions {
+    maxRetries?: number;
+    backoffBaseMs?: number;
+}
+type ImaControllerOptions = AdControllerOptions;
 interface ClientInfo {
     brand: string;
     os: string;
@@ -94,40 +99,60 @@ interface ClientInfo {
 interface TrackingData extends ClientInfo {
     browserId: string;
 }
+interface PlayerAnalyticsContext {
+    inputStreamType?: string;
+}
 interface HeartbeatData {
     browserId: string;
+    player_id: string;
+    device_type: ClientInfo["deviceType"];
+    input_stream_type?: string;
+    os: string;
+    ad_loaded?: boolean;
+    ad_detect?: boolean;
+    license_key?: string;
+    capture_at: string;
     timestamp: string;
 }
-interface VastBidResponse {
-    bidder: string;
-    cpm: number;
+interface AdDetectInfo {
+    source: "scte35";
+    durationSeconds?: number;
+    ptsSeconds?: number;
+    detectedAtFragmentSn?: number;
+    timestamp: string;
+}
+interface AdLoadedInfo {
+    source: "vast" | "hls";
     vastUrl?: string;
-    vastXml?: string;
-    width: number;
-    height: number;
-    adId: string;
-    impId: string;
-    creativeId: string;
-    currency: string;
-    adomain?: string[];
-    durationSec?: number;
+    durationSeconds?: number;
+    timestamp: string;
+}
+interface AdImpressionInfo {
+    source: "vast" | "hls";
+    adIndex: number;
+    adUrl?: string;
+    durationSeconds?: number;
+    timestamp: string;
 }
 
-type DebugLogLevel = "info" | "warn" | "error";
 declare class StormcloudVideoPlayer {
     private readonly video;
     private readonly config;
     private hls?;
-    private adLayer;
-    private pendingNextAdBids;
-    private continuousFetchLoopPromise;
+    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 vmapBreaks;
+    private consumedVmapBreakIds;
     private lastHeartbeatTime;
     private heartbeatInterval;
     private currentAdIndex;
@@ -139,115 +164,164 @@ declare class StormcloudVideoPlayer {
     private bufferedSegmentsCount;
     private shouldAutoplayAfterBuffering;
     private hasInitialBufferCompleted;
+    private adRequestTokenCounter;
     private activeAdRequestToken;
     private adRequestWatchdogId;
     private adRequestWatchdogToken;
     private adFailsafeToken;
+    private failedVastUrls;
+    private temporaryFailureUrls;
+    private readonly temporaryFailureCooldownMs;
     private continuousFetchingActive;
-    private isInAdTransition;
+    private adRequestQueue;
     private maxPlaceholderDurationMs;
     private isShowingPlaceholder;
     private timeUpdateHandler?;
     private emptiedHandler?;
-    private adInsertionPollingId;
-    private lastAdInsertionPoint;
-    private processedAdInsertionUpdatedAt;
-    private adInsertionOffsetTimerId;
+    private readonly tsScte35Pids;
+    private readonly pmtPids;
+    private readonly processedTsScte35Sections;
+    private readonly pendingScte35Cues;
+    private readonly recentScte35CueKeys;
+    private readonly recentScte35CueLimit;
+    private pendingScte35CueKey;
+    private activeScte35BreakKey;
+    private scheduledScte35BreakKey;
     private totalAdRequestsInBreak;
     private readonly maxTotalAdRequestsPerBreak;
     private pendingAdBreak;
     private prefetchTimerId;
-    private savedMutedStateBeforeAd;
-    private adLayerInitialized;
     private consecutiveFailures;
     private readonly maxConsecutiveFailures;
     private lastAdRequestTime;
     private readonly minAdRequestIntervalMs;
     private readonly backoffBaseMs;
     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 adInsertionDebugHistory;
+    private placeholderContainer;
+    private globalConsecutiveNoFills;
+    private readonly globalNoFillThreshold;
+    private globalNoFillCooldownUntil;
+    private readonly globalNoFillBackoffBaseMs;
+    private readonly globalNoFillBackoffMaxMs;
+    private globalLastGamRequestTime;
+    private readonly globalMinGamIntervalMs;
+    private preloadPool;
+    private readonly maxPreloadPoolSize;
+    private preloadPoolActive;
+    private preloadPoolLoopRunning;
+    private adDetectSentForCurrentBreak;
+    private palNonce;
+    private palPlaybackStarted;
     constructor(config: StormcloudVideoPlayerConfig);
-    private adRequest;
+    private createAdPlayer;
     load(): Promise<void>;
-    private getAdSource;
-    private attachAdLayerEventListeners;
-    private ensureFillerVideo;
+    private attachImaEventListeners;
+    private recreateAdController;
+    private ensurePlaceholderContainer;
     private showPlaceholderLayer;
     private hidePlaceholderLayer;
-    private startFillerBreakTimer;
-    private stopFillerBreakTimer;
     private attach;
     private shouldUseNativeHls;
+    private onId3Tag;
+    private parseScte35FromId3;
+    private decodeId3ValueToText;
+    private createScte35CueContext;
+    private getFragmentStartSeconds;
+    private onScte35Cue;
+    private createScte35Cue;
+    private getScte35CueKey;
+    private getPendingScte35CueKey;
+    private getScte35MarkerRaw;
+    private toIdentityString;
+    private isStrongScte35CueKey;
+    private hasRecentlyHandledScte35Cue;
+    private markScte35CueHandled;
+    private trimRecentScte35CueMaps;
+    private shouldAcceptScte35EndCue;
+    private activatePendingScte35CuesForFragment;
+    private onScte35Marker;
+    private startScte35AdBreak;
+    private parseCueOutDuration;
+    private parseCueOutCont;
+    private parseAttributeList;
+    private toNumber;
+    private isManifestBasedMarker;
+    private normalizeFragmentPayload;
+    private processFragmentScte35Payload;
+    private parseScte35FromTsPackets;
+    private detectTsPacketFormat;
+    private parsePatSection;
+    private parsePmtSection;
+    private descriptorsIdentifyScte35;
+    private collectScte35SectionsFromPayload;
+    private appendScte35Bytes;
+    private addScte35SectionMarker;
+    private hasProcessedTsScte35Section;
+    private getPsiSectionStart;
+    private getPsiSectionLength;
+    private parseScte35Binary;
+    private parseScte35SegmentationDescriptors;
+    private parseScte35SegmentationDescriptor;
+    private markerTypeFromSegmentationTypeId;
     private initializeTracking;
     private sendHeartbeatIfNeeded;
+    private fetchAdConfiguration;
+    private fetchAndParseVmap;
+    private parseVmapToBreaks;
+    private parseVmapTimeOffsetToMs;
+    private getAdBreakKey;
+    private resolveBreakStartMs;
     getCurrentAdIndex(): number;
     getTotalAdsInBreak(): number;
-    getRemainingAdSeconds(): number;
+    getAdRemainingMs(): number;
+    private generateVastUrlsWithCorrelators;
     isAdPlaying(): boolean;
     isShowingAds(): boolean;
-    isInAdBreak(): boolean;
-    private initializeAdLayer;
-    setDisableAds(disabled: boolean): void;
-    private syncMainContentAudioWhenVisible;
     getStreamType(): "hls" | "other";
     shouldShowNativeControls(): boolean;
     private shouldContinueLiveStreamDuringAds;
     private startAdPrefetch;
-    private runAdPrefetch;
     private clearPendingAdBreak;
-    private cancelAndClearPreloadedTokens;
-    private startAdInsertionPolling;
-    private stopAdInsertionPolling;
-    private fetchAdInsertionPoint;
-    private checkAdInsertionInManifest;
-    private extractTsFilename;
-    private fragmentMatchesSegment;
-    private clearAdInsertionOffsetTimer;
-    private startContinuousFetchLoop;
-    private runContinuousFetchLoop;
+    private startPreloadPool;
+    private preloadAdIntoPool;
+    private preloadPoolLoop;
+    private getPreloadedAd;
+    private stopPreloadPool;
     private handleAdStart;
+    private continuousFetchLoopRunning;
+    private startContinuousFetching;
+    private continuousFetchLoop;
     private stopContinuousFetching;
     private tryNextAvailableAdWithRateLimit;
     private tryNextAvailableAd;
     private showPlaceholderAndWaitForAds;
+    private findCurrentOrNextBreak;
     private onTimeUpdate;
+    private handleMidAdJoin;
     private scheduleAdStopCountdown;
     private clearAdStopTimer;
     private ensureAdStoppedByTimer;
+    private scheduleAdStartIn;
+    private clearAdStartTimer;
+    private updatePtsDrift;
+    private isTemporaryAdError;
+    private isUrlInCooldown;
+    private cleanupTemporaryFailures;
+    private isGamInCooldown;
+    private recordGamNoFill;
+    private resetGamNoFillCounter;
+    private enforceGlobalRateLimit;
+    private playSingleAd;
     private handleAdPodComplete;
     private handleAdFailure;
     private startAdRequestWatchdog;
     private clearAdRequestWatchdog;
     private startAdFailsafeTimer;
     private clearAdFailsafeTimer;
+    private selectVastTagsForBreak;
     private logAdState;
     private getRemainingAdMs;
-    private pushDebugLog;
-    private pushAdInsertionDebug;
-    getAdInsertionDebugLog(): ReadonlyArray<{
-        timestampMs: number;
-        event: string;
-        segmentName: string;
-        offsetSeconds?: number;
-        updatedAt?: string;
-        detail?: string;
-    }>;
-    getDebugLogs(): ReadonlyArray<{
-        timestampMs: number;
-        level: DebugLogLevel;
-        category: string;
-        message: string;
-        details?: Record<string, unknown>;
-    }>;
+    private findBreakForTime;
     toggleMute(): void;
     toggleFullscreen(): Promise<void>;
     isMuted(): boolean;
@@ -256,15 +330,6 @@ declare class StormcloudVideoPlayer {
     getVolume(): number;
     isFullscreen(): boolean;
     isLive(): boolean;
-    getMinHlsResolution(): {
-        width: number;
-        height: number;
-    } | null;
-    getMaxHlsResolution(): {
-        width: number;
-        height: number;
-    } | null;
-    getCurrentHlsSegmentDurationMs(): number | null;
     get videoElement(): HTMLVideoElement;
     resize(): void;
     destroy(): void;
@@ -275,19 +340,6 @@ type StormcloudVideoPlayerProps = Omit<StormcloudVideoPlayerConfig, "videoElemen
     wrapperClassName?: string;
     wrapperStyle?: React.CSSProperties;
     licenseKey?: string;
-    swirlProjectId?: number;
-    swirlShowcaseDemo?: boolean;
-    swirlOverlayApiBaseUrl?: string;
-    swirlOverlayCoordinateSpace?: {
-        width: number;
-        height: number;
-    } | null;
-    adcisionChannelId?: number;
-    disableOverlays?: boolean;
-    showAdsControl?: boolean;
-    showOverlaysControl?: boolean;
-    showAiContextControl?: boolean;
-    showDebugControl?: boolean;
 };
 declare const StormcloudVideoPlayerComponent: React.FC<StormcloudVideoPlayerProps>;
 
@@ -324,10 +376,9 @@ interface BaseStormcloudPlayerProps {
     showCustomControls?: boolean;
     hideLoadingIndicator?: boolean;
     licenseKey?: string;
+    vmapUrl?: string;
     adFailsafeTimeoutMs?: number;
     minSegmentsBeforePlay?: number;
-    disableAds?: boolean;
-    disableFiller?: boolean;
     onReady?: (player: StormcloudVideoPlayer) => void;
     onStart?: () => void;
     onPlay?: () => void;
@@ -4013,77 +4064,16 @@ declare const SUPPORTS_DASH: () => boolean;
 
 declare function getClientInfo(): ClientInfo;
 declare function getBrowserID(clientInfo: ClientInfo): Promise<string>;
-declare function sendInitialTracking(licenseKey?: string): Promise<void>;
-declare function sendHeartbeat(licenseKey?: string): Promise<void>;
-
-declare const OVERLAY_API_BASE = "https://adstorm.co/api-adstorm-dev";
-interface OverlayCoordinateSpace {
-    width: number;
-    height: number;
-}
-interface SwirlScrollerConfig {
-    rss_url?: string;
-    update_interval?: number;
-    scroll_speed?: number;
-    direction?: string;
-    font_size?: number;
-    font_family?: string;
-    font_weight?: string;
-    text_color?: string;
-    background_color?: string;
-    background_opacity?: number;
-    border_color?: string;
-    border_width?: number;
-    border_radius?: number;
-    padding?: number;
-    margin?: number;
-    show_title?: boolean;
-    show_description?: boolean;
-    show_timestamp?: boolean;
-    show_author?: boolean;
-    show_category?: boolean;
-    max_items?: number;
-    item_spacing?: number;
-    fade_in_out?: boolean;
-    fade_distance?: number;
-    auto_refresh?: boolean;
-    use_custom_text?: boolean;
-    custom_text?: string;
-    label?: string;
-    label_line2?: string;
-    label_color?: string;
-    label_text_color?: string;
-    accent_color?: string;
-    show_accent_line?: boolean;
-    separator_char?: string;
-    preset?: string;
-}
-type SwirlOverlayType = "image" | "text" | "scroller" | "shape" | "score_bug" | "lower_third" | "qr_code" | "coming_up_next" | "contextual_trigger" | "odds_betting" | "breaking_news" | "countdown";
-interface SwirlOverlay {
-    id: number;
-    project_id: number;
-    name: string;
-    type: SwirlOverlayType | string;
-    visible: boolean;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    opacity: number;
-    start_time: string;
-    duration: string;
-    content?: string;
-    image_url?: string;
-    scroller_config?: SwirlScrollerConfig;
-    z_index: number;
-    created_at?: string;
-    updated_at?: string;
-}
-declare function timeStringToSeconds(timeStr: string): number;
-declare function isOverlayActive(overlay: SwirlOverlay, currentTime: number): boolean;
-declare function normalizeSwirlOverlay(raw: SwirlOverlay & Record<string, unknown>): SwirlOverlay;
-declare function fetchProjectOverlays(projectId: number, apiBaseUrl?: string): Promise<SwirlOverlay[]>;
-declare function resolveImageUrl(imageUrl: string, apiBaseUrl?: string): string;
+type PlayerMetricFlags = {
+    adLoaded?: boolean;
+    adDetect?: boolean;
+    captureAt?: string;
+};
+declare function sendInitialTracking(licenseKey?: string, context?: PlayerAnalyticsContext): Promise<void>;
+declare function sendAdDetectTracking(licenseKey: string | undefined, adDetectInfo: AdDetectInfo, context?: PlayerAnalyticsContext): Promise<void>;
+declare function sendAdLoadedTracking(licenseKey: string | undefined, adLoadedInfo: AdLoadedInfo, context?: PlayerAnalyticsContext): Promise<void>;
+declare function sendAdImpressionTracking(licenseKey: string | undefined, adImpressionInfo: AdImpressionInfo, context?: PlayerAnalyticsContext): Promise<void>;
+declare function sendHeartbeat(licenseKey?: string, context?: PlayerAnalyticsContext, flags?: PlayerMetricFlags): Promise<void>;
 
 declare function initializePolyfills(): void;
 
@@ -4107,39 +4097,50 @@ interface BrowserInfo {
     isSmartTV: boolean;
     isLegacyTV: boolean;
     platform: string;
-    supportsIMA: boolean;
     supportsModernJS: boolean;
-    recommendedAdPlayer: 'ima' | 'hls';
     webOSVersion?: number | undefined;
     tizenVersion?: number | undefined;
     chromeVersion?: number | undefined;
 }
 declare function detectBrowser(): BrowserInfo;
-declare function supportsModernJS(): boolean;
-declare function logBrowserInfo(debug?: boolean): void;
 declare function getBrowserConfigOverrides(): {
     allowNativeHls?: boolean;
 };
+declare function supportsModernJS(): boolean;
+declare function logBrowserInfo(debug?: boolean): void;
 declare function supportsFeature(feature: string): boolean;
 
-interface AdStormPlayerOptions {
-    licenseKey: string;
-    debug?: boolean;
-    channelId?: number;
-}
-interface AdStormLayerOptionsUpdate {
+declare function createHlsAdPlayer(contentVideo: HTMLVideoElement, options?: {
     continueLiveStreamDuringAds?: boolean;
-    mainHlsInstance?: unknown;
+    licenseKey?: string;
+    mainHlsInstance?: Hls;
+}): AdController;
+
+declare global {
+    interface Window {
+        goog?: any;
+    }
+}
+interface PalNonceOptions {
+    videoWidth?: number;
+    videoHeight?: number;
+    descriptionUrl?: string;
+    ppid?: string;
+    sessionId?: string;
+    adWillAutoPlay?: boolean;
+    adWillPlayMuted?: boolean;
+    continuousPlayback?: boolean;
 }
-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;
+interface PalNonceManager {
+    generateNonce(options?: PalNonceOptions): Promise<string>;
+    getCurrentNonce(): string;
+    injectNonce(vastTagUrl: string): string;
+    sendPlaybackStart(): void;
+    sendPlaybackEnd(): void;
+    sendAdClick(): void;
+    sendAdTouch(event: MouseEvent | TouchEvent): void;
+    reset(): void;
 }
-declare function createAdStormPlayer(contentVideo: HTMLVideoElement, options: AdStormPlayerOptions): AdStormAdLayer;
+declare function createPalNonceManager(): PalNonceManager;
 
-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, OVERLAY_API_BASE, 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, normalizeSwirlOverlay, omit, parseQuery, players, randomString, resolveImageUrl, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, timeStringToSeconds };
+export { type AdBreak, type AdController, type AdControllerOptions, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, 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, type PalNonceManager, type PalNonceOptions, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, canPlay, createHlsAdPlayer, createPalNonceManager, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, getBrowserConfigOverrides, getBrowserID, getClientInfo, initializePolyfills, isMediaStream, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode };