stormcloud-video-player 0.3.60 → 0.3.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/dist/stormcloud-vp.min.js +1 -1
  2. package/lib/index.cjs +445 -359
  3. package/lib/index.cjs.map +1 -1
  4. package/lib/index.d.cts +26 -16
  5. package/lib/index.d.ts +26 -16
  6. package/lib/index.js +445 -359
  7. package/lib/index.js.map +1 -1
  8. package/lib/player/StormcloudVideoPlayer.cjs +265 -224
  9. package/lib/player/StormcloudVideoPlayer.cjs.map +1 -1
  10. package/lib/player/StormcloudVideoPlayer.d.cts +1 -1
  11. package/lib/players/HlsPlayer.cjs +265 -224
  12. package/lib/players/HlsPlayer.cjs.map +1 -1
  13. package/lib/players/HlsPlayer.d.cts +1 -1
  14. package/lib/players/index.cjs +265 -224
  15. package/lib/players/index.cjs.map +1 -1
  16. package/lib/sdk/hlsAdPlayer.d.cts +1 -1
  17. package/lib/sdk/ima.d.cts +1 -1
  18. package/lib/{types-Vj55FghO.d.cts → types-BJPNhfLV.d.cts} +14 -4
  19. package/lib/ui/StormcloudVideoPlayer.cjs +445 -359
  20. package/lib/ui/StormcloudVideoPlayer.cjs.map +1 -1
  21. package/lib/ui/StormcloudVideoPlayer.d.cts +1 -1
  22. package/lib/utils/tracking.cjs +210 -217
  23. package/lib/utils/tracking.cjs.map +1 -1
  24. package/lib/utils/tracking.d.cts +11 -13
  25. package/package.json +1 -1
