Class MKAnalyticsCollector

MKPlayer analytics controller to enable and fetch analytics data

Index

Constructors

Methods

deInit getPlayerMetrics getVersion startAnalyticsSession

Constructors

constructor

new MKAnalyticsCollector(
    player: MKPlayerAPI,
    periodicInterval?: number,
    periodicCallback?: MKAnalyticsPeriodicDataCallback,
): MKAnalyticsCollector
MKPlayer analytics collector.

Periodic data is enabled only when both periodicInterval (> 0) and periodicCallback are set.
Parameters
- player: MKPlayerAPI
  the MKPlayer instance
- OptionalperiodicInterval: number
  interval in seconds at which periodicCallback is called
- OptionalperiodicCallback: MKAnalyticsPeriodicDataCallback
  callback which resolves periodic analytics data, also called when source unloaded
Returns MKAnalyticsCollector

Methods

deInit

deInit(): void
Function to de-initialize the analytics for current player

Returns void

getPlayerMetrics

getPlayerMetrics(): MKAnalyticsData
Returns the current snapshot of analytics Data collected since the start of the current playback session.

Returns MKAnalyticsData

getVersion

getVersion(): string
Get plugin version string.

Returns string
plugin version string.

startAnalyticsSession

startAnalyticsSession(): void
Function to start capturing analytics data for current playback session

Returns void