Analytics

Analytics collector configuration and SSAI tracking

AdPosition

Type

AdPosition = "preroll" | "midroll" | "postroll"

AnalyticsConfig

Interface

Properties

cdnProvider?

optional cdnProvider?: string

config?

optional config?: CollectorConfig

customData1?

optional customData1?: any

customData10?

optional customData10?: any

customData100?

optional customData100?: any

customData11?

optional customData11?: any

customData12?

optional customData12?: any

customData13?

optional customData13?: any

customData14?

optional customData14?: any

customData15?

optional customData15?: any

customData16?

optional customData16?: any

customData17?

optional customData17?: any

customData18?

optional customData18?: any

customData19?

optional customData19?: any

customData2?

optional customData2?: any

customData20?

optional customData20?: any

customData21?

optional customData21?: any

customData22?

optional customData22?: any

customData23?

optional customData23?: any

customData24?

optional customData24?: any

customData25?

optional customData25?: any

customData26?

optional customData26?: any

customData27?

optional customData27?: any

customData28?

optional customData28?: any

customData29?

optional customData29?: any

customData3?

optional customData3?: any

customData30?

optional customData30?: any

customData31?

optional customData31?: any

customData32?

optional customData32?: any

customData33?

optional customData33?: any

customData34?

optional customData34?: any

customData35?

optional customData35?: any

customData36?

optional customData36?: any

customData37?

optional customData37?: any

customData38?

optional customData38?: any

customData39?

optional customData39?: any

customData4?

optional customData4?: any

customData40?

optional customData40?: any

customData41?

optional customData41?: any

customData42?

optional customData42?: any

customData43?

optional customData43?: any

customData44?

optional customData44?: any

customData45?

optional customData45?: any

customData46?

optional customData46?: any

customData47?

optional customData47?: any

customData48?

optional customData48?: any

customData49?

optional customData49?: any

customData5?

optional customData5?: any

customData50?

optional customData50?: any

customData51?

optional customData51?: any

customData52?

optional customData52?: any

customData53?

optional customData53?: any

customData54?

optional customData54?: any

customData55?

optional customData55?: any

customData56?

optional customData56?: any

customData57?

optional customData57?: any

customData58?

optional customData58?: any

customData59?

optional customData59?: any

customData6?

optional customData6?: any

customData60?

optional customData60?: any

customData61?

optional customData61?: any

customData62?

optional customData62?: any

customData63?

optional customData63?: any

customData64?

optional customData64?: any

customData65?

optional customData65?: any

customData66?

optional customData66?: any

customData67?

optional customData67?: any

customData68?

optional customData68?: any

customData69?

optional customData69?: any

customData7?

optional customData7?: any

customData70?

optional customData70?: any

customData71?

optional customData71?: any

customData72?

optional customData72?: any

customData73?

optional customData73?: any

customData74?

optional customData74?: any

customData75?

optional customData75?: any

customData76?

optional customData76?: any

customData77?

optional customData77?: any

customData78?

optional customData78?: any

customData79?

optional customData79?: any

customData8?

optional customData8?: any

customData80?

optional customData80?: any

customData81?

optional customData81?: any

customData82?

optional customData82?: any

customData83?

optional customData83?: any

customData84?

optional customData84?: any

customData85?

optional customData85?: any

customData86?

optional customData86?: any

customData87?

optional customData87?: any

customData88?

optional customData88?: any

customData89?

optional customData89?: any

customData9?

optional customData9?: any

customData90?

optional customData90?: any

customData91?

optional customData91?: any

customData92?

optional customData92?: any

customData93?

optional customData93?: any

customData94?

optional customData94?: any

customData95?

optional customData95?: any

customData96?

optional customData96?: any

customData97?

optional customData97?: any

customData98?

optional customData98?: any

customData99?

optional customData99?: any

customUserId?

optional customUserId?: string

debug?

optional debug?: boolean | AnalyticsDebugConfig

deviceClass?

optional deviceClass?: "Console" | "Desktop" | "Other" | "Phone" | "STB" | "Tablet" | "TV" | "Wearable"

deviceType?

optional deviceType?: string

experimentName?

optional experimentName?: string

isLive?

optional isLive?: boolean

key?

optional key?: string

player?

optional player?: string

playerKey?

optional playerKey?: string

title?

optional title?: string

userId?

optional userId?: string

videoId?

optional videoId?: string

AnalyticsDebugConfig

Interface

Properties

fields?

optional fields?: string[]

AnalyticsError

Interface

Properties

code

code: number

message

message: string

severity

severity: ErrorSeverity

Bitmovin8Adapter

Interface

Properties

ssai

readonly ssai: SsaiApi

Accessors

version

Get Signature

get version(): string

Returns

string

Methods

getCurrentImpressionId()

getCurrentImpressionId(): string

Returns

string

getUserId()

getUserId(): string

Returns

string

programChange()

programChange(sourceMetadata): void

Parameters

sourceMetadata

SourceMetadata

Returns

void

setCustomData()

setCustomData(values): void

Parameters

values

CustomDataValues

Returns

void

setCustomDataOnce()

setCustomDataOnce(values): void

Parameters

values

CustomDataValues

Returns

void

sourceChange()

sourceChange(config): void

Parameters

config

AnalyticsConfig

Returns

void

CollectorConfig

Interface

Properties

backendUrl?

optional backendUrl?: string

cookiesDomain?

optional cookiesDomain?: string

cookiesEnabled?

optional cookiesEnabled?: boolean

cookiesMaxAge?

optional cookiesMaxAge?: number

enabled?

optional enabled?: boolean

errorTransformerCallback?

optional errorTransformerCallback?: ErrorTransformerCallback

