bitmovin-analytics 2.28.1 → 2.29.0-beta2

package/js/types/CustomDataValues.d.ts

@@ -1,41 +0,0 @@
-export interface CustomDataValues {
-    customData1?: string;
-    customData2?: string;
-    customData3?: string;
-    customData4?: string;
-    customData5?: string;
-    customData6?: string;
-    customData7?: string;
-    customData8?: string;
-    customData9?: string;
-    customData10?: string;
-    customData11?: string;
-    customData12?: string;
-    customData13?: string;
-    customData14?: string;
-    customData15?: string;
-    customData16?: string;
-    customData17?: string;
-    customData18?: string;
-    customData19?: string;
-    customData20?: string;
-    customData21?: string;
-    customData22?: string;
-    customData23?: string;
-    customData24?: string;
-    customData25?: string;
-    customData26?: string;
-    customData27?: string;
-    customData28?: string;
-    customData29?: string;
-    customData30?: string;
-    experimentName?: string;
-}
-/**
- * Lists all keys of the {@see CustomDataValues} interface.
- */
-export declare const customDataValuesKeys: Array<keyof CustomDataValues>;
-/**
- * The number of CustomDataXX fields in {@see CustomDataValues}.
- */
-export declare const customDataFieldCount: number;

package/js/types/DownloadSpeedInfo.d.ts

@@ -1,30 +0,0 @@
-export interface DownloadSpeedInfo {
-    /**
-     * Number of completed segment downloads
-     */
-    segmentsDownloadCount: number;
-    /**
-     * Total download size in bytes
-     */
-    segmentsDownloadSize: number;
-    /**
-     * Total time spent downloading segments in milliseconds
-     */
-    segmentsDownloadTime: number;
-    /**
-     * Average download speed in kbps
-     */
-    avgDownloadSpeed: number;
-    /**
-     * Maximum download speed in kbps
-     */
-    maxDownloadSpeed: number;
-    /**
-     * Minimum download speed in kbps
-     */
-    minDownloadSpeed: number;
-    /**
-     * Average time to first byte in milliseconds
-     */
-    avgTimeToFirstByte: number;
-}

package/js/types/DrmPerformanceInfo.d.ts

@@ -1,4 +0,0 @@
-export interface DrmPerformanceInfo {
-    readonly drmType: string;
-    readonly drmLoadTime: number;
-}

package/js/types/EventData.d.ts

@@ -1,28 +0,0 @@
-import { VideoStartFailedReason } from '../enums/VideoStartFailedReason';
-import { ErrorData } from '../features/errordetails/ErrorData';
-import { AnalyticsConfig } from './AnalyticsConfig';
-export interface AnalyticsEventBase {
-    currentTime?: number;
-}
-export interface SourceChangeEvent extends AnalyticsEventBase {
-    config: AnalyticsConfig;
-}
-export interface ErrorEvent extends AnalyticsEventBase {
-    code: number | undefined;
-    message: string | undefined;
-    legacyData?: any;
-    data: ErrorData;
-}
-export interface AudioChangeEvent extends AnalyticsEventBase {
-    bitrate?: number;
-    codec?: string;
-}
-export interface VideoChangeEvent extends AnalyticsEventBase {
-    bitrate?: number;
-    height?: number;
-    width?: number;
-    codec?: string;
-}
-export interface VideoStartFailedEvent extends AnalyticsEventBase {
-    reason: VideoStartFailedReason;
-}

package/js/types/FeatureConfigContainer.d.ts

@@ -1,4 +0,0 @@
-import { ErrorDetailTrackingConfig } from '../features/errordetails/ErrorDetailTrackingConfig';
-export interface FeatureConfigContainer {
-    errorDetails?: ErrorDetailTrackingConfig;
-}

package/js/types/LicensingRequest.d.ts

@@ -1,17 +0,0 @@
-import { FeatureConfigContainer } from './FeatureConfigContainer';
-export interface LicensingRequest {
-    key?: string;
-    domain: string;
-    version: string;
-}
-export declare enum LicensingResult {
-    Granted = "granted",
-    Denied = "denied",
-    Skip = "skip"
-}
-export interface LicensingResponse {
-    status: LicensingResult;
-    message: string;
-    features?: FeatureConfigContainer;
-}
-export declare type LicenseCallFunc = (key: string, domain: string, version: string, baseUrl: string) => Promise<LicensingResponse>;

