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 version(): string
Returns
string
Methods
getCurrentImpressionId
▸ getCurrentImpressionId(): string
Returns
string
getUserId
▸ getUserId(): string
Returns
string
setCustomData
▸ setCustomData(values): void
Parameters
| Name | Type |
|---|---|
values | CustomDataValues |
Returns
void
setCustomDataOnce
▸ setCustomDataOnce(values): void
Parameters
| Name | Type |
|---|---|
values | CustomDataValues |
Returns
void
sourceChange
▸ sourceChange(config): void
Parameters
| Name | Type |
|---|---|
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: AnalyticsError, context: ErrorContext) => AnalyticsError
Type declaration
▸ (error, context): AnalyticsError
Parameters
| Name | Type |
|---|---|
error | AnalyticsError |
context | ErrorContext |
Returns
SsaiAdBreakMetadata
Type
Ƭ SsaiAdBreakMetadata: Object
Type declaration
| Name | Type |
|---|---|
adPosition? | AdPosition |
SsaiAdMetadata
Type
Ƭ SsaiAdMetadata: Object
Type declaration
| Name | Type |
|---|---|
adId? | string |
adSystem? | string |
customData? | CustomDataValues |
SsaiAdQuartile
Type
Ƭ SsaiAdQuartile: "first" | "midpoint" | "third" | "completed"
SsaiAdQuartileMetadata
Type
Ƭ SsaiAdQuartileMetadata: Object
Type declaration
| Name | Type |
|---|---|
failedBeaconUrl? | string |
SsaiApi
Interface
Methods
adBreakEnd
▸ adBreakEnd(): void
Returns
void
adBreakStart
▸ adBreakStart(adBreakMetadata?): void
Parameters
| Name | Type |
|---|---|
adBreakMetadata? | SsaiAdBreakMetadata |
Returns
void
adQuartileFinished
▸ adQuartileFinished(adQuartile, adQuartileMetadata?): void
Parameters
| Name | Type |
|---|---|
adQuartile | SsaiAdQuartile |
adQuartileMetadata? | SsaiAdQuartileMetadata |
Returns
void
adStart
▸ adStart(adMetadata?): void
Parameters
| Name | Type |
|---|---|
adMetadata? | SsaiAdMetadata |
Returns
void