Interface MKPlayerAPI

Sends custom metadata to a remote receiver app (e.g. Chromecast).

Adds a subtitle track.

isFragmented type of subtitle tracks are not supported when added via this method.

Stops a running Cast session (i.e. isCasting returns true).

Has no effect if isCasting returns false.

Initiates casting the current video to a Cast-compatible device.

The user has to choose the target device.

Unloads the player and removes all inserted HTML elements and event handlers.

Disables an already enabled subtitle track.

Enables a subtitle track.

Returns the current aspect ratio of the player, or 0 if there is no style module.

Note: the default player aspect ratio is 16:9.

Returns the currently used audio track, or null if no track is active.

Returns the currently selected audio quality.

One of the elements of getAvailableAudioQualities.

Returns an array of all available audio tracks.

Returns an array of all available audio qualities the player can adapt between.

Get list of all available subtitle tracks.

Returns an array containing all available video qualities the player can adapt between.

Returns the current and target buffer level for the given buffer type and media type.

Returns the currently buffered time ranges of the video element.

Returns the current latency sync configuration for catchup.

Returns the current playback time in seconds of the video.

Returns data about the last downloaded audio segment.

Returns data about the last downloaded video segment.

Returns the total number of dropped video frames since playback started.

Returns the total duration in seconds of the current video.

Returns the current latency sync configuration for fallback.

Returns the current latency in seconds.

Returns the limit in seconds for time shift.

Is either negative or 0 and applicable to live streams only.

Returns data about the currently playing audio segment.

Returns the current playback speed of the player.

1 is the default playback speed, values between 0 and 1 refer to slow motion and values greater than 1 refer to fast forward.

Values less or equal zero are ignored.

Returns data about the currently playing video segment.

Returns the time range that is currently valid for seeking.

Note For VOD default mode is RelativeTime and for Live it is AbsoluteTime.

Returns the current target latency in seconds.

Returns a thumbnail image for a certain time or null if there is no thumbnail available.

Requires a configured thumbnails track in thumbnailTrack if sideloaded thumbnails are configured.

Requires enableHlsImageMediaPlaylistSupport to be true if thumbnail images from the HLS manifest are needed.

When thumbnailTrack are configured, this will have preference over the thumbnails found in the HLS manifest.

Returns the current time shift offset to the live edge in seconds.

Is either negative or 0 and applicable to live streams only.

Offset 0 indicates the current live edge.

Returns the stalled time in seconds since playback started.

Returns current MKPlayer SDK version.

Returns the html element that the player is embedded in, which has been provided in the player constructor.

Returns the used HTML5 video element.

Returns the currently selected video quality, if the user manually selected one.

In this case it returns one of the elements of getAvailableVideoQualities.

Gets the active MKViewMode.

Returns the player’s volume between 0 (silent) and 100 (max volume).

Returns true if the video has ended.

Checks if Apple Airplay is enabled.

Checks if Apple AirPlay support is available.

Returns true if casting to another device (such as a ChromeCast) is available, otherwise false.

Please note that this function only returns true after the CastAvailable event has fired.

Returns true if the video is currently casted to a device and not played in the browser, or false if the video is played locally.

Return true if the displayed video is a live stream.

Returns true if the player has been muted.

Returns true if the player has started playback but is currently paused.

Returns true if the player is currently playing, i.e. has started and is not paused.

Returns true if the player is currently stalling due to an empty buffer.

Tests if a particular ViewMode is available for selection with setViewMode.

Sets a new video source and returns a promise which resolves when the source has loaded successfully.

Mutes the player if an audio track is available. Has no effect if the player is already muted.

Removes a handler for a player event.

Subscribes an event handler to a player event.

Pauses the video if it is playing. Has no effect if the player is already paused.

Starts playback or resumes after being paused.

No need to call it if the player is stup with autoplay.

Calling play has no effect when player is already playing.

Starts preloading the content of the currently loaded source.

Reload the currently playing source.

Note:

• Specifying start parameter is only supported for Live or Event asset types.
• Specifying sourceOptions for VOD, startOffset must be positive value bewtween 0 and duration of the VOD asset and no startOffsetTimelineReference must be set.
• Specifying sourceOptions for Live, startOffset for bookmark offset must always be an UNIX Epoch absolute timestamp and no startOffsetTimelineReference must be set.

