Class ConvivaConnector

Index

Constructors

Methods

connect destroy reportPlaybackEvent reportPlaybackFailed setAdInfo setContentInfo stopAndStartNewSession

Constructors

constructor

new ConvivaConnector(
    player: ChromelessPlayer,
    convivaMetadata: ConvivaMetadata,
    convivaConfig: ConvivaConfiguration,
): ConvivaConnector
Parameters
- player: ChromelessPlayer
- convivaMetadata: ConvivaMetadata
- convivaConfig: ConvivaConfiguration
Returns ConvivaConnector
- Defined in ConvivaConnector.ts:10

Methods

connect

connect(connector: YospaceConnector): void
Optionally connects the ConvivaConnector to the YospaceConnector to report SSAI.
Parameters
- connector: YospaceConnector
  the YospaceConnector
Returns void
- Defined in ConvivaConnector.ts:18

destroy

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

Returns void
- Defined in ConvivaConnector.ts:72

reportPlaybackEvent

reportPlaybackEvent(eventType: string, eventDetail?: object): void
Reports a custom event to the current Conviva session.
Parameters
- eventType: string
  the type of the custom event.
- OptionaleventDetail: object
  an optional object containing event details.
Returns void
- Defined in ConvivaConnector.ts:52

reportPlaybackFailed

reportPlaybackFailed(errorMessage: string): void
Reports an error to the Conviva session and closes the session.
Parameters
- errorMessage: string
  string explaining what the error is.
Returns void
- Defined in ConvivaConnector.ts:43

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 ConvivaConnector.ts:35

setContentInfo

setContentInfo(metadata: ConvivaMetadata): void
Sets Conviva metadata on the Conviva video analytics. Use this method to set source specific metadata after setting a source to the player.
Parameters
- metadata: ConvivaMetadata
  object of key value pairs
Returns void
- Defined in 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 for an ad break.
Parameters
- metadata: ConvivaMetadata
  object of key value pairs.
Returns void
- Defined in ConvivaConnector.ts:65