Class AnalyticsImpressionSample

Export

AnalyticsImpressionSample

Constructors

constructor

Properties

ad? analyticsVersion? audioBitrate? audioCodec? audioLanguage? autoplay? browser? browserVersionMajor? browserVersionMinor? buffered? castTech? cdnProvider? city? clientTime? country? customData1? customData10? customData11? customData12? customData13? customData14? customData15? customData16? customData17? customData18? customData19? customData2? customData20? customData21? customData22? customData23? customData24? customData25? customData26? customData27? customData28? customData29? customData3? customData30? customData4? customData5? customData6? customData7? customData8? customData9? customUserId? deviceClass? deviceType? domain? drmLoadTime? drmType? droppedFrames? duration? errorCode? errorMessage? experimentName? impressionId? ipAddress? isCasting? isLive? isMuted? isp? language? licenseKey? m3u8Url? mpdUrl? operatingsystem? operatingsystemVersionMajor? operatingsystemVersionMinor? pageLoadTime? pageLoadType? path? paused? platform? played? player? playerKey? playerStartuptime? playerTech? playerVersion? progUrl? region? screenHeight? screenOrientation? screenWidth? seeked? segmentDownloadCount? segmentDownloadSize? segmentDownloadTime? sequenceNumber? size? startuptime? state? streamFormat? subtitleEnabled? subtitleLanguage? supportedVideoCodes? time? userId? videoBitrate? videoCodec? videoDuration? videoId? videoPlaybackHeight? videoPlaybackWidth? videoStartuptime? videoTitle? videoWindowHeight? videoWindowWidth? videostartFailed? videostartFailedReason? videotimeEnd? videotimeStart?

Constructors

constructor

Properties

Optional ad

ad?: number

Is an ad playing. 0 indicates no, 1 indicates yes

Memberof

AnalyticsImpressionSample

Optional analyticsVersion

analyticsVersion?: string

Collector version

Memberof

AnalyticsImpressionSample

Optional audioBitrate

audioBitrate?: number

Audio Bitrate

Memberof

AnalyticsImpressionSample

Optional audioCodec

audioCodec?: string

Audio codec of currently playing stream

Memberof

AnalyticsImpressionSample

Optional audioLanguage

audioLanguage?: string

Selected audio language

Memberof

AnalyticsImpressionSample

Optional autoplay

autoplay?: boolean

Autoplay enabled

Memberof

AnalyticsImpressionSample

Optional browser

browser?: string

Browser name

Memberof

AnalyticsImpressionSample

Optional browserVersionMajor

browserVersionMajor?: string

Browser version major

Memberof

AnalyticsImpressionSample

Optional browserVersionMinor

browserVersionMinor?: string

Browser version minor

Memberof

AnalyticsImpressionSample

Optional buffered

buffered?: number

Milliseconds the player buffered

Memberof

AnalyticsImpressionSample

Optional castTech

castTech?: string

Casting Technology

Memberof

AnalyticsImpressionSample

Optional cdnProvider

cdnProvider?: string

CDN Provider

Memberof

AnalyticsImpressionSample

Optional city

city?: string

City

Memberof

AnalyticsImpressionSample

Optional clientTime

clientTime?: number

Current time of the client

Memberof

AnalyticsImpressionSample

Optional country

country?: string

Country

Memberof

AnalyticsImpressionSample

Optional customData1

customData1?: string

Free form data set via the customData1 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData10

customData10?: string

Free form data set via the customData10 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData11

customData11?: string

Free form data set via the customData11 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData12

customData12?: string

Free form data set via the customData12 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData13

customData13?: string

Free form data set via the customData13 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData14

customData14?: string

Free form data set via the customData14 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData15

customData15?: string

Free form data set via the customData15 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData16

customData16?: string

Free form data set via the customData16 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData17

customData17?: string

Free form data set via the customData17 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData18

customData18?: string

Free form data set via the customData18 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData19

customData19?: string

Free form data set via the customData19 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData2

customData2?: string

Free form data set via the customData2 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData20

customData20?: string

Free form data set via the customData20 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData21

customData21?: string

Free form data set via the customData21 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData22

customData22?: string

Free form data set via the customData22 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData23

customData23?: string

Free form data set via the customData23 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData24

customData24?: string

Free form data set via the customData24 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData25

customData25?: string

Free form data set via the customData25 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData26

customData26?: string

Free form data set via the customData26 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData27

customData27?: string

Free form data set via the customData27 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData28

customData28?: string

Free form data set via the customData28 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData29

customData29?: string

Free form data set via the customData29 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData3

customData3?: string

Free form data set via the customData3 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData30

customData30?: string

Free form data set via the customData30 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData4

customData4?: string

Free form data set via the customData4 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData5

customData5?: string

Free form data set via the customData5 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData6

customData6?: string

Free form data set via the customData6 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData7

customData7?: string

Free form data set via the customData7 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData8

customData8?: string

Free form data set via the customData8 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customData9

customData9?: string

