Interface ConvivaConfiguration

Describes the configuration of the Conviva integration.

Remarks


- Available since v2.14.4.

interface ConvivaConfiguration {
    contentMetadata: ConvivaContentMetadata;
    customerKey: string;
    gatewayUrl?: string;
    heartbeatInterval?: number;
    integration: "conviva";
    manualSessionControl?: boolean;
}

Hierarchy (view full)

Properties

contentMetadata customerKey gatewayUrl? heartbeatInterval? integration manualSessionControl?

Properties

contentMetadata

contentMetadata: ConvivaContentMetadata

The metadata which will be sent to Conviva.

customerKey

customerKey: string

The customer key.

Optional gatewayUrl

gatewayUrl?: string

The URL of your Conviva gateway.

Remarks


- When not filled in, no gateway will be used.

Optional heartbeatInterval

heartbeatInterval?: number

The interval at which metrics are reported, in seconds.

integration

integration: "conviva"

The identifier of the analytics integration.

Optional manualSessionControl

manualSessionControl?: boolean

Whether the player should not handle sessions automatically.

Remarks


- This should be used if you manually want to create and cleanup sessions.

Default Value

false

Settings

Member Visibility

Theme

On This Page

contentMetadatacustomerKeygatewayUrlheartbeatIntervalintegrationmanualSessionControl