@mediakind/mkplayer 1.46.0 → 1.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +85 -58
- package/README.md +1 -1
- package/docs/assets/hierarchy.js +1 -0
- package/docs/assets/highlight.css +10 -17
- package/docs/assets/icons.js +18 -0
- package/docs/assets/icons.svg +1 -0
- package/docs/assets/main.js +5 -3
- package/docs/assets/navigation.js +1 -0
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +1425 -1181
- package/docs/documents/CHANGELOG.html +577 -0
- package/docs/enums/MKAdInteractionType.html +2 -0
- package/docs/enums/MKAdQuartile.html +8 -272
- package/docs/enums/MKAdTagType.html +5 -0
- package/docs/enums/MKAdType.html +10 -280
- package/docs/enums/MKAdaptationLogicType.html +10 -272
- package/docs/enums/MKAssetType.html +12 -288
- package/docs/enums/MKBufferType.html +5 -260
- package/docs/enums/MKDrmType.html +12 -288
- package/docs/enums/MKErrorCode.html +289 -1296
- package/docs/enums/MKHttpRequestType.html +21 -343
- package/docs/enums/MKHttpResponseType.html +7 -273
- package/docs/enums/MKLatencyMode.html +10 -280
- package/docs/enums/MKLiveSynchronizationMethod.html +8 -272
- package/docs/enums/MKLogLevel.html +10 -274
- package/docs/enums/MKMediaType.html +3 -254
- package/docs/enums/MKMetadataType.html +17 -308
- package/docs/enums/MKPlatformType.html +3 -254
- package/docs/enums/MKPlayerEngineType.html +6 -264
- package/docs/enums/MKPlayerEvent.html +225 -1047
- package/docs/enums/MKPlayerType.html +10 -280
- package/docs/enums/MKProgramRestrictionType.html +36 -384
- package/docs/enums/MKRttEstimationMethod.html +5 -260
- package/docs/enums/MKStartOffsetTimelineReference.html +8 -263
- package/docs/enums/MKStreamType.html +12 -296
- package/docs/enums/MKTimeMode.html +5 -262
- package/docs/enums/MKViewMode.html +5 -263
- package/docs/hierarchy.html +1 -0
- package/docs/index.html +598 -285
- package/docs/interfaces/MKAd.html +25 -350
- package/docs/interfaces/MKAdBreak.html +13 -293
- package/docs/interfaces/MKAdBreakConfig.html +27 -337
- package/docs/interfaces/MKAdBreakEvent.html +7 -279
- package/docs/interfaces/MKAdBreakFinishedEvent.html +8 -280
- package/docs/interfaces/MKAdBreakSkippedEvent.html +8 -280
- package/docs/interfaces/MKAdBreakStartedEvent.html +16 -312
- package/docs/interfaces/MKAdClickThroughEvent.html +12 -296
- package/docs/interfaces/MKAdClickedEvent.html +8 -280
- package/docs/interfaces/MKAdCompanionEvent.html +10 -288
- package/docs/interfaces/MKAdConfig.html +3 -258
- package/docs/interfaces/MKAdData.html +10 -0
- package/docs/interfaces/MKAdEvent.html +7 -277
- package/docs/interfaces/MKAdFinishedEvent.html +8 -280
- package/docs/interfaces/MKAdInteractionEvent.html +10 -288
- package/docs/interfaces/MKAdLinearityChangedEvent.html +8 -280
- package/docs/interfaces/MKAdManifestLoadedEvent.html +9 -288
- package/docs/interfaces/MKAdMarkerEvent.html +8 -280
- package/docs/interfaces/MKAdQuartileEvent.html +10 -288
- package/docs/interfaces/MKAdSkippedEvent.html +22 -336
- package/docs/interfaces/MKAdStartedEvent.html +22 -336
- package/docs/interfaces/MKAdTag.html +7 -0
- package/docs/interfaces/MKAdTagConfig.html +20 -0
- package/docs/interfaces/MKAdTagPlaceholders.html +19 -0
- package/docs/interfaces/MKAdVerificationEvent.html +12 -296
- package/docs/interfaces/MKAdaptationAPI.html +7 -282
- package/docs/interfaces/MKAdaptationConfig.html +38 -401
- package/docs/interfaces/MKAdaptationData.html +6 -278
- package/docs/interfaces/MKAdaptationEvent.html +8 -283
- package/docs/interfaces/MKAdaptationPlatformConfig.html +42 -425
- package/docs/interfaces/MKAdobePrimetimeConfig.html +19 -320
- package/docs/interfaces/MKAdvertisingConfig.html +30 -343
- package/docs/interfaces/MKAirplayChangedEvent.html +13 -299
- package/docs/interfaces/MKAnalyticsConfig.html +70 -555
- package/docs/interfaces/MKAspectRatioChangedEvent.html +10 -288
- package/docs/interfaces/MKAudioAdaptationData.html +6 -279
- package/docs/interfaces/MKAudioAdaptationEvent.html +8 -281
- package/docs/interfaces/MKAudioChangedEvent.html +15 -307
- package/docs/interfaces/MKAudioDownloadQualityChangeEvent.html +14 -308
- package/docs/interfaces/MKAudioDownloadQualityChangedEvent.html +14 -308
- package/docs/interfaces/MKAudioPlaybackQualityChangedEvent.html +10 -290
- package/docs/interfaces/MKAudioQuality.html +12 -295
- package/docs/interfaces/MKAudioQualityChangedEvent.html +14 -308
- package/docs/interfaces/MKAudioQualityEvent.html +7 -278
- package/docs/interfaces/MKAudioTrack.html +12 -301
- package/docs/interfaces/MKAudioTrackEvent.html +13 -299
- package/docs/interfaces/MKBitrateLimitationConfig.html +10 -284
- package/docs/interfaces/MKBufferAPI.html +14 -306
- package/docs/interfaces/MKBufferConfig.html +10 -270
- package/docs/interfaces/MKBufferLevel.html +10 -280
- package/docs/interfaces/MKBufferMediaTypeConfig.html +6 -268
- package/docs/interfaces/MKCastAvailableEvent.html +8 -280
- package/docs/interfaces/MKCastConfig.html +16 -299
- package/docs/interfaces/MKCastStartedEvent.html +10 -288
- package/docs/interfaces/MKCastWaitingForDeviceEvent.html +7 -288
- package/docs/interfaces/MKCdnOptions.html +7 -267
- package/docs/interfaces/MKClearKeyDRMConfig.html +5 -242
- package/docs/interfaces/MKClearKeyDRMConfigEntry.html +7 -264
- package/docs/interfaces/MKClearKeyDRMServerConfig.html +23 -300
- package/docs/interfaces/MKCompanionAd.html +6 -0
- package/docs/interfaces/MKDownloadFinishedEvent.html +26 -352
- package/docs/interfaces/MKDownloadTiming.html +5 -264
- package/docs/interfaces/MKDownloadedAudioData.html +8 -281
- package/docs/interfaces/MKDownloadedData.html +8 -279
- package/docs/interfaces/MKDownloadedVideoData.html +12 -297
- package/docs/interfaces/MKDrmAPI.html +12 -300
- package/docs/interfaces/MKDrmConfig.html +22 -314
- package/docs/interfaces/MKDrmLicense.html +4 -263
- package/docs/interfaces/MKDrmLicenseAddedEvent.html +8 -280
- package/docs/interfaces/MKDurationChangedEvent.html +10 -288
- package/docs/interfaces/MKDynamicAdaptationConfig.html +8 -278
- package/docs/interfaces/MKEnvironmentConfig.html +11 -285
- package/docs/interfaces/MKError.html +8 -282
- package/docs/interfaces/MKErrorEvent.html +16 -321
- package/docs/interfaces/MKFMTSASiDEvent.html +10 -288
- package/docs/interfaces/MKFairplayDrmConfig.html +48 -448
- package/docs/interfaces/MKLatencyModeChangedEvent.html +10 -288
- package/docs/interfaces/MKLinearAdUiConfig.html +15 -0
- package/docs/interfaces/MKLiveConfigAtSourceLevel.html +8 -276
- package/docs/interfaces/MKLogConfig.html +4 -260
- package/docs/interfaces/MKLowLatencyAPI.html +20 -351
- package/docs/interfaces/MKLowLatencyConfig.html +10 -277
- package/docs/interfaces/MKLowLatencySyncConfig.html +9 -276
- package/docs/interfaces/MKManifestAPI.html +3 -259
- package/docs/interfaces/MKMediaPlaybackQualityChangeEvent.html +10 -296
- package/docs/interfaces/MKMediaQualityChangeEvent.html +14 -311
- package/docs/interfaces/MKMediaQualityEvent.html +7 -280
- package/docs/interfaces/MKMediaTrack.html +7 -276
- package/docs/interfaces/MKMediaTrackRole.html +5 -270
- package/docs/interfaces/MKMetadata.html +9 -280
- package/docs/interfaces/MKMetadataChangedEvent.html +14 -308
- package/docs/interfaces/MKMetadataEvent.html +14 -307
- package/docs/interfaces/MKMetadataParsedEvent.html +14 -308
- package/docs/interfaces/MKModuleInfo.html +3 -258
- package/docs/interfaces/MKPauseAd.html +15 -302
- package/docs/interfaces/MKPauseAdDismissedEvent.html +7 -273
- package/docs/interfaces/MKPauseAdShownEvent.html +8 -280
- package/docs/interfaces/MKPauseAdWarningEvent.html +8 -280
- package/docs/interfaces/MKPeriodContentInformation.html +7 -272
- package/docs/interfaces/MKPeriodInformation.html +6 -264
- package/docs/interfaces/MKPeriodSwitchObject.html +3 -256
- package/docs/interfaces/MKPeriodSwitchedEvent.html +10 -288
- package/docs/interfaces/MKPlayReadyDrmConfig.html +23 -327
- package/docs/interfaces/MKPlayStation5Tweaks.html +7 -272
- package/docs/interfaces/MKPlaybackConfig.html +43 -376
- package/docs/interfaces/MKPlaybackEvent.html +11 -295
- package/docs/interfaces/MKPlaybackSpeedChangedEvent.html +10 -288
- package/docs/interfaces/MKPlayerAPI.html +357 -1897
- package/docs/interfaces/MKPlayerConfig.html +58 -415
- package/docs/interfaces/MKPlayerEventBase.html +6 -317
- package/docs/interfaces/MKPlayerEventCallback.html +2 -253
- package/docs/interfaces/MKPlayerEventConfig.html +7 -237
- package/docs/interfaces/MKPlayerResizedEvent.html +10 -288
- package/docs/interfaces/MKPlayerTechnology.html +6 -270
- package/docs/interfaces/MKPreferredTechnology.html +8 -280
- package/docs/interfaces/MKProgramRestrictions.html +10 -270
- package/docs/interfaces/MKProgramRestrictionsEvent.html +8 -280
- package/docs/interfaces/MKProgramTimeChangedEvent.html +8 -280
- package/docs/interfaces/MKProgressiveSource.html +11 -288
- package/docs/interfaces/MKQuality.html +11 -291
- package/docs/interfaces/MKQualityMetadata.html +15 -304
- package/docs/interfaces/MKRegisteredSource.html +16 -308
- package/docs/interfaces/MKRestrictStrategy.html +11 -0
- package/docs/interfaces/MKSeekEvent.html +13 -298
- package/docs/interfaces/MKSegmentInfo.html +8 -276
- package/docs/interfaces/MKSegmentMap.html +2 -241
- package/docs/interfaces/MKSegmentPlaybackEvent.html +30 -386
- package/docs/interfaces/MKSegmentQualityMap.html +2 -241
- package/docs/interfaces/MKSegmentRequestFinishedEvent.html +22 -336
- package/docs/interfaces/MKSessionDataEvent.html +10 -293
- package/docs/interfaces/MKSourceConfig.html +65 -449
- package/docs/interfaces/MKSourceLabelingConfig.html +11 -324
- package/docs/interfaces/MKSourceLabelingStreamTypeConfig.html +6 -268
- package/docs/interfaces/MKSourceOptions.html +42 -399
- package/docs/interfaces/MKSsaiAdConfig.html +19 -284
- package/docs/interfaces/MKStyleConfig.html +11 -272
- package/docs/interfaces/MKSubtitleCueEvent.html +30 -356
- package/docs/interfaces/MKSubtitleCuePosition.html +6 -268
- package/docs/interfaces/MKSubtitleEvent.html +8 -280
- package/docs/interfaces/MKSubtitleTrack.html +20 -329
- package/docs/interfaces/MKSubtitlesAPI.html +23 -379
- package/docs/interfaces/MKSynchronizationConfigEntry.html +5 -264
- package/docs/interfaces/MKTargetLatencyChangedEvent.html +10 -288
- package/docs/interfaces/MKTextTrack.html +16 -311
- package/docs/interfaces/MKThumbnail.html +18 -316
- package/docs/interfaces/MKThumbnailTrack.html +4 -260
- package/docs/interfaces/MKTimeChangedEvent.html +11 -291
- package/docs/interfaces/MKTimeRange.html +5 -264
- package/docs/interfaces/MKTimelineMarker.html +14 -294
- package/docs/interfaces/MKTrackMetadata.html +7 -272
- package/docs/interfaces/MKTweaksConfig.html +82 -545
- package/docs/interfaces/MKUserInteractionEvent.html +9 -285
- package/docs/interfaces/MKVSPPSessionIdEvent.html +8 -280
- package/docs/interfaces/MKVTTProperties.html +21 -328
- package/docs/interfaces/MKVTTRegionProperties.html +17 -312
- package/docs/interfaces/MKVastAdExtension.html +9 -0
- package/docs/interfaces/MKVastAdExtensionAttributes.html +1 -0
- package/docs/interfaces/MKVideoAdaptationData.html +6 -279
- package/docs/interfaces/MKVideoAdaptationEvent.html +8 -281
- package/docs/interfaces/MKVideoDownloadQualityChangeEvent.html +14 -308
- package/docs/interfaces/MKVideoDownloadQualityChangedEvent.html +14 -308
- package/docs/interfaces/MKVideoPlaybackQualityChangedEvent.html +10 -290
- package/docs/interfaces/MKVideoQuality.html +18 -319
- package/docs/interfaces/MKVideoQualityChangedEvent.html +14 -308
- package/docs/interfaces/MKVideoQualityEvent.html +7 -278
- package/docs/interfaces/MKVideoSizeLimitationConfig.html +9 -280
- package/docs/interfaces/MKVideoTrack.html +10 -293
- package/docs/interfaces/MKViewModeChangedEvent.html +12 -296
- package/docs/interfaces/MKViewModeOptions.html +4 -260
- package/docs/interfaces/MKVolumeChangedEvent.html +13 -298
- package/docs/interfaces/MKWidevineModularDrmConfig.html +25 -361
- package/docs/modules.html +1 -436
- package/docs/types/MKBitrate.html +1 -231
- package/docs/types/MKHeaders.html +1 -236
- package/docs/types/MKUserEngagement.html +1 -236
- package/docs/types/MKWishAbrConfig.html +8 -259
- package/mkplayer.js +1 -1
- package/package.json +2 -2
- package/types/alias/index.d.ts +0 -7
- package/types/classes/common/MKEventBase.d.ts +9 -1
- package/types/classes/player/MKPlayer.d.ts +5 -4
- package/types/constants/MKVersion.d.ts +1 -1
- package/types/enums/MKAdInteractionType.d.ts +3 -0
- package/types/enums/MKAdTagType.d.ts +5 -0
- package/types/enums/MKErrorCode.d.ts +5 -2
- package/types/enums/index.d.ts +2 -0
- package/types/interfaces/MKAdBreakConfig.d.ts +2 -7
- package/types/interfaces/MKAdvertisingConfig.d.ts +6 -6
- package/types/interfaces/MKHttpRequestOptions.d.ts +1 -8
- package/types/interfaces/MKHttpResponse.d.ts +1 -12
- package/types/interfaces/MKModuleInfo.d.ts +4 -0
- package/types/interfaces/MKPlayerAPI.d.ts +3 -1
- package/types/interfaces/MKPlayerConfig.d.ts +1 -1
- package/types/interfaces/MKPlayerCoreAPI.d.ts +4 -3
- package/types/interfaces/MKSourceConfig.d.ts +0 -1
- package/types/interfaces/MKTweaksConfig.d.ts +0 -2
- package/types/interfaces/MKVTTProperties.d.ts +1 -1
- package/types/interfaces/events/MKAdInteractionEvent.d.ts +1 -3
- package/types/interfaces/events/MKAdQuartileEvent.d.ts +1 -3
- package/types/interfaces/index.d.ts +4 -5
- package/docs/interfaces/MKHttpRequestOptions.html +0 -293
- package/docs/interfaces/MKHttpResponse.html +0 -345
- package/docs/interfaces/MKPlayerAdvertisingAPI.html +0 -378
- package/docs/interfaces/MKPlayerCoreAPI.html +0 -1736
- package/docs/types/MKHttpMethod.html +0 -231
- package/docs/types/MKRequestBody.html +0 -236
- package/docs/types/MKRequestQueryParams.html +0 -236
- package/types/interfaces/MKPlayerAdvertisingAPI.d.ts +0 -17
package/docs/index.html
CHANGED
|
@@ -1,307 +1,620 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
2
|
-
<div class="tsd-toolbar-contents container">
|
|
3
|
-
<div class="table-cell" id="tsd-search" data-base=".">
|
|
4
|
-
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
-
<div class="field">
|
|
6
|
-
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
-
<ul class="results">
|
|
8
|
-
<li class="state loading">Preparing search index...</li>
|
|
9
|
-
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">MKPlayer - v1.46.0</a></div>
|
|
10
|
-
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
-
<div class="container container-main">
|
|
12
|
-
<div class="col-content">
|
|
13
|
-
<div class="tsd-page-title">
|
|
14
|
-
<h2>MKPlayer - v1.46.0</h2></div>
|
|
15
|
-
<div class="tsd-panel tsd-typography"><p>MKPlayer is an HTML5 video player SDK used for playing back HLS and DASH adaptive bitrate streams without using browser plugins.</p>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MKPlayer - v1.47.0</title><meta name="description" content="Documentation for MKPlayer"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">MKPlayer - v1.47.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>MKPlayer - v1.47.0</h1></div><div class="tsd-panel tsd-typography"><p>MKPlayer is an HTML5 video player SDK used for playing back HLS and DASH adaptive bitrate streams without using browser plugins.</p>
|
|
16
2
|
<p>Our main goal is to provide a simple, abstract API that allows you to quickly get video playback of MediaKind streams running on your web page.</p>
|
|
17
|
-
<
|
|
18
|
-
<a id="
|
|
3
|
+
<hr>
|
|
4
|
+
<a id="prerequisite" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Prerequisite<a href="#prerequisite" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Please reach out to MediaKind team as a player (mandatory) and analytics (optional) license subscription is required and respective domains must be whitelisted on which our player is expected to run on.</p>
|
|
5
|
+
<hr>
|
|
6
|
+
<a id="setup" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Setup<a href="#setup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="getting-started" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Getting Started<a href="#getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><h3>Step 1: Get the latest release of MKPlayer.</h3>
|
|
7
|
+
<p>You can checkout the latest version of MKPlayer from <a href="https://www.npmjs.com/package/@mediakind/mkplayer">npmjs.com</a> using the following command:</p>
|
|
19
8
|
<pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">i</span><span class="hl-1"> @</span><span class="hl-0">mediakind</span><span class="hl-1">/</span><span class="hl-0">mkplayer</span>
|
|
20
9
|
</code><button>Copy</button></pre>
|
|
21
|
-
|
|
22
|
-
<
|
|
23
|
-
</code
|
|
24
|
-
<
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
<
|
|
28
|
-
<
|
|
29
|
-
|
|
10
|
+
|
|
11
|
+
<h3>Step 2: Include JavaScript and CSS files in the head of your page.</h3>
|
|
12
|
+
<p>After getting hold of the latest version of MKPlayer from NPM, you need to include <code>mkplayer.js</code> and <code>mkplayer-ui.css</code> in the <code><head></code> of your HTML page as below:</p>
|
|
13
|
+
<pre><code class="html"><span class="hl-2"><</span><span class="hl-3">head</span><span class="hl-2">></span><br/><span class="hl-1"> </span><span class="hl-2"><</span><span class="hl-3">title</span><span class="hl-2">></span><span class="hl-1">My Video Player</span><span class="hl-2"></</span><span class="hl-3">title</span><span class="hl-2">></span><br/><span class="hl-1"> </span><span class="hl-2"><</span><span class="hl-3">meta</span><span class="hl-1"> </span><span class="hl-4">charset</span><span class="hl-1">=</span><span class="hl-5">"utf-8"</span><span class="hl-2">></span><br/><span class="hl-1"> </span><span class="hl-2"><</span><span class="hl-3">meta</span><span class="hl-1"> </span><span class="hl-4">name</span><span class="hl-1">=</span><span class="hl-5">"viewport"</span><span class="hl-1"> </span><span class="hl-4">content</span><span class="hl-1">=</span><span class="hl-5">"width=device-width, initial-scale=1"</span><span class="hl-2">></span><br/><span class="hl-1"> </span><span class="hl-6"><!-- MKPlayer JavaScript and CSS --></span><br/><span class="hl-1"> </span><span class="hl-2"><</span><span class="hl-3">script</span><span class="hl-7"> </span><span class="hl-4">type</span><span class="hl-7">=</span><span class="hl-5">"text/javascript"</span><span class="hl-7"> </span><span class="hl-4">src</span><span class="hl-7">=</span><span class="hl-5">"./node_modules/@mediakind/mkplayer/mkplayer.js"</span><span class="hl-2">></</span><span class="hl-3">script</span><span class="hl-2">></span><br/><span class="hl-1"> </span><span class="hl-2"><</span><span class="hl-3">link</span><span class="hl-1"> </span><span class="hl-4">rel</span><span class="hl-1">=</span><span class="hl-5">"stylesheet"</span><span class="hl-1"> </span><span class="hl-4">href</span><span class="hl-1">=</span><span class="hl-5">"./node_modules/@mediakind/mkplayer/mkplayer-ui.css"</span><span class="hl-2">></span><br/><span class="hl-2"></</span><span class="hl-3">head</span><span class="hl-2">></span>
|
|
14
|
+
</code><button type="button">Copy</button></pre>
|
|
15
|
+
|
|
16
|
+
<h3>Step 3: Add a HTML <div> for your video container.</h3>
|
|
17
|
+
<p>As the next step you need to define a HTML <code><div></code> in your HTML page <code><body></code>. This is going to be your video container used by the player for playback.</p>
|
|
18
|
+
<pre><code class="html"><span class="hl-2"><</span><span class="hl-3">body</span><span class="hl-2">></span><br/><span class="hl-1"> </span><span class="hl-2"><</span><span class="hl-3">div</span><span class="hl-1"> </span><span class="hl-4">id</span><span class="hl-1">=</span><span class="hl-5">"video-container"</span><span class="hl-2">></</span><span class="hl-3">div</span><span class="hl-2">></span><br/><span class="hl-2"></</span><span class="hl-3">body</span><span class="hl-2">></span>
|
|
19
|
+
</code><button type="button">Copy</button></pre>
|
|
20
|
+
|
|
21
|
+
<h3>Step 4: Player initialization.</h3>
|
|
22
|
+
<p>Now, inside your JavaScript source, we can initialize the player and configure the player for your needs as below:</p>
|
|
23
|
+
<pre><code class="javascript"><span class="hl-6">// 1. Grab the video container</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">videoContainer</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-10">getElementById</span><span class="hl-1">(</span><span class="hl-11">"video-container"</span><span class="hl-1">);</span><br/><br/><span class="hl-6">// 2. Prepare the player configuration</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">playerConfig</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-11">"PLAYER_LICENSE_HERE"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">playback:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">muted:</span><span class="hl-1"> </span><span class="hl-8">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">autoplay:</span><span class="hl-1"> </span><span class="hl-8">true</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-6">// Subscribe to player events</span><br/><span class="hl-1"> </span><span class="hl-0">events:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">[mkplayer.MKPlayerEvent.Error]:</span><span class="hl-1"> (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-10">log</span><span class="hl-1">(</span><span class="hl-11">"Encountered player error: "</span><span class="hl-1">, </span><span class="hl-9">JSON</span><span class="hl-1">.</span><span class="hl-10">stringify</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">));</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">[mkplayer.MKPlayerEvent.TimeChanged]:</span><span class="hl-1"> (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-10">log</span><span class="hl-1">(</span><span class="hl-11">"Current player position: "</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">time</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-6">// 3. Initialize the player with video container and player configuration</span><br/><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">player</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-10">MKPlayer</span><span class="hl-1">(</span><span class="hl-0">videoContainer</span><span class="hl-1">, </span><span class="hl-0">playerConfig</span><span class="hl-1">);</span>
|
|
24
|
+
</code><button type="button">Copy</button></pre>
|
|
25
|
+
|
|
30
26
|
<p>Please see <a href="./interfaces/MKPlayerConfig.html">MKPlayerConfig</a> for more details.</p>
|
|
31
|
-
<p>From this point onwards, we are all set to use the many player
|
|
27
|
+
<p>From this point onwards, we are all set to use the many player APIs and handle and respond to the many player events.</p>
|
|
32
28
|
<p>Optionally you can dynamically subscribe to player events in addition to the ones subscribed in player configuration as below:</p>
|
|
33
|
-
<pre><code class="
|
|
34
|
-
</code><button>Copy</button></pre>
|
|
35
|
-
|
|
36
|
-
<
|
|
37
|
-
|
|
38
|
-
<
|
|
39
|
-
|
|
40
|
-
|
|
29
|
+
<pre><code class="javascript"><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">SourceLoaded</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-10">log</span><span class="hl-1">(</span><span class="hl-11">"Source loaded successfully!"</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">Ready</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-10">log</span><span class="hl-1">(</span><span class="hl-11">"Player is ready for playback!"</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
30
|
+
</code><button type="button">Copy</button></pre>
|
|
31
|
+
|
|
32
|
+
<h3>Step 5: Start playback.</h3>
|
|
33
|
+
<p>At this step, we have a player which is properly initialized and ready for use. All we need to do now is prepare a source configuration object as below:</p>
|
|
34
|
+
<pre><code class="javascript"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">sourceConfig</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-11">"Title for your source"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">description:</span><span class="hl-1"> </span><span class="hl-11">"Brief description of your source"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">poster:</span><span class="hl-1"> </span><span class="hl-11">"https://my-cdn.com/mysource/poster.png"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">hls:</span><span class="hl-1"> </span><span class="hl-11">"https://my-cdn.com/mysource/hls/index.m3u8"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">dash:</span><span class="hl-1"> </span><span class="hl-11">"https://my-cdn.com/mysource/dash/manifest.mpd"</span><br/><span class="hl-1">};</span>
|
|
35
|
+
</code><button type="button">Copy</button></pre>
|
|
36
|
+
|
|
37
|
+
<p>When attempting to setup playback for DRM protected content, we need to pass in a <a href="./interfaces/MKDrmConfig.html">MKDrmConfig</a> as one of the properties to the source configuration above as below:</p>
|
|
38
|
+
<pre><code class="javascript"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">sourceConfig</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-11">"Title for your source"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">description:</span><span class="hl-1"> </span><span class="hl-11">"Brief description of your source"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">poster:</span><span class="hl-1"> </span><span class="hl-11">"https://my-cdn.com/mysource/poster.png"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">hls:</span><span class="hl-1"> </span><span class="hl-11">"https://my-cdn.com/mysource/hls/index.m3u8"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">dash:</span><span class="hl-1"> </span><span class="hl-11">"https://my-cdn.com/mysource/dash/manifest.mpd"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">// when your source is DRM protected</span><br/><span class="hl-1"> </span><span class="hl-0">drm:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">widevine:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">LA_URL:</span><span class="hl-1"> </span><span class="hl-11">"License server URL"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">headers:</span><span class="hl-1"> { </span><span class="hl-6">// custom headers if available</span><br/><span class="hl-1"> </span><span class="hl-11">"X-CustomHeader1"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-11">"Custom header value"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"X-CustomHeader2"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-11">"Custom header value"</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">playready:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">LA_URL:</span><span class="hl-1"> </span><span class="hl-11">"License server URL"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">headers:</span><span class="hl-1"> { </span><span class="hl-6">// custom headers if available</span><br/><span class="hl-1"> </span><span class="hl-11">"X-CustomHeader1"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-11">"Custom header value"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"X-CustomHeader2"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-11">"Custom header value"</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-6">// FairPlay DRM applies only to HLS sources on apple devices</span><br/><span class="hl-1"> </span><span class="hl-0">fairplay:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">LA_URL:</span><span class="hl-1"> </span><span class="hl-11">"License server URL"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">certificateURL:</span><span class="hl-1"> </span><span class="hl-11">"Certificate URL"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">headers:</span><span class="hl-1"> { </span><span class="hl-6">// custom headers if available</span><br/><span class="hl-1"> </span><span class="hl-11">"X-CustomHeader1"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-11">"Custom header value"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-11">"X-CustomHeader2"</span><span class="hl-0">:</span><span class="hl-1"> </span><span class="hl-11">"Custom header value"</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">};</span>
|
|
39
|
+
</code><button type="button">Copy</button></pre>
|
|
40
|
+
|
|
41
41
|
<p>Please see <a href="./interfaces/MKSourceConfig.html">MKSourceConfig</a> for more details.</p>
|
|
42
42
|
<p>Now with the above source config we are all set to start playback as below:</p>
|
|
43
|
-
<pre><code class="
|
|
44
|
-
</code><button>Copy</button></pre>
|
|
45
|
-
|
|
46
|
-
<
|
|
47
|
-
|
|
48
|
-
<
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
<
|
|
43
|
+
<pre><code class="javascript"><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">load</span><span class="hl-1">(</span><span class="hl-0">sourceConfig</span><span class="hl-1">)</span><br/><span class="hl-1">.</span><span class="hl-10">then</span><span class="hl-1">(() </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// you can also get notified when subscribed to `SourceLoaded` event, `Error` event to know if in case load failed.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-10">log</span><span class="hl-1">(</span><span class="hl-11">"Source loaded successfully!"</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
44
|
+
</code><button type="button">Copy</button></pre>
|
|
45
|
+
|
|
46
|
+
<h3>Step 6: Stop playback.</h3>
|
|
47
|
+
<p>To stop the current playback session:</p>
|
|
48
|
+
<pre><code class="javascript"><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">unload</span><span class="hl-1">()</span><br/><span class="hl-1">.</span><span class="hl-10">then</span><span class="hl-1">(() </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// you can also get notified when subscribed to `SourceUnloaded` event.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-10">log</span><span class="hl-1">(</span><span class="hl-11">"Source unloaded successfully!"</span><span class="hl-1">);</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-10">catch</span><span class="hl-1">((</span><span class="hl-0">error</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-10">error</span><span class="hl-1">(</span><span class="hl-11">"Source unload failed with error: "</span><span class="hl-1">, </span><span class="hl-0">error</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
49
|
+
</code><button type="button">Copy</button></pre>
|
|
50
|
+
|
|
51
|
+
<h3>Step 7: Destroy player instance and release resources.</h3>
|
|
52
|
+
<p>Finally to destroy the player instance and release all held resources, you can call <code>destroy()</code>. You must create a new instance of the player after a call to <code>destroy()</code>.</p>
|
|
53
|
+
<pre><code class="javascript"><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">destroy</span><span class="hl-1">();</span><br/><br/><span class="hl-6">// It is recommended to wait for `Destroy` event notification after a call to `destroy()`.</span>
|
|
54
|
+
</code><button type="button">Copy</button></pre>
|
|
55
|
+
|
|
56
|
+
<hr>
|
|
57
|
+
<a id="additional-requirements-for-apple-devices-for-mac-iphone-ipad" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Additional requirements for Apple devices (for Mac, iPhone, iPad)<a href="#additional-requirements-for-apple-devices-for-mac-iphone-ipad" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>For overcoming platform-specific limitations (to support <a href="./interfaces/MKPlayerConfig.html#enablesecureurl">secureUrl</a> and customHeaders addition through <a href="./interfaces/MKPlayerAPI.html#sethttpheaders">setHttpHeaders</a>), below additional steps need to be followed:</p>
|
|
52
58
|
<ol>
|
|
53
59
|
<li><strong>Download serviceWorker.js file</strong><br>
|
|
54
60
|
Click <a href="../../serviceWorkerDownloader.html">here</a> to download the file.</li>
|
|
55
61
|
<li><strong>Place the file at the root of domain</strong><br>
|
|
56
62
|
The <code>serviceWorker.js</code> file is expected to be added at the root of domain where webApp is hosted</li>
|
|
57
63
|
</ol>
|
|
58
|
-
<pre><code><span class="hl-
|
|
64
|
+
<pre><code><span class="hl-12">Ex</span><span class="hl-1">: </span><span class="hl-12">https</span><span class="hl-1">:</span><span class="hl-6">//yourdomain.com/serviceWorker.js</span>
|
|
59
65
|
</code><button>Copy</button></pre>
|
|
66
|
+
|
|
60
67
|
<ol start="3">
|
|
61
68
|
<li><strong>Enable native_hls_parsing</strong><br>
|
|
62
|
-
MKPlayerSDK enables <a href="./interfaces/MKTweaksConfig.html#native_hls_parsing">native_hls_parsing</a> by default if not set, but explicitly setting it ensures consistent behaviour.</li>
|
|
69
|
+
MKPlayerSDK enables <a href="./interfaces/MKTweaksConfig.html#native_hls_parsing">native_hls_parsing</a> by default if not set, but explicitly setting it ensures consistent behaviour. This to be done during MKPlayer initialization.</li>
|
|
63
70
|
</ol>
|
|
64
|
-
<pre><code><span class="hl-
|
|
65
|
-
</code><button>Copy</button></pre>
|
|
66
|
-
|
|
67
|
-
<
|
|
71
|
+
<pre><code class="javascript"><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">player</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-10">MKPlayer</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-0">videoContainer</span><span class="hl-1">, </span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> ...</span><span class="hl-0">playerConfig</span><span class="hl-1">, </span><span class="hl-6">// rest of playerConfig</span><br/><span class="hl-1"> </span><span class="hl-0">tweaks:</span><span class="hl-1"> {</span><br/><span class="hl-1"> ...</span><span class="hl-0">playerConfig</span><span class="hl-1">.</span><span class="hl-0">tweaks</span><span class="hl-1">, </span><span class="hl-6">// rest of playerConfig.tweaks</span><br/><span class="hl-1"> </span><span class="hl-0">native_hls_parsing:</span><span class="hl-1"> </span><span class="hl-8">true</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">);</span>
|
|
72
|
+
</code><button type="button">Copy</button></pre>
|
|
73
|
+
|
|
74
|
+
<p><strong>Note:</strong> If you continue to experience issues related to <code>secureUrl</code> and <code>setHttpHeaders</code> on Apple devices even after completing the steps above, ensure that you're using latest version of MKPlayer Web SDK.<br>
|
|
75
|
+
If issue persists even after updating to latest version then please contact MKPlayer Web SDK team.</p>
|
|
76
|
+
<hr>
|
|
77
|
+
<a id="support-matrix-and-error-codes" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Support Matrix and Error Codes<a href="#support-matrix-and-error-codes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="supported-platforms" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Supported Platforms<a href="#supported-platforms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Note:</strong> We support the codecs (video and audio) that the individual platforms support. Codec support varies across platforms, but H.264/AVC video and AAC audio tend to be supported by all major vendors.</p>
|
|
78
|
+
<h3>On Desktop Browsers</h3>
|
|
79
|
+
<table>
|
|
80
|
+
<thead>
|
|
81
|
+
<tr>
|
|
82
|
+
<th style="text-align:left"><strong>Browser</strong></th>
|
|
83
|
+
<th style="text-align:left"><strong>Supported</strong></th>
|
|
84
|
+
<th style="text-align:left"><strong>Supported stream formats</strong></th>
|
|
85
|
+
</tr>
|
|
86
|
+
</thead>
|
|
87
|
+
<tbody>
|
|
88
|
+
<tr>
|
|
89
|
+
<td style="text-align:left">Chrome</td>
|
|
90
|
+
<td style="text-align:left">Last three major versions</td>
|
|
91
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
92
|
+
</tr>
|
|
93
|
+
<tr>
|
|
94
|
+
<td style="text-align:left">Edge</td>
|
|
95
|
+
<td style="text-align:left">Last three major versions <em>(Chromium based)</em></td>
|
|
96
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
97
|
+
</tr>
|
|
98
|
+
<tr>
|
|
99
|
+
<td style="text-align:left">Safari</td>
|
|
100
|
+
<td style="text-align:left">Last three major versions</td>
|
|
101
|
+
<td style="text-align:left">HLS/DASH<sup>1</sup></td>
|
|
102
|
+
</tr>
|
|
103
|
+
<tr>
|
|
104
|
+
<td style="text-align:left">Firefox<sup>2</sup></td>
|
|
105
|
+
<td style="text-align:left">Last three major versions</td>
|
|
106
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
107
|
+
</tr>
|
|
108
|
+
<tr>
|
|
109
|
+
<td style="text-align:left">Opera<sup>2</sup></td>
|
|
110
|
+
<td style="text-align:left">Last three major versions</td>
|
|
111
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
112
|
+
</tr>
|
|
113
|
+
</tbody>
|
|
114
|
+
</table>
|
|
115
|
+
<p><strong>Chromium</strong> (on ChromeOS): Not yet evaluated.<br>
|
|
116
|
+
Internet Explorer is not supported.</p>
|
|
117
|
+
<p><sup>1</sup> HLS is officially supported on Safari using native playback capabilities</p>
|
|
118
|
+
<p><sup>2</sup> Limited support from MediaKind</p>
|
|
119
|
+
<h3>On Mobile Devices</h3>
|
|
120
|
+
<table>
|
|
121
|
+
<thead>
|
|
122
|
+
<tr>
|
|
123
|
+
<th style="text-align:left"><strong>Mobile Browser</strong></th>
|
|
124
|
+
<th style="text-align:left"><strong>Supported</strong></th>
|
|
125
|
+
<th style="text-align:left"><strong>Supported stream formats</strong></th>
|
|
126
|
+
</tr>
|
|
127
|
+
</thead>
|
|
128
|
+
<tbody>
|
|
129
|
+
<tr>
|
|
130
|
+
<td style="text-align:left">Chrome <em>on Android</em></td>
|
|
131
|
+
<td style="text-align:left">Android 8+, Android 4.4 - 7.x</td>
|
|
132
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
133
|
+
</tr>
|
|
134
|
+
<tr>
|
|
135
|
+
<td style="text-align:left">Edge</td>
|
|
136
|
+
<td style="text-align:left">Android 8+</td>
|
|
137
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
138
|
+
</tr>
|
|
139
|
+
<tr>
|
|
140
|
+
<td style="text-align:left">Safari 10+</td>
|
|
141
|
+
<td style="text-align:left">iOS 15+, iOS 11+</td>
|
|
142
|
+
<td style="text-align:left">HLS/DASH</td>
|
|
143
|
+
</tr>
|
|
144
|
+
</tbody>
|
|
145
|
+
</table>
|
|
146
|
+
<h3>On Smart TVs</h3>
|
|
147
|
+
<table>
|
|
148
|
+
<thead>
|
|
149
|
+
<tr>
|
|
150
|
+
<th style="text-align:left"><strong>Smart TV</strong></th>
|
|
151
|
+
<th style="text-align:left"><strong>Supported</strong></th>
|
|
152
|
+
<th style="text-align:left"><strong>Supported stream formats</strong></th>
|
|
153
|
+
</tr>
|
|
154
|
+
</thead>
|
|
155
|
+
<tbody>
|
|
156
|
+
<tr>
|
|
157
|
+
<td style="text-align:left">Samsung</td>
|
|
158
|
+
<td style="text-align:left">Tizen 2.4+ (2016)</td>
|
|
159
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
160
|
+
</tr>
|
|
161
|
+
<tr>
|
|
162
|
+
<td style="text-align:left">LG</td>
|
|
163
|
+
<td style="text-align:left">webOS 3.0+ (2016)</td>
|
|
164
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
165
|
+
</tr>
|
|
166
|
+
<tr>
|
|
167
|
+
<td style="text-align:left">Vizio</td>
|
|
168
|
+
<td style="text-align:left">2020+</td>
|
|
169
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
170
|
+
</tr>
|
|
171
|
+
<tr>
|
|
172
|
+
<td style="text-align:left">Hisense (VIDAA U)</td>
|
|
173
|
+
<td style="text-align:left">2018+</td>
|
|
174
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
175
|
+
</tr>
|
|
176
|
+
<tr>
|
|
177
|
+
<td style="text-align:left">Multiple Brands</td>
|
|
178
|
+
<td style="text-align:left">TiVo OS</td>
|
|
179
|
+
<td style="text-align:left">DASH/HLS</td>
|
|
180
|
+
</tr>
|
|
181
|
+
</tbody>
|
|
182
|
+
</table>
|
|
183
|
+
<p><strong>Hisense:</strong> Due to significant device fragmentation within the Hisense platform, we do not have access to all devices for testing purposes and thus cannot guarantee there won't be edge cases for this platform. However, some devices (specifically Android TV and Roku-based devices) may have higher levels of compatibility than others.</p>
|
|
184
|
+
<h3>On Consoles</h3>
|
|
185
|
+
<table>
|
|
186
|
+
<thead>
|
|
187
|
+
<tr>
|
|
188
|
+
<th style="text-align:left"><strong>Console</strong></th>
|
|
189
|
+
<th style="text-align:left"><strong>Supported</strong></th>
|
|
190
|
+
<th style="text-align:left"><strong>Supported stream formats</strong></th>
|
|
191
|
+
</tr>
|
|
192
|
+
</thead>
|
|
193
|
+
<tbody>
|
|
194
|
+
<tr>
|
|
195
|
+
<td style="text-align:left">Xbox</td>
|
|
196
|
+
<td style="text-align:left">One, Series S, Series X</td>
|
|
197
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
198
|
+
</tr>
|
|
199
|
+
<tr>
|
|
200
|
+
<td style="text-align:left">PlayStation</td>
|
|
201
|
+
<td style="text-align:left">4, 5</td>
|
|
202
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
203
|
+
</tr>
|
|
204
|
+
<tr>
|
|
205
|
+
<td style="text-align:left">Comcast</td>
|
|
206
|
+
<td style="text-align:left">X1</td>
|
|
207
|
+
<td style="text-align:left">DASH/HLS/SMOOTH</td>
|
|
208
|
+
</tr>
|
|
209
|
+
</tbody>
|
|
210
|
+
</table>
|
|
211
|
+
<hr>
|
|
212
|
+
<a id="drm-support" class="tsd-anchor"></a><h3 class="tsd-anchor-link">DRM Support<a href="#drm-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><h3>On Desktop Devices</h3>
|
|
213
|
+
<p style="font-size: 14.4px; color: #999; margin: 0 0 9px;">Scroll sideways to view all columns</p>
|
|
214
|
+
<div style="width: 100%; overflow-x: auto;">
|
|
215
|
+
<table>
|
|
216
|
+
<thead>
|
|
217
|
+
<tr>
|
|
218
|
+
<th>Browser</th>
|
|
219
|
+
<th>Minimum OS Version</th>
|
|
220
|
+
<th>DASH ClearKey</th>
|
|
221
|
+
<th>DASH Widevine</th>
|
|
222
|
+
<th>DASH/SMOOTH/HLS PlayReady</th>
|
|
223
|
+
<th>HLS AES128</th>
|
|
224
|
+
<th>HLS Widevine</th>
|
|
225
|
+
<th>HLS FairPlay</th>
|
|
226
|
+
</tr>
|
|
227
|
+
</thead>
|
|
228
|
+
<tbody>
|
|
229
|
+
<tr>
|
|
230
|
+
<td>Chrome (last 3 major versions)</td>
|
|
231
|
+
<td>OS versions supported by Chrome</td>
|
|
232
|
+
<td>✅</td>
|
|
233
|
+
<td>✅</td>
|
|
234
|
+
<td>-</td>
|
|
235
|
+
<td>✅</td>
|
|
236
|
+
<td>✅</td>
|
|
237
|
+
<td>-</td>
|
|
238
|
+
</tr>
|
|
239
|
+
<tr>
|
|
240
|
+
<td>Firefox (last 3 major versions)</td>
|
|
241
|
+
<td>OS versions supported by Firefox</td>
|
|
242
|
+
<td>✅</td>
|
|
243
|
+
<td>✅</td>
|
|
244
|
+
<td>-</td>
|
|
245
|
+
<td>✅</td>
|
|
246
|
+
<td>✅</td>
|
|
247
|
+
<td>-</td>
|
|
248
|
+
</tr>
|
|
249
|
+
<tr>
|
|
250
|
+
<td>Opera (last 3 major versions)</td>
|
|
251
|
+
<td>OS versions supported by Opera</td>
|
|
252
|
+
<td>✅</td>
|
|
253
|
+
<td>✅</td>
|
|
254
|
+
<td>-</td>
|
|
255
|
+
<td>✅</td>
|
|
256
|
+
<td>✅</td>
|
|
257
|
+
<td>-</td>
|
|
258
|
+
</tr>
|
|
259
|
+
<tr>
|
|
260
|
+
<td>Safari 10+</td>
|
|
261
|
+
<td>macOS Sierra</td>
|
|
262
|
+
<td>☓</td>
|
|
263
|
+
<td>-</td>
|
|
264
|
+
<td>-</td>
|
|
265
|
+
<td>✅</td>
|
|
266
|
+
<td>-</td>
|
|
267
|
+
<td>✅</td>
|
|
268
|
+
</tr>
|
|
269
|
+
<tr>
|
|
270
|
+
<td>Edge (last 3 major versions)</td>
|
|
271
|
+
<td>Windows 8.1</td>
|
|
272
|
+
<td>✅</td>
|
|
273
|
+
<td>✅</td>
|
|
274
|
+
<td>✅</td>
|
|
275
|
+
<td>✅</td>
|
|
276
|
+
<td>✅</td>
|
|
277
|
+
<td>-</td>
|
|
278
|
+
</tr>
|
|
279
|
+
<tr>
|
|
280
|
+
<td>Edge (last 3 major versions)</td>
|
|
281
|
+
<td>Windows 7 / macOS 10.12</td>
|
|
282
|
+
<td>✅</td>
|
|
283
|
+
<td>✅</td>
|
|
284
|
+
<td>-</td>
|
|
285
|
+
<td>✅</td>
|
|
286
|
+
<td>✅</td>
|
|
287
|
+
<td>-</td>
|
|
288
|
+
</tr>
|
|
289
|
+
</tbody>
|
|
290
|
+
</table>
|
|
291
|
+
</div>
|
|
292
|
+
<h3>On Mobile Devices</h3>
|
|
293
|
+
<p style="font-size: 14.4px; color: #999; margin: 0 0 9px;">Scroll sideways to view all columns</p>
|
|
294
|
+
<div style="width: 100%; overflow-x: auto;">
|
|
295
|
+
<table>
|
|
296
|
+
<thead>
|
|
297
|
+
<tr>
|
|
298
|
+
<th>Browser</th>
|
|
299
|
+
<th>Minimum OS Version</th>
|
|
300
|
+
<th>DASH ClearKey</th>
|
|
301
|
+
<th>DASH Widevine</th>
|
|
302
|
+
<th>DASH/SMOOTH/HLS PlayReady</th>
|
|
303
|
+
<th>HLS AES128</th>
|
|
304
|
+
<th>HLS Widevine</th>
|
|
305
|
+
<th>HLS FairPlay</th>
|
|
306
|
+
</tr>
|
|
307
|
+
</thead>
|
|
308
|
+
<tbody>
|
|
309
|
+
<tr>
|
|
310
|
+
<td>Chrome on Android (latest major release)</td>
|
|
311
|
+
<td>Android 4.4 - 6</td>
|
|
312
|
+
<td>✅</td>
|
|
313
|
+
<td>✅</td>
|
|
314
|
+
<td>-</td>
|
|
315
|
+
<td>✅</td>
|
|
316
|
+
<td>✅</td>
|
|
317
|
+
<td>-</td>
|
|
318
|
+
</tr>
|
|
319
|
+
<tr>
|
|
320
|
+
<td>Chrome on Android (last 3 major versions)</td>
|
|
321
|
+
<td>Android 7</td>
|
|
322
|
+
<td>✅</td>
|
|
323
|
+
<td>✅</td>
|
|
324
|
+
<td>-</td>
|
|
325
|
+
<td>✅</td>
|
|
326
|
+
<td>✅</td>
|
|
327
|
+
<td>-</td>
|
|
328
|
+
</tr>
|
|
329
|
+
<tr>
|
|
330
|
+
<td>Edge (last 3 major versions)</td>
|
|
331
|
+
<td>Android 4.4</td>
|
|
332
|
+
<td>✅</td>
|
|
333
|
+
<td>✅</td>
|
|
334
|
+
<td>-</td>
|
|
335
|
+
<td>✅</td>
|
|
336
|
+
<td>✅</td>
|
|
337
|
+
<td>-</td>
|
|
338
|
+
</tr>
|
|
339
|
+
<tr>
|
|
340
|
+
<td>Safari 10</td>
|
|
341
|
+
<td>iOS 14</td>
|
|
342
|
+
<td>-</td>
|
|
343
|
+
<td>-</td>
|
|
344
|
+
<td>-</td>
|
|
345
|
+
<td>✅</td>
|
|
346
|
+
<td>-</td>
|
|
347
|
+
<td>-</td>
|
|
348
|
+
</tr>
|
|
349
|
+
<tr>
|
|
350
|
+
<td>Safari 11.2</td>
|
|
351
|
+
<td>iOS 14</td>
|
|
352
|
+
<td>-</td>
|
|
353
|
+
<td>-</td>
|
|
354
|
+
<td>-</td>
|
|
355
|
+
<td>✅</td>
|
|
356
|
+
<td>-</td>
|
|
357
|
+
<td>✅</td>
|
|
358
|
+
</tr>
|
|
359
|
+
</tbody>
|
|
360
|
+
</table>
|
|
361
|
+
</div>
|
|
362
|
+
<h3>On Smart TVs & Consoles</h3>
|
|
363
|
+
<p style="font-size: 14.4px; color: #999; margin: 0 0 9px;">Scroll sideways to view all columns</p>
|
|
364
|
+
<div style="width: 100%; overflow-x: auto;">
|
|
365
|
+
<table>
|
|
366
|
+
<thead>
|
|
367
|
+
<tr>
|
|
368
|
+
<th>Device</th>
|
|
369
|
+
<th>Minimum Model/Year</th>
|
|
370
|
+
<th>DASH ClearKey</th>
|
|
371
|
+
<th>DASH Widevine</th>
|
|
372
|
+
<th>DASH PlayReady</th>
|
|
373
|
+
<th>SMOOTH/HLS PlayReady</th>
|
|
374
|
+
<th>HLS AES128</th>
|
|
375
|
+
<th>HLS Widevine</th>
|
|
376
|
+
<th>HLS FairPlay</th>
|
|
377
|
+
</tr>
|
|
378
|
+
</thead>
|
|
379
|
+
<tbody>
|
|
380
|
+
<tr>
|
|
381
|
+
<td>Samsung</td>
|
|
382
|
+
<td><a href="https://developer.samsung.com/tv/develop/specifications/general-specifications#platform-features">Tizen 2.4 (2016)</a></td>
|
|
383
|
+
<td>✅</td>
|
|
384
|
+
<td>-</td>
|
|
385
|
+
<td>✅</td>
|
|
386
|
+
<td>✅</td>
|
|
387
|
+
<td>✅</td>
|
|
388
|
+
<td>-</td>
|
|
389
|
+
<td>-</td>
|
|
390
|
+
</tr>
|
|
391
|
+
<tr>
|
|
392
|
+
<td></td>
|
|
393
|
+
<td><a href="https://developer.samsung.com/tv/develop/specifications/general-specifications#platform-features">Tizen 3.0 (2017)</a></td>
|
|
394
|
+
<td>✅</td>
|
|
395
|
+
<td>✅</td>
|
|
396
|
+
<td>✅</td>
|
|
397
|
+
<td>✅</td>
|
|
398
|
+
<td>✅</td>
|
|
399
|
+
<td>✅</td>
|
|
400
|
+
<td>-</td>
|
|
401
|
+
</tr>
|
|
402
|
+
<tr>
|
|
403
|
+
<td></td>
|
|
404
|
+
<td><a href="https://developer.samsung.com/tv/develop/specifications/general-specifications#platform-features">Tizen 4.0+ (2019+)</a></td>
|
|
405
|
+
<td>✅</td>
|
|
406
|
+
<td>✅</td>
|
|
407
|
+
<td>✅</td>
|
|
408
|
+
<td>✅</td>
|
|
409
|
+
<td>✅</td>
|
|
410
|
+
<td>✅</td>
|
|
411
|
+
<td>-</td>
|
|
412
|
+
</tr>
|
|
413
|
+
<tr>
|
|
414
|
+
<td>LG</td>
|
|
415
|
+
<td><a href="https://webostv.developer.lge.com/develop/specifications/streaming-protocol-drm">webOS 3.0 (2016)</a></td>
|
|
416
|
+
<td>✅</td>
|
|
417
|
+
<td>✅</td>
|
|
418
|
+
<td>✅</td>
|
|
419
|
+
<td>✅</td>
|
|
420
|
+
<td>✅</td>
|
|
421
|
+
<td>✅</td>
|
|
422
|
+
<td>-</td>
|
|
423
|
+
</tr>
|
|
424
|
+
<tr>
|
|
425
|
+
<td>Hisense</td>
|
|
426
|
+
<td>2018+</td>
|
|
427
|
+
<td>-</td>
|
|
428
|
+
<td>-</td>
|
|
429
|
+
<td>✅</td>
|
|
430
|
+
<td>-</td>
|
|
431
|
+
<td>-</td>
|
|
432
|
+
<td>-</td>
|
|
433
|
+
<td>-</td>
|
|
434
|
+
</tr>
|
|
435
|
+
<tr>
|
|
436
|
+
<td>Xbox</td>
|
|
437
|
+
<td>One</td>
|
|
438
|
+
<td>✅</td>
|
|
439
|
+
<td>-</td>
|
|
440
|
+
<td>✅</td>
|
|
441
|
+
<td>✅</td>
|
|
442
|
+
<td>✅</td>
|
|
443
|
+
<td>-</td>
|
|
444
|
+
<td>-</td>
|
|
445
|
+
</tr>
|
|
446
|
+
<tr>
|
|
447
|
+
<td>PlayStation</td>
|
|
448
|
+
<td>4</td>
|
|
449
|
+
<td>✅</td>
|
|
450
|
+
<td>-</td>
|
|
451
|
+
<td>✅</td>
|
|
452
|
+
<td>✅</td>
|
|
453
|
+
<td>✅</td>
|
|
454
|
+
<td>-</td>
|
|
455
|
+
<td>-</td>
|
|
456
|
+
</tr>
|
|
457
|
+
<tr>
|
|
458
|
+
<td>PlayStation</td>
|
|
459
|
+
<td>5</td>
|
|
460
|
+
<td>✅</td>
|
|
461
|
+
<td>✅</td>
|
|
462
|
+
<td>✅</td>
|
|
463
|
+
<td>✅</td>
|
|
464
|
+
<td>✅</td>
|
|
465
|
+
<td>✅</td>
|
|
466
|
+
<td>-</td>
|
|
467
|
+
</tr>
|
|
468
|
+
</tbody>
|
|
469
|
+
</table>
|
|
470
|
+
</div>
|
|
471
|
+
<p>✅ supported | ☓ not supported | - restricted by the platform</p>
|
|
472
|
+
<hr>
|
|
473
|
+
<a id="error-codes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Error Codes<a href="#error-codes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Refer <a href="./enums/MKErrorCode.html">MKErrorCodes</a> for more details regarding error codes.</p>
|
|
474
|
+
<hr>
|
|
475
|
+
<a id="features" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Features<a href="#features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="player-analytics" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Player Analytics<a href="#player-analytics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Analytics comes pre-integrated in the player and can be used to track playback activity. You can enable analytics by configuring analytics license key during mkplayer setup.<br>
|
|
476
|
+
For a minimal setup, only analytics license key needs to be specified in analytics configuration. This is sufficient to enable basic playback tracking.</p>
|
|
477
|
+
<pre><code class="javascript"><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">player</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-10">MKPlayer</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-0">videoContainer</span><span class="hl-1">, </span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> ...</span><span class="hl-0">playerConfig</span><span class="hl-1">, </span><span class="hl-6">// rest of playerConfig</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-11">"PLAYER_LICENSE_HERE"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">analytics:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-11">"ANALYTICS_LICENSE_HERE"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">);</span>
|
|
478
|
+
</code><button type="button">Copy</button></pre>
|
|
479
|
+
|
|
480
|
+
<p>To enrich analytics data, custom data can be used to provide additional information about user, session or content being played. This custom data can be supplied during player initialization (through playerConfig) or associated with individual sources (through sourceConfig).<br>
|
|
481
|
+
Refer <a href="./interfaces/MKAnalyticsConfig.html">MKAnalyticsConfig</a> for more details.</p>
|
|
482
|
+
<hr>
|
|
483
|
+
<a id="http-signing-requests-and-widevine-license-encryption" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Http Signing Requests and Widevine License Encryption<a href="#http-signing-requests-and-widevine-license-encryption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Prerequisites</strong> - Please refer to the <a href="#setup">quick start guide</a> to configure and set up MKPlayer.</p>
|
|
484
|
+
<p>MKPlayer Web SDK supports Http request signing using Key Sign Service (KSS) and Widevine license encryption for supported MediaKind registered sources. These features can be enabled through playerConfig.</p>
|
|
485
|
+
<h3>Http Signing Requests</h3>
|
|
486
|
+
<p>Http signing generates signatures for playback Http requests to help secure access to content. To enable Http signing, set <a href="./interfaces/MKPlayerConfig.html#enablesecureurl">enableSecureUrl</a> to <code>true</code> in playerConfig and provide kssUrl through <code>registered.environmentConfig.kssUrl</code> in <a href="./interfaces/MKEnvironmentConfig.html">MKEnvironmentConfig</a>.</p>
|
|
487
|
+
<pre><code class="javascript"><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">player</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-10">MKPlayer</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-0">videoContainer</span><span class="hl-1">, </span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> ...</span><span class="hl-0">playerConfig</span><span class="hl-1">, </span><span class="hl-6">// rest of playerConfig</span><br/><span class="hl-1"> </span><span class="hl-0">enableSecureUrl:</span><span class="hl-1"> </span><span class="hl-8">true</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">sourceConfig</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-11">"Title for your source"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">assetType:</span><span class="hl-1"> </span><span class="hl-11">"Your asset type"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">registered:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">mediaId:</span><span class="hl-1"> </span><span class="hl-11">"Media ID"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">environmentConfig:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">serverUrl:</span><span class="hl-1"> </span><span class="hl-11">"Server URL"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">authToken:</span><span class="hl-1"> </span><span class="hl-11">"STS Authentication Token"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">ownerUid:</span><span class="hl-1"> </span><span class="hl-11">"azuki"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">kssUrl:</span><span class="hl-1"> </span><span class="hl-11">"KSS URL"</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">load</span><span class="hl-1">(</span><span class="hl-0">sourceConfig</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-10">then</span><span class="hl-1">(() </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-10">log</span><span class="hl-1">(</span><span class="hl-11">"Source loaded successfully!"</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span>
|
|
488
|
+
</code><button type="button">Copy</button></pre>
|
|
489
|
+
|
|
490
|
+
<p>Refer <a href="./interfaces/MKRegisteredSource.html">MKRegisteredSource</a> and <a href="./interfaces/MKEnvironmentConfig.html">MKEnvironmentConfig</a> for more details.</p>
|
|
491
|
+
<h3>Widevine License Encryption</h3>
|
|
492
|
+
<p>Widevine license encryption is supported through the same Key Sign Service (KSS). To enable this feature, set <a href="./interfaces/MKPlayerConfig.html#enablewidevineencryption">enableWidevineEncryption</a> to <code>true</code> in playerConfig during MKPlayer initialization.</p>
|
|
493
|
+
<pre><code class="javascript"><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">player</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-10">MKPlayer</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-0">videoContainer</span><span class="hl-1">, </span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> ...</span><span class="hl-0">playerConfig</span><span class="hl-1">, </span><span class="hl-6">// rest of playerConfig</span><br/><span class="hl-1"> </span><span class="hl-0">enableWidevineEncryption:</span><span class="hl-1"> </span><span class="hl-8">true</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">);</span>
|
|
494
|
+
</code><button type="button">Copy</button></pre>
|
|
495
|
+
|
|
496
|
+
<p>A KSS URL is required for widevine license encryption. Configure <code>kssUrl</code> same way as shown for <a href="#http-signing-requests">Http request signing</a>.<br>
|
|
497
|
+
Refer <a href="./interfaces/MKEnvironmentConfig.html">MKEnvironmentConfig</a> for more details.</p>
|
|
498
|
+
<p><strong>Note: Enabling <code>widevineEncryption</code> and <code>secureUrl</code> from client-side does not guarantee encrypted widevine DRM key and KSS feature, alignment with backend is required.</strong></p>
|
|
499
|
+
<hr>
|
|
500
|
+
<a id="adobe-primetime-support" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Adobe Primetime support<a href="#adobe-primetime-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Prerequisites</strong> - Please refer to the <a href="#setup">quick start guide</a> to configure and set up MKPlayer.</p>
|
|
501
|
+
<p>MKPlayer Web SDK supports Adobe Primetime integration to enable Adobe Primetime authentication for content playback. This feature can be configured and passed as part of <code>MKRegisteredSource</code> config.<br>
|
|
502
|
+
Refer <a href="./interfaces/MKAdobePrimetimeConfig.html">MKAdobePrimetimeConfig</a> and <a href="./interfaces/MKRegisteredSource.html">MKRegisteredSource</a> for more details</p>
|
|
503
|
+
<hr>
|
|
504
|
+
<a id="dai-ssaicsai-support" class="tsd-anchor"></a><h3 class="tsd-anchor-link">DAI (SSAI/CSAI) support<a href="#dai-ssaicsai-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Prerequisites</strong> - Please refer to the <a href="#setup">quick start guide</a> to configure and set up MKPlayer.</p>
|
|
505
|
+
<h3>Events</h3>
|
|
506
|
+
<p>The DAI events can be listened through events emitted by MKPlayer Web SDK along with other events. You can register event listeners to track ad playback lifecycle events.</p>
|
|
507
|
+
<pre><code class="javascript"><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">AdMarker</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is called after the ad data is discovered</span><br/><span class="hl-1">});</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">AdBreakStarted</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is called after the ad break started</span><br/><span class="hl-1">});</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">AdStarted</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is called after the ad in an ad break started</span><br/><span class="hl-1">});</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">AdQuartile</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is called during ad to indicate stages of ad playback</span><br/><span class="hl-1">});</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">AdFinished</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is called after the ad in an ad break ends</span><br/><span class="hl-1">});</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">AdBreakFinished</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is called after the ad break ends</span><br/><span class="hl-1">});</span>
|
|
508
|
+
</code><button type="button">Copy</button></pre>
|
|
509
|
+
|
|
510
|
+
<p>Refer <a href="./enums/MKPlayerEvent.html">MKPlayerEvents</a> for more details.</p>
|
|
511
|
+
<h3>APIs</h3>
|
|
512
|
+
<ul>
|
|
513
|
+
<li><strong>skipAd(isCSAI: boolean): Promise<void></strong> - To skip the current CSAI/SSAI ad. Has no effect if no ad is active or if ad's end is out of seekableRange.<br>
|
|
514
|
+
Refer <a href="./interfaces/MKPlayerAPI.html#skipad">skipAd</a> for more details.</li>
|
|
515
|
+
<li><strong>skipAdBreak(): void</strong> - To skip the current SSAI adBreak. Has no effect if no adBreak is active or if adBreak's end is out of seekableRange.<br>
|
|
516
|
+
Refer <a href="./interfaces/MKPlayerAPI.html#skipadbreak">skipAdBreak</a> for more details.</li>
|
|
517
|
+
</ul>
|
|
518
|
+
<hr>
|
|
519
|
+
<a id="google-pal-sdk-support" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Google PAL SDK support<a href="#google-pal-sdk-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Google's PAL (Programmatic Access Library) can be used with MKPlayer Web SDK and can be enabled by setting <a href="./interfaces/MKPlayerConfig.html#enablegooglepal">enableGooglePal</a>.<br>
|
|
520
|
+
Refer <a href="https://developers.google.com/ad-manager/pal/html5/get-started">Google PAL SDK doc</a> for more details.</p>
|
|
521
|
+
<hr>
|
|
522
|
+
<a id="pause-ads" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Pause Ads<a href="#pause-ads" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>MKPlayer Web SDK supports pause ads, which display an image overlay when user pauses playback. This feature is disabled by default and is not supported when <a href="./interfaces/MKPlayerConfig.html#ui">MKPlayerConfig.ui</a> is enabled.</p>
|
|
523
|
+
<h3>Configuration and Container</h3>
|
|
524
|
+
<p>Enable pauseAds by setting <code>pauseAdEnabled</code> to true and providing document-attached HTML div element through <code>pauseAdView</code> during player initialization process. The application is responsible for creating and managing container's layout and styling.</p>
|
|
525
|
+
<pre><code class="javascript"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">pauseAdContainer</span><span class="hl-1"> = </span><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-10">createElement</span><span class="hl-1">(</span><span class="hl-11">"div"</span><span class="hl-1">);</span><br/><span class="hl-0">pauseAdContainer</span><span class="hl-1">.</span><span class="hl-0">id</span><span class="hl-1"> = </span><span class="hl-11">"pause-ad-container"</span><span class="hl-1">;</span><br/><span class="hl-0">document</span><span class="hl-1">.</span><span class="hl-0">body</span><span class="hl-1">.</span><span class="hl-10">appendChild</span><span class="hl-1">(</span><span class="hl-0">pauseAdContainer</span><span class="hl-1">);</span><br/><br/><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">player</span><span class="hl-1"> = </span><span class="hl-8">new</span><span class="hl-1"> </span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-10">MKPlayer</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-0">videoContainer</span><span class="hl-1">, </span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> ...</span><span class="hl-0">playerConfig</span><span class="hl-1">, </span><span class="hl-6">// rest of playerConfig</span><br/><span class="hl-1"> </span><span class="hl-0">ssaiAdConfig:</span><span class="hl-1"> {</span><br/><span class="hl-1"> ...</span><span class="hl-0">playerConfig</span><span class="hl-1">.</span><span class="hl-0">ssaiAdConfig</span><span class="hl-1">, </span><span class="hl-6">// rest of playerConfig.ssaiAdConfig</span><br/><span class="hl-1"> </span><span class="hl-0">pauseAdEnabled:</span><span class="hl-1"> </span><span class="hl-8">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">pauseAdView:</span><span class="hl-1"> </span><span class="hl-0">pauseAdContainer</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">);</span>
|
|
526
|
+
</code><button type="button">Copy</button></pre>
|
|
527
|
+
|
|
528
|
+
<h3>Requirements and Limitations</h3>
|
|
529
|
+
<ul>
|
|
530
|
+
<li>Position pauseAd container above video elements and below playback controls. The displayed pauseAd image size depends on container dimensions, which are managed by app.</li>
|
|
531
|
+
<li>Pause ads require <code>#EXT-X-SESSION-DATA</code> tag in HLS master manifest.</li>
|
|
532
|
+
<li>Pause ads are displayed only for user initiated pauses.</li>
|
|
533
|
+
<li>Pause ads are suppressed during ad breaks (both SSAI and CSAI) and Picture-in-Picture (PiP) mode.</li>
|
|
534
|
+
<li>Pause ad feature is disabled when <code>MKPlayerConfig.ui</code> is enabled.</li>
|
|
535
|
+
</ul>
|
|
536
|
+
<h3>Events</h3>
|
|
537
|
+
<p>MKPlayer Web SDK provides the following events to track the pause ad lifecycle and event listeners for them can be registered as shown below:</p>
|
|
538
|
+
<pre><code class="javascript"><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">PauseAdShown</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is fired when the pause ad overlay is rendered</span><br/><span class="hl-1">});</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">PauseAdDismissed</span><span class="hl-1">, () </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is fired when the overlay is dismissed or playback resumes by dismissing pause ad overlay if active</span><br/><span class="hl-1">});</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">on</span><span class="hl-1">(</span><span class="hl-0">mkplayer</span><span class="hl-1">.</span><span class="hl-0">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">PauseAdWarning</span><span class="hl-1">, (</span><span class="hl-0">event</span><span class="hl-1">) </span><span class="hl-8">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">// Is fired when image preloading fails or times out, or when the pause ad container is missing</span><br/><span class="hl-1">});</span>
|
|
539
|
+
</code><button type="button">Copy</button></pre>
|
|
540
|
+
|
|
541
|
+
<h3>APIs</h3>
|
|
542
|
+
<ul>
|
|
543
|
+
<li><strong>dismissPauseAd(): boolean</strong> - Dismisses the active pause ad overlay, fires the dismissal event and close beacon, and returns true if an overlay was dismissed. Otherwise, returns false.<br>
|
|
544
|
+
If any preloading or rendering of pause ad overlay was in progress then that is cleared and returns false (since ad was not active).<br>
|
|
545
|
+
Refer <a href="./interfaces/MKPlayerAPI.html#dismisspausead">dismissPauseAd</a> for more details.</li>
|
|
546
|
+
<li><strong>isPauseAdActive(): boolean</strong> — Returns true if a pause ad overlay is active; otherwise, returns false.<br>
|
|
547
|
+
Refer <a href="./interfaces/MKPlayerAPI.html#ispauseadactive">isPauseAdActive</a> for more details.</li>
|
|
548
|
+
</ul>
|
|
549
|
+
<p>Both methods return false when the pause ad feature is disabled.</p>
|
|
550
|
+
<p>Refer <a href="./interfaces/MKSsaiAdConfig.html">MKSsaiAdConfig</a>, <a href="./interfaces/MKPauseAd.html">MKPauseAd</a> for more details.</p>
|
|
551
|
+
<hr>
|
|
552
|
+
<a id="low-latency" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Low Latency<a href="#low-latency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Prerequisites</strong> - Please refer to the <a href="#setup">quick start guide</a> to configure and set up MKPlayer.</p>
|
|
553
|
+
<p>MKPlayer Web SDK supports low latency playback for live streams using LL-HLS and LL-DASH.<br>
|
|
554
|
+
Low latency playback can be configured at source level using <code>lowLatency</code> in <a href="./interfaces/MKLiveConfigAtSourceLevel.html">MKLiveConfigAtSourceLevel</a>. You can configure target latency and catchup/fallback behaviour. Default target latency is 8 sec.<br>
|
|
555
|
+
<strong>Note: Enabling <code>lowLatency</code> from MKPlayer Web SDK doesn't guarantee low latency playback, it enforces client-side only. Alignment with backend is required i.e., stream must be configured correctly.</strong></p>
|
|
556
|
+
<h3>Default Configuration</h3>
|
|
557
|
+
<p>Set <a href="./interfaces/MKSourceConfig.html#enablelowlatency">enableLowLatency</a> to <code>true</code> to enable low latency playback for supported live streams.</p>
|
|
558
|
+
<pre><code class="javascript"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">sourceConfig</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">hls:</span><span class="hl-1"> </span><span class="hl-11">"https://my-cdn.com/mysource/hls/index.m3u8"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">enableLowLatency:</span><span class="hl-1"> </span><span class="hl-8">true</span><br/><span class="hl-1">};</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">load</span><span class="hl-1">(</span><span class="hl-0">sourceConfig</span><span class="hl-1">);</span>
|
|
559
|
+
</code><button type="button">Copy</button></pre>
|
|
560
|
+
|
|
561
|
+
<h3>Manual Configuration</h3>
|
|
562
|
+
<p>Manual lowlatency configs can be configured using <code>lowLatency</code> property in <a href="./interfaces/MKSourceConfig.html#live">live</a></p>
|
|
563
|
+
<pre><code class="javascript"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">sourceConfig</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">hls:</span><span class="hl-1"> </span><span class="hl-11">"https://my-cdn.com/mysource/hls/index.m3u8"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">enableLowLatency:</span><span class="hl-1"> </span><span class="hl-8">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">live:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">lowLatency:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">targetLatency:</span><span class="hl-1"> </span><span class="hl-13">8</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">catchup:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">playbackRateThreshold:</span><span class="hl-1"> </span><span class="hl-13">0.075</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">seekThreshold:</span><span class="hl-1"> </span><span class="hl-13">5</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">playbackRate:</span><span class="hl-1"> </span><span class="hl-13">1.08</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">fallback:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">playbackRateThreshold:</span><span class="hl-1"> </span><span class="hl-13">0.075</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">seekThreshold:</span><span class="hl-1"> </span><span class="hl-13">5</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">playbackRate:</span><span class="hl-1"> </span><span class="hl-13">0.95</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">};</span><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">load</span><span class="hl-1">(</span><span class="hl-0">sourceConfig</span><span class="hl-1">);</span>
|
|
564
|
+
</code><button type="button">Copy</button></pre>
|
|
565
|
+
|
|
566
|
+
<p>The above same configuration approach applies to DASH live streams by using <code>dash</code> source URL.</p>
|
|
567
|
+
<h3>APIs</h3>
|
|
568
|
+
<ul>
|
|
569
|
+
<li>Use <a href="./interfaces/MKPlayerAPI.html#islowlatencyplayback">isLowLatencyPlayback</a> to check whether active live stream is playing in low latency mode.</li>
|
|
570
|
+
<li>Can also use <code>player.lowlatency</code> API to get current latency and target latency.</li>
|
|
571
|
+
</ul>
|
|
572
|
+
<pre><code class="javascript"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">currentLatency</span><span class="hl-1"> = </span><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-0">lowlatency</span><span class="hl-1">.</span><span class="hl-10">getLatency</span><span class="hl-1">();</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">targetLatency</span><span class="hl-1"> = </span><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-0">lowlatency</span><span class="hl-1">.</span><span class="hl-10">getTargetLatency</span><span class="hl-1">();</span>
|
|
573
|
+
</code><button type="button">Copy</button></pre>
|
|
574
|
+
|
|
575
|
+
<p>These APIs return values in sec. Enabling low latency doesn't guarantee that it will work, stream must support LL-HLS or LL-DASH.<br>
|
|
576
|
+
Refer <a href="./interfaces/MKLowLatencyAPI.html">MKLowLatencyAPI</a> for more details.</p>
|
|
577
|
+
<hr>
|
|
578
|
+
<a id="thumbnails" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Thumbnails<a href="#thumbnails" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><strong>Prerequisites</strong> - Please refer to the <a href="#setup">quick start guide</a> to configure and set up MKPlayer.</p>
|
|
579
|
+
<p>MKPlayer Web SDK supports both HLS Image Media Playlist and DASH Image Adaptation Set formats to display thumbnails.<br>
|
|
580
|
+
DASH Image Adaptation Set processing is enabled by default in SDK.<br>
|
|
581
|
+
HLS Image Media Playlist processing is disabled by default. Enable it by setting <a href="./interfaces/MKPlayerConfig.html#enablehlsimagemediaplaylistsupport">enableHlsImageMediaPlaylistSupport</a> to true in playerConfig.<br>
|
|
582
|
+
The getThumbnail(time) API returns thumbnail for specified playback time or null if no thumbnail available.</p>
|
|
583
|
+
<pre><code class="javascript"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">thumbnail</span><span class="hl-1"> = </span><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">getThumbnail</span><span class="hl-1">(</span><span class="hl-0">time</span><span class="hl-1">);</span>
|
|
584
|
+
</code><button type="button">Copy</button></pre>
|
|
585
|
+
|
|
586
|
+
<p>The returned thumbnail provides the image URL and coordinates needed to extract the corresponding thumbnail from the sprite sheet.<br>
|
|
587
|
+
Refer <a href="./interfaces/MKPlayerAPI.html#getthumbnail">getThumbnail</a> for more details.</p>
|
|
588
|
+
<hr>
|
|
589
|
+
<a id="mkplayer-web-plugins" class="tsd-anchor"></a><h2 class="tsd-anchor-link">MKPlayer Web Plugins<a href="#mkplayer-web-plugins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><h3>MKAnalytics Plugin</h3>
|
|
590
|
+
<p>Analytics Plugin is a web plugin for MKPlayer Web SDK to enable and fetch playback analytics data.<br>
|
|
591
|
+
Refer <a href="https://mkplayer.azureedge.net/%24web/websdk/plugins/analytics/latest/docs/index.html">MKAnalytics Plugin</a></p>
|
|
592
|
+
<h3>MKBrandbrigade Plugin</h3>
|
|
593
|
+
<p>MKBrandbrigade Plugin is a web plugin for MKPlayer Web SDK to support augmented ads.<br>
|
|
594
|
+
Refer <a href="https://mkplayer.azureedge.net/%24web/websdk/plugins/brandbrigade/latest/docs/index.html">MKBrandbrigade Plugin</a></p>
|
|
595
|
+
<h3>MKConviva Plugin</h3>
|
|
596
|
+
<p>MKConviva Plugin is a web plugin for MKPlayer Web SDK that adds support for Conviva analytics to collect variety of player, user and app specific metrics.<br>
|
|
597
|
+
Refer <a href="https://mkplayer.azureedge.net/%24web/websdk/plugins/conviva/latest/docs/index.html">MKConviva Plugin</a></p>
|
|
598
|
+
<h3>MKCustomUI Plugin</h3>
|
|
599
|
+
<p>MKCustomUI Plugin is a web plugin for MKPlayer Web SDK allows developers to implement a customizable playback UI using Bitmovin Player V3.<br>
|
|
600
|
+
Refer <a href="https://mkplayer.azureedge.net/%24web/websdk/plugins/customui/latest/docs/index.html">MKCustomUI Plugin</a></p>
|
|
601
|
+
<h3>MKFMTS Plugin</h3>
|
|
602
|
+
<p>MKFMTS Plugin is a web plugin for MKPlayer Web SDK that adds <strong>Friend MTS ASiD</strong> watermarking support to provide advanced content security and anti-piracy features.<br>
|
|
603
|
+
Refer <a href="https://mkplayer.azureedge.net/%24web/websdk/plugins/fmts/latest/docs/index.html">MKFMTS Plugin</a></p>
|
|
604
|
+
<h3>MKGeoComply Plugin</h3>
|
|
605
|
+
<p>MKGeoComply Plugin is a web plugin for MKPlayer Web SDK that adds GeoComply BrowserGuard location verification support, gating playback of geo-restricted content behind a signed location JWT attached to the Azuki roll request.<br>
|
|
606
|
+
Refer <a href="https://mkplayer.azureedge.net/%24web/websdk/plugins/geocomply/latest/docs/index.html">MKGeoComply Plugin</a></p>
|
|
607
|
+
<h3>MKOMSDK Plugin</h3>
|
|
608
|
+
<p>MKOMSDK Plugin is a web plugin for MKPlayer Web SDK to support <code>AD Verification</code> on streaming assets.<br>
|
|
609
|
+
Refer <a href="https://mkplayer.azureedge.net/%24web/websdk/plugins/omsdk/latest/docs/index.html">MKOMSDK Plugin</a></p>
|
|
610
|
+
<hr>
|
|
611
|
+
<a id="quick-links" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Quick links<a href="#quick-links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
|
|
612
|
+
<li><a href="https://mkplayer.dev.mr.tv3cloud.com/player">MKPlayer Web RefApp</a></li>
|
|
613
|
+
<li><a href="./modules.html">Modules</a></li>
|
|
68
614
|
<li><a href="./interfaces/MKPlayerAPI.html">MKPlayerAPI</a></li>
|
|
69
615
|
<li><a href="./enums/MKPlayerEvent.html">MKPlayerEvents</a></li>
|
|
70
|
-
<li><a href="./enums/MKErrorCode.html">MKErrorCode</a></li>
|
|
71
616
|
<li><a href="./interfaces/MKPlayerConfig.html">MKPlayerConfig</a></li>
|
|
72
617
|
<li><a href="./interfaces/MKSourceConfig.html">MKSourceConfig</a></li>
|
|
618
|
+
<li><a href="./documents/CHANGELOG.html">CHANGELOG</a></li>
|
|
73
619
|
</ul>
|
|
74
|
-
</div></div>
|
|
75
|
-
<div class="col-sidebar">
|
|
76
|
-
<div class="page-menu">
|
|
77
|
-
<div class="tsd-navigation settings">
|
|
78
|
-
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
79
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
80
|
-
<div class="tsd-accordion-details">
|
|
81
|
-
<div class="tsd-filter-visibility">
|
|
82
|
-
<h4 class="uppercase">Member Visibility</h4><form>
|
|
83
|
-
<ul id="tsd-filter-options">
|
|
84
|
-
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div>
|
|
85
|
-
<div class="tsd-theme-toggle">
|
|
86
|
-
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
87
|
-
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
88
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
89
|
-
<div class="tsd-accordion-details">
|
|
90
|
-
<ul>
|
|
91
|
-
<li>
|
|
92
|
-
<ul>
|
|
93
|
-
<li><a href="#md:getting-started"><span>Getting <wbr/>Started</span></a></li>
|
|
94
|
-
<li>
|
|
95
|
-
<ul>
|
|
96
|
-
<li><a href="#md:step-1-get-the-latest-release-of-mkplayer"><span>Step 1: <wbr/>Get the latest release of MKPlayer.</span></a></li>
|
|
97
|
-
<li>
|
|
98
|
-
<ul>
|
|
99
|
-
<li><a href="#md:step-2-include-javascript-and-css-files-in-the-head-of-your-page"><span>Step 2: <wbr/>Include <wbr/>Java<wbr/>Script and CSS files in the head of your page.</span></a></li>
|
|
100
|
-
<li><a href="#md:step-3-add-a-html-ltdivgt-for-your-video-container"><span>Step 3: <wbr/>Add a HTML <div> for your video container.</span></a></li>
|
|
101
|
-
<li><a href="#md:step-4-player-initialization"><span>Step 4: <wbr/>Player initialization.</span></a></li>
|
|
102
|
-
<li><a href="#md:step-5-start-playback"><span>Step 5: <wbr/>Start playback.</span></a></li>
|
|
103
|
-
<li><a href="#md:step-6-stop-playback"><span>Step 6: <wbr/>Stop playback.</span></a></li>
|
|
104
|
-
<li><a href="#md:step-7-destroy-player-instance-and-release-resources"><span>Step 7: <wbr/>Destroy player instance and release resources.</span></a></li>
|
|
105
|
-
<li><a href="#md:note-additional-requirements-for-apple-devices-for-mac-iphone-ipad"><span>Note: <wbr/>Additional requirements for <wbr/>Apple devices (for <wbr/>Mac, i<wbr/>Phone, i<wbr/>Pad)</span></a></li>
|
|
106
|
-
<li><a href="#md:quick-links"><span>Quick links</span></a></li></ul></li></ul></li></ul></li></ul></div></details></div>
|
|
107
|
-
<div class="site-menu">
|
|
108
|
-
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>MKPlayer -<wbr/> v1.46.0</span></a>
|
|
109
|
-
<ul class="tsd-small-nested-navigation">
|
|
110
|
-
<li><a href="enums/MKAdQuartile.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g></svg><span>MKAd<wbr/>Quartile</span></a></li>
|
|
111
|
-
<li><a href="enums/MKAdType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKAd<wbr/>Type</span></a></li>
|
|
112
|
-
<li><a href="enums/MKAdaptationLogicType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKAdaptation<wbr/>Logic<wbr/>Type</span></a></li>
|
|
113
|
-
<li><a href="enums/MKAssetType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKAsset<wbr/>Type</span></a></li>
|
|
114
|
-
<li><a href="enums/MKBufferType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKBuffer<wbr/>Type</span></a></li>
|
|
115
|
-
<li><a href="enums/MKDrmType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKDrm<wbr/>Type</span></a></li>
|
|
116
|
-
<li><a href="enums/MKErrorCode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKError<wbr/>Code</span></a></li>
|
|
117
|
-
<li><a href="enums/MKHttpRequestType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKHttp<wbr/>Request<wbr/>Type</span></a></li>
|
|
118
|
-
<li><a href="enums/MKHttpResponseType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKHttp<wbr/>Response<wbr/>Type</span></a></li>
|
|
119
|
-
<li><a href="enums/MKLatencyMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKLatency<wbr/>Mode</span></a></li>
|
|
120
|
-
<li><a href="enums/MKLiveSynchronizationMethod.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKLive<wbr/>Synchronization<wbr/>Method</span></a></li>
|
|
121
|
-
<li><a href="enums/MKLogLevel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKLog<wbr/>Level</span></a></li>
|
|
122
|
-
<li><a href="enums/MKMediaType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKMedia<wbr/>Type</span></a></li>
|
|
123
|
-
<li><a href="enums/MKMetadataType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKMetadata<wbr/>Type</span></a></li>
|
|
124
|
-
<li><a href="enums/MKPlatformType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKPlatform<wbr/>Type</span></a></li>
|
|
125
|
-
<li><a href="enums/MKPlayerEngineType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKPlayer<wbr/>Engine<wbr/>Type</span></a></li>
|
|
126
|
-
<li><a href="enums/MKPlayerEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKPlayer<wbr/>Event</span></a></li>
|
|
127
|
-
<li><a href="enums/MKPlayerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKPlayer<wbr/>Type</span></a></li>
|
|
128
|
-
<li><a href="enums/MKProgramRestrictionType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKProgram<wbr/>Restriction<wbr/>Type</span></a></li>
|
|
129
|
-
<li><a href="enums/MKRttEstimationMethod.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKRtt<wbr/>Estimation<wbr/>Method</span></a></li>
|
|
130
|
-
<li><a href="enums/MKStartOffsetTimelineReference.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKStart<wbr/>Offset<wbr/>Timeline<wbr/>Reference</span></a></li>
|
|
131
|
-
<li><a href="enums/MKStreamType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKStream<wbr/>Type</span></a></li>
|
|
132
|
-
<li><a href="enums/MKTimeMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKTime<wbr/>Mode</span></a></li>
|
|
133
|
-
<li><a href="enums/MKViewMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKView<wbr/>Mode</span></a></li>
|
|
134
|
-
<li><a href="interfaces/MKAd.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>MKAd</span></a></li>
|
|
135
|
-
<li><a href="interfaces/MKAdBreak.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Break</span></a></li>
|
|
136
|
-
<li><a href="interfaces/MKAdBreakConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Break<wbr/>Config</span></a></li>
|
|
137
|
-
<li><a href="interfaces/MKAdBreakEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Break<wbr/>Event</span></a></li>
|
|
138
|
-
<li><a href="interfaces/MKAdBreakFinishedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Break<wbr/>Finished<wbr/>Event</span></a></li>
|
|
139
|
-
<li><a href="interfaces/MKAdBreakSkippedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Break<wbr/>Skipped<wbr/>Event</span></a></li>
|
|
140
|
-
<li><a href="interfaces/MKAdBreakStartedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Break<wbr/>Started<wbr/>Event</span></a></li>
|
|
141
|
-
<li><a href="interfaces/MKAdClickThroughEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Click<wbr/>Through<wbr/>Event</span></a></li>
|
|
142
|
-
<li><a href="interfaces/MKAdClickedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Clicked<wbr/>Event</span></a></li>
|
|
143
|
-
<li><a href="interfaces/MKAdCompanionEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Companion<wbr/>Event</span></a></li>
|
|
144
|
-
<li><a href="interfaces/MKAdConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Config</span></a></li>
|
|
145
|
-
<li><a href="interfaces/MKAdEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Event</span></a></li>
|
|
146
|
-
<li><a href="interfaces/MKAdFinishedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Finished<wbr/>Event</span></a></li>
|
|
147
|
-
<li><a href="interfaces/MKAdInteractionEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Interaction<wbr/>Event</span></a></li>
|
|
148
|
-
<li><a href="interfaces/MKAdLinearityChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Linearity<wbr/>Changed<wbr/>Event</span></a></li>
|
|
149
|
-
<li><a href="interfaces/MKAdManifestLoadedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Manifest<wbr/>Loaded<wbr/>Event</span></a></li>
|
|
150
|
-
<li><a href="interfaces/MKAdMarkerEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Marker<wbr/>Event</span></a></li>
|
|
151
|
-
<li><a href="interfaces/MKAdQuartileEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Quartile<wbr/>Event</span></a></li>
|
|
152
|
-
<li><a href="interfaces/MKAdSkippedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Skipped<wbr/>Event</span></a></li>
|
|
153
|
-
<li><a href="interfaces/MKAdStartedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Started<wbr/>Event</span></a></li>
|
|
154
|
-
<li><a href="interfaces/MKAdVerificationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Verification<wbr/>Event</span></a></li>
|
|
155
|
-
<li><a href="interfaces/MKAdaptationAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAdaptationAPI</span></a></li>
|
|
156
|
-
<li><a href="interfaces/MKAdaptationConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAdaptation<wbr/>Config</span></a></li>
|
|
157
|
-
<li><a href="interfaces/MKAdaptationData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAdaptation<wbr/>Data</span></a></li>
|
|
158
|
-
<li><a href="interfaces/MKAdaptationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAdaptation<wbr/>Event</span></a></li>
|
|
159
|
-
<li><a href="interfaces/MKAdaptationPlatformConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAdaptation<wbr/>Platform<wbr/>Config</span></a></li>
|
|
160
|
-
<li><a href="interfaces/MKAdobePrimetimeConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAdobe<wbr/>Primetime<wbr/>Config</span></a></li>
|
|
161
|
-
<li><a href="interfaces/MKAdvertisingConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAdvertising<wbr/>Config</span></a></li>
|
|
162
|
-
<li><a href="interfaces/MKAirplayChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAirplay<wbr/>Changed<wbr/>Event</span></a></li>
|
|
163
|
-
<li><a href="interfaces/MKAnalyticsConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAnalytics<wbr/>Config</span></a></li>
|
|
164
|
-
<li><a href="interfaces/MKAspectRatioChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAspect<wbr/>Ratio<wbr/>Changed<wbr/>Event</span></a></li>
|
|
165
|
-
<li><a href="interfaces/MKAudioAdaptationData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Adaptation<wbr/>Data</span></a></li>
|
|
166
|
-
<li><a href="interfaces/MKAudioAdaptationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Adaptation<wbr/>Event</span></a></li>
|
|
167
|
-
<li><a href="interfaces/MKAudioChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Changed<wbr/>Event</span></a></li>
|
|
168
|
-
<li><a href="interfaces/MKAudioDownloadQualityChangeEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Download<wbr/>Quality<wbr/>Change<wbr/>Event</span></a></li>
|
|
169
|
-
<li><a href="interfaces/MKAudioDownloadQualityChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Download<wbr/>Quality<wbr/>Changed<wbr/>Event</span></a></li>
|
|
170
|
-
<li><a href="interfaces/MKAudioPlaybackQualityChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Playback<wbr/>Quality<wbr/>Changed<wbr/>Event</span></a></li>
|
|
171
|
-
<li><a href="interfaces/MKAudioQuality.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Quality</span></a></li>
|
|
172
|
-
<li><a href="interfaces/MKAudioQualityChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Quality<wbr/>Changed<wbr/>Event</span></a></li>
|
|
173
|
-
<li><a href="interfaces/MKAudioQualityEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Quality<wbr/>Event</span></a></li>
|
|
174
|
-
<li><a href="interfaces/MKAudioTrack.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Track</span></a></li>
|
|
175
|
-
<li><a href="interfaces/MKAudioTrackEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAudio<wbr/>Track<wbr/>Event</span></a></li>
|
|
176
|
-
<li><a href="interfaces/MKBitrateLimitationConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKBitrate<wbr/>Limitation<wbr/>Config</span></a></li>
|
|
177
|
-
<li><a href="interfaces/MKBufferAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKBufferAPI</span></a></li>
|
|
178
|
-
<li><a href="interfaces/MKBufferConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKBuffer<wbr/>Config</span></a></li>
|
|
179
|
-
<li><a href="interfaces/MKBufferLevel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKBuffer<wbr/>Level</span></a></li>
|
|
180
|
-
<li><a href="interfaces/MKBufferMediaTypeConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKBuffer<wbr/>Media<wbr/>Type<wbr/>Config</span></a></li>
|
|
181
|
-
<li><a href="interfaces/MKCastAvailableEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCast<wbr/>Available<wbr/>Event</span></a></li>
|
|
182
|
-
<li><a href="interfaces/MKCastConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCast<wbr/>Config</span></a></li>
|
|
183
|
-
<li><a href="interfaces/MKCastStartedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCast<wbr/>Started<wbr/>Event</span></a></li>
|
|
184
|
-
<li><a href="interfaces/MKCastWaitingForDeviceEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCast<wbr/>Waiting<wbr/>For<wbr/>Device<wbr/>Event</span></a></li>
|
|
185
|
-
<li><a href="interfaces/MKCdnOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCdn<wbr/>Options</span></a></li>
|
|
186
|
-
<li><a href="interfaces/MKClearKeyDRMConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKClear<wbr/>KeyDRMConfig</span></a></li>
|
|
187
|
-
<li><a href="interfaces/MKClearKeyDRMConfigEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKClear<wbr/>KeyDRMConfig<wbr/>Entry</span></a></li>
|
|
188
|
-
<li><a href="interfaces/MKClearKeyDRMServerConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKClear<wbr/>KeyDRMServer<wbr/>Config</span></a></li>
|
|
189
|
-
<li><a href="interfaces/MKDownloadFinishedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDownload<wbr/>Finished<wbr/>Event</span></a></li>
|
|
190
|
-
<li><a href="interfaces/MKDownloadTiming.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDownload<wbr/>Timing</span></a></li>
|
|
191
|
-
<li><a href="interfaces/MKDownloadedAudioData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDownloaded<wbr/>Audio<wbr/>Data</span></a></li>
|
|
192
|
-
<li><a href="interfaces/MKDownloadedData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDownloaded<wbr/>Data</span></a></li>
|
|
193
|
-
<li><a href="interfaces/MKDownloadedVideoData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDownloaded<wbr/>Video<wbr/>Data</span></a></li>
|
|
194
|
-
<li><a href="interfaces/MKDrmAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDrmAPI</span></a></li>
|
|
195
|
-
<li><a href="interfaces/MKDrmConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDrm<wbr/>Config</span></a></li>
|
|
196
|
-
<li><a href="interfaces/MKDrmLicense.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDrm<wbr/>License</span></a></li>
|
|
197
|
-
<li><a href="interfaces/MKDrmLicenseAddedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDrm<wbr/>License<wbr/>Added<wbr/>Event</span></a></li>
|
|
198
|
-
<li><a href="interfaces/MKDurationChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDuration<wbr/>Changed<wbr/>Event</span></a></li>
|
|
199
|
-
<li><a href="interfaces/MKDynamicAdaptationConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDynamic<wbr/>Adaptation<wbr/>Config</span></a></li>
|
|
200
|
-
<li><a href="interfaces/MKEnvironmentConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKEnvironment<wbr/>Config</span></a></li>
|
|
201
|
-
<li><a href="interfaces/MKError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKError</span></a></li>
|
|
202
|
-
<li><a href="interfaces/MKErrorEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKError<wbr/>Event</span></a></li>
|
|
203
|
-
<li><a href="interfaces/MKFMTSASiDEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKFMTSASiDEvent</span></a></li>
|
|
204
|
-
<li><a href="interfaces/MKFairplayDrmConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKFairplay<wbr/>Drm<wbr/>Config</span></a></li>
|
|
205
|
-
<li><a href="interfaces/MKHttpRequestOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKHttp<wbr/>Request<wbr/>Options</span></a></li>
|
|
206
|
-
<li><a href="interfaces/MKHttpResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKHttp<wbr/>Response</span></a></li>
|
|
207
|
-
<li><a href="interfaces/MKLatencyModeChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKLatency<wbr/>Mode<wbr/>Changed<wbr/>Event</span></a></li>
|
|
208
|
-
<li><a href="interfaces/MKLiveConfigAtSourceLevel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKLive<wbr/>Config<wbr/>At<wbr/>Source<wbr/>Level</span></a></li>
|
|
209
|
-
<li><a href="interfaces/MKLogConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKLog<wbr/>Config</span></a></li>
|
|
210
|
-
<li><a href="interfaces/MKLowLatencyAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKLow<wbr/>LatencyAPI</span></a></li>
|
|
211
|
-
<li><a href="interfaces/MKLowLatencyConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKLow<wbr/>Latency<wbr/>Config</span></a></li>
|
|
212
|
-
<li><a href="interfaces/MKLowLatencySyncConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKLow<wbr/>Latency<wbr/>Sync<wbr/>Config</span></a></li>
|
|
213
|
-
<li><a href="interfaces/MKManifestAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKManifestAPI</span></a></li>
|
|
214
|
-
<li><a href="interfaces/MKMediaPlaybackQualityChangeEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMedia<wbr/>Playback<wbr/>Quality<wbr/>Change<wbr/>Event</span></a></li>
|
|
215
|
-
<li><a href="interfaces/MKMediaQualityChangeEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMedia<wbr/>Quality<wbr/>Change<wbr/>Event</span></a></li>
|
|
216
|
-
<li><a href="interfaces/MKMediaQualityEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMedia<wbr/>Quality<wbr/>Event</span></a></li>
|
|
217
|
-
<li><a href="interfaces/MKMediaTrack.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMedia<wbr/>Track</span></a></li>
|
|
218
|
-
<li><a href="interfaces/MKMediaTrackRole.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMedia<wbr/>Track<wbr/>Role</span></a></li>
|
|
219
|
-
<li><a href="interfaces/MKMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMetadata</span></a></li>
|
|
220
|
-
<li><a href="interfaces/MKMetadataChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMetadata<wbr/>Changed<wbr/>Event</span></a></li>
|
|
221
|
-
<li><a href="interfaces/MKMetadataEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMetadata<wbr/>Event</span></a></li>
|
|
222
|
-
<li><a href="interfaces/MKMetadataParsedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMetadata<wbr/>Parsed<wbr/>Event</span></a></li>
|
|
223
|
-
<li><a href="interfaces/MKModuleInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKModule<wbr/>Info</span></a></li>
|
|
224
|
-
<li><a href="interfaces/MKPauseAd.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPause<wbr/>Ad</span></a></li>
|
|
225
|
-
<li><a href="interfaces/MKPauseAdDismissedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPause<wbr/>Ad<wbr/>Dismissed<wbr/>Event</span></a></li>
|
|
226
|
-
<li><a href="interfaces/MKPauseAdShownEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPause<wbr/>Ad<wbr/>Shown<wbr/>Event</span></a></li>
|
|
227
|
-
<li><a href="interfaces/MKPauseAdWarningEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPause<wbr/>Ad<wbr/>Warning<wbr/>Event</span></a></li>
|
|
228
|
-
<li><a href="interfaces/MKPeriodContentInformation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPeriod<wbr/>Content<wbr/>Information</span></a></li>
|
|
229
|
-
<li><a href="interfaces/MKPeriodInformation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPeriod<wbr/>Information</span></a></li>
|
|
230
|
-
<li><a href="interfaces/MKPeriodSwitchObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPeriod<wbr/>Switch<wbr/>Object</span></a></li>
|
|
231
|
-
<li><a href="interfaces/MKPeriodSwitchedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPeriod<wbr/>Switched<wbr/>Event</span></a></li>
|
|
232
|
-
<li><a href="interfaces/MKPlayReadyDrmConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlay<wbr/>Ready<wbr/>Drm<wbr/>Config</span></a></li>
|
|
233
|
-
<li><a href="interfaces/MKPlayStation5Tweaks.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlay<wbr/>Station5<wbr/>Tweaks</span></a></li>
|
|
234
|
-
<li><a href="interfaces/MKPlaybackConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayback<wbr/>Config</span></a></li>
|
|
235
|
-
<li><a href="interfaces/MKPlaybackEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayback<wbr/>Event</span></a></li>
|
|
236
|
-
<li><a href="interfaces/MKPlaybackSpeedChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayback<wbr/>Speed<wbr/>Changed<wbr/>Event</span></a></li>
|
|
237
|
-
<li><a href="interfaces/MKPlayerAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayerAPI</span></a></li>
|
|
238
|
-
<li><a href="interfaces/MKPlayerAdvertisingAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayer<wbr/>AdvertisingAPI</span></a></li>
|
|
239
|
-
<li><a href="interfaces/MKPlayerConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayer<wbr/>Config</span></a></li>
|
|
240
|
-
<li><a href="interfaces/MKPlayerCoreAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayer<wbr/>CoreAPI</span></a></li>
|
|
241
|
-
<li><a href="interfaces/MKPlayerEventBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayer<wbr/>Event<wbr/>Base</span></a></li>
|
|
242
|
-
<li><a href="interfaces/MKPlayerEventCallback.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayer<wbr/>Event<wbr/>Callback</span></a></li>
|
|
243
|
-
<li><a href="interfaces/MKPlayerEventConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayer<wbr/>Event<wbr/>Config</span></a></li>
|
|
244
|
-
<li><a href="interfaces/MKPlayerResizedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayer<wbr/>Resized<wbr/>Event</span></a></li>
|
|
245
|
-
<li><a href="interfaces/MKPlayerTechnology.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayer<wbr/>Technology</span></a></li>
|
|
246
|
-
<li><a href="interfaces/MKPreferredTechnology.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPreferred<wbr/>Technology</span></a></li>
|
|
247
|
-
<li><a href="interfaces/MKProgramRestrictions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKProgram<wbr/>Restrictions</span></a></li>
|
|
248
|
-
<li><a href="interfaces/MKProgramRestrictionsEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKProgram<wbr/>Restrictions<wbr/>Event</span></a></li>
|
|
249
|
-
<li><a href="interfaces/MKProgramTimeChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKProgram<wbr/>Time<wbr/>Changed<wbr/>Event</span></a></li>
|
|
250
|
-
<li><a href="interfaces/MKProgressiveSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKProgressive<wbr/>Source</span></a></li>
|
|
251
|
-
<li><a href="interfaces/MKQuality.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKQuality</span></a></li>
|
|
252
|
-
<li><a href="interfaces/MKQualityMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKQuality<wbr/>Metadata</span></a></li>
|
|
253
|
-
<li><a href="interfaces/MKRegisteredSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKRegistered<wbr/>Source</span></a></li>
|
|
254
|
-
<li><a href="interfaces/MKSeekEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSeek<wbr/>Event</span></a></li>
|
|
255
|
-
<li><a href="interfaces/MKSegmentInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSegment<wbr/>Info</span></a></li>
|
|
256
|
-
<li><a href="interfaces/MKSegmentMap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSegment<wbr/>Map</span></a></li>
|
|
257
|
-
<li><a href="interfaces/MKSegmentPlaybackEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSegment<wbr/>Playback<wbr/>Event</span></a></li>
|
|
258
|
-
<li><a href="interfaces/MKSegmentQualityMap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSegment<wbr/>Quality<wbr/>Map</span></a></li>
|
|
259
|
-
<li><a href="interfaces/MKSegmentRequestFinishedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSegment<wbr/>Request<wbr/>Finished<wbr/>Event</span></a></li>
|
|
260
|
-
<li><a href="interfaces/MKSessionDataEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSession<wbr/>Data<wbr/>Event</span></a></li>
|
|
261
|
-
<li><a href="interfaces/MKSourceConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSource<wbr/>Config</span></a></li>
|
|
262
|
-
<li><a href="interfaces/MKSourceLabelingConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSource<wbr/>Labeling<wbr/>Config</span></a></li>
|
|
263
|
-
<li><a href="interfaces/MKSourceLabelingStreamTypeConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSource<wbr/>Labeling<wbr/>Stream<wbr/>Type<wbr/>Config</span></a></li>
|
|
264
|
-
<li><a href="interfaces/MKSourceOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSource<wbr/>Options</span></a></li>
|
|
265
|
-
<li><a href="interfaces/MKSsaiAdConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSsai<wbr/>Ad<wbr/>Config</span></a></li>
|
|
266
|
-
<li><a href="interfaces/MKStyleConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKStyle<wbr/>Config</span></a></li>
|
|
267
|
-
<li><a href="interfaces/MKSubtitleCueEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSubtitle<wbr/>Cue<wbr/>Event</span></a></li>
|
|
268
|
-
<li><a href="interfaces/MKSubtitleCuePosition.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSubtitle<wbr/>Cue<wbr/>Position</span></a></li>
|
|
269
|
-
<li><a href="interfaces/MKSubtitleEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSubtitle<wbr/>Event</span></a></li>
|
|
270
|
-
<li><a href="interfaces/MKSubtitleTrack.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSubtitle<wbr/>Track</span></a></li>
|
|
271
|
-
<li><a href="interfaces/MKSubtitlesAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSubtitlesAPI</span></a></li>
|
|
272
|
-
<li><a href="interfaces/MKSynchronizationConfigEntry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSynchronization<wbr/>Config<wbr/>Entry</span></a></li>
|
|
273
|
-
<li><a href="interfaces/MKTargetLatencyChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKTarget<wbr/>Latency<wbr/>Changed<wbr/>Event</span></a></li>
|
|
274
|
-
<li><a href="interfaces/MKTextTrack.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKText<wbr/>Track</span></a></li>
|
|
275
|
-
<li><a href="interfaces/MKThumbnail.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKThumbnail</span></a></li>
|
|
276
|
-
<li><a href="interfaces/MKThumbnailTrack.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKThumbnail<wbr/>Track</span></a></li>
|
|
277
|
-
<li><a href="interfaces/MKTimeChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKTime<wbr/>Changed<wbr/>Event</span></a></li>
|
|
278
|
-
<li><a href="interfaces/MKTimeRange.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKTime<wbr/>Range</span></a></li>
|
|
279
|
-
<li><a href="interfaces/MKTimelineMarker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKTimeline<wbr/>Marker</span></a></li>
|
|
280
|
-
<li><a href="interfaces/MKTrackMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKTrack<wbr/>Metadata</span></a></li>
|
|
281
|
-
<li><a href="interfaces/MKTweaksConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKTweaks<wbr/>Config</span></a></li>
|
|
282
|
-
<li><a href="interfaces/MKUserInteractionEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKUser<wbr/>Interaction<wbr/>Event</span></a></li>
|
|
283
|
-
<li><a href="interfaces/MKVSPPSessionIdEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVSPPSession<wbr/>Id<wbr/>Event</span></a></li>
|
|
284
|
-
<li><a href="interfaces/MKVTTProperties.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVTTProperties</span></a></li>
|
|
285
|
-
<li><a href="interfaces/MKVTTRegionProperties.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVTTRegion<wbr/>Properties</span></a></li>
|
|
286
|
-
<li><a href="interfaces/MKVideoAdaptationData.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Adaptation<wbr/>Data</span></a></li>
|
|
287
|
-
<li><a href="interfaces/MKVideoAdaptationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Adaptation<wbr/>Event</span></a></li>
|
|
288
|
-
<li><a href="interfaces/MKVideoDownloadQualityChangeEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Download<wbr/>Quality<wbr/>Change<wbr/>Event</span></a></li>
|
|
289
|
-
<li><a href="interfaces/MKVideoDownloadQualityChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Download<wbr/>Quality<wbr/>Changed<wbr/>Event</span></a></li>
|
|
290
|
-
<li><a href="interfaces/MKVideoPlaybackQualityChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Playback<wbr/>Quality<wbr/>Changed<wbr/>Event</span></a></li>
|
|
291
|
-
<li><a href="interfaces/MKVideoQuality.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Quality</span></a></li>
|
|
292
|
-
<li><a href="interfaces/MKVideoQualityChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Quality<wbr/>Changed<wbr/>Event</span></a></li>
|
|
293
|
-
<li><a href="interfaces/MKVideoQualityEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Quality<wbr/>Event</span></a></li>
|
|
294
|
-
<li><a href="interfaces/MKVideoSizeLimitationConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Size<wbr/>Limitation<wbr/>Config</span></a></li>
|
|
295
|
-
<li><a href="interfaces/MKVideoTrack.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVideo<wbr/>Track</span></a></li>
|
|
296
|
-
<li><a href="interfaces/MKViewModeChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKView<wbr/>Mode<wbr/>Changed<wbr/>Event</span></a></li>
|
|
297
|
-
<li><a href="interfaces/MKViewModeOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKView<wbr/>Mode<wbr/>Options</span></a></li>
|
|
298
|
-
<li><a href="interfaces/MKVolumeChangedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVolume<wbr/>Changed<wbr/>Event</span></a></li>
|
|
299
|
-
<li><a href="interfaces/MKWidevineModularDrmConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKWidevine<wbr/>Modular<wbr/>Drm<wbr/>Config</span></a></li>
|
|
300
|
-
<li><a href="types/MKBitrate.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>MKBitrate</span></a></li>
|
|
301
|
-
<li><a href="types/MKHeaders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>MKHeaders</span></a></li>
|
|
302
|
-
<li><a href="types/MKHttpMethod.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>MKHttp<wbr/>Method</span></a></li>
|
|
303
|
-
<li><a href="types/MKRequestBody.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>MKRequest<wbr/>Body</span></a></li>
|
|
304
|
-
<li><a href="types/MKRequestQueryParams.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>MKRequest<wbr/>Query<wbr/>Params</span></a></li>
|
|
305
|
-
<li><a href="types/MKUserEngagement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>MKUser<wbr/>Engagement</span></a></li>
|
|
306
|
-
<li><a href="types/MKWishAbrConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>MKWish<wbr/>Abr<wbr/>Config</span></a></li></ul></nav></div></div></div>
|
|
307
|
-
<div class="overlay"></div></body></html>
|
|
620
|
+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#prerequisite"><span>Prerequisite</span></a><a href="#setup"><span>Setup</span></a><ul><li><a href="#getting-started"><span>Getting <wbr/>Started</span></a></li><li><a href="#additional-requirements-for-apple-devices-for-mac-iphone-ipad"><span>Additional requirements for <wbr/>Apple devices (for <wbr/>Mac, i<wbr/>Phone, i<wbr/>Pad)</span></a></li></ul><a href="#support-matrix-and-error-codes"><span>Support <wbr/>Matrix and <wbr/>Error <wbr/>Codes</span></a><ul><li><a href="#supported-platforms"><span>Supported <wbr/>Platforms</span></a></li><li><a href="#drm-support"><span>DRM <wbr/>Support</span></a></li><li><a href="#error-codes"><span>Error <wbr/>Codes</span></a></li></ul><a href="#features"><span>Features</span></a><ul><li><a href="#player-analytics"><span>Player <wbr/>Analytics</span></a></li><li><a href="#http-signing-requests-and-widevine-license-encryption"><span>Http <wbr/>Signing <wbr/>Requests and <wbr/>Widevine <wbr/>License <wbr/>Encryption</span></a></li><li><a href="#adobe-primetime-support"><span>Adobe <wbr/>Primetime support</span></a></li><li><a href="#dai-ssaicsai-support"><span>DAI (SSAI/CSAI) support</span></a></li><li><a href="#google-pal-sdk-support"><span>Google PAL SDK support</span></a></li><li><a href="#pause-ads"><span>Pause <wbr/>Ads</span></a></li><li><a href="#low-latency"><span>Low <wbr/>Latency</span></a></li><li><a href="#thumbnails"><span>Thumbnails</span></a></li></ul><a href="#mkplayer-web-plugins"><span>MKPlayer <wbr/>Web <wbr/>Plugins</span></a><a href="#quick-links"><span>Quick links</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">MKPlayer - v1.47.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|