Interface MKPlaybackConfig

MKPlayer playback configuration interface.

If MKPlayerConfig.playback not provided, MKPlayerWeb SDK uses

{
    muted: true,
    autoplay: true
}

When it is provided, the defaults below apply to the properties left out.

interface MKPlaybackConfig {
    audioCodecPriority?: string[];
    audioLanguage?: string[];
    autoplay?: boolean;
    isForcedSubtitle?: (subtitle: MKSubtitleTrack) => boolean;
    muted?: boolean;
    playsInline?: boolean;
    preferredTech?: MKPreferredTechnology[];
    seeking?: boolean;
    subtitleLanguage?: string[];
    timeShift?: boolean;
    videoCodecPriority?: string[];
    volume?: number;
}

Properties

audioCodecPriority? audioLanguage? autoplay? isForcedSubtitle? muted? playsInline? preferredTech? seeking? subtitleLanguage? timeShift? videoCodecPriority? volume?

Properties

OptionalaudioCodecPriority

audioCodecPriority?: string[]

Audio codec priority.

If more than one audio codec is available this order will be respected while finding a codec which is supported by the current browser.

If there is a codec which is not in this priority list, it will be tried only if none of this list are available / supported.

Default priority order is ['ec-4', 'ac-4', 'ec-3', 'mp4a.a6', 'ac-3', 'mp4a.a5', 'mp4a.40']

OptionalaudioLanguage

audioLanguage?: string[]

Defines one or more audio languages which should be used in the specified order on start up.

Optionalautoplay

autoplay?: boolean

Whether the player starts playback automatically after loading the source or not?

Default value is false.

Also note that unmuted autoplay is blocked on several browsers.

OptionalisForcedSubtitle

isForcedSubtitle?: (subtitle: MKSubtitleTrack) => boolean

Determines if the subtitle should be selected by the player per default and kept in sync with the selected audio language.

The subtitle will not appear in MKSubtitlesAPI.list and can't be deactivated or activated through the API.

Per default subtitle tracks with forced=true will be selected.

In case of DASH these are subtitles with the role forced_subtitle and in case of HLS subtitles with the attribute FORCED=YES.

Type declaration

Optionalmuted

muted?: boolean

Whether the audio is muted on startup or not?

Default value is false.

OptionalplaysInline

playsInline?: boolean

Whether to add the playsinline attribute to the video element or not.

This stops videos immediately going fullscreen after starting playback on iOS for example.

Default is true.

OptionalpreferredTech

preferredTech?: MKPreferredTechnology[]

An array of objects to specify the player and streaming technology order to use. If the first is supported, these technologies are used. If not, the second is tried etc. If none of the specified combinations are supported, then a MKErrorCode.PLAYER_SOURCE_NO_SUPPORTED_TECHNOLOGY will be thrown.

Player technologies:

  • html5 refers to the MediaSource Extension (MSE) based JavaScript player
  • native refers to the browser’s native capabilities are being used, e.g. playing back HLS in Safari on iOS

Currently supported combinations:

{ player: 'html5', streaming: 'dash'}
{ player: 'html5', streaming: 'hls'}
{ player: 'html5', streaming: 'smooth'}
{ player: 'native', streaming: 'hls'}
{ player: 'native', streaming: 'progressive'}

Example:

preferredTech : [{
    player: 'html5',
    streaming: 'dash'
}, {
    player: 'native',
    streaming: 'hls'
}]

Optionalseeking

seeking?: boolean

Whether to allow seeking or not.

Default is true.

OptionalsubtitleLanguage

subtitleLanguage?: string[]

Defines one or more subtitle languages which should be used in the specified order on start up.

OptionaltimeShift

timeShift?: boolean

Enables time shift / DVR for live streams.

Default is true (enabled). If time shift is disabled (set to false), the timeline (scrub bar) will not be shown any more.

OptionalvideoCodecPriority

videoCodecPriority?: string[]

Video codec priority.

If more than one video codec is available this order will be respected while finding a codec which is supported by the current browser. If there is a codec which is not in this priority list, it will be tried only if none of this list are available / supported.

Default priority order is ['dvhe', 'dvh1', 'vvc', 'vvi', 'av01', 'av1', 'hevc', 'hev', 'hvc', 'vp9', 'avc']

Optionalvolume

volume?: number

Defines the volume level of the player when started for the first time.

Default value is 100.

Settings

Member Visibility

On This Page

Properties