stormcloud-video-player 0.2.12 → 0.2.14

package/lib/index.d.cts

@@ -1,5 +1,6 @@
 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 {
@@ -28,6 +29,28 @@ interface StormcloudVideoPlayerConfig {
     onFullscreenToggle?: () => void;
     onControlClick?: () => void;
     licenseKey?: string;
+    adPlayerType?: 'ima' | 'hls';
+    vastTagUrl?: string;
+    vastMode?: 'adstorm' | 'default';
+}
+interface ImaController {
+    initialize: () => void;
+    requestAds: (vastTagUrl: string) => Promise<void>;
+    play: () => Promise<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) => void;
+    getOriginalMutedState: () => boolean;
+    setAdVolume: (volume: number) => void;
+    getAdVolume: () => number;
+}
+interface ImaControllerOptions {
+    maxRetries?: number;
+    backoffBaseMs?: number;
 }
 interface ClientInfo {
     brand: string;
@@ -85,7 +108,6 @@ declare class StormcloudVideoPlayer {
     private ptsDriftEmaMs;
     private adPodQueue;
     private apiVastTagUrl;
-    private vastConfig;
     private lastHeartbeatTime;
     private heartbeatInterval;
     private currentAdIndex;
@@ -93,6 +115,7 @@ declare class StormcloudVideoPlayer {
     private showAds;
     private isLiveStream;
     constructor(config: StormcloudVideoPlayerConfig);
+    private createAdPlayer;
     load(): Promise<void>;
     private attach;
     private shouldUseNativeHls;
@@ -3744,4 +3767,56 @@ declare function getBrowserID(clientInfo: ClientInfo): Promise<string>;
 declare function sendInitialTracking(licenseKey?: string): Promise<void>;
 declare function sendHeartbeat(licenseKey?: string): Promise<void>;
 
-export { type AdBreak, type AdSchedule, type BaseStormcloudPlayerProps, 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, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, getBrowserID, getClientInfo, isMediaStream, lazy, merge, omit, parseQuery, players, randomString, sendHeartbeat, sendInitialTracking, supportsWebKitPresentationMode };
+declare function initializePolyfills(): void;
+
+interface NavigatorUAData {
+    platform?: string;
+    brands?: Array<{
+        brand: string;
+        version: string;
+    }>;
+    mobile?: boolean;
+}
+declare global {
+    interface Navigator {
+        userAgentData?: NavigatorUAData;
+    }
+}
+interface BrowserInfo {
+    name: string;
+    version: string;
+    majorVersion: number;
+    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;
+
+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 };

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 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 {
@@ -28,6 +29,28 @@ interface StormcloudVideoPlayerConfig {
     onFullscreenToggle?: () => void;
     onControlClick?: () => void;
     licenseKey?: string;
+    adPlayerType?: 'ima' | 'hls';
+    vastTagUrl?: string;
+    vastMode?: 'adstorm' | 'default';
+}
+interface ImaController {
+    initialize: () => void;
+    requestAds: (vastTagUrl: string) => Promise<void>;
+    play: () => Promise<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) => void;
+    getOriginalMutedState: () => boolean;
+    setAdVolume: (volume: number) => void;
+    getAdVolume: () => number;
+}
+interface ImaControllerOptions {
+    maxRetries?: number;
+    backoffBaseMs?: number;
 }
 interface ClientInfo {
     brand: string;
@@ -85,7 +108,6 @@ declare class StormcloudVideoPlayer {
     private ptsDriftEmaMs;
     private adPodQueue;
     private apiVastTagUrl;
-    private vastConfig;
     private lastHeartbeatTime;
     private heartbeatInterval;
     private currentAdIndex;
@@ -93,6 +115,7 @@ declare class StormcloudVideoPlayer {
     private showAds;
     private isLiveStream;
     constructor(config: StormcloudVideoPlayerConfig);
+    private createAdPlayer;
     load(): Promise<void>;
     private attach;
     private shouldUseNativeHls;
@@ -3744,4 +3767,56 @@ declare function getBrowserID(clientInfo: ClientInfo): Promise<string>;
 declare function sendInitialTracking(licenseKey?: string): Promise<void>;
 declare function sendHeartbeat(licenseKey?: string): Promise<void>;
 
-export { type AdBreak, type AdSchedule, type BaseStormcloudPlayerProps, 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, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, getBrowserID, getClientInfo, isMediaStream, lazy, merge, omit, parseQuery, players, randomString, sendHeartbeat, sendInitialTracking, supportsWebKitPresentationMode };
+declare function initializePolyfills(): void;
+
+interface NavigatorUAData {
+    platform?: string;
+    brands?: Array<{
+        brand: string;
+        version: string;
+    }>;
+    mobile?: boolean;
+}
+declare global {
+    interface Navigator {
+        userAgentData?: NavigatorUAData;
+    }
+}
+interface BrowserInfo {
+    name: string;
+    version: string;
+    majorVersion: number;
+    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;
+
+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 };