Interface MKPlayerConfig

MKPlayer SDK configuration interface.

Hierarchy

  • MKPlayerConfig

Properties

Adaptation configuration.

advertising?: MKAdvertisingConfig
analytics?: false | MKAnalyticsConfig

Bundled Analytics Configuration used to specify metadata and other related info.

Can also be used to completely disable Analytics by setting this to false in case the Analytics module is loaded, but Analytics is not desired.

For more information, please see documentation for MKAnalyticsConfig.

appId?: string

Application Identifier / Bundle Identifier for retail device native application.

This is required to set for retail devices native applications e.g. Tizen, LG WebOS, etc.

Buffer configuration.

Google Cast Configuration

enableAdTrackingBeacons?: boolean

Enable DAI Ad Tracking beacons.

Default is true (enabled).

enableHlsImageMediaPlaylistSupport?: boolean

Enable HLS image media playlist support.

Default is false (disabled)

enableSubtitleOverlay?: boolean

Enable captions and subtitle overlay.

To process subititle cue events and render subtitles/captions yourself, you must set this setting to false to disable SDK's internal subtitle/captions overlay.

Default is true (enabled). However, when ui is enabled custom subtitle overlay is disabled. So to use subtitle overlay you must keep ui disalbed.

A mapping of MKPlayerEvent values to event handler callback functions.

Events can also be dynamically added and removed through on and off.

Example:

events: {
[MKPlayerEvent.SourceLoaded]: (data) => {
console.log("Source loaded: ", data);
},
[MKPlayerEvent.Playing]: (data) => {
console.log("Video is playing: ", data);
},
[MKPlayerEvent.Error]: (data) => {
console.log("An error occurred: ", data);
}
}
key?: string

Player license key.

Provide parameters specific to live streams.

Log configuration.

playback?: MKPlaybackConfig

Playback configuration.

Player Tweaks.

Note: Use these only if you know what you are doing.

ui?: boolean

Enable or disable default player UI.

When enabled, ensure that mkplayer-ui.css is added as part of your HTML document.

Default is false.