package/js/types/NoExtraProperties.d.ts

@@ -1,5 +0,0 @@
-declare type Impossible<K extends keyof any> = {
-    [P in K]: never;
-};
-export declare type NoExtraProperties<T, U extends T = T> = U & Impossible<Exclude<keyof U, keyof T>>;
-export {};

package/js/types/PlaybackInfo.d.ts

@@ -1,29 +0,0 @@
-import { PlayerSize } from '../enums/PlayerSize';
-export interface PlaybackInfo {
-    isLive?: boolean;
-    playerTech?: string;
-    videoDuration?: number;
-    streamFormat?: string;
-    progUrl?: string;
-    m3u8Url?: string;
-    mpdUrl?: string;
-    videoWindowWidth?: number;
-    videoWindowHeight?: number;
-    isMuted?: boolean;
-    videoBitrate?: number;
-    audioBitrate?: number;
-    droppedFrames: number;
-    isCasting?: boolean;
-    castTech?: string;
-    screenHeight?: number;
-    screenWidth?: number;
-    videoPlaybackHeight?: number;
-    videoPlaybackWidth?: number;
-    videoTitle?: string;
-    size?: PlayerSize;
-    audioCodec?: string;
-    videoCodec?: string;
-    audioLanguage?: string;
-    subtitleEnabled?: boolean;
-    subtitleLanguage?: string;
-}

package/js/types/ProgressiveSourceConfig.d.ts

@@ -1,5 +0,0 @@
-export interface ProgressiveSourceObject {
-    url: string;
-    bitrate?: number;
-}
-export declare type ProgressiveSourceConfig = ProgressiveSourceObject | ProgressiveSourceObject[] | string | undefined;

package/js/types/QualityLevelInfo.d.ts

@@ -1,5 +0,0 @@
-export interface QualityLevelInfo {
-    width?: number;
-    height?: number;
-    bitrate?: number;
-}

package/js/types/Sample.d.ts

@@ -1,74 +0,0 @@
-import { CustomDataValues } from './CustomDataValues';
-import { DownloadSpeedInfo } from './DownloadSpeedInfo';
-export interface Sample extends CustomDataValues {
-    platform: string;
-    sequenceNumber?: number;
-    domain?: any;
-    path?: string;
-    language?: string;
-    userAgent?: string;
-    screenWidth?: number;
-    screenHeight?: number;
-    isLive?: boolean;
-    isCasting?: boolean;
-    castTech?: string;
-    videoDuration?: number;
-    size?: string;
-    time?: number;
-    videoWindowWidth?: number;
-    videoWindowHeight?: number;
-    droppedFrames?: number;
-    played?: number;
-    buffered?: number;
-    paused?: number;
-    ad?: number;
-    seeked?: number;
-    videoPlaybackWidth?: number;
-    videoPlaybackHeight?: number;
-    videoBitrate?: number;
-    audioBitrate?: number;
-    videoTimeStart?: number;
-    videoTimeEnd?: number;
-    videoStartupTime?: number;
-    duration?: number;
-    startupTime?: number;
-    analyticsVersion?: any;
-    playerStartupTime: number;
-    pageLoadType: number;
-    streamFormat?: string;
-    isMuted?: boolean;
-    progUrl?: string;
-    m3u8Url?: string;
-    mpdUrl?: string;
-    playerTech?: string;
-    version?: string;
-    player?: any;
-    state?: string;
-    impressionId?: string;
-    userId?: string;
-    errorMessage?: any;
-    errorCode?: any;
-    errorData?: string;
-    videoStartFailed?: boolean;
-    videoStartFailedReason?: string;
-    autoplay?: any;
-    pageLoadTime: number;
-    key?: string;
-    playerKey?: any;
-    cdnProvider?: any;
-    videoId?: string;
-    videoTitle?: string;
-    customUserId?: string;
-    drmType?: string;
-    drmLoadTime?: number;
-    subtitleEnabled?: boolean;
-    subtitleLanguage?: string;
-    downloadSpeedInfo?: DownloadSpeedInfo;
-    errorSegments?: any[];
-    audioCodec?: string;
-    videoCodec?: string;
-    supportedVideoCodecs?: string[];
-    audioLanguage?: string;
-    completed?: number;
-    completedTotal?: number;
-}

