stormcloud-video-player 0.8.72 → 0.8.74

package/lib/index.d.cts

@@ -2,6 +2,7 @@ export { StormcloudVideoPlayerComponent, StormcloudVideoPlayerProps, StormcloudV
 export { default as StormcloudPlayer, createStormcloudPlayer } from './StormcloudPlayer.cjs';
 export { StormcloudVideoPlayer } from './player/StormcloudVideoPlayer.cjs';
 export { AdBreak, AdController, AdControllerOptions, AdDetectInfo, AdFloorLadderConfig, AdImpressionInfo, AdLoadedInfo, AdPosition, AdSchedule, ClientInfo, FloorLadderMode, HeartbeatData, ImaController, ImaControllerOptions, LateJoinPolicy, PlayerAnalyticsContext, StormcloudVideoPlayerConfig, TrackingData } from './types.cjs';
+export { AdPodConfig, DEFAULT_REQUEST_SAFETY_MS, GAM_AD_OPPORTUNITY_DURATION_MS, OptimizedPodDiagnostics, PodResponseDiagnostics } from './player/OptimizedPodRequest.cjs';
 export { DEFAULT_FLOOR_LADDER_BOUNDS, DEFAULT_WEB_FLOOR_LADDER_CONFIG, FloorLadderBounds, FloorLadderValidationReport, FloorSelectionContext, FloorSelector, FloorSelectorResult, FloorSource, FloorValidation, OpportunityFloor, fixedFloorSelector, generateFloorLevels, resolveFloorLadderBounds, validateFloorCents, validateFloorLadderConfig } from './player/FloorLadder.cjs';
 export { BaseStormcloudPlayerProps, OnProgressProps } from './props.cjs';
 export { canPlay } from './patterns.cjs';

package/lib/index.d.ts

@@ -2,6 +2,37 @@ import React, { CSSProperties, lazy as lazy$1 } from 'react';
 import * as csstype from 'csstype';
 import Hls from 'hls.js';
 
+interface AdPodConfig {
+    requestSafetyMs?: number;
+    minPodDurationMs?: number;
+    maxAdsPerBreak?: number | null;
+    maxPodDurationMs?: number;
+}
+declare const DEFAULT_REQUEST_SAFETY_MS = 1500;
+declare const GAM_AD_OPPORTUNITY_DURATION_MS = 30000;
+type PmxdSource = "break_remaining" | "configured_cap" | "tag_cap";
+interface OptimizedPodDiagnostics {
+    breakId: number;
+    optimizedPod: boolean;
+    pmxdSource: PmxdSource | undefined;
+    scteBreakDurationMs: number | undefined;
+    elapsedBeforeGamRequestMs: number | undefined;
+    remainingAtGamDispatchMs: number | undefined;
+    safetyReserveMs: number;
+    pmndSent: number | undefined;
+    pmxdSent: number | undefined;
+    pmadSent: number | undefined;
+    palNoncePresent: boolean;
+    gamRequestDispatchTimestamp: string;
+    strippedMacros: string[];
+}
+interface PodResponseDiagnostics {
+    vastAdCount: number;
+    totalVastCreativeDurationMs: number;
+    estimatedUnusedPodMs: number;
+    estimatedUnmatchedCount: number;
+}
+
 type LateJoinPolicy = "play_remaining" | "skip_to_content";
 interface AdBreak {
     id?: string;
@@ -41,12 +72,13 @@ interface StormcloudVideoPlayerConfig {
     vastTagUrl?: string;
     isVmap?: boolean;
     vmapUrl?: string;
-    vastMode?: 'adstorm' | 'default';
     minSegmentsBeforePlay?: number;
     ctvAdRequest?: boolean;
     adTest?: boolean;
     programTitle?: string;
     channelName?: string;
+    contentNetwork?: string;
+    adPodConfig?: AdPodConfig;
     podMaxAds?: number;
     podMaxDurationMs?: number;
     podExactDuration?: boolean;
@@ -77,6 +109,7 @@ interface AdFloorLadderConfig {
 type AdRequestSource = "gam" | "edge";
 interface AdRequestOptions {
     source?: AdRequestSource;
+    finalizeRequestUrl?: (vastTagUrl: string, attempt: number) => string;
 }
 interface AdController {
     initialize: () => void;
@@ -154,6 +187,9 @@ interface TrackingData extends ClientInfo {
 interface PlayerAnalyticsContext {
     inputStreamType?: string;
     debugAdTiming?: boolean;
+    contentNetwork?: string;
+    contentChannel?: string;
+    contentTitle?: string;
 }
 interface HeartbeatData {
     browserId: string;
@@ -4038,7 +4074,7 @@ declare const IS_SAFARI: boolean;
 declare const SUPPORTS_HLS: () => boolean;
 declare const SUPPORTS_DASH: () => boolean;
 
-declare function buildAnalyticsContext(config: Pick<StormcloudVideoPlayerConfig, "debugAdTiming" | "isLiveStream">): PlayerAnalyticsContext;
+declare function buildAnalyticsContext(config: Pick<StormcloudVideoPlayerConfig, "debugAdTiming" | "isLiveStream" | "contentNetwork" | "channelName" | "programTitle">): PlayerAnalyticsContext;
 declare function getClientInfo(): ClientInfo;
 declare function getBrowserID(clientInfo: ClientInfo): Promise<string>;
 type PlayerMetricFlags = {
@@ -4128,6 +4164,7 @@ interface PalNonceOptions {
 interface PalNonceManager {
     generateNonce(options?: PalNonceOptions): Promise<string>;
     getCurrentNonce(): string;
+    waitForNonce(maxWaitMs: number): Promise<string>;
     injectNonce(vastTagUrl: string): string;
     sendPlaybackStart(): void;
     sendPlaybackEnd(): void;
@@ -4137,4 +4174,4 @@ interface PalNonceManager {
 }
 declare function createPalNonceManager(): PalNonceManager;
 
-export { type AdBreak, type AdController, type AdControllerOptions, type AdDetectInfo, type AdFloorLadderConfig, type AdImpressionInfo, type AdLoadedInfo, type AdPosition, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, DEFAULT_FLOOR_LADDER_BOUNDS, DEFAULT_TRACKING_INGEST_CONFIG, DEFAULT_WEB_FLOOR_LADDER_CONFIG, type FloorLadderBounds, type FloorLadderMode, type FloorLadderValidationReport, type FloorSelectionContext, type FloorSelector, type FloorSelectorResult, type FloorSource, type FloorValidation, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, type OpportunityFloor, type PalNonceManager, type PalNonceOptions, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, type TrackingIngestChannel, type TrackingIngestConfig, applyTrackingIngestConfig, buildAnalyticsContext, canPlay, configureTrackingIngest, createHlsAdPlayer, createPalNonceManager, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, fixedFloorSelector, generateFloorLevels, getBrowserConfigOverrides, getBrowserID, getClientInfo, ingestPlayerTracking, initializePolyfills, isMediaStream, isTrackingIngestEnabled, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, requiresMediaPipelineResetAfterAds, resolveFloorLadderBounds, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, trackingIngestConfig, validateFloorCents, validateFloorLadderConfig };
+export { type AdBreak, type AdController, type AdControllerOptions, type AdDetectInfo, type AdFloorLadderConfig, type AdImpressionInfo, type AdLoadedInfo, type AdPodConfig, type AdPosition, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, DEFAULT_FLOOR_LADDER_BOUNDS, DEFAULT_REQUEST_SAFETY_MS, DEFAULT_TRACKING_INGEST_CONFIG, DEFAULT_WEB_FLOOR_LADDER_CONFIG, type FloorLadderBounds, type FloorLadderMode, type FloorLadderValidationReport, type FloorSelectionContext, type FloorSelector, type FloorSelectorResult, type FloorSource, type FloorValidation, GAM_AD_OPPORTUNITY_DURATION_MS, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type OnProgressProps, type OpportunityFloor, type OptimizedPodDiagnostics, type PalNonceManager, type PalNonceOptions, type PlayerAnalyticsContext, type PodResponseDiagnostics, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, type TrackingIngestChannel, type TrackingIngestConfig, applyTrackingIngestConfig, buildAnalyticsContext, canPlay, configureTrackingIngest, createHlsAdPlayer, createPalNonceManager, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, fixedFloorSelector, generateFloorLevels, getBrowserConfigOverrides, getBrowserID, getClientInfo, ingestPlayerTracking, initializePolyfills, isMediaStream, isTrackingIngestEnabled, lazy, logBrowserInfo, merge, omit, parseQuery, players, randomString, requiresMediaPipelineResetAfterAds, resolveFloorLadderBounds, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, trackingIngestConfig, validateFloorCents, validateFloorLadderConfig };