Class MKConvivaAnalyticsCollector

Conviva Analytics Collector.

Initialize and setup MKPlayer Conviva Analytics Collector plugin for use.

Note: Can throw an error when mandatory input or configuration value is missing or invalid.

Release and destroy the current instance of analytics collector.

Note: you must reinitialize analytics collector before attempting to use any APIs.

Get plugin version string.

Send or update a custom application-level event to Conviva's Player Insight.

An application-level event can always be sent and is not tied to a specific video.

Note: Conviva has event attribute capped and 256 bytes for custom events and will show up as a warning in monitoring session if greater than 256 bytes.

Example:

// Sample for "share-click" event with 3 attributes
var eventName = "share-click";
var eventAttributes = {};
eventAttributes["location"] =  "Toolbar";
eventAttributes["assetName"] = "Sample Video";
eventAttributes["shareService"] = "Facebook";

mkConvivaAnalyticsController.updateCustomApplicationEvent(eventName, eventAttributes);
Copy

Send or update a custom playback-level event to Conviva's Player Insight.

A playback-level event can only be sent during an active video session.

Note: Conviva has event attribute capped and 256 bytes for custom events and will show up as a warning in monitoring session if greater than 256 bytes.

Example:

// Sample code snippet illustrating event on explicit change of video quality in the player
var eventName = "fullscreen";
var eventAttributes = {};
eventAttributes["old_quality"] = "SD";
eventAttributes["new_quality"] = "HD";

mkConvivaAnlyticsCollector.updateCustomPlaybackEvent(eventName, eventAttributes);
Copy