package/lib/index.d.cts CHANGED
@@ -20,6 +20,7 @@ interface StormcloudVideoPlayerConfig {
20
20
  muted?: boolean;
21
21
  allowNativeHls?: boolean;
22
22
  lowLatencyMode?: boolean;
23
+ isLiveStream?: boolean;
23
24
  driftToleranceMs?: number;
24
25
  immediateManifestAds?: boolean;
25
26
  debugAdTiming?: boolean;
@@ -98,27 +99,38 @@ interface ClientInfo {
98
99
  interface TrackingData extends ClientInfo {
99
100
  browserId: string;
100
101
  }
102
+ interface PlayerAnalyticsContext {
103
+ inputStreamType?: string;
104
+ }
101
105
  interface HeartbeatData {
102
106
  browserId: string;
107
+ player_id: string;
108
+ device_type: ClientInfo["deviceType"];
109
+ input_stream_type?: string;
110
+ os: string;
111
+ ad_loaded?: boolean;
112
+ ad_detect?: boolean;
113
+ license_key?: string;
114
+ capture_at: string;
103
115
  timestamp: string;
104
116
  }
105
117
  interface AdDetectInfo {
106
- source: string;
118
+ source: "scte35";
107
119
  durationSeconds?: number;
108
120
  ptsSeconds?: number;
109
121
  detectedAtFragmentSn?: number;
110
122
  timestamp: string;
111
123
  }
112
- type AdTrackingSource = "prebid" | "ima" | "hls";
113
124
  interface AdLoadedInfo {
114
- source: AdTrackingSource;
125
+ source: "vast" | "ima" | "hls";
115
126
  vastUrl?: string;
116
127
  durationSeconds?: number;
117
128
  timestamp: string;
118
129
  }
119
130
  interface AdImpressionInfo {
120
- source: AdTrackingSource;
131
+ source: "vast" | "ima" | "hls";
121
132
  adIndex: number;
133
+ adUrl?: string;
122
134
  durationSeconds?: number;
123
135
  timestamp: string;
124
136
  }
@@ -4050,18 +4062,16 @@ declare const SUPPORTS_DASH: () => boolean;
4050
4062
 
4051
4063
  declare function getClientInfo(): ClientInfo;
4052
4064
  declare function getBrowserID(clientInfo: ClientInfo): Promise<string>;
4053
- declare function sendInitialTracking(licenseKey?: string): Promise<void>;
4054
- declare function sendHeartbeat(licenseKey?: string): Promise<void>;
4055
- declare function sendAdDetectTracking(licenseKey: string | undefined, payload: Omit<AdDetectInfo, "source" | "timestamp"> & Partial<Pick<AdDetectInfo, "source" | "timestamp">>): Promise<void>;
4056
- declare function sendAdLoadedTracking(licenseKey: string | undefined, payload: Omit<AdLoadedInfo, "timestamp" | "source"> & {
4057
- source?: AdTrackingSource | string;
4058
- }, adPlayerType?: "ima" | "hls"): Promise<void>;
4059
- type AdImpressionTrackingPayload = {
4060
- adIndex: number;
4061
- source?: AdTrackingSource | string;
4062
- durationSeconds?: number;
4065
+ type PlayerMetricFlags = {
4066
+ adLoaded?: boolean;
4067
+ adDetect?: boolean;
4068
+ captureAt?: string;
4063
4069
  };
4064
- declare function sendAdImpressionTracking(licenseKey: string | undefined, payload: AdImpressionTrackingPayload, adPlayerType?: "ima" | "hls"): Promise<void>;
4070
+ declare function sendInitialTracking(licenseKey?: string, context?: PlayerAnalyticsContext): Promise<void>;
4071
+ declare function sendAdDetectTracking(licenseKey: string | undefined, adDetectInfo: AdDetectInfo, context?: PlayerAnalyticsContext): Promise<void>;
4072
+ declare function sendAdLoadedTracking(licenseKey: string | undefined, adLoadedInfo: AdLoadedInfo, context?: PlayerAnalyticsContext): Promise<void>;
4073
+ declare function sendAdImpressionTracking(licenseKey: string | undefined, adImpressionInfo: AdImpressionInfo, context?: PlayerAnalyticsContext): Promise<void>;
4074
+ declare function sendHeartbeat(licenseKey?: string, context?: PlayerAnalyticsContext, flags?: PlayerMetricFlags): Promise<void>;
4065
4075
 
4066
4076
  declare function initializePolyfills(): void;
4067
4077
 
@@ -4118,4 +4128,4 @@ declare function createHlsAdPlayer(contentVideo: HTMLVideoElement, options?: {
4118
4128
  mainHlsInstance?: Hls;
4119
4129
  }): ImaController;
4120
4130
 
4121
- export { type AdBreak, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type AdTrackingSource, 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, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };
4131
+ export { type AdBreak, 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 PlayerAnalyticsContext, 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, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };
package/lib/index.d.ts CHANGED
@@ -20,6 +20,7 @@ interface StormcloudVideoPlayerConfig {
20
20
  muted?: boolean;
21
21
  allowNativeHls?: boolean;
22
22
  lowLatencyMode?: boolean;
23
+ isLiveStream?: boolean;
23
24
  driftToleranceMs?: number;
24
25
  immediateManifestAds?: boolean;
25
26
  debugAdTiming?: boolean;
@@ -98,27 +99,38 @@ interface ClientInfo {
98
99
  interface TrackingData extends ClientInfo {
99
100
  browserId: string;
100
101
  }
102
+ interface PlayerAnalyticsContext {
103
+ inputStreamType?: string;
104
+ }
101
105
  interface HeartbeatData {
102
106
  browserId: string;
107
+ player_id: string;
108
+ device_type: ClientInfo["deviceType"];
109
+ input_stream_type?: string;
110
+ os: string;
111
+ ad_loaded?: boolean;
112
+ ad_detect?: boolean;
113
+ license_key?: string;
114
+ capture_at: string;
103
115
  timestamp: string;
104
116
  }
105
117
  interface AdDetectInfo {
106
- source: string;
118
+ source: "scte35";
107
119
  durationSeconds?: number;
108
120
  ptsSeconds?: number;
109
121
  detectedAtFragmentSn?: number;
110
122
  timestamp: string;
111
123
  }
112
- type AdTrackingSource = "prebid" | "ima" | "hls";
113
124
  interface AdLoadedInfo {
114
- source: AdTrackingSource;
125
+ source: "vast" | "ima" | "hls";
115
126
  vastUrl?: string;
116
127
  durationSeconds?: number;
117
128
  timestamp: string;
118
129
  }
119
130
  interface AdImpressionInfo {
120
- source: AdTrackingSource;
131
+ source: "vast" | "ima" | "hls";
121
132
  adIndex: number;
133
+ adUrl?: string;
122
134
  durationSeconds?: number;
123
135
  timestamp: string;
124
136
  }
@@ -4050,18 +4062,16 @@ declare const SUPPORTS_DASH: () => boolean;
4050
4062
 
4051
4063
  declare function getClientInfo(): ClientInfo;
4052
4064
  declare function getBrowserID(clientInfo: ClientInfo): Promise<string>;
4053
- declare function sendInitialTracking(licenseKey?: string): Promise<void>;
4054
- declare function sendHeartbeat(licenseKey?: string): Promise<void>;
4055
- declare function sendAdDetectTracking(licenseKey: string | undefined, payload: Omit<AdDetectInfo, "source" | "timestamp"> & Partial<Pick<AdDetectInfo, "source" | "timestamp">>): Promise<void>;
4056
- declare function sendAdLoadedTracking(licenseKey: string | undefined, payload: Omit<AdLoadedInfo, "timestamp" | "source"> & {
4057
- source?: AdTrackingSource | string;
4058
- }, adPlayerType?: "ima" | "hls"): Promise<void>;
4059
- type AdImpressionTrackingPayload = {
4060
- adIndex: number;
4061
- source?: AdTrackingSource | string;
4062
- durationSeconds?: number;
4065
+ type PlayerMetricFlags = {
4066
+ adLoaded?: boolean;
4067
+ adDetect?: boolean;
4068
+ captureAt?: string;
4063
4069
  };
4064
- declare function sendAdImpressionTracking(licenseKey: string | undefined, payload: AdImpressionTrackingPayload, adPlayerType?: "ima" | "hls"): Promise<void>;
4070
+ declare function sendInitialTracking(licenseKey?: string, context?: PlayerAnalyticsContext): Promise<void>;
4071
+ declare function sendAdDetectTracking(licenseKey: string | undefined, adDetectInfo: AdDetectInfo, context?: PlayerAnalyticsContext): Promise<void>;
4072
+ declare function sendAdLoadedTracking(licenseKey: string | undefined, adLoadedInfo: AdLoadedInfo, context?: PlayerAnalyticsContext): Promise<void>;
4073
+ declare function sendAdImpressionTracking(licenseKey: string | undefined, adImpressionInfo: AdImpressionInfo, context?: PlayerAnalyticsContext): Promise<void>;
4074
+ declare function sendHeartbeat(licenseKey?: string, context?: PlayerAnalyticsContext, flags?: PlayerMetricFlags): Promise<void>;
4065
4075
 
4066
4076
  declare function initializePolyfills(): void;
4067
4077
 
@@ -4118,4 +4128,4 @@ declare function createHlsAdPlayer(contentVideo: HTMLVideoElement, options?: {
4118
4128
  mainHlsInstance?: Hls;
4119
4129
  }): ImaController;
4120
4130
 
4121
- export { type AdBreak, type AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type AdTrackingSource, 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, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };
4131
+ export { type AdBreak, 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 PlayerAnalyticsContext, 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, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsGoogleIMA, supportsModernJS, supportsWebKitPresentationMode };