Interface MKPlayerConfig

MKPlayer SDK configuration interface.

Hierarchy

  • MKPlayerConfig

Properties

Adaptation configuration.

Buffer configuration.

ChromeCast 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).

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.

ui?: boolean

Enable or disable default player UI.

Default is false.