For more details, please refer to notes for startOffset.

Examples

To reload the same source

reload()
Copy

To reload same source and start at bookmark offset

reload(undefined, {startOffset: 120});
Copy

To reload same source and start 5 minutes behind live edge for live

reload(undefined, {startOffset: -300, startOffsetTimelineReference: "end"});
Copy

To reload the same source and start at a specified bookmark offset (absolute timestamp) for live

reload(undefined, {startOffset: 1692268911.789})
Copy

To reload with a new start time for live and start at the live edge

reload("2023-06-28T10:00:00Z");

// OR
reload("2023-06-28T10:00:00Z", {"startOffset": 0, "startOffsetTimelineReference": "end"});
Copy

To reload with a new start time for live and start at the beginning

reload("2023-06-28T10:00:00Z", {"startOffset": 0, "startOffsetTimelineReference": "start"});
Copy

To reload with a new start time for live and start at the specified startOffset

const currentTime = player.getCurrentTime(); // current time used for example
reload("2023-06-28T10:00:00Z", {"startOffset": currentTime});
Copy

Removes a subtitle track.

Disables it in case it's enabled before removal.

Seeks to the given playback time specified by the parameter time in seconds.

The time offset specified must always be a positive value and within the current getSeekableRange.

For Live and Events the specified time either be relative or absolute offset.

• Calling seek(0) will take you to the start of the live window
• Calling seek(getSeekableRange().end) will take you near the current live edge. You can also call () to jump to current live edge easily.

Seeks to the current live edge.

Applicable only for live sources.

Modifies the current aspect ratio of the player.

Sets the audio track to the ID specified by trackID.

Available tracks can be retrieved with getAvailableAudio.

Manually sets the audio stream to a fixed quality, identified by ID.

Has to be an ID defined in the MPD or the keyword 'auto'.

Auto resets to dynamic switching.

A list with valid IDs can be retrieved by calling getAvailableAudioQualities.

Sets the configuration specifying parameters for latency catchup.

Sets the configuration specifying parameters for latency fallback.

Set HTTP headers.

Header keys are case sensitive, chaning cases may result in duplicate entires in the headers.

Note: To update STS authToken for the registered source, you must call updateAuthToken. You should only set other custom headers required from here.

Sets the level of player log outputs.

Sets the playback speed of the player.

Available only for HTML5 player.

Fast forward as well as slow motion is supported.

Slow motion is used by values between 0 and 1, fast forward by values greater than 1.

Sets a poster image. Will be displayed immediately, even if a video stream is playing.

Sets the target buffer level for the chosen buffer and media type.

Sets the target latency to be maintained during playback.

Causes firing a TargetLatencyChanged event.

Passes an HTML video element to the player, which should be used in case of Html5 or Native playback.

For this to take effect you must call this function before calling load.

When no video element is set on the player, the player will create one for use internally. You may call getVideoElement to get hold of the video element in use by the player.

Also the video element should be contained within the video container element that was passed as part of player creation.

Example:

' In the HTML body
<div id="videoContainer">
    <video id="videoElement"></video>
</div>

' In the script
let videoContainer = document.getElementById("videoContainer");
let videoElement = document.getElementById("videoElement");
let playerConfig = {
    key: "<license_key>",
    playback: {
        autoplay: true,
        muted: true
    }
};

let player = new mkplayer.MKPlayer(playerConfig, videoContainer);
player.setVideoElement(videoElement);
player.load(sourceConfig);
Copy

Manually sets the video stream to a fixed quality, identified by ID.

Has to be an ID defined in the Manifest/MPD or the keyword 'auto'.

Auto resets to dynamic switching.

A list with valid IDs can be retrieved by calling getAvailableVideoQualities.

Sets the player to a particular ViewMode.

Will only work if the selected view mode is available and isViewModeAvailable returns true, else this call will be ignored.

If successful, a ViewModeChanged will be fired.

Sets the player’s volume in the range of 0 (silent) to 100 (max volume). Unmutes a muted player.

Shows the airplay playback target picker.

Unloads the current video source.

Unmutes the player if muted.