package/js/types/SegmentInfo.d.ts

@@ -1,5 +0,0 @@
-export interface SegmentInfo {
-    name: string;
-    timestamp: number;
-    url: string;
-}

package/js/types/SourceInfo.d.ts

@@ -1,13 +0,0 @@
-export interface SourceInfo {
-    videoId?: string;
-    userId?: string;
-    mpdUrl?: string;
-    m3u8Url?: string;
-    progUrl?: string;
-    progBitrate?: number;
-    title?: string;
-}
-export interface ProgressiveSourceInfo {
-    progUrl?: string;
-    progBitrate?: number;
-}

package/js/types/SpeedMeasurement.d.ts

@@ -1,25 +0,0 @@
-/**
- * Represents one download speed measurement
- */
-export interface SpeedMeasurement {
-    /**
-     * Download time in seconds
-     */
-    duration: number;
-    /**
-     * Bytes downloaded
-     */
-    size: number;
-    /**
-     * Time to first byte of this download
-     */
-    timeToFirstByte: number;
-    /**
-     * Time the download finished
-     */
-    timestamp: Date;
-    /**
-     * HTTP Status of the download measurement
-     */
-    httpStatus: number;
-}

package/js/types/StateMachineCallbacks.d.ts

@@ -1,47 +0,0 @@
-import { AnalyticsConfig } from './AnalyticsConfig';
-import { CustomDataValues } from './CustomDataValues';
-import * as EventData from './EventData';
-import { Sample } from './Sample';
-export interface StateMachineCallbacks {
-    setup: (duration: number, state: string) => void;
-    startup: (duration: number, state: string) => void;
-    playing: (duration: number, state: string) => void;
-    heartbeat: (duration: number, state: string, payload: Pick<Sample, 'played'> | Pick<Sample, 'buffered'>) => void;
-    qualitychange: (duration: number, state: string) => void;
-    qualitychange_pause: (duration: number, state: string) => void;
-    qualitychange_rebuffering: (duration: number, state: string) => void;
-    videoChange: (event: any) => void;
-    audioChange: (event: any) => void;
-    audiotrack_changing: () => void;
-    pause: (duration: number, state: string) => void;
-    paused_seeking: (duration: number, state: string) => void;
-    end_play_seeking: (duration: number, state: string) => void;
-    rebuffering: (duration: number, state: string) => void;
-    error: (event: Readonly<EventData.ErrorEvent>) => void;
-    end: (duration: number, state: string) => void;
-    unload: (duration: number, state: string) => void;
-    ad: (duration: number, state: string) => void;
-    mute: () => void;
-    unMute: () => void;
-    subtitle_changing: () => void;
-    setVideoTimeEndFromEvent: (event: any) => void;
-    setVideoTimeStartFromEvent: (event: any) => void;
-    videoStartFailed: (event: Readonly<EventData.VideoStartFailedEvent>, sendRequest: boolean) => void;
-    source_changing: (duration: number, state: string, event: any) => void;
-    ready: (duration: number, state: string, event: any) => void;
-    startCasting: (duration: number, event: any) => void;
-    casting: (duration: number, event: any) => void;
-    manualSourceChange: (event: {
-        config: AnalyticsConfig;
-    }) => void;
-    initialSourceChange: (event: {
-        config: AnalyticsConfig;
-    }) => void;
-    muting_ready: (duration: number, state: string, event: any) => void;
-    customdatachange: (duration?: number, state?: string, event?: {
-        values: CustomDataValues;
-    }) => void;
-    release: () => void;
-    playlistTransition: (event: Readonly<EventData.AnalyticsEventBase>) => void;
-}
-export declare const defaultStateMachineCallbacks: StateMachineCallbacks;

package/js/types/StreamSources.d.ts

