Analytics Plugin

Analytics Plugin is a web plugin for MKPlayer web SDK to enable and fetch playback analytics data.

How to use:

Install plugin

npm install @medikind/mkplayer-analytics-plugin
Copy

Import plugin in your source.

import { MKAnalyticsCollector, MKAnalyticsData, MKAnalyticsPeriodicData } from "@medikind/mkplayer-analytics-plugin";
Copy

Define analytics periodic time interval and periodic data callback method

const analyticsPeriodicTimeInterval = 60;     // seconds
const analyticsPeriodicDataCallback = function (periodicData: MKAnalyticsPeriodicData) {
    if (!!periodicData) {
      console.log("Playback analytics periodic data: " + JSON.stringify(periodicData));
    }
}
Copy

Initialize MKPlayer as usual

const player = new mkplayer.MKPlayer(videoContainer, playerConfig);
Copy

Initialize MKAnalyticsCollector with MKPlayer instance, periodic time interval in seconds and callback for periodic data

const analyticsCollector = new MKAnalyticsCollector(this.player, analyticsPeriodicTimeInterval, analyticsPeriodicDataCallback);
Copy

Fetch playback analytics data

const analyticsData = analyticsCollector.getPlayerMetrics();
Copy

Reset the analytics data for every new playback session

alyticsCollector.startAnalyticsSession();
Copy