@bitmovin/api-sdk 1.188.0 → 1.189.0

package/dist/models/AnalyticsImpressionSample.d.ts

@@ -1,687 +0,0 @@
-import AnalyticsVideoStartFailedReason from './AnalyticsVideoStartFailedReason';
-/**
- * @export
- * @class AnalyticsImpressionSample
- */
-export declare class AnalyticsImpressionSample {
-    /**
-     * Is an ad playing. 0 indicates no, 1 indicates yes
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    ad?: number;
-    /**
-     * Collector version
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    analyticsVersion?: string;
-    /**
-     * Audio Bitrate
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    audioBitrate?: number;
-    /**
-     * Audio codec of currently playing stream
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    audioCodec?: string;
-    /**
-     * Selected audio language
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    audioLanguage?: string;
-    /**
-     * Autoplay enabled
-     * @type {boolean}
-     * @memberof AnalyticsImpressionSample
-     */
-    autoplay?: boolean;
-    /**
-     * Browser name
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    browser?: string;
-    /**
-     * Browser version major
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    browserVersionMajor?: string;
-    /**
-     * Browser version minor
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    browserVersionMinor?: string;
-    /**
-     * Milliseconds the player buffered
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    buffered?: number;
-    /**
-     * CDN Provider
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    cdnProvider?: string;
-    /**
-     * Casting Technology
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    castTech?: string;
-    /**
-     * City
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    city?: string;
-    /**
-     * Current time of the client
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    clientTime?: number;
-    /**
-     * Country
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    country?: string;
-    /**
-     * Custom user ID
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customUserId?: string;
-    /**
-     * Free form data set via the customData1 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData1?: string;
-    /**
-     * Free form data set via the customData2 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData2?: string;
-    /**
-     * Free form data set via the customData3 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData3?: string;
-    /**
-     * Free form data set via the customData4 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData4?: string;
-    /**
-     * Free form data set via the customData5 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData5?: string;
-    /**
-     * Free form data set via the customData6 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData6?: string;
-    /**
-     * Free form data set via the customData7 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData7?: string;
-    /**
-     * Free form data set via the customData8 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData8?: string;
-    /**
-     * Free form data set via the customData9 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData9?: string;
-    /**
-     * Free form data set via the customData10 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData10?: string;
-    /**
-     * Free form data set via the customData11 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData11?: string;
-    /**
-     * Free form data set via the customData12 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData12?: string;
-    /**
-     * Free form data set via the customData13 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData13?: string;
-    /**
-     * Free form data set via the customData14 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData14?: string;
-    /**
-     * Free form data set via the customData15 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData15?: string;
-    /**
-     * Free form data set via the customData16 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData16?: string;
-    /**
-     * Free form data set via the customData17 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData17?: string;
-    /**
-     * Free form data set via the customData18 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData18?: string;
-    /**
-     * Free form data set via the customData19 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData19?: string;
-    /**
-     * Free form data set via the customData20 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData20?: string;
-    /**
-     * Free form data set via the customData21 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData21?: string;
-    /**
-     * Free form data set via the customData22 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData22?: string;
-    /**
-     * Free form data set via the customData23 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData23?: string;
-    /**
-     * Free form data set via the customData24 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData24?: string;
-    /**
-     * Free form data set via the customData25 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData25?: string;
-    /**
-     * Free form data set via the customData26 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData26?: string;
-    /**
-     * Free form data set via the customData27 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData27?: string;
-    /**
-     * Free form data set via the customData28 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData28?: string;
-    /**
-     * Free form data set via the customData29 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData29?: string;
-    /**
-     * Free form data set via the customData30 field in the analytics collector configuration
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    customData30?: string;
-    /**
-     * Type of device (Desktop, Phone, Tablet)
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    deviceClass?: string;
-    /**
-     * Type of the device detected via User Agent
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    deviceType?: string;
-    /**
-     * Domain the player was loaded on (.www is stripped away)
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    domain?: string;
-    /**
-     * Time in milliseconds it took the DRM server to respond
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    drmLoadTime?: number;
-    /**
-     * DRM system used for this impression
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    drmType?: string;
-    /**
-     * Dropped frames during playback
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    droppedFrames?: number;
-    /**
-     * Duration of the sample in milliseconds
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    duration?: number;
-    /**
-     * Error code
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    errorCode?: number;
-    /**
-     * Error message
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    errorMessage?: string;
-    /**
-     * A/B test experiment name
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    experimentName?: string;
-    /**
-     * Random UUID that is used to identify a session (required)
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    impressionId?: string;
-    /**
-     * IP Address of the client
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    ipAddress?: string;
-    /**
-     * Is chromecast active
-     * @type {boolean}
-     * @memberof AnalyticsImpressionSample
-     */
-    isCasting?: boolean;
-    /**
-     * Is the stream live or VoD
-     * @type {boolean}
-     * @memberof AnalyticsImpressionSample
-     */
-    isLive?: boolean;
-    /**
-     * Is the player muted
-     * @type {boolean}
-     * @memberof AnalyticsImpressionSample
-     */
-    isMuted?: boolean;
-    /**
-     * The users Internet Service Provider inferred via the IP address
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    isp?: string;
-    /**
-     * Language set in the browser
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    language?: string;
-    /**
-     * Analytics license key
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    licenseKey?: string;
-    /**
-     * URL of the HLS source
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    m3u8Url?: string;
-    /**
-     * URL of the DASH source
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    mpdUrl?: string;
-    /**
-     * Operating system
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    operatingsystem?: string;
-    /**
-     * Operating system version major
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    operatingsystemVersionMajor?: string;
-    /**
-     * Operating system version minor
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    operatingsystemVersionMinor?: string;
-    /**
-     * Time in milliseconds the page took to load
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    pageLoadTime?: number;
-    /**
-     * Player load type. 1 = Foreground, 2 = Background
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    pageLoadType?: number;
-    /**
-     * path on the website
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    path?: string;
-    /**
-     * Milliseconds the player was paused
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    paused?: number;
-    /**
-     * Platform the player is running on (web, android, ios)
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    platform?: string;
-    /**
-     * Milliseconds the player played
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    played?: number;
-    /**
-     * Video player being used for this session
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    player?: string;
-    /**
-     * Player license key
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    playerKey?: string;
-    /**
-     * Time in milliseconds the player took to start up
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    playerStartuptime?: number;
-    /**
-     * HTML or native playback
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    playerTech?: string;
-    /**
-     * Player software version
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    playerVersion?: string;
-    /**
-     * URL of the progressive MP4 source
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    progUrl?: string;
-    /**
-     * Geographic region (ISO 3166-2 code)
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    region?: string;
-    /**
-     * Screen as reported by the browser
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    screenHeight?: number;
-    /**
-     * Screen as reported by the browser
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    screenWidth?: number;
-    /**
-     * Screen orientation (PORTRAIT, LANDSCAPE OR UNKNOWN)
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    screenOrientation?: string;
-    /**
-     * Milliseconds it took the player to seek
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    seeked?: number;
-    /**
-     * Number of video segments downloaded
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    segmentDownloadCount?: number;
-    /**
-     * Size of downloaded video segments (byte)
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    segmentDownloadSize?: number;
-    /**
-     * Cumulative time needed to download video segments
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    segmentDownloadTime?: number;
-    /**
-     * Sequence number of the sample in which it occurred in the session
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    sequenceNumber?: number;
-    /**
-     * Video size (FULLSCREEN or WINDOW)
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    size?: string;
-    /**
-     * Combination of player- and videoStartuptime
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    startuptime?: number;
-    /**
-     * Internal state of the analytics state machine
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    state?: string;
-    /**
-     * Format of the stream (HLS, DASH, Progressive MP4)
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    streamFormat?: string;
-    /**
-     * Subtitle enabled
-     * @type {boolean}
-     * @memberof AnalyticsImpressionSample
-     */
-    subtitleEnabled?: boolean;
-    /**
-     * Selected subtitle language
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    subtitleLanguage?: string;
-    /**
-     * Video codecs supported by platform/browser
-     * @type {string[]}
-     * @memberof AnalyticsImpressionSample
-     */
-    supportedVideoCodes?: string[];
-    /**
-     * Current time in milliseconds
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    time?: number;
-    /**
-     * ID that is persisted across sessions to identify a browser
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    userId?: string;
-    /**
-     * Bitrate of the played back video rendition
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoBitrate?: number;
-    /**
-     * Video codec of current stream
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoCodec?: string;
-    /**
-     * Length of the video in milliseconds
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoDuration?: number;
-    /**
-     * ID of the video as configured via the analytics config
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoId?: string;
-    /**
-     * Free form human readable video title as configured in the analytics config
-     * @type {string}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoTitle?: string;
-    /**
-     * Resolution of the played back Video Rendition
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoPlaybackHeight?: number;
-    /**
-     * Resolution of the played back Video Rendition
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoPlaybackWidth?: number;
-    /**
-     * Time in milliseconds it took to start video playback
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoStartuptime?: number;
-    /**
-     * End time of the sample in the video (milliseconds)
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videotimeEnd?: number;
-    /**
-     * Start time of the sample in the video (milliseconds)
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videotimeStart?: number;
-    /**
-     * Height of the video player on the page
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoWindowHeight?: number;
-    /**
-     * Width of the video player on the page
-     * @type {number}
-     * @memberof AnalyticsImpressionSample
-     */
-    videoWindowWidth?: number;
-    /**
-     * True if starting the video failed
-     * @type {boolean}
-     * @memberof AnalyticsImpressionSample
-     */
-    videostartFailed?: boolean;
-    /**
-     * Reason why starting the video failed
-     * @type {AnalyticsVideoStartFailedReason}
-     * @memberof AnalyticsImpressionSample
-     */
-    videostartFailedReason?: AnalyticsVideoStartFailedReason;
-    constructor(obj?: Partial<AnalyticsImpressionSample>);
-}
-export default AnalyticsImpressionSample;