Free form data set via the customData9 field in the analytics collector configuration

Memberof

AnalyticsImpressionSample

Optional customUserId

customUserId?: string

Custom user ID

Memberof

AnalyticsImpressionSample

Optional deviceClass

deviceClass?: string

Type of device (Desktop, Phone, Tablet)

Memberof

AnalyticsImpressionSample

Optional deviceType

deviceType?: string

Type of the device detected via User Agent

Memberof

AnalyticsImpressionSample

Optional domain

domain?: string

Domain the player was loaded on (.www is stripped away)

Memberof

AnalyticsImpressionSample

Optional drmLoadTime

drmLoadTime?: number

Time in milliseconds it took the DRM server to respond

Memberof

AnalyticsImpressionSample

Optional drmType

drmType?: string

DRM system used for this impression

Memberof

AnalyticsImpressionSample

Optional droppedFrames

droppedFrames?: number

Dropped frames during playback

Memberof

AnalyticsImpressionSample

Optional duration

duration?: number

Duration of the sample in milliseconds

Memberof

AnalyticsImpressionSample

Optional errorCode

errorCode?: number

Error code

Memberof

AnalyticsImpressionSample

Optional errorMessage

errorMessage?: string

Error message

Memberof

AnalyticsImpressionSample

Optional experimentName

experimentName?: string

A/B test experiment name

Memberof

AnalyticsImpressionSample

Optional impressionId

impressionId?: string

Random UUID that is used to identify a session (required)

Memberof

AnalyticsImpressionSample

Optional ipAddress

ipAddress?: string

IP Address of the client

Memberof

AnalyticsImpressionSample

Optional isCasting

isCasting?: boolean

Is chromecast active

Memberof

AnalyticsImpressionSample

Optional isLive

isLive?: boolean

Is the stream live or VoD

Memberof

AnalyticsImpressionSample

Optional isMuted

isMuted?: boolean

Is the player muted

Memberof

AnalyticsImpressionSample

Optional isp

isp?: string

The users Internet Service Provider inferred via the IP address

Memberof

AnalyticsImpressionSample

Optional language

language?: string

Language set in the browser

Memberof

AnalyticsImpressionSample

Optional licenseKey

licenseKey?: string

Analytics license key

Memberof

AnalyticsImpressionSample

Optional m3u8Url

m3u8Url?: string

URL of the HLS source

Memberof

AnalyticsImpressionSample

Optional mpdUrl

mpdUrl?: string

URL of the DASH source

Memberof

AnalyticsImpressionSample

Optional operatingsystem

operatingsystem?: string

Operating system

Memberof

AnalyticsImpressionSample

Optional operatingsystemVersionMajor

operatingsystemVersionMajor?: string

Operating system version major

Memberof

AnalyticsImpressionSample

Optional operatingsystemVersionMinor

operatingsystemVersionMinor?: string

Operating system version minor

Memberof

AnalyticsImpressionSample

Optional pageLoadTime

pageLoadTime?: number

Time in milliseconds the page took to load

Memberof

AnalyticsImpressionSample

Optional pageLoadType

pageLoadType?: number

Player load type. 1 = Foreground, 2 = Background

Memberof

AnalyticsImpressionSample

Optional path

path?: string

path on the website

Memberof

AnalyticsImpressionSample

Optional paused

paused?: number

Milliseconds the player was paused

Memberof

AnalyticsImpressionSample

Optional platform

platform?: string

Platform the player is running on (web, android, ios)

Memberof

AnalyticsImpressionSample

Optional played

played?: number

Milliseconds the player played

Memberof

AnalyticsImpressionSample

Optional player

player?: string

Video player being used for this session

Memberof

AnalyticsImpressionSample

Optional playerKey

playerKey?: string

Player license key

Memberof

AnalyticsImpressionSample

Optional playerStartuptime

playerStartuptime?: number

Time in milliseconds the player took to start up

Memberof

AnalyticsImpressionSample

Optional playerTech

playerTech?: string

HTML or native playback

Memberof

AnalyticsImpressionSample

Optional playerVersion

playerVersion?: string

Player software version

Memberof

AnalyticsImpressionSample

Optional progUrl

progUrl?: string

URL of the progressive MP4 source

Memberof

AnalyticsImpressionSample

Optional region

region?: string

Geographic region (ISO 3166-2 code)

Memberof

AnalyticsImpressionSample

Optional screenHeight

screenHeight?: number

Screen as reported by the browser

Memberof

AnalyticsImpressionSample

Optional screenOrientation

screenOrientation?: string

Screen orientation (PORTRAIT, LANDSCAPE OR UNKNOWN)

Memberof

AnalyticsImpressionSample

Optional screenWidth

screenWidth?: number

Screen as reported by the browser

Memberof

AnalyticsImpressionSample

Optional seeked

seeked?: number

Milliseconds it took the player to seek

Memberof

AnalyticsImpressionSample

Optional segmentDownloadCount

segmentDownloadCount?: number

Number of video segments downloaded

Memberof

AnalyticsImpressionSample

