Class ConvivaConnector

Index

Constructors

Methods

destroy reportPlaybackEvent reportPlaybackFailed setAdInfo setContentInfo stopAndStartNewSession

Constructors

constructor

new ConvivaConnector(
    player: THEOplayer,
    convivaMetadata: ConvivaMetadata,
    convivaConfig: ConvivaConfiguration,
): ConvivaConnector
Create a new Conviva connector instance.
Parameters
- player: THEOplayer
  THEOplayer instance.
- convivaMetadata: ConvivaMetadata
  object of key value pairs with initial metadata.
- convivaConfig: ConvivaConfiguration
  configuration object.
Returns ConvivaConnector
- Defined in api/ConvivaConnector.ts:18

Methods

destroy

destroy(): void
Stops video and ad analytics and closes all sessions.

Returns void
- Defined in api/ConvivaConnector.ts:75

reportPlaybackEvent

reportPlaybackEvent(eventType: string, eventDetail: ConvivaEventDetail): void
Reports a custom event to Conviva.
Parameters
- eventType: string
  string explaining what kind of event it is.
- eventDetail: ConvivaEventDetail
  object of key value pairs.
Returns void
- Defined in api/ConvivaConnector.ts:68

reportPlaybackFailed

reportPlaybackFailed(errorMessage: string): void
Sets an error to the conviva session and closes the session.
Parameters
- errorMessage: string
  string explaining what the error is.
Returns void
- Defined in api/ConvivaConnector.ts:58

setAdInfo

setAdInfo(metadata: ConvivaMetadata): void
Sets Conviva metadata on the Conviva ad analytics.
Parameters
- metadata: ConvivaMetadata
  object of key value pairs.
Returns void
- Defined in api/ConvivaConnector.ts:36

setContentInfo

setContentInfo(metadata: ConvivaMetadata): void
Sets Conviva metadata on the Conviva video analytics.
Parameters
- metadata: ConvivaMetadata
  object of key value pairs.
Returns void
- Defined in api/ConvivaConnector.ts:27

stopAndStartNewSession

stopAndStartNewSession(metadata: ConvivaMetadata): void
Explicitly stop the current session and start a new one.

This can be used to manually mark the start of a new session during a live stream, for example when a new program starts. By default, new sessions are only started on play-out of a new source, or when an ad break starts.
Parameters
- metadata: ConvivaMetadata
  object of key value pairs.
Returns void
- Defined in api/ConvivaConnector.ts:49