Skip to main content

Conviva

Lura Conviva Plugin uses the conviva library which enables it to send analytics data to the conviva end point when this plugin is enabled. The plugin also allows the application to send custom metadata in these calls. The following sections describe how the conviva plugin can be enabled and how the application can pass data to the SDK to be inserted in the conviva calls. Conviva dashboards provide insights to content broadcasters by gathering key metrics during high demand events and monitor the system in real time.

Configuration

AttributeTypeRequiredDescription
enabledbooleanYesEnable the plugin (Defaults to false if no value is given.)
customerKeystringYesConviva customer key, it can be test or production key.
gatewayUrlstringNoService URL of your conviva touchstone gateway. Don't fill this parameter in production.
viewerIdstringNoViewer ID of the session, if you don't fill this parameter, it will be filled automatically.
contentInfoObject<[key: string]: string>NoThe metadata to be sent to the conviva dashboard for current session.
deviceMetadataObject<[key: string]: string>NoDevice metadata to be sent to the conviva for current session.
const config = {
...
plugins: {
...
conviva: {
enabled: true,
customerKey: "CUSTOMER_KEY",
gatewayUrl: "https://test.conviva.com",
viewerId: "test-viewer",
contentInfo: {
...
key: "value",
...
},
deviceMetadata: {
...
key: "value",
...
},
},
...
},
...
};
const player = new lura.Player();
player.setConfig(config);