stormcloud-video-player 0.8.3 → 0.8.5

package/lib/index.d.cts

@@ -34,9 +34,14 @@ interface StormcloudVideoPlayerConfig {
     onControlClick?: () => void;
     licenseKey?: string;
     vastTagUrl?: string;
+    isVmap?: boolean;
     vmapUrl?: string;
     vastMode?: 'adstorm' | 'default';
     minSegmentsBeforePlay?: number;
+    deviceId?: string;
+    deviceIdType?: string;
+    limitAdTracking?: boolean;
+    adTest?: boolean;
 }
 interface AdController {
     initialize: () => void;
@@ -178,6 +183,7 @@ declare class StormcloudVideoPlayer {
     private maxPlaceholderDurationMs;
     private isShowingPlaceholder;
     private timeUpdateHandler?;
+    private endedHandler?;
     private emptiedHandler?;
     private readonly tsScte35Pids;
     private readonly pmtPids;
@@ -213,6 +219,11 @@ declare class StormcloudVideoPlayer {
     private adDetectSentForCurrentBreak;
     private palNonce;
     private palPlaybackStarted;
+    private readonly streamCorrelator;
+    private consentSignals;
+    private podCounter;
+    private podAssignedByPrefetch;
+    private adRequestPositionInBreak;
     constructor(config: StormcloudVideoPlayerConfig);
     private createAdPlayer;
     load(): Promise<void>;
@@ -266,6 +277,7 @@ declare class StormcloudVideoPlayer {
     private markerTypeFromSegmentationTypeId;
     private initializeTracking;
     private sendHeartbeatIfNeeded;
+    private isVmapEnabled;
     private fetchAdConfiguration;
     private fetchAndParseVmap;
     private parseVmapToBreaks;
@@ -275,6 +287,7 @@ declare class StormcloudVideoPlayer {
     getCurrentAdIndex(): number;
     getTotalAdsInBreak(): number;
     getAdRemainingMs(): number;
+    private beginNewAdPod;
     private generateVastUrlsWithCorrelators;
     isAdPlaying(): boolean;
     isShowingAds(): boolean;
@@ -298,7 +311,8 @@ declare class StormcloudVideoPlayer {
     private showPlaceholderAndWaitForAds;
     private findCurrentOrNextBreak;
     private onTimeUpdate;
-    private handleMidAdJoin;
+    private onVideoEnded;
+    private handleVmapAdBreak;
     private scheduleAdStopCountdown;
     private clearAdStopTimer;
     private ensureAdStoppedByTimer;
@@ -377,6 +391,7 @@ interface BaseStormcloudPlayerProps {
     showCustomControls?: boolean;
     hideLoadingIndicator?: boolean;
     licenseKey?: string;
+    isVmap?: boolean;
     vmapUrl?: string;
     adFailsafeTimeoutMs?: number;
     minSegmentsBeforePlay?: number;
@@ -4076,6 +4091,35 @@ declare function sendAdLoadedTracking(licenseKey: string | undefined, adLoadedIn
 declare function sendAdImpressionTracking(licenseKey: string | undefined, adImpressionInfo: AdImpressionInfo, context?: PlayerAnalyticsContext): Promise<void>;
 declare function sendHeartbeat(licenseKey?: string, context?: PlayerAnalyticsContext, flags?: PlayerMetricFlags): Promise<void>;
 
+declare const MQTT_CA_CERT_FILE = "src/certs/emqxsl-ca.crt";
+type MQTTConfig = {
+    enabled: boolean;
+    brokerAddress: string;
+    brokerPort: number;
+    wsPort: number;
+    username: string;
+    password: string;
+    topicPrefix: string;
+    qos: 0 | 1 | 2;
+    brokerUrl?: string;
+};
+declare const DEFAULT_MQTT_CONFIG: MQTTConfig;
+declare const mqttConfig: MQTTConfig;
+declare function applyMQTTConfig(overrides: Partial<MQTTConfig>): void;
+declare function isMQTTEnabled(): boolean;
+declare function buildMQTTBrokerUrl(): string;
+declare function buildPlayerTopic(licenseKey: string, channel: "metrics" | "impressions" | "heartbeat"): string;
+
+type MQTTStatus = "disconnected" | "connecting" | "connected" | "error";
+declare function getMQTTStatus(): MQTTStatus;
+declare function isMQTTConnected(): boolean;
+declare function isMQTTConfigured(): boolean;
+declare function configureMQTT(overrides: Partial<MQTTConfig>): void;
+declare function initMQTTClient(): void;
+declare function ensureMQTTClient(): void;
+declare function publishMQTT(topic: string, payload: Record<string, unknown>): boolean;
+declare function disconnectMQTT(): void;
+
 declare function initializePolyfills(): void;
 
 interface NavigatorUAData {
@@ -4144,4 +4188,4 @@ interface PalNonceManager {
 }
 declare function createPalNonceManager(): PalNonceManager;
 
-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 };
+export { type AdBreak, type AdController, type AdControllerOptions, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, DEFAULT_MQTT_CONFIG, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type MQTTConfig, type MQTTStatus, MQTT_CA_CERT_FILE, type OnProgressProps, type PalNonceManager, type PalNonceOptions, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, applyMQTTConfig, buildMQTTBrokerUrl, buildPlayerTopic, canPlay, configureMQTT, createHlsAdPlayer, createPalNonceManager, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, disconnectMQTT, ensureMQTTClient, getBrowserConfigOverrides, getBrowserID, getClientInfo, getMQTTStatus, initMQTTClient, initializePolyfills, isMQTTConfigured, isMQTTConnected, isMQTTEnabled, isMediaStream, lazy, logBrowserInfo, merge, mqttConfig, omit, parseQuery, players, publishMQTT, randomString, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode };

package/lib/index.d.ts

@@ -34,9 +34,14 @@ interface StormcloudVideoPlayerConfig {
     onControlClick?: () => void;
     licenseKey?: string;
     vastTagUrl?: string;
+    isVmap?: boolean;
     vmapUrl?: string;
     vastMode?: 'adstorm' | 'default';
     minSegmentsBeforePlay?: number;
+    deviceId?: string;
+    deviceIdType?: string;
+    limitAdTracking?: boolean;
+    adTest?: boolean;
 }
 interface AdController {
     initialize: () => void;
@@ -178,6 +183,7 @@ declare class StormcloudVideoPlayer {
     private maxPlaceholderDurationMs;
     private isShowingPlaceholder;
     private timeUpdateHandler?;
+    private endedHandler?;
     private emptiedHandler?;
     private readonly tsScte35Pids;
     private readonly pmtPids;
@@ -213,6 +219,11 @@ declare class StormcloudVideoPlayer {
     private adDetectSentForCurrentBreak;
     private palNonce;
     private palPlaybackStarted;
+    private readonly streamCorrelator;
+    private consentSignals;
+    private podCounter;
+    private podAssignedByPrefetch;
+    private adRequestPositionInBreak;
     constructor(config: StormcloudVideoPlayerConfig);
     private createAdPlayer;
     load(): Promise<void>;
@@ -266,6 +277,7 @@ declare class StormcloudVideoPlayer {
     private markerTypeFromSegmentationTypeId;
     private initializeTracking;
     private sendHeartbeatIfNeeded;
+    private isVmapEnabled;
     private fetchAdConfiguration;
     private fetchAndParseVmap;
     private parseVmapToBreaks;
@@ -275,6 +287,7 @@ declare class StormcloudVideoPlayer {
     getCurrentAdIndex(): number;
     getTotalAdsInBreak(): number;
     getAdRemainingMs(): number;
+    private beginNewAdPod;
     private generateVastUrlsWithCorrelators;
     isAdPlaying(): boolean;
     isShowingAds(): boolean;
@@ -298,7 +311,8 @@ declare class StormcloudVideoPlayer {
     private showPlaceholderAndWaitForAds;
     private findCurrentOrNextBreak;
     private onTimeUpdate;
-    private handleMidAdJoin;
+    private onVideoEnded;
+    private handleVmapAdBreak;
     private scheduleAdStopCountdown;
     private clearAdStopTimer;
     private ensureAdStoppedByTimer;
@@ -377,6 +391,7 @@ interface BaseStormcloudPlayerProps {
     showCustomControls?: boolean;
     hideLoadingIndicator?: boolean;
     licenseKey?: string;
+    isVmap?: boolean;
     vmapUrl?: string;
     adFailsafeTimeoutMs?: number;
     minSegmentsBeforePlay?: number;
@@ -4076,6 +4091,35 @@ declare function sendAdLoadedTracking(licenseKey: string | undefined, adLoadedIn
 declare function sendAdImpressionTracking(licenseKey: string | undefined, adImpressionInfo: AdImpressionInfo, context?: PlayerAnalyticsContext): Promise<void>;
 declare function sendHeartbeat(licenseKey?: string, context?: PlayerAnalyticsContext, flags?: PlayerMetricFlags): Promise<void>;
 
+declare const MQTT_CA_CERT_FILE = "src/certs/emqxsl-ca.crt";
+type MQTTConfig = {
+    enabled: boolean;
+    brokerAddress: string;
+    brokerPort: number;
+    wsPort: number;
+    username: string;
+    password: string;
+    topicPrefix: string;
+    qos: 0 | 1 | 2;
+    brokerUrl?: string;
+};
+declare const DEFAULT_MQTT_CONFIG: MQTTConfig;
+declare const mqttConfig: MQTTConfig;
+declare function applyMQTTConfig(overrides: Partial<MQTTConfig>): void;
+declare function isMQTTEnabled(): boolean;
+declare function buildMQTTBrokerUrl(): string;
+declare function buildPlayerTopic(licenseKey: string, channel: "metrics" | "impressions" | "heartbeat"): string;
+
+type MQTTStatus = "disconnected" | "connecting" | "connected" | "error";
+declare function getMQTTStatus(): MQTTStatus;
+declare function isMQTTConnected(): boolean;
+declare function isMQTTConfigured(): boolean;
+declare function configureMQTT(overrides: Partial<MQTTConfig>): void;
+declare function initMQTTClient(): void;
+declare function ensureMQTTClient(): void;
+declare function publishMQTT(topic: string, payload: Record<string, unknown>): boolean;
+declare function disconnectMQTT(): void;
+
 declare function initializePolyfills(): void;
 
 interface NavigatorUAData {
@@ -4144,4 +4188,4 @@ interface PalNonceManager {
 }
 declare function createPalNonceManager(): PalNonceManager;
 
-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 };
+export { type AdBreak, type AdController, type AdControllerOptions, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, DEFAULT_MQTT_CONFIG, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type ImaController, type ImaControllerOptions, type LateJoinPolicy, type MQTTConfig, type MQTTStatus, MQTT_CA_CERT_FILE, type OnProgressProps, type PalNonceManager, type PalNonceOptions, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type TrackingData, applyMQTTConfig, buildMQTTBrokerUrl, buildPlayerTopic, canPlay, configureMQTT, createHlsAdPlayer, createPalNonceManager, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, disconnectMQTT, ensureMQTTClient, getBrowserConfigOverrides, getBrowserID, getClientInfo, getMQTTStatus, initMQTTClient, initializePolyfills, isMQTTConfigured, isMQTTConnected, isMQTTEnabled, isMediaStream, lazy, logBrowserInfo, merge, mqttConfig, omit, parseQuery, players, publishMQTT, randomString, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode };