stormcloud-video-player 0.7.49 → 0.7.51

package/lib/index.d.cts

@@ -1,6 +1,25 @@
 import React, { CSSProperties, lazy as lazy$1 } from 'react';
 import * as csstype from 'csstype';
 
+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 LateJoinPolicy = "play_remaining" | "skip_to_content";
 interface AdBreak {
     id?: string;
@@ -37,6 +56,7 @@ interface StormcloudVideoPlayerConfig {
     singlePipelineMode?: boolean;
     projectId?: string;
     channelId?: number;
+    mqttConfig?: Partial<MQTTConfig>;
 }
 interface AdController {
     initialize: () => void;
@@ -94,8 +114,39 @@ 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 AdDetectInfo {
+    source: "scte35";
+    durationSeconds?: number;
+    ptsSeconds?: number;
+    detectedAtFragmentSn?: number;
+    timestamp: string;
+}
+interface AdLoadedInfo {
+    source: "vast" | "ima" | "hls";
+    vastUrl?: string;
+    durationSeconds?: number;
+    timestamp: string;
+}
+interface AdImpressionInfo {
+    source: "vast" | "ima" | "hls";
+    adIndex: number;
+    adUrl?: string;
+    durationSeconds?: number;
     timestamp: string;
 }
 interface VastBidResponse {
@@ -199,6 +250,7 @@ declare class StormcloudVideoPlayer {
     setDisableAds(disabled: boolean): void;
     private syncMainContentAudioWhenVisible;
     getStreamType(): "hls" | "other";
+    private getPlayerAnalyticsContext;
     shouldShowNativeControls(): boolean;
     private shouldContinueLiveStreamDuringAds;
     private startAdPrefetch;
@@ -4013,8 +4065,26 @@ 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>;
+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>;
+
+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 const OVERLAY_API_BASE = "https://adstorm.co/api-adstorm-dev";
 interface OverlayCoordinateSpace {
@@ -4142,4 +4212,4 @@ interface AdStormAdLayer extends AdController {
 }
 declare function createAdStormPlayer(contentVideo: HTMLVideoElement, options: AdStormPlayerOptions): AdStormAdLayer;
 
-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 AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type AdStormAdLayer, type AdStormLayerOptionsUpdate, type AdStormPlayerOptions, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, DEFAULT_MQTT_CONFIG, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type LateJoinPolicy, type MQTTConfig, type MQTTStatus, MQTT_CA_CERT_FILE, OVERLAY_API_BASE, type OnProgressProps, type OverlayCoordinateSpace, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type SwirlOverlay, type SwirlOverlayType, type SwirlScrollerConfig, type TrackingData, type VastBidResponse, applyMQTTConfig, buildMQTTBrokerUrl, buildPlayerTopic, canPlay, configureMQTT, createAdStormPlayer, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, disconnectMQTT, ensureMQTTClient, fetchProjectOverlays, getBrowserConfigOverrides, getBrowserID, getClientInfo, getMQTTStatus, initMQTTClient, initializePolyfills, isMQTTConfigured, isMQTTConnected, isMQTTEnabled, isMediaStream, isOverlayActive, lazy, logBrowserInfo, merge, mqttConfig, normalizeSwirlOverlay, omit, parseQuery, players, publishMQTT, randomString, resolveImageUrl, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, timeStringToSeconds };

package/lib/index.d.ts

@@ -1,6 +1,25 @@
 import React, { CSSProperties, lazy as lazy$1 } from 'react';
 import * as csstype from 'csstype';
 
+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 LateJoinPolicy = "play_remaining" | "skip_to_content";
 interface AdBreak {
     id?: string;
@@ -37,6 +56,7 @@ interface StormcloudVideoPlayerConfig {
     singlePipelineMode?: boolean;
     projectId?: string;
     channelId?: number;
+    mqttConfig?: Partial<MQTTConfig>;
 }
 interface AdController {
     initialize: () => void;
@@ -94,8 +114,39 @@ 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 AdDetectInfo {
+    source: "scte35";
+    durationSeconds?: number;
+    ptsSeconds?: number;
+    detectedAtFragmentSn?: number;
+    timestamp: string;
+}
+interface AdLoadedInfo {
+    source: "vast" | "ima" | "hls";
+    vastUrl?: string;
+    durationSeconds?: number;
+    timestamp: string;
+}
+interface AdImpressionInfo {
+    source: "vast" | "ima" | "hls";
+    adIndex: number;
+    adUrl?: string;
+    durationSeconds?: number;
     timestamp: string;
 }
 interface VastBidResponse {
@@ -199,6 +250,7 @@ declare class StormcloudVideoPlayer {
     setDisableAds(disabled: boolean): void;
     private syncMainContentAudioWhenVisible;
     getStreamType(): "hls" | "other";
+    private getPlayerAnalyticsContext;
     shouldShowNativeControls(): boolean;
     private shouldContinueLiveStreamDuringAds;
     private startAdPrefetch;
@@ -4013,8 +4065,26 @@ 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>;
+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>;
+
+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 const OVERLAY_API_BASE = "https://adstorm.co/api-adstorm-dev";
 interface OverlayCoordinateSpace {
@@ -4142,4 +4212,4 @@ interface AdStormAdLayer extends AdController {
 }
 declare function createAdStormPlayer(contentVideo: HTMLVideoElement, options: AdStormPlayerOptions): AdStormAdLayer;
 
-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 AdDetectInfo, type AdImpressionInfo, type AdLoadedInfo, type AdSchedule, type AdStormAdLayer, type AdStormLayerOptionsUpdate, type AdStormPlayerOptions, type BaseStormcloudPlayerProps, type BrowserInfo, type ClientInfo, DEFAULT_MQTT_CONFIG, type HeartbeatData, IS_BROWSER, IS_GLOBAL, IS_IOS, IS_SAFARI, type LateJoinPolicy, type MQTTConfig, type MQTTStatus, MQTT_CA_CERT_FILE, OVERLAY_API_BASE, type OnProgressProps, type OverlayCoordinateSpace, type PlayerAnalyticsContext, SUPPORTS_DASH, SUPPORTS_HLS, StormcloudPlayer, StormcloudVideoPlayer, StormcloudVideoPlayerComponent, type StormcloudVideoPlayerConfig, type StormcloudVideoPlayerProps, type SwirlOverlay, type SwirlOverlayType, type SwirlScrollerConfig, type TrackingData, type VastBidResponse, applyMQTTConfig, buildMQTTBrokerUrl, buildPlayerTopic, canPlay, configureMQTT, createAdStormPlayer, createStormcloudPlayer, StormcloudVideoPlayerComponent as default, detectBrowser, disconnectMQTT, ensureMQTTClient, fetchProjectOverlays, getBrowserConfigOverrides, getBrowserID, getClientInfo, getMQTTStatus, initMQTTClient, initializePolyfills, isMQTTConfigured, isMQTTConnected, isMQTTEnabled, isMediaStream, isOverlayActive, lazy, logBrowserInfo, merge, mqttConfig, normalizeSwirlOverlay, omit, parseQuery, players, publishMQTT, randomString, resolveImageUrl, sendAdDetectTracking, sendAdImpressionTracking, sendAdLoadedTracking, sendHeartbeat, sendInitialTracking, supportsFeature, supportsModernJS, supportsWebKitPresentationMode, timeStringToSeconds };