Interface Conviva

The Conviva API.

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

Properties

client: any

The Conviva client used by the player.

Remarks


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

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

  • 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.

  • 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.

Generated using TypeDoc