@@ -1,5 +0,0 @@
-export interface StreamSources {
-    mpdUrl?: string;
-    m3u8Url?: string;
-    progUrl?: string;
-}

package/js/types/SubtitleInfo.d.ts

@@ -1,11 +0,0 @@
-export interface SubtitleInfo {
-    /**
-     * Indicates if subtitles are displayed.
-     */
-    enabled: boolean;
-    /**
-     * The selected subtitle/captions language.
-     */
-    language?: string;
-}
-export declare const isDifferentSubtitleInfo: (info1?: SubtitleInfo | undefined, info2?: SubtitleInfo | undefined) => boolean;

package/js/types/Timespan.d.ts

@@ -1,4 +0,0 @@
-export default interface Timespan {
-    start: number;
-    end: number;
-}

package/js/utils/AnalyticsCall.d.ts

@@ -1,14 +0,0 @@
-import { AdSample } from '../types/AdSample';
-import { Sample } from '../types/Sample';
-export declare class AnalyticsCall {
-    private analyticsServerUrl;
-    private adAnalyticsServerUrl;
-    constructor(baseUrl: string);
-    sendRequest(sample: Sample, callback: () => void): void;
-    sendUnloadRequest(sample: Sample): void;
-    trySendBeacon(fallbackFunction: (data: any) => void, url: string, data: any): void;
-    sendRequestSynchronous(sample: Sample, callback: () => void): void;
-    sendAdRequest(sample: AdSample): void;
-    getAnalyticsServerUrl(): string;
-    getAdAnalyticsServerUrl(): string;
-}

package/js/utils/BitmovinProgressiveSourceHelper.d.ts

@@ -1,3 +0,0 @@
-import { ProgressiveSourceConfig } from '../types/ProgressiveSourceConfig';
-import { ProgressiveSourceInfo } from '../types/SourceInfo';
-export declare const getSourceInfoFromBitmovinSourceConfig: (progressive: ProgressiveSourceConfig, player: any) => ProgressiveSourceInfo;

package/js/utils/CodecHelper.d.ts

@@ -1,4 +0,0 @@
-export declare class CodecHelper {
-    static get supportedVideoFormats(): string[] | undefined;
-    static isCodecSupported(codec: string): boolean;
-}

package/js/utils/Converter.d.ts

@@ -1,6 +0,0 @@
-export declare class Converter {
-    static bytesToBits(bytes: number): number;
-    static bitsToBytes(bits: number): number;
-    static bytesToKiloBytes(bytes: number): number;
-    static kiloBytesToMegaBytes(kiloByte: number): number;
-}

package/js/utils/EventDebugging.d.ts

@@ -1,8 +0,0 @@
-export declare class EventDebugging {
-    event: string | undefined;
-    from: string | undefined;
-    to: string | undefined;
-    timestamp: number;
-    eventObject: any;
-    constructor(event: string | undefined, from: string | undefined, to: string | undefined, timestamp: number, eventObject: any);
-}

package/js/utils/Http.d.ts

@@ -1 +0,0 @@
-export declare function post(url: string, body: any, callback: Function, async?: boolean): void;

package/js/utils/LicenseCall.d.ts

@@ -1,2 +0,0 @@
-import { LicensingResponse } from '../types/LicensingRequest';
-export declare function LicenseCall(key: string, domain: string, version: string, baseUrl: string): Promise<LicensingResponse>;

package/js/utils/Logger.d.ts

@@ -1,14 +0,0 @@
-declare class Logger {
-    constructor(showLogs?: boolean);
-    setLogging(logging: boolean): void;
-    isLogging(): any;
-    log(msg: string, ...optionalParamters: any[]): void;
-    logTable(fields: any[]): void;
-    errorMessageToUser(msg: string, ...optionalParamters: any[]): void;
-    error(msg: string | undefined, ...optionalParamters: any[]): void;
-    warning(msg: string): void;
-    warningMessageToUser(msg: string, ...optionalParameters: any[]): void;
-}
-export declare const padRight: (str: string | undefined, length: number) => string;
-export declare const logger: Logger;
-export {};

package/js/utils/Queue.d.ts

