Interface Conviva

The Conviva API.

interface Conviva {
    client: any;
    contentSessionKey: undefined | number;
    cleanupSession(): void;
    createSession(): void;
}

Index

Properties

client contentSessionKey

Methods

cleanupSession createSession

Properties

`Readonly` client

client: any

The Conviva client used by the player.

Remarks

- Available since v2.31.2.
- For more information, consult the Conviva SDK documentation.

`Readonly` contentSessionKey

contentSessionKey: undefined | number

The session key of the active Conviva session, if any.

Remarks

- Available since v2.31.2.
- For more information, consult the Conviva SDK documentation.

Methods

cleanupSession

cleanupSession(): void
Clean up a Conviva session.

Returns void
Remarks

- This should only be used together with ConvivaConfiguration.manualSessionControl.
- For more information, consult the Conviva SDK documentation about Client.cleanupSession.

createSession

createSession(): void
Create a Conviva session.

Returns void
Remarks

- This should only be used together with ConvivaConfiguration.manualSessionControl.
- For more information, consult the Conviva SDK documentation about Client.createSession.