Optional segmentDownloadSize

segmentDownloadSize?: number

Size of downloaded video segments (byte)

Memberof

AnalyticsImpressionSample

Optional segmentDownloadTime

segmentDownloadTime?: number

Cumulative time needed to download video segments

Memberof

AnalyticsImpressionSample

Optional sequenceNumber

sequenceNumber?: number

Sequence number of the sample in which it occurred in the session

Memberof

AnalyticsImpressionSample

Optional size

size?: string

Video size (FULLSCREEN or WINDOW)

Memberof

AnalyticsImpressionSample

Optional startuptime

startuptime?: number

Combination of player- and videoStartuptime

Memberof

AnalyticsImpressionSample

Optional state

state?: string

Internal state of the analytics state machine

Memberof

AnalyticsImpressionSample

Optional streamFormat

streamFormat?: string

Format of the stream (HLS, DASH, Progressive MP4)

Memberof

AnalyticsImpressionSample

Optional subtitleEnabled

subtitleEnabled?: boolean

Subtitle enabled

Memberof

AnalyticsImpressionSample

Optional subtitleLanguage

subtitleLanguage?: string

Selected subtitle language

Memberof

AnalyticsImpressionSample

Optional supportedVideoCodes

supportedVideoCodes?: string[]

Video codecs supported by platform/browser

Memberof

AnalyticsImpressionSample

Optional time

time?: number

Current time in milliseconds

Memberof

AnalyticsImpressionSample

Optional userId

userId?: string

ID that is persisted across sessions to identify a browser

Memberof

AnalyticsImpressionSample

Optional videoBitrate

videoBitrate?: number

Bitrate of the played back video rendition

Memberof

AnalyticsImpressionSample

Optional videoCodec

videoCodec?: string

Video codec of current stream

Memberof

AnalyticsImpressionSample

Optional videoDuration

videoDuration?: number

Length of the video in milliseconds

Memberof

AnalyticsImpressionSample

Optional videoId

videoId?: string

ID of the video as configured via the analytics config

Memberof

AnalyticsImpressionSample

Optional videoPlaybackHeight

videoPlaybackHeight?: number

Resolution of the played back Video Rendition

Memberof

AnalyticsImpressionSample

Optional videoPlaybackWidth

videoPlaybackWidth?: number

Resolution of the played back Video Rendition

Memberof

AnalyticsImpressionSample

Optional videoStartuptime

videoStartuptime?: number

Time in milliseconds it took to start video playback

Memberof

AnalyticsImpressionSample

Optional videoTitle

videoTitle?: string

Free form human readable video title as configured in the analytics config

Memberof

AnalyticsImpressionSample

Optional videoWindowHeight

videoWindowHeight?: number

Height of the video player on the page

Memberof

AnalyticsImpressionSample

Optional videoWindowWidth

videoWindowWidth?: number

Width of the video player on the page

Memberof

AnalyticsImpressionSample

Optional videostartFailed

videostartFailed?: boolean

True if starting the video failed

Memberof

AnalyticsImpressionSample

Optional videostartFailedReason

videostartFailedReason?: AnalyticsVideoStartFailedReason

Reason why starting the video failed

Memberof

AnalyticsImpressionSample

Optional videotimeEnd

videotimeEnd?: number

End time of the sample in the video (milliseconds)

Memberof

AnalyticsImpressionSample

Optional videotimeStart

videotimeStart?: number

Start time of the sample in the video (milliseconds)

Memberof

AnalyticsImpressionSample

Settings

Member Visibility

Theme

On This Page

constructoradanalyticsVersionaudioBitrateaudioCodecaudioLanguageautoplaybrowserbrowserVersionMajorbrowserVersionMinorbufferedcastTechcdnProvidercityclientTimecountrycustomData1customData10customData11customData12customData13customData14customData15customData16customData17customData18customData19customData2customData20customData21customData22customData23customData24customData25customData26customData27customData28customData29customData3customData30customData4customData5customData6customData7customData8customData9customUserIddeviceClassdeviceTypedomaindrmLoadTimedrmTypedroppedFramesdurationerrorCodeerrorMessageexperimentNameimpressionIdipAddressisCastingisLiveisMutedisplanguagelicenseKeym3u8UrlmpdUrloperatingsystemoperatingsystemVersionMajoroperatingsystemVersionMinorpageLoadTimepageLoadTypepathpausedplatformplayedplayerplayerKeyplayerStartuptimeplayerTechplayerVersionprogUrlregionscreenHeightscreenOrientationscreenWidthseekedsegmentDownloadCountsegmentDownloadSizesegmentDownloadTimesequenceNumbersizestartuptimestatestreamFormatsubtitleEnabledsubtitleLanguagesupportedVideoCodestimeuserIdvideoBitratevideoCodecvideoDurationvideoIdvideoPlaybackHeightvideoPlaybackWidthvideoStartuptimevideoTitlevideoWindowHeightvideoWindowWidthvideostartFailedvideostartFailedReasonvideotimeEndvideotimeStart

Generated using TypeDoc