@@ -1,9 +0,0 @@
-export declare class Queue<T> {
-    private readonly _items;
-    get items(): ReadonlyArray<T>;
-    get length(): number;
-    offer(item: T): void;
-    poll(): T | undefined;
-    clear(): void;
-    limit(maxElements: number): void;
-}

package/js/utils/Settings.d.ts

@@ -1,14 +0,0 @@
-export declare const MESSAGE_NAMESPACE = "urn:x-cast:com.bitmovin.analytics.cast";
-export declare const ANALYTICS_BACKEND_BASE_URL = "https://analytics-ingress-global.bitmovin.com";
-export declare const ANALYTICS_LICENSECALL_TIMEOUT: number;
-export declare const ANALYTICS_VIDEOSTART_TIMEOUT: number;
-export declare const ANALYTICS_QUALITY_CHANGE_COUNT_THRESHOLD = 50;
-export declare const ANALYTICS_QUALITY_CHANGE_COUNT_RESET_INTERVAL: number;
-/**
- * Time (in milliseconds) of consecutive buffering until a REBUFFER_TIMEOUT_ERROR is raised.
- */
-export declare const ANALYTICS_REBUFFER_TIMEOUT: number;
-/**
- * minimal time (in seconds) a seek event should have in order to be recogniced as seek
- */
-export declare const ANALYTICS_MIN_SEEK_DIFFERENCE_THRESHOLD = 3;

package/js/utils/Utils.d.ts

@@ -1,36 +0,0 @@
-import { PAGE_LOAD_TYPE } from '../enums/PageLoadType';
-import { CustomDataValues } from '../types/CustomDataValues';
-export declare const validString: (text: any) => boolean;
-export declare const isNullOrEmptyString: (text: any) => boolean;
-export declare const validBoolean: (bool: any) => boolean;
-export declare const validNumber: (num: any) => boolean;
-export declare const sanitizePath: (path: string) => string;
-export declare const calculateTimeWithUndefined: (time?: number | undefined) => number | undefined;
-export declare const calculateTime: (time: number) => number;
-/**
- * Return the current time in milliseconds.
- */
-export declare const getCurrentTimestamp: () => number;
-export declare const getDurationFromTimestampToNow: (timestamp: number) => number;
-export declare const generateUUID: () => string;
-export declare const getCookie: (cname: string) => string;
-export declare const noOp: () => void;
-export declare const getCustomDataString: (customData: any) => string | undefined;
-export declare const transferCustomDataFields: (fromConfig: CustomDataValues, toConfig: CustomDataValues) => void;
-export declare const getDocumentPropWithPrefix: (prop: string) => string | undefined;
-export declare const isVideoInFullscreen: () => boolean;
-export declare const getHiddenProp: () => string | undefined;
-export declare function getPageLoadType(): PAGE_LOAD_TYPE;
-export declare const getHostnameAndPathFromUrl: (url: string) => {
-    hostname: string;
-    path: string;
-};
-export declare const calculatePercentage: (numerator?: number | undefined, denominator?: number | undefined) => number | undefined;
-export declare const getBrowserInfo: () => {
-    name: any;
-    version: any;
-};
-export declare const getURLResourceName: (url: string) => string;
-export declare const joinUrls: (...args: string[]) => string;
-export declare const endsWith: (str: string, suffix: string) => boolean;
-export declare const startsWith: (str: string, prefix: string) => boolean;

package/js/utils/ViewportTracker.d.ts

@@ -1,15 +0,0 @@
-export declare class ViewportTracker {
-    private onIntersectionChanged;
-    private observer?;
-    private element;
-    private inViewport?;
-    private threshold;
-    private hidden;
-    private visibilityChange?;
-    constructor(element: HTMLElement, onIntersectionChanged: () => void, threshold?: number);
-    isHidden(): any;
-    isInViewport(): boolean;
-    dispose(): void;
-    private handleVisibilityChange;
-    private handleIntersect;
-}

package/js/utils/WindowEventTracker.d.ts

@@ -1,5 +0,0 @@
-export declare class WindowEventTracker {
-    private trackedObjects;
-    addEventListener(eventName: string, func: EventListenerOrEventListenerObject): void;
-    release(): void;
-}