Class ComscoreConnector

Index

Constructors

Methods

destroy setPersistentLabel setPersistentLabels update updateUserConsent

Constructors

constructor

new ComscoreConnector(player, comscoreConfig, comscoreMetadata): ComscoreConnector
Constructor for the THEOplayer Comscore connector
Parameters
- player: ChromelessPlayer
  a THEOplayer instance reference
- comscoreConfig: ComscoreConfiguration
  configuration object that should at least hold the publisher id, application name and an initial user consent value
- comscoreMetadata: ComscoreMetadata
  metadata associated with the SourceDescription that is or will be passed to the THEOplayer instance
Returns ComscoreConnector
- Defined in api/ComscoreConnector.ts:21

Methods

destroy

destroy(): void
Destroy ComScoreStreamingAnalytics and unregister it from player

Returns void
- Defined in api/ComscoreConnector.ts:99

setPersistentLabel

setPersistentLabel(label, value): void
Set persistent label on the ComScore PublisherConfiguration
Parameters
- label: string
- value: string
Returns void
- Defined in api/ComscoreConnector.ts:80

setPersistentLabels

setPersistentLabels(labels): void
Set persistent labels on the ComScore PublisherConfiguration
Parameters
- labels: {
  [key: string]: string;
  }
  object of key value pairs
  - [key: string]: string
Returns void
- Defined in api/ComscoreConnector.ts:90

update

update(metadata): void
Sets/updates Comscore metadata on the Comscore video analytics.
Parameters
- metadata: ComscoreMetadata
  object of key value pairs
Returns void
- Defined in api/ComscoreConnector.ts:60

updateUserConsent

updateUserConsent(consentValue): void
Update the user consent
Parameters
- consentValue: ComscoreUserConsent
  "1" indicates consent was granted, "0" not granted and "" unknown.
Returns void
- Defined in api/ComscoreConnector.ts:68

Generated using TypeDoc