origin?

optional origin?: string

ssaiEngagementTrackingEnabled?

optional ssaiEngagementTrackingEnabled?: boolean

CustomDataValues

Interface

Properties

customData1?

optional customData1?: string

customData10?

optional customData10?: string

customData100?

optional customData100?: string

customData11?

optional customData11?: string

customData12?

optional customData12?: string

customData13?

optional customData13?: string

customData14?

optional customData14?: string

customData15?

optional customData15?: string

customData16?

optional customData16?: string

customData17?

optional customData17?: string

customData18?

optional customData18?: string

customData19?

optional customData19?: string

customData2?

optional customData2?: string

customData20?

optional customData20?: string

customData21?

optional customData21?: string

customData22?

optional customData22?: string

customData23?

optional customData23?: string

customData24?

optional customData24?: string

customData25?

optional customData25?: string

customData26?

optional customData26?: string

customData27?

optional customData27?: string

customData28?

optional customData28?: string

customData29?

optional customData29?: string

customData3?

optional customData3?: string

customData30?

optional customData30?: string

customData31?

optional customData31?: string

customData32?

optional customData32?: string

customData33?

optional customData33?: string

customData34?

optional customData34?: string

customData35?

optional customData35?: string

customData36?

optional customData36?: string

customData37?

optional customData37?: string

customData38?

optional customData38?: string

customData39?

optional customData39?: string

customData4?

optional customData4?: string

customData40?

optional customData40?: string

customData41?

optional customData41?: string

customData42?

optional customData42?: string

customData43?

optional customData43?: string

customData44?

optional customData44?: string

customData45?

optional customData45?: string

customData46?

optional customData46?: string

customData47?

optional customData47?: string

customData48?

optional customData48?: string

customData49?

optional customData49?: string

customData5?

optional customData5?: string

customData50?

optional customData50?: string

customData51?

optional customData51?: string

customData52?

optional customData52?: string

customData53?

optional customData53?: string

customData54?

optional customData54?: string

customData55?

optional customData55?: string

customData56?

optional customData56?: string

customData57?

optional customData57?: string

customData58?

optional customData58?: string

customData59?

optional customData59?: string

customData6?

optional customData6?: string

customData60?

optional customData60?: string

customData61?

optional customData61?: string

customData62?

optional customData62?: string

customData63?

optional customData63?: string

customData64?

optional customData64?: string

customData65?

optional customData65?: string

customData66?

optional customData66?: string

customData67?

optional customData67?: string

customData68?

optional customData68?: string

customData69?

optional customData69?: string

customData7?

optional customData7?: string

customData70?

optional customData70?: string

customData71?

optional customData71?: string

customData72?

optional customData72?: string

customData73?

optional customData73?: string

customData74?

optional customData74?: string

customData75?

optional customData75?: string

customData76?

optional customData76?: string

customData77?

optional customData77?: string

customData78?

optional customData78?: string

customData79?

optional customData79?: string

customData8?

optional customData8?: string

customData80?

optional customData80?: string

customData81?

optional customData81?: string

customData82?

optional customData82?: string

customData83?

optional customData83?: string

customData84?

optional customData84?: string

customData85?

optional customData85?: string

customData86?

optional customData86?: string

customData87?

optional customData87?: string

customData88?

optional customData88?: string

customData89?

optional customData89?: string

customData9?

optional customData9?: string

customData90?

optional customData90?: string

customData91?

optional customData91?: string

customData92?

optional customData92?: string

customData93?

optional customData93?: string

customData94?

optional customData94?: string

customData95?

optional customData95?: string

customData96?

optional customData96?: string

customData97?

optional customData97?: string

customData98?

optional customData98?: string

customData99?

optional customData99?: string

experimentName?

optional experimentName?: string

ErrorContext

Interface

Properties

originalError?

optional originalError?: any

ErrorSeverity

Type

ErrorSeverity = "CRITICAL" | "INFO"

ErrorTransformerCallback

Interface

Properties

transform

transform: (error, context) => AnalyticsError

Parameters

SourceMetadata

Interface

Properties

cdnProvider?

optional cdnProvider?: string

customData?

optional customData?: CustomDataValues

isLive?

optional isLive?: boolean

path?

optional path?: string

title?

optional title?: string

videoId?

optional videoId?: string

SsaiAdBreakMetadata

Type

SsaiAdBreakMetadata = object

Properties

adPosition?

optional adPosition?: AdPosition

expectedPaidAds?

optional expectedPaidAds?: number

expectedSlates?

optional expectedSlates?: number

SsaiAdMetadata

Type

SsaiAdMetadata = object

Properties

adId?

optional adId?: string

adSystem?

optional adSystem?: string

customData?

optional customData?: CustomDataValues

durationInMs?

optional durationInMs?: number

isSlate?

optional isSlate?: boolean

SsaiAdQuartile

Type

SsaiAdQuartile = "first" | "midpoint" | "third" | "completed"

SsaiAdQuartileMetadata

Type

SsaiAdQuartileMetadata = object

Properties

failedBeaconUrl?

optional failedBeaconUrl?: string

SsaiApi

Interface

Methods

adBreakEnd()

adBreakEnd(): void

Returns

void

adBreakStart()

adBreakStart(adBreakMetadata?): void

Parameters

adBreakMetadata?

SsaiAdBreakMetadata

Returns

void

adQuartileFinished()

adQuartileFinished(adQuartile, adQuartileMetadata?): void

Parameters

adQuartile

SsaiAdQuartile

adQuartileMetadata?

SsaiAdQuartileMetadata

Returns

void

adStart()

adStart(adMetadata?): void

Parameters

adMetadata?

SsaiAdMetadata

Returns

void