@mediakind/mkplayer 1.46.0 → 1.48.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 +100 -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 +591 -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 +26 -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/MKPlayReadyDrmConfig.d.ts +1 -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
|
@@ -1,1463 +1,392 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
2
|
-
<
|
|
3
|
-
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
-
<
|
|
5
|
-
<
|
|
6
|
-
<
|
|
7
|
-
<
|
|
8
|
-
<
|
|
9
|
-
|
|
10
|
-
<
|
|
11
|
-
<
|
|
12
|
-
<
|
|
13
|
-
<
|
|
14
|
-
<
|
|
15
|
-
<
|
|
16
|
-
<
|
|
17
|
-
<
|
|
18
|
-
<
|
|
19
|
-
<
|
|
20
|
-
<
|
|
21
|
-
</
|
|
22
|
-
<
|
|
23
|
-
<
|
|
24
|
-
<
|
|
25
|
-
<
|
|
26
|
-
<
|
|
27
|
-
<
|
|
28
|
-
<
|
|
29
|
-
<
|
|
30
|
-
<
|
|
31
|
-
<
|
|
32
|
-
<
|
|
33
|
-
<
|
|
34
|
-
<
|
|
35
|
-
<
|
|
36
|
-
<
|
|
37
|
-
<a href="MKPlayerAPI.html#
|
|
38
|
-
<a href="MKPlayerAPI.html#
|
|
39
|
-
<a href="MKPlayerAPI.html#
|
|
40
|
-
<a href="MKPlayerAPI.html#
|
|
41
|
-
<a href="MKPlayerAPI.html#
|
|
42
|
-
</
|
|
43
|
-
<
|
|
44
|
-
<
|
|
45
|
-
<
|
|
46
|
-
<a href="MKPlayerAPI.html#
|
|
47
|
-
<a href="MKPlayerAPI.html#
|
|
48
|
-
<a href="MKPlayerAPI.html#
|
|
49
|
-
<a href="MKPlayerAPI.html#
|
|
50
|
-
<a href="MKPlayerAPI.html#
|
|
51
|
-
<a href="MKPlayerAPI.html#
|
|
52
|
-
<a href="MKPlayerAPI.html#
|
|
53
|
-
<a href="MKPlayerAPI.html#
|
|
54
|
-
<a href="MKPlayerAPI.html#
|
|
55
|
-
<a href="MKPlayerAPI.html#
|
|
56
|
-
<a href="MKPlayerAPI.html#
|
|
57
|
-
<a href="MKPlayerAPI.html#
|
|
58
|
-
<a href="MKPlayerAPI.html#
|
|
59
|
-
<a href="MKPlayerAPI.html#
|
|
60
|
-
<a href="MKPlayerAPI.html#
|
|
61
|
-
<a href="MKPlayerAPI.html#
|
|
62
|
-
<a href="MKPlayerAPI.html#
|
|
63
|
-
<a href="MKPlayerAPI.html#
|
|
64
|
-
<a href="MKPlayerAPI.html#
|
|
65
|
-
<a href="MKPlayerAPI.html#
|
|
66
|
-
<a href="MKPlayerAPI.html#
|
|
67
|
-
<a href="MKPlayerAPI.html#
|
|
68
|
-
<a href="MKPlayerAPI.html#
|
|
69
|
-
<a href="MKPlayerAPI.html#
|
|
70
|
-
<a href="MKPlayerAPI.html#
|
|
71
|
-
<a href="MKPlayerAPI.html#
|
|
72
|
-
<a href="MKPlayerAPI.html#
|
|
73
|
-
<a href="MKPlayerAPI.html#
|
|
74
|
-
<a href="MKPlayerAPI.html#
|
|
75
|
-
<a href="MKPlayerAPI.html#
|
|
76
|
-
<a href="MKPlayerAPI.html#
|
|
77
|
-
<a href="MKPlayerAPI.html#
|
|
78
|
-
<a href="MKPlayerAPI.html#
|
|
79
|
-
<a href="MKPlayerAPI.html#
|
|
80
|
-
<a href="MKPlayerAPI.html#
|
|
81
|
-
<a href="MKPlayerAPI.html#
|
|
82
|
-
<a href="MKPlayerAPI.html#
|
|
83
|
-
<a href="MKPlayerAPI.html#
|
|
84
|
-
<a href="MKPlayerAPI.html#
|
|
85
|
-
<a href="MKPlayerAPI.html#
|
|
86
|
-
<a href="MKPlayerAPI.html#
|
|
87
|
-
<a href="MKPlayerAPI.html#
|
|
88
|
-
<a href="MKPlayerAPI.html#
|
|
89
|
-
<a href="MKPlayerAPI.html#
|
|
90
|
-
<a href="MKPlayerAPI.html#
|
|
91
|
-
<a href="MKPlayerAPI.html#
|
|
92
|
-
<a href="MKPlayerAPI.html#
|
|
93
|
-
<a href="MKPlayerAPI.html#
|
|
94
|
-
<a href="MKPlayerAPI.html#
|
|
95
|
-
<a href="MKPlayerAPI.html#
|
|
96
|
-
<a href="MKPlayerAPI.html#
|
|
97
|
-
<a href="MKPlayerAPI.html#
|
|
98
|
-
<a href="MKPlayerAPI.html#
|
|
99
|
-
<a href="MKPlayerAPI.html#
|
|
100
|
-
<a href="MKPlayerAPI.html#
|
|
101
|
-
<a href="MKPlayerAPI.html#
|
|
102
|
-
<a href="MKPlayerAPI.html#
|
|
103
|
-
<a href="MKPlayerAPI.html#
|
|
104
|
-
<a href="MKPlayerAPI.html#
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
<
|
|
115
|
-
<a href="MKPlayerAPI.html#seek" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>seek</span></a>
|
|
116
|
-
<a href="MKPlayerAPI.html#seekToLiveEdge" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>seek<wbr/>To<wbr/>Live<wbr/>Edge</span></a>
|
|
117
|
-
<a href="MKPlayerAPI.html#setAnalyticsCustomData" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Analytics<wbr/>Custom<wbr/>Data</span></a>
|
|
118
|
-
<a href="MKPlayerAPI.html#setAspectRatio" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Aspect<wbr/>Ratio</span></a>
|
|
119
|
-
<a href="MKPlayerAPI.html#setAudio" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Audio</span></a>
|
|
120
|
-
<a href="MKPlayerAPI.html#setAudioQuality" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Audio<wbr/>Quality</span></a>
|
|
121
|
-
<a href="MKPlayerAPI.html#setCloudIdConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Cloud<wbr/>Id<wbr/>Config</span></a>
|
|
122
|
-
<a href="MKPlayerAPI.html#setGeoComplyLocationProvider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Geo<wbr/>Comply<wbr/>Location<wbr/>Provider</span></a>
|
|
123
|
-
<a href="MKPlayerAPI.html#setHttpHeaders" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Http<wbr/>Headers</span></a>
|
|
124
|
-
<a href="MKPlayerAPI.html#setInhomeStatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Inhome<wbr/>Status</span></a>
|
|
125
|
-
<a href="MKPlayerAPI.html#setLocationDetail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Location<wbr/>Detail</span></a>
|
|
126
|
-
<a href="MKPlayerAPI.html#setLogLevel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Log<wbr/>Level</span></a>
|
|
127
|
-
<a href="MKPlayerAPI.html#setPlaybackSpeed" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Playback<wbr/>Speed</span></a>
|
|
128
|
-
<a href="MKPlayerAPI.html#setPosterImage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Poster<wbr/>Image</span></a>
|
|
129
|
-
<a href="MKPlayerAPI.html#setSubtitleStyle" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Subtitle<wbr/>Style</span></a>
|
|
130
|
-
<a href="MKPlayerAPI.html#setUserEngagementData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Engagement<wbr/>Data</span></a>
|
|
131
|
-
<a href="MKPlayerAPI.html#setVideoElement" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Element</span></a>
|
|
132
|
-
<a href="MKPlayerAPI.html#setVideoQuality" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Quality</span></a>
|
|
133
|
-
<a href="MKPlayerAPI.html#setViewMode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>View<wbr/>Mode</span></a>
|
|
134
|
-
<a href="MKPlayerAPI.html#setVolume" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Volume</span></a>
|
|
135
|
-
<a href="MKPlayerAPI.html#showAirplayTargetPicker" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>show<wbr/>Airplay<wbr/>Target<wbr/>Picker</span></a>
|
|
136
|
-
<a href="MKPlayerAPI.html#skipAd" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>skip<wbr/>Ad</span></a>
|
|
137
|
-
<a href="MKPlayerAPI.html#unload" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unload</span></a>
|
|
138
|
-
<a href="MKPlayerAPI.html#unmute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a>
|
|
139
|
-
<a href="MKPlayerAPI.html#updateAuthToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Auth<wbr/>Token</span></a>
|
|
140
|
-
</div></section></div></details></section></section>
|
|
141
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
142
|
-
<h2>Properties</h2>
|
|
143
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="adaptation" class="tsd-anchor"></a>
|
|
144
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>adaptation</span><a href="#adaptation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
145
|
-
<div class="tsd-signature"><span class="tsd-kind-property">adaptation</span><span class="tsd-signature-symbol">:</span> <a href="MKAdaptationAPI.html" class="tsd-signature-type tsd-kind-interface">MKAdaptationAPI</a></div>
|
|
146
|
-
<div class="tsd-comment tsd-typography"><p>MKPlayer Adaption APIs.</p>
|
|
147
|
-
</div>
|
|
148
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
149
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#adaptation">adaptation</a></p></aside></section>
|
|
150
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="buffer" class="tsd-anchor"></a>
|
|
151
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>buffer</span><a href="#buffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
152
|
-
<div class="tsd-signature"><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">:</span> <a href="MKBufferAPI.html" class="tsd-signature-type tsd-kind-interface">MKBufferAPI</a></div>
|
|
153
|
-
<div class="tsd-comment tsd-typography"><p>MKPlayer Buffer APIs.</p>
|
|
154
|
-
</div>
|
|
155
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
156
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#buffer">buffer</a></p></aside></section>
|
|
157
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="drm" class="tsd-anchor"></a>
|
|
158
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>drm</span><a href="#drm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
159
|
-
<div class="tsd-signature"><span class="tsd-kind-property">drm</span><span class="tsd-signature-symbol">:</span> <a href="MKDrmAPI.html" class="tsd-signature-type tsd-kind-interface">MKDrmAPI</a></div>
|
|
160
|
-
<div class="tsd-comment tsd-typography"><p>MKPlayer DRM APIs.</p>
|
|
161
|
-
</div>
|
|
162
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
163
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#drm">drm</a></p></aside></section>
|
|
164
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="lowlatency" class="tsd-anchor"></a>
|
|
165
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>lowlatency</span><a href="#lowlatency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
166
|
-
<div class="tsd-signature"><span class="tsd-kind-property">lowlatency</span><span class="tsd-signature-symbol">:</span> <a href="MKLowLatencyAPI.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencyAPI</a></div>
|
|
167
|
-
<div class="tsd-comment tsd-typography"><p>MKPlayer Low Latency APIs.</p>
|
|
168
|
-
</div>
|
|
169
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
170
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#lowlatency">lowlatency</a></p></aside></section>
|
|
171
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="manifest" class="tsd-anchor"></a>
|
|
172
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>manifest</span><a href="#manifest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
173
|
-
<div class="tsd-signature"><span class="tsd-kind-property">manifest</span><span class="tsd-signature-symbol">:</span> <a href="MKManifestAPI.html" class="tsd-signature-type tsd-kind-interface">MKManifestAPI</a></div>
|
|
174
|
-
<div class="tsd-comment tsd-typography"><p>MKPlayer Manifest APIs.</p>
|
|
175
|
-
</div>
|
|
176
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
177
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#manifest">manifest</a></p></aside></section>
|
|
178
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="subtitles" class="tsd-anchor"></a>
|
|
179
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>subtitles</span><a href="#subtitles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
180
|
-
<div class="tsd-signature"><span class="tsd-kind-property">subtitles</span><span class="tsd-signature-symbol">:</span> <a href="MKSubtitlesAPI.html" class="tsd-signature-type tsd-kind-interface">MKSubtitlesAPI</a></div>
|
|
181
|
-
<div class="tsd-comment tsd-typography"><p>MKPlayer Subtitles APIs.</p>
|
|
182
|
-
</div>
|
|
183
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
184
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#subtitles">subtitles</a></p></aside></section></section>
|
|
185
|
-
<section class="tsd-panel-group tsd-member-group">
|
|
186
|
-
<h2>Methods</h2>
|
|
187
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="addCastMetadata" class="tsd-anchor"></a>
|
|
188
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Cast<wbr/>Metadata</span><a href="#addCastMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
189
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
190
|
-
<li class="tsd-signature tsd-anchor-link" id="addCastMetadata.addCastMetadata-1"><span class="tsd-kind-call-signature">add<wbr/>Cast<wbr/>Metadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#addCastMetadata.addCastMetadata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
191
|
-
<li class="tsd-description">
|
|
192
|
-
<div class="tsd-comment tsd-typography"><p>Sends custom metadata to a remote receiver app (e.g. Chromecast).</p>
|
|
193
|
-
</div>
|
|
194
|
-
<div class="tsd-parameters">
|
|
195
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
196
|
-
<ul class="tsd-parameter-list">
|
|
197
|
-
<li>
|
|
198
|
-
<h5><span class="tsd-kind-parameter">metadata</span>: <span class="tsd-signature-type">any</span></h5>
|
|
199
|
-
<div class="tsd-comment tsd-typography"><p>the custom metadata to send to the receiver.</p>
|
|
200
|
-
</div>
|
|
201
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
202
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if it was successful.</p>
|
|
203
|
-
|
|
204
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
205
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#addCastMetadata">addCastMetadata</a></p></aside></li></ul></section>
|
|
206
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="addTimelineMarker" class="tsd-anchor"></a>
|
|
207
|
-
<h3 class="tsd-anchor-link"><span>add<wbr/>Timeline<wbr/>Marker</span><a href="#addTimelineMarker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
208
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
209
|
-
<li class="tsd-signature tsd-anchor-link" id="addTimelineMarker.addTimelineMarker-1"><span class="tsd-kind-call-signature">add<wbr/>Timeline<wbr/>Marker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timelineMarker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addTimelineMarker.addTimelineMarker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
210
|
-
<li class="tsd-description">
|
|
211
|
-
<div class="tsd-comment tsd-typography"><p>Adds a marker to the timeline.</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>MKPlayerAPI | MKPlayer - v1.48.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.48.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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">MKPlayer</a></li><li><a href="MKPlayerAPI.html">MKPlayerAPI</a></li></ul><h1>Interface MKPlayerAPI</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>MKPlayer API.</p>
|
|
2
|
+
<p>Defines the API's supported by MKPlayer.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MKPlayerAPI</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="MKPlayerAPI.html#adaptation">adaptation</a><span class="tsd-signature-symbol">:</span> <a href="MKAdaptationAPI.html" class="tsd-signature-type tsd-kind-interface">MKAdaptationAPI</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="MKPlayerAPI.html#buffer">buffer</a><span class="tsd-signature-symbol">:</span> <a href="MKBufferAPI.html" class="tsd-signature-type tsd-kind-interface">MKBufferAPI</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="MKPlayerAPI.html#drm">drm</a><span class="tsd-signature-symbol">:</span> <a href="MKDrmAPI.html" class="tsd-signature-type tsd-kind-interface">MKDrmAPI</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="MKPlayerAPI.html#lowlatency">lowlatency</a><span class="tsd-signature-symbol">:</span> <a href="MKLowLatencyAPI.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencyAPI</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="MKPlayerAPI.html#manifest">manifest</a><span class="tsd-signature-symbol">:</span> <a href="MKManifestAPI.html" class="tsd-signature-type tsd-kind-interface">MKManifestAPI</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="MKPlayerAPI.html#subtitles">subtitles</a><span class="tsd-signature-symbol">:</span> <a href="MKSubtitlesAPI.html" class="tsd-signature-type tsd-kind-interface">MKSubtitlesAPI</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#addcastmetadata-1">addCastMetadata</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#addtimelinemarker-1">addTimelineMarker</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timelineMarker</span><span class="tsd-signature-symbol">:</span> <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#caststop-1">castStop</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#castvideo-1">castVideo</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#destroy-1">destroy</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#discardadbreak-1">discardAdBreak</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">adBreakId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#dismisspausead-1">dismissPauseAd</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getactivead-1">getActiveAd</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAd.html" class="tsd-signature-type tsd-kind-interface">MKAd</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getactiveadbreak-1">getActiveAdBreak</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getaspectratio-1">getAspectRatio</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getaudio-1">getAudio</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getaudioquality-1">getAudioQuality</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getavailableaudio-1">getAvailableAudio</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getavailableaudioqualities-1">getAvailableAudioQualities</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getavailablesegments-1">getAvailableSegments</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKSegmentMap.html" class="tsd-signature-type tsd-kind-interface">MKSegmentMap</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getavailablevideoqualities-1">getAvailableVideoQualities</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getbufferedranges-1">getBufferedRanges</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getconfig-1">getConfig</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mergedConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="MKPlayerConfig.html" class="tsd-signature-type tsd-kind-interface">MKPlayerConfig</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getcurrenttime-1">getCurrentTime</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/MKTimeMode.html" class="tsd-signature-type tsd-kind-enum">MKTimeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getdownloadedaudiodata-1">getDownloadedAudioData</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKDownloadedAudioData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedAudioData</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getdownloadedvideodata-1">getDownloadedVideoData</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKDownloadedVideoData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedVideoData</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getdroppedvideoframes-1">getDroppedVideoFrames</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getduration-1">getDuration</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getlivelatency-1">getLiveLatency</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getmaxtimeshift-1">getMaxTimeShift</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getmoduleinfo-1">getModuleInfo</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKModuleInfo.html" class="tsd-signature-type tsd-kind-interface">MKModuleInfo</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getplaybackaudiodata-1">getPlaybackAudioData</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getplaybackspeed-1">getPlaybackSpeed</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getplaybackvideodata-1">getPlaybackVideoData</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getplayertype-1">getPlayerType</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKPlayerType.html" class="tsd-signature-type tsd-kind-enum">MKPlayerType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getseekablerange-1">getSeekableRange</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/MKTimeMode.html" class="tsd-signature-type tsd-kind-enum">MKTimeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getsource-1">getSource</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getsourceconfig-1">getSourceConfig</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getstreamtype-1">getStreamType</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKStreamType.html" class="tsd-signature-type tsd-kind-enum">MKStreamType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getthumbnail-1">getThumbnail</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKThumbnail.html" class="tsd-signature-type tsd-kind-interface">MKThumbnail</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#gettimelinemarkers-1">getTimelineMarkers</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#gettimeshift-1">getTimeShift</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#gettotalstalledtime-1">getTotalStalledTime</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getversion-1">getVersion</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getvideocontainer-1">getVideoContainer</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getvideoelement-1">getVideoElement</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLVideoElement</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getvideoquality-1">getVideoQuality</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getviewmode-1">getViewMode</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#getvolume-1">getVolume</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#hasended-1">hasEnded</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#isairplayactive-1">isAirplayActive</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#isairplayavailable-1">isAirplayAvailable</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#iscastavailable-1">isCastAvailable</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#iscasting-1">isCasting</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#islinearadactive-1">isLinearAdActive</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#islive-1">isLive</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#islowlatencyplayback-1">isLowLatencyPlayback</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#ismuted-1">isMuted</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#ispauseadactive-1">isPauseAdActive</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#ispaused-1">isPaused</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#isplaying-1">isPlaying</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#isstalled-1">isStalled</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#isviewmodeavailable-1">isViewModeAvailable</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">viewMode</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#listad-1">listAd</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#load-1">load</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sourceConfig</span><span class="tsd-signature-symbol">:</span> <a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">disableSeeking</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#mute-1">mute</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#off-1">off</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#offt">T</a> <span class="tsd-signature-keyword">extends</span> <a href="MKPlayerEventBase.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventBase</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#offt">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#offall-1">offAll</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#on-1">on</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#ont">T</a> <span class="tsd-signature-keyword">extends</span> <a href="MKPlayerEventBase.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventBase</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#ont">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#pause-1">pause</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#play-1">play</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#preload-1">preload</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#reload-1">reload</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">startTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">startOffset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#removetimelinemarker-1">removeTimelineMarker</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timelineMarker</span><span class="tsd-signature-symbol">:</span> <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#schedulead-1">scheduleAd</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">adConfig</span><span class="tsd-signature-symbol">:</span> <a href="MKAdConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdConfig</a> <span class="tsd-signature-symbol">|</span> <a href="MKAdBreakConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdBreakConfig</a> <span class="tsd-signature-symbol">|</span> <a href="MKAdTagConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdTagConfig</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#seek-1">seek</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#seektoliveedge-1">seekToLiveEdge</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setanalyticscustomdata-1">setAnalyticsCustomData</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">:</span> <a href="MKAnalyticsConfig.html" class="tsd-signature-type tsd-kind-interface">MKAnalyticsConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setaspectratio-1">setAspectRatio</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aspectratio</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setaudio-1">setAudio</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trackID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setaudioquality-1">setAudioQuality</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">audioQualityID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setcloudidconfig-1">setCloudIdConfig</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cloudIdInfo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setgeocomplylocationprovider-1">setGeoComplyLocationProvider</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">provider</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#sethttpheaders-1">setHttpHeaders</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/MKHeaders.html" class="tsd-signature-type tsd-kind-type-alias">MKHeaders</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setinhomestatus-1">setInhomeStatus</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inhomeStatus</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setlocationdetail-1">setLocationDetail</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">locationDetail</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setloglevel-1">setLogLevel</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKLogLevel.html" class="tsd-signature-type tsd-kind-enum">MKLogLevel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setplaybackspeed-1">setPlaybackSpeed</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">speed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setposterimage-1">setPosterImage</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">keepPersistent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setsubtitlestyle-1">setSubtitleStyle</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">styleOptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setuserengagementdata-1">setUserEngagementData</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userEngagementData</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/MKUserEngagement.html" class="tsd-signature-type tsd-kind-type-alias">MKUserEngagement</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setvideoelement-1">setVideoElement</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoElement</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLVideoElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setvideoquality-1">setVideoQuality</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoQualityID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setviewmode-1">setViewMode</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">viewMode</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="MKViewModeOptions.html" class="tsd-signature-type tsd-kind-interface">MKViewModeOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#setvolume-1">setVolume</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">volume</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#showairplaytargetpicker-1">showAirplayTargetPicker</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#skipad-1">skipAd</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">isCSAI</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#skipadbreak-1">skipAdBreak</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#unload-1">unload</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#unmute-1">unmute</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="MKPlayerAPI.html#updateauthtoken-1">updateAuthToken</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authToken</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="2433"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">MKPlayerCoreAPI</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MKPlayerAPI</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="MKPlayerAPI.html#adaptation" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>adaptation</span></a>
|
|
4
|
+
<a href="MKPlayerAPI.html#buffer" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>buffer</span></a>
|
|
5
|
+
<a href="MKPlayerAPI.html#drm" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>drm</span></a>
|
|
6
|
+
<a href="MKPlayerAPI.html#lowlatency" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lowlatency</span></a>
|
|
7
|
+
<a href="MKPlayerAPI.html#manifest" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>manifest</span></a>
|
|
8
|
+
<a href="MKPlayerAPI.html#subtitles" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subtitles</span></a>
|
|
9
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="MKPlayerAPI.html#addcastmetadata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cast<wbr/>Metadata</span></a>
|
|
10
|
+
<a href="MKPlayerAPI.html#addtimelinemarker" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Timeline<wbr/>Marker</span></a>
|
|
11
|
+
<a href="MKPlayerAPI.html#caststop" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cast<wbr/>Stop</span></a>
|
|
12
|
+
<a href="MKPlayerAPI.html#castvideo" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cast<wbr/>Video</span></a>
|
|
13
|
+
<a href="MKPlayerAPI.html#destroy" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a>
|
|
14
|
+
<a href="MKPlayerAPI.html#discardadbreak" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>discard<wbr/>Ad<wbr/>Break</span></a>
|
|
15
|
+
<a href="MKPlayerAPI.html#dismisspausead" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dismiss<wbr/>Pause<wbr/>Ad</span></a>
|
|
16
|
+
<a href="MKPlayerAPI.html#getactivead" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Active<wbr/>Ad</span></a>
|
|
17
|
+
<a href="MKPlayerAPI.html#getactiveadbreak" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Active<wbr/>Ad<wbr/>Break</span></a>
|
|
18
|
+
<a href="MKPlayerAPI.html#getaspectratio" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Aspect<wbr/>Ratio</span></a>
|
|
19
|
+
<a href="MKPlayerAPI.html#getaudio" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Audio</span></a>
|
|
20
|
+
<a href="MKPlayerAPI.html#getaudioquality" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Quality</span></a>
|
|
21
|
+
<a href="MKPlayerAPI.html#getavailableaudio" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Audio</span></a>
|
|
22
|
+
<a href="MKPlayerAPI.html#getavailableaudioqualities" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Audio<wbr/>Qualities</span></a>
|
|
23
|
+
<a href="MKPlayerAPI.html#getavailablesegments" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Segments</span></a>
|
|
24
|
+
<a href="MKPlayerAPI.html#getavailablevideoqualities" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Video<wbr/>Qualities</span></a>
|
|
25
|
+
<a href="MKPlayerAPI.html#getbufferedranges" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Buffered<wbr/>Ranges</span></a>
|
|
26
|
+
<a href="MKPlayerAPI.html#getconfig" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config</span></a>
|
|
27
|
+
<a href="MKPlayerAPI.html#getcurrenttime" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Time</span></a>
|
|
28
|
+
<a href="MKPlayerAPI.html#getdownloadedaudiodata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Downloaded<wbr/>Audio<wbr/>Data</span></a>
|
|
29
|
+
<a href="MKPlayerAPI.html#getdownloadedvideodata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Downloaded<wbr/>Video<wbr/>Data</span></a>
|
|
30
|
+
<a href="MKPlayerAPI.html#getdroppedvideoframes" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Dropped<wbr/>Video<wbr/>Frames</span></a>
|
|
31
|
+
<a href="MKPlayerAPI.html#getduration" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Duration</span></a>
|
|
32
|
+
<a href="MKPlayerAPI.html#getlivelatency" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Live<wbr/>Latency</span></a>
|
|
33
|
+
<a href="MKPlayerAPI.html#getmaxtimeshift" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Time<wbr/>Shift</span></a>
|
|
34
|
+
<a href="MKPlayerAPI.html#getmoduleinfo" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Module<wbr/>Info</span></a>
|
|
35
|
+
<a href="MKPlayerAPI.html#getplaybackaudiodata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Audio<wbr/>Data</span></a>
|
|
36
|
+
<a href="MKPlayerAPI.html#getplaybackspeed" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Speed</span></a>
|
|
37
|
+
<a href="MKPlayerAPI.html#getplaybackvideodata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Video<wbr/>Data</span></a>
|
|
38
|
+
<a href="MKPlayerAPI.html#getplayertype" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Player<wbr/>Type</span></a>
|
|
39
|
+
<a href="MKPlayerAPI.html#getseekablerange" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Seekable<wbr/>Range</span></a>
|
|
40
|
+
<a href="MKPlayerAPI.html#getsource" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Source</span></a>
|
|
41
|
+
<a href="MKPlayerAPI.html#getsourceconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Source<wbr/>Config</span></a>
|
|
42
|
+
<a href="MKPlayerAPI.html#getstreamtype" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Stream<wbr/>Type</span></a>
|
|
43
|
+
<a href="MKPlayerAPI.html#getthumbnail" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Thumbnail</span></a>
|
|
44
|
+
<a href="MKPlayerAPI.html#gettimelinemarkers" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Timeline<wbr/>Markers</span></a>
|
|
45
|
+
<a href="MKPlayerAPI.html#gettimeshift" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Time<wbr/>Shift</span></a>
|
|
46
|
+
<a href="MKPlayerAPI.html#gettotalstalledtime" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Stalled<wbr/>Time</span></a>
|
|
47
|
+
<a href="MKPlayerAPI.html#getversion" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Version</span></a>
|
|
48
|
+
<a href="MKPlayerAPI.html#getvideocontainer" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Container</span></a>
|
|
49
|
+
<a href="MKPlayerAPI.html#getvideoelement" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Element</span></a>
|
|
50
|
+
<a href="MKPlayerAPI.html#getvideoquality" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Quality</span></a>
|
|
51
|
+
<a href="MKPlayerAPI.html#getviewmode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>View<wbr/>Mode</span></a>
|
|
52
|
+
<a href="MKPlayerAPI.html#getvolume" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Volume</span></a>
|
|
53
|
+
<a href="MKPlayerAPI.html#hasended" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Ended</span></a>
|
|
54
|
+
<a href="MKPlayerAPI.html#isairplayactive" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Airplay<wbr/>Active</span></a>
|
|
55
|
+
<a href="MKPlayerAPI.html#isairplayavailable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Airplay<wbr/>Available</span></a>
|
|
56
|
+
<a href="MKPlayerAPI.html#iscastavailable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Cast<wbr/>Available</span></a>
|
|
57
|
+
<a href="MKPlayerAPI.html#iscasting" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Casting</span></a>
|
|
58
|
+
<a href="MKPlayerAPI.html#islinearadactive" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Linear<wbr/>Ad<wbr/>Active</span></a>
|
|
59
|
+
<a href="MKPlayerAPI.html#islive" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Live</span></a>
|
|
60
|
+
<a href="MKPlayerAPI.html#islowlatencyplayback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Low<wbr/>Latency<wbr/>Playback</span></a>
|
|
61
|
+
<a href="MKPlayerAPI.html#ismuted" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Muted</span></a>
|
|
62
|
+
<a href="MKPlayerAPI.html#ispauseadactive" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Pause<wbr/>Ad<wbr/>Active</span></a>
|
|
63
|
+
<a href="MKPlayerAPI.html#ispaused" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Paused</span></a>
|
|
64
|
+
<a href="MKPlayerAPI.html#isplaying" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Playing</span></a>
|
|
65
|
+
<a href="MKPlayerAPI.html#isstalled" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Stalled</span></a>
|
|
66
|
+
<a href="MKPlayerAPI.html#isviewmodeavailable" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>View<wbr/>Mode<wbr/>Available</span></a>
|
|
67
|
+
<a href="MKPlayerAPI.html#listad" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Ad</span></a>
|
|
68
|
+
<a href="MKPlayerAPI.html#load" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load</span></a>
|
|
69
|
+
<a href="MKPlayerAPI.html#mute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute</span></a>
|
|
70
|
+
<a href="MKPlayerAPI.html#off" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a>
|
|
71
|
+
<a href="MKPlayerAPI.html#offall" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off<wbr/>All</span></a>
|
|
72
|
+
<a href="MKPlayerAPI.html#on" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a>
|
|
73
|
+
<a href="MKPlayerAPI.html#pause" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pause</span></a>
|
|
74
|
+
<a href="MKPlayerAPI.html#play" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a>
|
|
75
|
+
<a href="MKPlayerAPI.html#preload" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preload</span></a>
|
|
76
|
+
<a href="MKPlayerAPI.html#reload" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a>
|
|
77
|
+
<a href="MKPlayerAPI.html#removetimelinemarker" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Timeline<wbr/>Marker</span></a>
|
|
78
|
+
<a href="MKPlayerAPI.html#schedulead" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>schedule<wbr/>Ad</span></a>
|
|
79
|
+
<a href="MKPlayerAPI.html#seek" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>seek</span></a>
|
|
80
|
+
<a href="MKPlayerAPI.html#seektoliveedge" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>seek<wbr/>To<wbr/>Live<wbr/>Edge</span></a>
|
|
81
|
+
<a href="MKPlayerAPI.html#setanalyticscustomdata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Analytics<wbr/>Custom<wbr/>Data</span></a>
|
|
82
|
+
<a href="MKPlayerAPI.html#setaspectratio" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Aspect<wbr/>Ratio</span></a>
|
|
83
|
+
<a href="MKPlayerAPI.html#setaudio" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Audio</span></a>
|
|
84
|
+
<a href="MKPlayerAPI.html#setaudioquality" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Audio<wbr/>Quality</span></a>
|
|
85
|
+
<a href="MKPlayerAPI.html#setcloudidconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Cloud<wbr/>Id<wbr/>Config</span></a>
|
|
86
|
+
<a href="MKPlayerAPI.html#setgeocomplylocationprovider" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Geo<wbr/>Comply<wbr/>Location<wbr/>Provider</span></a>
|
|
87
|
+
<a href="MKPlayerAPI.html#sethttpheaders" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Http<wbr/>Headers</span></a>
|
|
88
|
+
<a href="MKPlayerAPI.html#setinhomestatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Inhome<wbr/>Status</span></a>
|
|
89
|
+
<a href="MKPlayerAPI.html#setlocationdetail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Location<wbr/>Detail</span></a>
|
|
90
|
+
<a href="MKPlayerAPI.html#setloglevel" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Log<wbr/>Level</span></a>
|
|
91
|
+
<a href="MKPlayerAPI.html#setplaybackspeed" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Playback<wbr/>Speed</span></a>
|
|
92
|
+
<a href="MKPlayerAPI.html#setposterimage" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Poster<wbr/>Image</span></a>
|
|
93
|
+
<a href="MKPlayerAPI.html#setsubtitlestyle" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Subtitle<wbr/>Style</span></a>
|
|
94
|
+
<a href="MKPlayerAPI.html#setuserengagementdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Engagement<wbr/>Data</span></a>
|
|
95
|
+
<a href="MKPlayerAPI.html#setvideoelement" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Element</span></a>
|
|
96
|
+
<a href="MKPlayerAPI.html#setvideoquality" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Quality</span></a>
|
|
97
|
+
<a href="MKPlayerAPI.html#setviewmode" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>View<wbr/>Mode</span></a>
|
|
98
|
+
<a href="MKPlayerAPI.html#setvolume" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Volume</span></a>
|
|
99
|
+
<a href="MKPlayerAPI.html#showairplaytargetpicker" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Airplay<wbr/>Target<wbr/>Picker</span></a>
|
|
100
|
+
<a href="MKPlayerAPI.html#skipad" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>skip<wbr/>Ad</span></a>
|
|
101
|
+
<a href="MKPlayerAPI.html#skipadbreak" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>skip<wbr/>Ad<wbr/>Break</span></a>
|
|
102
|
+
<a href="MKPlayerAPI.html#unload" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unload</span></a>
|
|
103
|
+
<a href="MKPlayerAPI.html#unmute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute</span></a>
|
|
104
|
+
<a href="MKPlayerAPI.html#updateauthtoken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Auth<wbr/>Token</span></a>
|
|
105
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="adaptation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>adaptation</span><a href="#adaptation" 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><div class="tsd-signature"><span class="tsd-kind-property">adaptation</span><span class="tsd-signature-symbol">:</span> <a href="MKAdaptationAPI.html" class="tsd-signature-type tsd-kind-interface">MKAdaptationAPI</a></div><div class="tsd-comment tsd-typography"><p>MKPlayer Adaptation APIs.</p>
|
|
106
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.adaptation</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="buffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>buffer</span><a href="#buffer" 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><div class="tsd-signature"><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">:</span> <a href="MKBufferAPI.html" class="tsd-signature-type tsd-kind-interface">MKBufferAPI</a></div><div class="tsd-comment tsd-typography"><p>MKPlayer Buffer APIs.</p>
|
|
107
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.buffer</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="drm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>drm</span><a href="#drm" 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><div class="tsd-signature"><span class="tsd-kind-property">drm</span><span class="tsd-signature-symbol">:</span> <a href="MKDrmAPI.html" class="tsd-signature-type tsd-kind-interface">MKDrmAPI</a></div><div class="tsd-comment tsd-typography"><p>MKPlayer DRM APIs.</p>
|
|
108
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.drm</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="lowlatency" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>lowlatency</span><a href="#lowlatency" 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><div class="tsd-signature"><span class="tsd-kind-property">lowlatency</span><span class="tsd-signature-symbol">:</span> <a href="MKLowLatencyAPI.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencyAPI</a></div><div class="tsd-comment tsd-typography"><p>MKPlayer Low Latency APIs.</p>
|
|
109
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.lowlatency</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="manifest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>manifest</span><a href="#manifest" 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><div class="tsd-signature"><span class="tsd-kind-property">manifest</span><span class="tsd-signature-symbol">:</span> <a href="MKManifestAPI.html" class="tsd-signature-type tsd-kind-interface">MKManifestAPI</a></div><div class="tsd-comment tsd-typography"><p>MKPlayer Manifest APIs.</p>
|
|
110
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.manifest</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="subtitles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>subtitles</span><a href="#subtitles" 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><div class="tsd-signature"><span class="tsd-kind-property">subtitles</span><span class="tsd-signature-symbol">:</span> <a href="MKSubtitlesAPI.html" class="tsd-signature-type tsd-kind-interface">MKSubtitlesAPI</a></div><div class="tsd-comment tsd-typography"><p>MKPlayer Subtitles APIs.</p>
|
|
111
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.subtitles</p></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="addcastmetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Cast<wbr/>Metadata</span><a href="#addcastmetadata" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="addcastmetadata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addCastMetadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">metadata</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#addcastmetadata-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends custom metadata to a remote receiver app (e.g. Chromecast).</p>
|
|
112
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">metadata</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>the custom metadata to send to the receiver.</p>
|
|
113
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if it was successful.</p>
|
|
114
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.addCastMetadata</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="addtimelinemarker" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Timeline<wbr/>Marker</span><a href="#addtimelinemarker" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="addtimelinemarker-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addTimelineMarker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timelineMarker</span><span class="tsd-signature-symbol">:</span> <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#addtimelinemarker-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a marker to the timeline.</p>
|
|
212
115
|
<p><strong>Note:</strong> Does not check for duplicates/overlaps at the specified <code>time</code>.</p>
|
|
213
|
-
<p><strong>Note:</strong> This API is only available when <a href="MKPlayerConfig.html#ui" class="tsd-kind-property">ui</a> is enabled.</p>
|
|
116
|
+
<p><strong>Note:</strong> This API is only available when <a href="MKPlayerConfig.html#ui" class="tsd-kind-property">MKPlayerConfig.ui</a> is enabled.</p>
|
|
214
117
|
<p><strong>Note:</strong> It is also recommended to call this API after playback starts as the positioning
|
|
215
118
|
of the timeline marker depends on knowing the current seekable range. The best place to call
|
|
216
|
-
this the first time is as soon as the first time changed event is received from <a href="../enums/MKPlayerEvent.html#
|
|
119
|
+
this the first time is as soon as the first time changed event is received from <a href="../enums/MKPlayerEvent.html#timechanged" class="tsd-kind-enum-member">MKPlayerEvent.TimeChanged</a>.</p>
|
|
217
120
|
<p>Example to place timeline marker during ongoing playback:</p>
|
|
218
|
-
<pre><code><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">timelineMarkers</span><span class="hl-1"> = [</span><br/><span class="hl-1"> { </span><span class="hl-0">time:</span><span class="hl-1"> </span><span class="hl-
|
|
121
|
+
<pre><code><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">timelineMarkers</span><span class="hl-1"> = [</span><br/><span class="hl-1"> { </span><span class="hl-0">time:</span><span class="hl-1"> </span><span class="hl-13">24</span><span class="hl-1">, </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-11">'Salto on the edge'</span><span class="hl-1"> },</span><br/><span class="hl-1"> { </span><span class="hl-0">time:</span><span class="hl-1"> </span><span class="hl-13">69</span><span class="hl-1">, </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-11">'Interview - Marcus Gustafsson'</span><span class="hl-1"> },</span><br/><span class="hl-1"> { </span><span class="hl-0">time:</span><span class="hl-1"> </span><span class="hl-13">105</span><span class="hl-1">, </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-11">'Parcour rating explained'</span><span class="hl-1"> },</span><br/><span class="hl-1"> { </span><span class="hl-0">time:</span><span class="hl-1"> </span><span class="hl-13">188</span><span class="hl-1">, </span><span class="hl-0">duration:</span><span class="hl-1"> </span><span class="hl-13">11</span><span class="hl-1">, </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-11">'And we have a winner!'</span><span class="hl-1">, </span><span class="hl-0">cssClasses:</span><span class="hl-1"> [</span><span class="hl-11">'seekbar-marker-interval'</span><span class="hl-1">] },</span><br/><span class="hl-1">];</span><br/><br/><span class="hl-6">// Call this anytime during any ongoing playback</span><br/><span class="hl-6">// to add all available timeline markers to the UI.</span><br/><span class="hl-0">timelineMarkers</span><span class="hl-1">.</span><span class="hl-10">map</span><span class="hl-1">((</span><span class="hl-0">marker</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">player</span><span class="hl-1">.</span><span class="hl-10">addTimelineMarker</span><span class="hl-1">(</span><span class="hl-0">marker</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
219
122
|
</code><button>Copy</button></pre>
|
|
220
|
-
|
|
221
|
-
<
|
|
123
|
+
|
|
124
|
+
<p>Example to place timelineMarker for an AdBreak based off <a href="../enums/MKPlayerEvent.html#admarker" class="tsd-kind-enum-member">MKPlayerEvent.AdMarker</a>:</p>
|
|
125
|
+
<pre><code><span class="hl-6">// list of AdBreaks</span><br/><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-9">adBreaks</span><span class="hl-1"> = [];</span><br/><br/><span class="hl-6">// collect AdMarkers and build the list of adBreaks</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">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-0">adBreaks</span><span class="hl-1">.</span><span class="hl-10">push</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">.</span><span class="hl-0">adMarker</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-6">// timeline markers cannot be added from here during ongoing playback</span><br/><span class="hl-1"> </span><span class="hl-6">// because this callback is always reported when metadata is parsed</span><br/><span class="hl-1"> </span><span class="hl-6">// which means the time for this ad is in the future and outside the</span><br/><span class="hl-1"> </span><span class="hl-6">// current seekable range. So for upcoming adBreaks new markers can</span><br/><span class="hl-1"> </span><span class="hl-6">// only be added when the time falls within the current seekable range</span><br/><span class="hl-1"> </span><span class="hl-6">// or when the next MKPlayerEvent.AdBreakStarted event is triggered.</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">// global variable</span><br/><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">firstTimeChangedEvent</span><span class="hl-1"> = </span><span class="hl-8">false</span><span class="hl-1">;</span><br/><br/><span class="hl-6">// Wait for the playback to start and the</span><br/><span class="hl-6">// first time changed event is received to add timeline markers</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">MKPlayerEvent</span><span class="hl-1">.</span><span class="hl-0">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-14">if</span><span class="hl-1"> (!</span><span class="hl-0">firstTimeChangedEvent</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">firstTimeChangedEvent</span><span class="hl-1"> = </span><span class="hl-8">true</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-6">// add timeline markers</span><br/><span class="hl-1"> </span><span class="hl-0">adBreaks</span><span class="hl-1">.</span><span class="hl-10">map</span><span class="hl-1">((</span><span class="hl-0">marker</span><span class="hl-1">, </span><span class="hl-0">index</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">player</span><span class="hl-1">.</span><span class="hl-10">addTimelineMarker</span><span class="hl-1">({</span><span class="hl-0">time:</span><span class="hl-1"> </span><span class="hl-0">marker</span><span class="hl-1">.</span><span class="hl-0">start</span><span class="hl-1">});</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
|
222
126
|
</code><button>Copy</button></pre>
|
|
223
|
-
</div>
|
|
224
|
-
<div class="tsd-parameters">
|
|
225
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
226
|
-
<ul class="tsd-parameter-list">
|
|
227
|
-
<li>
|
|
228
|
-
<h5><span class="tsd-kind-parameter">timelineMarker</span>: <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a></h5>
|
|
229
|
-
<div class="tsd-comment tsd-typography"><p>the timeline marker to be added.</p>
|
|
230
|
-
</div>
|
|
231
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
232
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
233
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
234
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#addTimelineMarker">addTimelineMarker</a></p></aside></li></ul></section>
|
|
235
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="castStop" class="tsd-anchor"></a>
|
|
236
|
-
<h3 class="tsd-anchor-link"><span>cast<wbr/>Stop</span><a href="#castStop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
237
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
238
|
-
<li class="tsd-signature tsd-anchor-link" id="castStop.castStop-1"><span class="tsd-kind-call-signature">cast<wbr/>Stop</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#castStop.castStop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
239
|
-
<li class="tsd-description">
|
|
240
|
-
<div class="tsd-comment tsd-typography"><p>Stops a running Cast session (i.e. <a href="MKPlayerAPI.html#isCasting" class="tsd-kind-method">isCasting</a> returns true).</p>
|
|
241
|
-
<p>Has no effect if <a href="MKPlayerAPI.html#isCasting" class="tsd-kind-method">isCasting</a> returns false.</p>
|
|
242
|
-
</div>
|
|
243
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
244
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
245
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#castStop">castStop</a></p></aside></li></ul></section>
|
|
246
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="castVideo" class="tsd-anchor"></a>
|
|
247
|
-
<h3 class="tsd-anchor-link"><span>cast<wbr/>Video</span><a href="#castVideo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
248
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
249
|
-
<li class="tsd-signature tsd-anchor-link" id="castVideo.castVideo-1"><span class="tsd-kind-call-signature">cast<wbr/>Video</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#castVideo.castVideo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
250
|
-
<li class="tsd-description">
|
|
251
|
-
<div class="tsd-comment tsd-typography"><p>Initiates casting the current video to a Cast-compatible device.</p>
|
|
252
|
-
<p>The user has to choose the target device.</p>
|
|
253
|
-
</div>
|
|
254
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
255
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
256
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#castVideo">castVideo</a></p></aside></li></ul></section>
|
|
257
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="destroy" class="tsd-anchor"></a>
|
|
258
|
-
<h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
259
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
260
|
-
<li class="tsd-signature tsd-anchor-link" id="destroy.destroy-1"><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
261
|
-
<li class="tsd-description">
|
|
262
|
-
<div class="tsd-comment tsd-typography"><p>Unloads the player and removes all inserted HTML elements and event handlers.</p>
|
|
263
|
-
</div>
|
|
264
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise resolves when the player has cleaned up all its event handlers & resources.</p>
|
|
265
127
|
|
|
266
|
-
|
|
267
|
-
<p>Inherited from <a href="
|
|
268
|
-
<
|
|
269
|
-
<h3 class="tsd-anchor-link"><span>
|
|
270
|
-
<
|
|
271
|
-
<li class="tsd-signature tsd-anchor-link" id="
|
|
272
|
-
<
|
|
273
|
-
<div class="tsd-comment tsd-typography"><p>Discards all scheduled ad breaks with the given ID. Also stops the current ad break if it has the same ID.
|
|
274
|
-
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">advertising</a> is provided in the PlayerConfig.</p>
|
|
275
|
-
</div>
|
|
276
|
-
<div class="tsd-
|
|
277
|
-
<
|
|
278
|
-
<ul class="tsd-parameter-list">
|
|
279
|
-
<li>
|
|
280
|
-
<h5><span class="tsd-kind-parameter">adBreakId</span>: <span class="tsd-signature-type">string</span></h5>
|
|
281
|
-
<div class="tsd-comment tsd-typography"><p>The ID of the ad break which shall be removed from the scheduled ad breaks.</p>
|
|
282
|
-
</div>
|
|
283
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
284
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
285
|
-
<div class="tsd-comment tsd-typography">
|
|
286
|
-
<h4>Since</h4><p>v8.0</p>
|
|
287
|
-
</div><aside class="tsd-sources">
|
|
288
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#discardAdBreak">discardAdBreak</a></p></aside></li></ul></section>
|
|
289
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="dismissPauseAd" class="tsd-anchor"></a>
|
|
290
|
-
<h3 class="tsd-anchor-link"><span>dismiss<wbr/>Pause<wbr/>Ad</span><a href="#dismissPauseAd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
291
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
292
|
-
<li class="tsd-signature tsd-anchor-link" id="dismissPauseAd.dismissPauseAd-1"><span class="tsd-kind-call-signature">dismiss<wbr/>Pause<wbr/>Ad</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#dismissPauseAd.dismissPauseAd-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
293
|
-
<li class="tsd-description">
|
|
294
|
-
<div class="tsd-comment tsd-typography"><p>Dismisses currently active pauseAd overlay, if any.</p>
|
|
128
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">timelineMarker</span>: <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a></span><div class="tsd-comment tsd-typography"><p>the timeline marker to be added.</p>
|
|
129
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.addTimelineMarker</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="caststop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cast<wbr/>Stop</span><a href="#caststop" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="caststop-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">castStop</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#caststop-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stops a running Cast session (i.e. <a href="MKPlayerAPI.html#iscasting" class="tsd-kind-method">isCasting</a> returns true).</p>
|
|
130
|
+
<p>Has no effect if <a href="MKPlayerAPI.html#iscasting" class="tsd-kind-method">isCasting</a> returns false.</p>
|
|
131
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.castStop</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="castvideo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cast<wbr/>Video</span><a href="#castvideo" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="castvideo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">castVideo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#castvideo-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initiates casting the current video to a Cast-compatible device.</p>
|
|
132
|
+
<p>The user has to choose the target device.</p>
|
|
133
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.castVideo</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="destroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#destroy-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unloads the player and removes all inserted HTML elements and event handlers.</p>
|
|
134
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise resolves when the player has cleaned up all its event handlers & resources.</p>
|
|
135
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.destroy</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="discardadbreak" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>discard<wbr/>Ad<wbr/>Break</span><a href="#discardadbreak" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="discardadbreak-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">discardAdBreak</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">adBreakId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#discardadbreak-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Discards all scheduled ad breaks with the given ID. Also stops the current ad break if it has the same ID.
|
|
136
|
+
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">MKPlayerConfig.advertising</a> is provided in the PlayerConfig.</p>
|
|
137
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">adBreakId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the ad break which shall be removed from the scheduled ad breaks.</p>
|
|
138
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since" class="tsd-anchor"></a>Since<a href="#since" 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></h4><p>v1.18.0</p>
|
|
139
|
+
</div></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.discardAdBreak</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="dismisspausead" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dismiss<wbr/>Pause<wbr/>Ad</span><a href="#dismisspausead" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="dismisspausead-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">dismissPauseAd</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#dismisspausead-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Dismisses currently active pauseAd overlay, if any.</p>
|
|
295
140
|
<p>Note:</p>
|
|
296
141
|
<ul>
|
|
297
|
-
<li>If a pauseAd overlay is currently active, then it is removed and method returns true. This fires <a href="../enums/MKPlayerEvent.html#
|
|
298
|
-
<li>If no pauseAd overlay is active, then any rendering in progress is stopped and false is returned, no events fired. PauseAd rendering will only re-trigger after next call to <a href="MKPlayerAPI.html#pause" class="tsd-kind-method">pause</a>.</li>
|
|
299
|
-
<li>If no pauseAd overlay active or <a href="MKSsaiAdConfig.html#
|
|
142
|
+
<li>If a pauseAd overlay is currently active, then it is removed and method returns true. This fires <a href="../enums/MKPlayerEvent.html#pauseaddismissed" class="tsd-kind-enum-member">MKPlayerEvent.PauseAdDismissed</a>.</li>
|
|
143
|
+
<li>If no pauseAd overlay is active, then any rendering in progress is stopped and false is returned, no events fired. PauseAd rendering will only re-trigger after next call to <a href="MKPlayerAPI.html#pause" class="tsd-kind-method">MKPlayerAPI.pause</a>.</li>
|
|
144
|
+
<li>If no pauseAd overlay active or <a href="MKSsaiAdConfig.html#pauseadenabled" class="tsd-kind-property">MKSsaiAdConfig.pauseAdEnabled</a> not enabled, then method returns false, no events fired.</li>
|
|
300
145
|
</ul>
|
|
301
|
-
</div>
|
|
302
|
-
<
|
|
303
|
-
|
|
304
|
-
<
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
<
|
|
308
|
-
<
|
|
309
|
-
<li class="tsd-description">
|
|
310
|
-
<div class="tsd-comment tsd-typography"><p>Returns the currently active ad.
|
|
311
|
-
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">advertising</a> is provided in the PlayerConfig.</p>
|
|
312
|
-
</div>
|
|
313
|
-
<h4 class="tsd-returns-title">Returns <a href="MKAd.html" class="tsd-signature-type tsd-kind-interface">MKAd</a></h4>
|
|
314
|
-
<div class="tsd-comment tsd-typography">
|
|
315
|
-
<h4>Since</h4><p>v8.1</p>
|
|
316
|
-
</div><aside class="tsd-sources">
|
|
317
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getActiveAd">getActiveAd</a></p></aside></li></ul></section>
|
|
318
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getActiveAdBreak" class="tsd-anchor"></a>
|
|
319
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Active<wbr/>Ad<wbr/>Break</span><a href="#getActiveAdBreak" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
320
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
321
|
-
<li class="tsd-signature tsd-anchor-link" id="getActiveAdBreak.getActiveAdBreak-1"><span class="tsd-kind-call-signature">get<wbr/>Active<wbr/>Ad<wbr/>Break</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><a href="#getActiveAdBreak.getActiveAdBreak-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
322
|
-
<li class="tsd-description">
|
|
323
|
-
<div class="tsd-comment tsd-typography"><p>Returns the currently active ad break.
|
|
324
|
-
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">advertising</a> is provided in the PlayerConfig.</p>
|
|
325
|
-
</div>
|
|
326
|
-
<h4 class="tsd-returns-title">Returns <a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a></h4><p>AdBreak</p>
|
|
327
|
-
|
|
328
|
-
<div class="tsd-comment tsd-typography">
|
|
329
|
-
<h4>Since</h4><p>v8.0</p>
|
|
330
|
-
</div><aside class="tsd-sources">
|
|
331
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getActiveAdBreak">getActiveAdBreak</a></p></aside></li></ul></section>
|
|
332
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getAspectRatio" class="tsd-anchor"></a>
|
|
333
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Aspect<wbr/>Ratio</span><a href="#getAspectRatio" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
334
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
335
|
-
<li class="tsd-signature tsd-anchor-link" id="getAspectRatio.getAspectRatio-1"><span class="tsd-kind-call-signature">get<wbr/>Aspect<wbr/>Ratio</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getAspectRatio.getAspectRatio-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
336
|
-
<li class="tsd-description">
|
|
337
|
-
<div class="tsd-comment tsd-typography"><p>Returns the current aspect ratio of the player, or 0 if there is no style module.</p>
|
|
146
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.dismissPauseAd</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getactivead" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Active<wbr/>Ad</span><a href="#getactivead" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getactivead-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getActiveAd</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAd.html" class="tsd-signature-type tsd-kind-interface">MKAd</a><a href="#getactivead-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the currently active ad, or null if no ad is active.
|
|
147
|
+
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">MKPlayerConfig.advertising</a> is provided in the PlayerConfig.</p>
|
|
148
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKAd.html" class="tsd-signature-type tsd-kind-interface">MKAd</a></h4><p>the active Ad, or null if none is active</p>
|
|
149
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since-1" class="tsd-anchor"></a>Since<a href="#since-1" 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></h4><p>v1.18.0</p>
|
|
150
|
+
</div></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getActiveAd</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getactiveadbreak" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Active<wbr/>Ad<wbr/>Break</span><a href="#getactiveadbreak" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getactiveadbreak-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getActiveAdBreak</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><a href="#getactiveadbreak-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the currently active ad break, or null if no ad break is active.
|
|
151
|
+
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">MKPlayerConfig.advertising</a> is provided in the PlayerConfig.</p>
|
|
152
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a></h4><p>the active AdBreak, or null if none is active</p>
|
|
153
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since-2" class="tsd-anchor"></a>Since<a href="#since-2" 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></h4><p>v1.18.0</p>
|
|
154
|
+
</div></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getActiveAdBreak</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getaspectratio" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Aspect<wbr/>Ratio</span><a href="#getaspectratio" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getaspectratio-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAspectRatio</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getaspectratio-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the current aspect ratio of the player, or 0 if there is no style module.</p>
|
|
338
155
|
<p>Note: the default player aspect ratio is 16:9.</p>
|
|
339
|
-
</div>
|
|
340
|
-
<
|
|
341
|
-
|
|
342
|
-
<
|
|
343
|
-
<p>Inherited from <a href="
|
|
344
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="
|
|
345
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>
|
|
346
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
347
|
-
<
|
|
348
|
-
<li class="tsd-description">
|
|
349
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
350
|
-
</div>
|
|
351
|
-
<
|
|
352
|
-
<
|
|
353
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getAudio">getAudio</a></p></aside></li></ul></section>
|
|
354
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getAudioQuality" class="tsd-anchor"></a>
|
|
355
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Audio<wbr/>Quality</span><a href="#getAudioQuality" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
356
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
357
|
-
<li class="tsd-signature tsd-anchor-link" id="getAudioQuality.getAudioQuality-1"><span class="tsd-kind-call-signature">get<wbr/>Audio<wbr/>Quality</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><a href="#getAudioQuality.getAudioQuality-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
358
|
-
<li class="tsd-description">
|
|
359
|
-
<div class="tsd-comment tsd-typography"><p>Returns the currently selected audio quality.</p>
|
|
360
|
-
<p>One of the elements of <a href="MKPlayerAPI.html#getAvailableAudioQualities" class="tsd-kind-method">getAvailableAudioQualities</a>.</p>
|
|
361
|
-
</div>
|
|
362
|
-
<h4 class="tsd-returns-title">Returns <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a></h4>
|
|
363
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
364
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getAudioQuality">getAudioQuality</a></p></aside></li></ul></section>
|
|
365
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getAvailableAudio" class="tsd-anchor"></a>
|
|
366
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Audio</span><a href="#getAvailableAudio" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
367
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
368
|
-
<li class="tsd-signature tsd-anchor-link" id="getAvailableAudio.getAvailableAudio-1"><span class="tsd-kind-call-signature">get<wbr/>Available<wbr/>Audio</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a><span class="tsd-signature-symbol">[]</span><a href="#getAvailableAudio.getAvailableAudio-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
369
|
-
<li class="tsd-description">
|
|
370
|
-
<div class="tsd-comment tsd-typography"><p>Returns an array of all available audio tracks.</p>
|
|
371
|
-
</div>
|
|
372
|
-
<h4 class="tsd-returns-title">Returns <a href="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
373
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
374
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getAvailableAudio">getAvailableAudio</a></p></aside></li></ul></section>
|
|
375
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getAvailableAudioQualities" class="tsd-anchor"></a>
|
|
376
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Audio<wbr/>Qualities</span><a href="#getAvailableAudioQualities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
377
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
378
|
-
<li class="tsd-signature tsd-anchor-link" id="getAvailableAudioQualities.getAvailableAudioQualities-1"><span class="tsd-kind-call-signature">get<wbr/>Available<wbr/>Audio<wbr/>Qualities</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><span class="tsd-signature-symbol">[]</span><a href="#getAvailableAudioQualities.getAvailableAudioQualities-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
379
|
-
<li class="tsd-description">
|
|
380
|
-
<div class="tsd-comment tsd-typography"><p>Returns an array of all available audio qualities the player can adapt between.</p>
|
|
381
|
-
</div>
|
|
382
|
-
<h4 class="tsd-returns-title">Returns <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
383
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
384
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getAvailableAudioQualities">getAvailableAudioQualities</a></p></aside></li></ul></section>
|
|
385
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getAvailableSegments" class="tsd-anchor"></a>
|
|
386
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Segments</span><a href="#getAvailableSegments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
387
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
388
|
-
<li class="tsd-signature tsd-anchor-link" id="getAvailableSegments.getAvailableSegments-1"><span class="tsd-kind-call-signature">get<wbr/>Available<wbr/>Segments</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKSegmentMap.html" class="tsd-signature-type tsd-kind-interface">MKSegmentMap</a><a href="#getAvailableSegments.getAvailableSegments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
389
|
-
<li class="tsd-description">
|
|
390
|
-
<div class="tsd-comment tsd-typography"><p>Returns info for segments that can be requested by the player.</p>
|
|
391
|
-
</div>
|
|
392
|
-
<h4 class="tsd-returns-title">Returns <a href="MKSegmentMap.html" class="tsd-signature-type tsd-kind-interface">MKSegmentMap</a></h4>
|
|
393
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
394
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getAvailableSegments">getAvailableSegments</a></p></aside></li></ul></section>
|
|
395
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getAvailableVideoQualities" class="tsd-anchor"></a>
|
|
396
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Video<wbr/>Qualities</span><a href="#getAvailableVideoQualities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
397
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
398
|
-
<li class="tsd-signature tsd-anchor-link" id="getAvailableVideoQualities.getAvailableVideoQualities-1"><span class="tsd-kind-call-signature">get<wbr/>Available<wbr/>Video<wbr/>Qualities</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><span class="tsd-signature-symbol">[]</span><a href="#getAvailableVideoQualities.getAvailableVideoQualities-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
399
|
-
<li class="tsd-description">
|
|
400
|
-
<div class="tsd-comment tsd-typography"><p>Returns an array containing all available video qualities the player can adapt between.</p>
|
|
401
|
-
</div>
|
|
402
|
-
<h4 class="tsd-returns-title">Returns <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
403
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
404
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getAvailableVideoQualities">getAvailableVideoQualities</a></p></aside></li></ul></section>
|
|
405
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getBufferedRanges" class="tsd-anchor"></a>
|
|
406
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Buffered<wbr/>Ranges</span><a href="#getBufferedRanges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
407
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
408
|
-
<li class="tsd-signature tsd-anchor-link" id="getBufferedRanges.getBufferedRanges-1"><span class="tsd-kind-call-signature">get<wbr/>Buffered<wbr/>Ranges</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a><span class="tsd-signature-symbol">[]</span><a href="#getBufferedRanges.getBufferedRanges-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
409
|
-
<li class="tsd-description">
|
|
410
|
-
<div class="tsd-comment tsd-typography"><p>Returns the currently buffered time ranges of the video element.</p>
|
|
411
|
-
</div>
|
|
412
|
-
<h4 class="tsd-returns-title">Returns <a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a><span class="tsd-signature-symbol">[]</span></h4>
|
|
413
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
414
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getBufferedRanges">getBufferedRanges</a></p></aside></li></ul></section>
|
|
415
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getConfig" class="tsd-anchor"></a>
|
|
416
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Config</span><a href="#getConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
417
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
418
|
-
<li class="tsd-signature tsd-anchor-link" id="getConfig.getConfig-1"><span class="tsd-kind-call-signature">get<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mergedConfig</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKPlayerConfig.html" class="tsd-signature-type tsd-kind-interface">MKPlayerConfig</a><a href="#getConfig.getConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
419
|
-
<li class="tsd-description">
|
|
420
|
-
<div class="tsd-comment tsd-typography"><p>Returns the config object of the current player instance.</p>
|
|
421
|
-
</div>
|
|
422
|
-
<div class="tsd-parameters">
|
|
423
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
424
|
-
<ul class="tsd-parameter-list">
|
|
425
|
-
<li>
|
|
426
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">mergedConfig</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
427
|
-
<div class="tsd-comment tsd-typography"><p>true to return the config expanded with all default values, false to return the user config passed to the player's constructor.</p>
|
|
428
|
-
</div>
|
|
429
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
430
|
-
<h4 class="tsd-returns-title">Returns <a href="MKPlayerConfig.html" class="tsd-signature-type tsd-kind-interface">MKPlayerConfig</a></h4><p>The current user or merged player config.</p>
|
|
431
|
-
|
|
432
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
433
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getConfig">getConfig</a></p></aside></li></ul></section>
|
|
434
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getCurrentTime" class="tsd-anchor"></a>
|
|
435
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Current<wbr/>Time</span><a href="#getCurrentTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
436
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
437
|
-
<li class="tsd-signature tsd-anchor-link" id="getCurrentTime.getCurrentTime-1"><span class="tsd-kind-call-signature">get<wbr/>Current<wbr/>Time</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getCurrentTime.getCurrentTime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
438
|
-
<li class="tsd-description">
|
|
439
|
-
<div class="tsd-comment tsd-typography"><p>Returns the current playback time in seconds of the video.
|
|
440
|
-
If <code>excludePrerollFromVodDuration</code> is set to <code>true</code> in the player config then,
|
|
156
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>A number indicating the player aspect ratio (e.g. 1.6 for 16:10) or <code>0</code> in case of error.</p>
|
|
157
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getAspectRatio</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getaudio" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Audio</span><a href="#getaudio" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getaudio-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAudio</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a><a href="#getaudio-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the currently used audio track, or null if no track is active.</p>
|
|
158
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getAudio</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getaudioquality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Audio<wbr/>Quality</span><a href="#getaudioquality" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getaudioquality-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAudioQuality</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><a href="#getaudioquality-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the currently selected audio quality.</p>
|
|
159
|
+
<p>One of the elements of <a href="MKPlayerAPI.html#getavailableaudioqualities" class="tsd-kind-method">getAvailableAudioQualities</a>.</p>
|
|
160
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getAudioQuality</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getavailableaudio" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Audio</span><a href="#getavailableaudio" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getavailableaudio-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAvailableAudio</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a><span class="tsd-signature-symbol">[]</span><a href="#getavailableaudio-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an array of all available audio tracks.</p>
|
|
161
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getAvailableAudio</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getavailableaudioqualities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Audio<wbr/>Qualities</span><a href="#getavailableaudioqualities" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getavailableaudioqualities-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAvailableAudioQualities</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><span class="tsd-signature-symbol">[]</span><a href="#getavailableaudioqualities-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an array of all available audio qualities the player can adapt between.</p>
|
|
162
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getAvailableAudioQualities</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getavailablesegments" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Segments</span><a href="#getavailablesegments" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getavailablesegments-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAvailableSegments</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKSegmentMap.html" class="tsd-signature-type tsd-kind-interface">MKSegmentMap</a><a href="#getavailablesegments-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns info for segments that can be requested by the player.</p>
|
|
163
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKSegmentMap.html" class="tsd-signature-type tsd-kind-interface">MKSegmentMap</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getAvailableSegments</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getavailablevideoqualities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Video<wbr/>Qualities</span><a href="#getavailablevideoqualities" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getavailablevideoqualities-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAvailableVideoQualities</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><span class="tsd-signature-symbol">[]</span><a href="#getavailablevideoqualities-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns an array containing all available video qualities the player can adapt between.</p>
|
|
164
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getAvailableVideoQualities</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getbufferedranges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Buffered<wbr/>Ranges</span><a href="#getbufferedranges" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getbufferedranges-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getBufferedRanges</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a><span class="tsd-signature-symbol">[]</span><a href="#getbufferedranges-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the currently buffered time ranges of the video element.</p>
|
|
165
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getBufferedRanges</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Config</span><a href="#getconfig" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getconfig-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getConfig</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mergedConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="MKPlayerConfig.html" class="tsd-signature-type tsd-kind-interface">MKPlayerConfig</a><a href="#getconfig-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the config object of the current player instance.</p>
|
|
166
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mergedConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true to return the config expanded with all default values, false to return the user config passed to the player's constructor.</p>
|
|
167
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="MKPlayerConfig.html" class="tsd-signature-type tsd-kind-interface">MKPlayerConfig</a></h4><p>The current user or merged player config.</p>
|
|
168
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getConfig</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getcurrenttime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Current<wbr/>Time</span><a href="#getcurrenttime" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getcurrenttime-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getCurrentTime</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/MKTimeMode.html" class="tsd-signature-type tsd-kind-enum">MKTimeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getcurrenttime-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the current playback time in seconds of the video.</p>
|
|
169
|
+
<p>If MKPlayerConfig.excludePrerollFromVodDuration is set to <code>true</code> in the player config then,
|
|
441
170
|
for VOD content, the duration of any preroll ads will be excluded from the returned current time while playing actual VOD content.</p>
|
|
442
|
-
</div>
|
|
443
|
-
<
|
|
444
|
-
|
|
445
|
-
<ul class="tsd-
|
|
446
|
-
<li>
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
<p>For
|
|
450
|
-
</div>
|
|
451
|
-
|
|
452
|
-
<
|
|
453
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
454
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getCurrentTime">getCurrentTime</a></p></aside></li></ul></section>
|
|
455
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getDownloadedAudioData" class="tsd-anchor"></a>
|
|
456
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Downloaded<wbr/>Audio<wbr/>Data</span><a href="#getDownloadedAudioData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
457
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
458
|
-
<li class="tsd-signature tsd-anchor-link" id="getDownloadedAudioData.getDownloadedAudioData-1"><span class="tsd-kind-call-signature">get<wbr/>Downloaded<wbr/>Audio<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKDownloadedAudioData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedAudioData</a><a href="#getDownloadedAudioData.getDownloadedAudioData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
459
|
-
<li class="tsd-description">
|
|
460
|
-
<div class="tsd-comment tsd-typography"><p>Returns data about the last downloaded audio segment.</p>
|
|
461
|
-
</div>
|
|
462
|
-
<h4 class="tsd-returns-title">Returns <a href="MKDownloadedAudioData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedAudioData</a></h4>
|
|
463
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
464
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getDownloadedAudioData">getDownloadedAudioData</a></p></aside></li></ul></section>
|
|
465
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getDownloadedVideoData" class="tsd-anchor"></a>
|
|
466
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Downloaded<wbr/>Video<wbr/>Data</span><a href="#getDownloadedVideoData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
467
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
468
|
-
<li class="tsd-signature tsd-anchor-link" id="getDownloadedVideoData.getDownloadedVideoData-1"><span class="tsd-kind-call-signature">get<wbr/>Downloaded<wbr/>Video<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKDownloadedVideoData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedVideoData</a><a href="#getDownloadedVideoData.getDownloadedVideoData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
469
|
-
<li class="tsd-description">
|
|
470
|
-
<div class="tsd-comment tsd-typography"><p>Returns data about the last downloaded video segment.</p>
|
|
471
|
-
</div>
|
|
472
|
-
<h4 class="tsd-returns-title">Returns <a href="MKDownloadedVideoData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedVideoData</a></h4>
|
|
473
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
474
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getDownloadedVideoData">getDownloadedVideoData</a></p></aside></li></ul></section>
|
|
475
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getDroppedVideoFrames" class="tsd-anchor"></a>
|
|
476
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Dropped<wbr/>Video<wbr/>Frames</span><a href="#getDroppedVideoFrames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
477
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
478
|
-
<li class="tsd-signature tsd-anchor-link" id="getDroppedVideoFrames.getDroppedVideoFrames-1"><span class="tsd-kind-call-signature">get<wbr/>Dropped<wbr/>Video<wbr/>Frames</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getDroppedVideoFrames.getDroppedVideoFrames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
479
|
-
<li class="tsd-description">
|
|
480
|
-
<div class="tsd-comment tsd-typography"><p>Returns the total number of dropped video frames since playback started.</p>
|
|
481
|
-
</div>
|
|
482
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
483
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
484
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getDroppedVideoFrames">getDroppedVideoFrames</a></p></aside></li></ul></section>
|
|
485
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getDuration" class="tsd-anchor"></a>
|
|
486
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Duration</span><a href="#getDuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
487
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
488
|
-
<li class="tsd-signature tsd-anchor-link" id="getDuration.getDuration-1"><span class="tsd-kind-call-signature">get<wbr/>Duration</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getDuration.getDuration-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
489
|
-
<li class="tsd-description">
|
|
490
|
-
<div class="tsd-comment tsd-typography"><p>Returns the total duration in seconds of the current video.
|
|
491
|
-
If <code>excludePrerollFromVodDuration</code> is set to <code>true</code> in the player config, the duration of any preroll ads for VOD content will be excluded from the returned duration.</p>
|
|
492
|
-
</div>
|
|
493
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
494
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
495
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getDuration">getDuration</a></p></aside></li></ul></section>
|
|
496
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getLiveLatency" class="tsd-anchor"></a>
|
|
497
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Live<wbr/>Latency</span><a href="#getLiveLatency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
498
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
499
|
-
<li class="tsd-signature tsd-anchor-link" id="getLiveLatency.getLiveLatency-1"><span class="tsd-kind-call-signature">get<wbr/>Live<wbr/>Latency</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getLiveLatency.getLiveLatency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
500
|
-
<li class="tsd-description">
|
|
501
|
-
<div class="tsd-comment tsd-typography"><p>Returns the current latency in seconds for the live stream.</p>
|
|
502
|
-
</div>
|
|
503
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>the current latency in seconds.</p>
|
|
504
|
-
|
|
505
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
506
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getLiveLatency">getLiveLatency</a></p></aside></li></ul></section>
|
|
507
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getMaxTimeShift" class="tsd-anchor"></a>
|
|
508
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Max<wbr/>Time<wbr/>Shift</span><a href="#getMaxTimeShift" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
509
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
510
|
-
<li class="tsd-signature tsd-anchor-link" id="getMaxTimeShift.getMaxTimeShift-1"><span class="tsd-kind-call-signature">get<wbr/>Max<wbr/>Time<wbr/>Shift</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getMaxTimeShift.getMaxTimeShift-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
511
|
-
<li class="tsd-description">
|
|
512
|
-
<div class="tsd-comment tsd-typography"><p>Returns the limit in seconds for time shift.</p>
|
|
171
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mode</span>: <a href="../enums/MKTimeMode.html" class="tsd-signature-type tsd-kind-enum">MKTimeMode</a></span><div class="tsd-comment tsd-typography"><p>The mode to decide if the returned time should be absolute or relative, see <a href="../enums/MKTimeMode.html" class="tsd-kind-enum">MKTimeMode</a>. Default mode is absolute.</p>
|
|
172
|
+
<p>For Live and Events the default mode is <a href="../enums/MKTimeMode.html#absolutetime" class="tsd-kind-enum-member">MKTimeMode.AbsoluteTime</a>. For VOD, Catchup and DVR its <a href="../enums/MKTimeMode.html#relativetime" class="tsd-kind-enum-member">MKTimeMode.RelativeTime</a>.</p>
|
|
173
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getCurrentTime</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getdownloadedaudiodata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Downloaded<wbr/>Audio<wbr/>Data</span><a href="#getdownloadedaudiodata" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getdownloadedaudiodata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getDownloadedAudioData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKDownloadedAudioData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedAudioData</a><a href="#getdownloadedaudiodata-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns data about the last downloaded audio segment.</p>
|
|
174
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKDownloadedAudioData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedAudioData</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getDownloadedAudioData</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getdownloadedvideodata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Downloaded<wbr/>Video<wbr/>Data</span><a href="#getdownloadedvideodata" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getdownloadedvideodata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getDownloadedVideoData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKDownloadedVideoData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedVideoData</a><a href="#getdownloadedvideodata-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns data about the last downloaded video segment.</p>
|
|
175
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKDownloadedVideoData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedVideoData</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getDownloadedVideoData</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getdroppedvideoframes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Dropped<wbr/>Video<wbr/>Frames</span><a href="#getdroppedvideoframes" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getdroppedvideoframes-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getDroppedVideoFrames</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getdroppedvideoframes-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the total number of dropped video frames since playback started.</p>
|
|
176
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getDroppedVideoFrames</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getduration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Duration</span><a href="#getduration" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getduration-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getDuration</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getduration-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the total duration in seconds of the current video.
|
|
177
|
+
If MKPlayerConfig.excludePrerollFromVodDuration is set to <code>true</code> in the player config, the duration of any preroll ads for VOD content will be excluded from the returned duration.</p>
|
|
178
|
+
<p>For live streams, it returns length of timeShift window.</p>
|
|
179
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getDuration</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getlivelatency" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Live<wbr/>Latency</span><a href="#getlivelatency" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getlivelatency-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getLiveLatency</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getlivelatency-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the current latency in seconds for the live stream.</p>
|
|
180
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>the current latency in seconds.</p>
|
|
181
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getLiveLatency</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getmaxtimeshift" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Max<wbr/>Time<wbr/>Shift</span><a href="#getmaxtimeshift" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getmaxtimeshift-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getMaxTimeShift</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getmaxtimeshift-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the limit in seconds for time shift.</p>
|
|
513
182
|
<p>Is either negative or 0 and applicable to live streams only.</p>
|
|
514
|
-
</div>
|
|
515
|
-
<
|
|
516
|
-
<div class="tsd-comment tsd-typography"
|
|
517
|
-
|
|
518
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="
|
|
519
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Module<wbr/>Info</span><a href="#getModuleInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
520
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
521
|
-
<li class="tsd-signature tsd-anchor-link" id="getModuleInfo.getModuleInfo-1"><span class="tsd-kind-call-signature">get<wbr/>Module<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKModuleInfo.html" class="tsd-signature-type tsd-kind-interface">MKModuleInfo</a><a href="#getModuleInfo.getModuleInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
522
|
-
<li class="tsd-description">
|
|
523
|
-
<div class="tsd-comment tsd-typography"><p>Returns the name and version of the currently used advertising module.
|
|
524
|
-
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">advertising</a> is provided in the PlayerConfig.</p>
|
|
525
|
-
</div>
|
|
526
|
-
<h4 class="tsd-returns-title">Returns <a href="MKModuleInfo.html" class="tsd-signature-type tsd-kind-interface">MKModuleInfo</a></h4>
|
|
527
|
-
<div class="tsd-comment tsd-typography">
|
|
528
|
-
<h4>Since</h4><p>v8.1</p>
|
|
529
|
-
</div><aside class="tsd-sources">
|
|
530
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getModuleInfo">getModuleInfo</a></p></aside></li></ul></section>
|
|
531
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getPlaybackAudioData" class="tsd-anchor"></a>
|
|
532
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Playback<wbr/>Audio<wbr/>Data</span><a href="#getPlaybackAudioData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
533
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
534
|
-
<li class="tsd-signature tsd-anchor-link" id="getPlaybackAudioData.getPlaybackAudioData-1"><span class="tsd-kind-call-signature">get<wbr/>Playback<wbr/>Audio<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><a href="#getPlaybackAudioData.getPlaybackAudioData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
535
|
-
<li class="tsd-description">
|
|
536
|
-
<div class="tsd-comment tsd-typography"><p>Returns data about the currently playing audio segment.</p>
|
|
537
|
-
</div>
|
|
538
|
-
<h4 class="tsd-returns-title">Returns <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a></h4>
|
|
539
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
540
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getPlaybackAudioData">getPlaybackAudioData</a></p></aside></li></ul></section>
|
|
541
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getPlaybackSpeed" class="tsd-anchor"></a>
|
|
542
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Playback<wbr/>Speed</span><a href="#getPlaybackSpeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
543
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
544
|
-
<li class="tsd-signature tsd-anchor-link" id="getPlaybackSpeed.getPlaybackSpeed-1"><span class="tsd-kind-call-signature">get<wbr/>Playback<wbr/>Speed</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getPlaybackSpeed.getPlaybackSpeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
545
|
-
<li class="tsd-description">
|
|
546
|
-
<div class="tsd-comment tsd-typography"><p>Returns the current playback speed of the player.</p>
|
|
183
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getMaxTimeShift</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getmoduleinfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Module<wbr/>Info</span><a href="#getmoduleinfo" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getmoduleinfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getModuleInfo</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKModuleInfo.html" class="tsd-signature-type tsd-kind-interface">MKModuleInfo</a><a href="#getmoduleinfo-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the name and version of the currently used advertising module.
|
|
184
|
+
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">MKPlayerConfig.advertising</a> is provided in the PlayerConfig.</p>
|
|
185
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKModuleInfo.html" class="tsd-signature-type tsd-kind-interface">MKModuleInfo</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since-3" class="tsd-anchor"></a>Since<a href="#since-3" 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></h4><p>v1.18.0</p>
|
|
186
|
+
</div></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getModuleInfo</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getplaybackaudiodata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Playback<wbr/>Audio<wbr/>Data</span><a href="#getplaybackaudiodata" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getplaybackaudiodata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getPlaybackAudioData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a><a href="#getplaybackaudiodata-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns data about the currently playing audio segment.</p>
|
|
187
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getPlaybackAudioData</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getplaybackspeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Playback<wbr/>Speed</span><a href="#getplaybackspeed" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getplaybackspeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getPlaybackSpeed</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getplaybackspeed-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the current playback speed of the player.</p>
|
|
547
188
|
<p><code>1</code> is the default playback speed, values between <code>0</code> and <code>1</code> refer to slow motion and values greater than <code>1</code> refer to fast forward.</p>
|
|
548
189
|
<p>Values less or equal zero are ignored.</p>
|
|
549
|
-
</div>
|
|
550
|
-
|
|
551
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
552
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getPlaybackSpeed">getPlaybackSpeed</a></p></aside></li></ul></section>
|
|
553
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getPlaybackVideoData" class="tsd-anchor"></a>
|
|
554
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Playback<wbr/>Video<wbr/>Data</span><a href="#getPlaybackVideoData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
555
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
556
|
-
<li class="tsd-signature tsd-anchor-link" id="getPlaybackVideoData.getPlaybackVideoData-1"><span class="tsd-kind-call-signature">get<wbr/>Playback<wbr/>Video<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><a href="#getPlaybackVideoData.getPlaybackVideoData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
557
|
-
<li class="tsd-description">
|
|
558
|
-
<div class="tsd-comment tsd-typography"><p>Returns data about the currently playing video segment.</p>
|
|
559
|
-
</div>
|
|
560
|
-
<h4 class="tsd-returns-title">Returns <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a></h4>
|
|
561
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
562
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getPlaybackVideoData">getPlaybackVideoData</a></p></aside></li></ul></section>
|
|
563
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getPlayerType" class="tsd-anchor"></a>
|
|
564
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Player<wbr/>Type</span><a href="#getPlayerType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
565
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
566
|
-
<li class="tsd-signature tsd-anchor-link" id="getPlayerType.getPlayerType-1"><span class="tsd-kind-call-signature">get<wbr/>Player<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/MKPlayerType.html" class="tsd-signature-type tsd-kind-enum">MKPlayerType</a><a href="#getPlayerType.getPlayerType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
567
|
-
<li class="tsd-description">
|
|
568
|
-
<div class="tsd-comment tsd-typography"><p>Returns the currently used rendering mode.</p>
|
|
190
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getPlaybackSpeed</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getplaybackvideodata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Playback<wbr/>Video<wbr/>Data</span><a href="#getplaybackvideodata" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getplaybackvideodata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getPlaybackVideoData</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><a href="#getplaybackvideodata-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns data about the currently playing video segment.</p>
|
|
191
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getPlaybackVideoData</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getplayertype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Player<wbr/>Type</span><a href="#getplayertype" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getplayertype-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getPlayerType</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKPlayerType.html" class="tsd-signature-type tsd-kind-enum">MKPlayerType</a><a href="#getplayertype-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the currently used rendering mode.</p>
|
|
569
192
|
<p>See <a href="../enums/MKPlayerType.html" class="tsd-kind-enum">MKPlayerType</a> for details on valid values.</p>
|
|
570
|
-
<p><a href="../enums/MKPlayerType.html#
|
|
571
|
-
</div>
|
|
572
|
-
<
|
|
573
|
-
<div class="tsd-comment tsd-typography"
|
|
574
|
-
|
|
575
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="
|
|
576
|
-
|
|
577
|
-
<ul class="tsd-signatures tsd-
|
|
578
|
-
|
|
579
|
-
<li class="tsd-description">
|
|
580
|
-
<div class="tsd-comment tsd-typography"><p>Returns
|
|
581
|
-
<p
|
|
582
|
-
</
|
|
583
|
-
<
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
<li>
|
|
587
|
-
<
|
|
588
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
589
|
-
</div>
|
|
590
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
591
|
-
<h4 class="tsd-returns-title">Returns <a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a></h4><p>the current seekable range when available or null otherwise.</p>
|
|
592
|
-
|
|
593
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
594
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getSeekableRange">getSeekableRange</a></p></aside></li></ul></section>
|
|
595
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getSource" class="tsd-anchor"></a>
|
|
596
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Source</span><a href="#getSource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
597
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
598
|
-
<li class="tsd-signature tsd-anchor-link" id="getSource.getSource-1"><span class="tsd-kind-call-signature">get<wbr/>Source</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a><a href="#getSource.getSource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
599
|
-
<li class="tsd-description">
|
|
600
|
-
<div class="tsd-comment tsd-typography"><p>Returns the source that was loaded via a successfully finished load call. Returns null if no source is loaded or a load is in progress.</p>
|
|
601
|
-
</div>
|
|
602
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a></h4><p>the loaded source or null if no source is loaded</p>
|
|
603
|
-
|
|
604
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
605
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getSource">getSource</a></p></aside></li></ul></section>
|
|
606
|
-
<section class="tsd-panel tsd-member"><a id="getSourceConfig" class="tsd-anchor"></a>
|
|
607
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Source<wbr/>Config</span><a href="#getSourceConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
608
|
-
<ul class="tsd-signatures">
|
|
609
|
-
<li class="tsd-signature tsd-anchor-link" id="getSourceConfig.getSourceConfig-1"><span class="tsd-kind-call-signature">get<wbr/>Source<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Object</span><a href="#getSourceConfig.getSourceConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
610
|
-
<li class="tsd-description">
|
|
611
|
-
<div class="tsd-comment tsd-typography"><p>Gets the current playback SourceConfig values</p>
|
|
612
|
-
</div>
|
|
613
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Object</span></h4><p>current SourceConfig values</p>
|
|
614
|
-
|
|
615
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
616
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getStreamType" class="tsd-anchor"></a>
|
|
617
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Stream<wbr/>Type</span><a href="#getStreamType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
618
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
619
|
-
<li class="tsd-signature tsd-anchor-link" id="getStreamType.getStreamType-1"><span class="tsd-kind-call-signature">get<wbr/>Stream<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/MKStreamType.html" class="tsd-signature-type tsd-kind-enum">MKStreamType</a><a href="#getStreamType.getStreamType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
620
|
-
<li class="tsd-description">
|
|
621
|
-
<div class="tsd-comment tsd-typography"><p>Returns the currently used streaming technology. See <a href="../enums/MKStreamType.html" class="tsd-kind-enum">MKStreamType</a> for details of the valid values.</p>
|
|
622
|
-
</div>
|
|
623
|
-
<h4 class="tsd-returns-title">Returns <a href="../enums/MKStreamType.html" class="tsd-signature-type tsd-kind-enum">MKStreamType</a></h4>
|
|
624
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
625
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getStreamType">getStreamType</a></p></aside></li></ul></section>
|
|
626
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getThumbnail" class="tsd-anchor"></a>
|
|
627
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Thumbnail</span><a href="#getThumbnail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
628
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
629
|
-
<li class="tsd-signature tsd-anchor-link" id="getThumbnail.getThumbnail-1"><span class="tsd-kind-call-signature">get<wbr/>Thumbnail</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKThumbnail.html" class="tsd-signature-type tsd-kind-interface">MKThumbnail</a><a href="#getThumbnail.getThumbnail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
630
|
-
<li class="tsd-description">
|
|
631
|
-
<div class="tsd-comment tsd-typography"><p>Returns a thumbnail image for a certain time or null if there is no thumbnail available.</p>
|
|
632
|
-
<p>Requires a configured thumbnails track in <a href="MKSourceConfig.html#thumbnailTrack" class="tsd-kind-property">thumbnailTrack</a> if sideloaded thumbnails are configured.</p>
|
|
633
|
-
<p>Requires <a href="MKPlayerConfig.html#enableHlsImageMediaPlaylistSupport" class="tsd-kind-property">enableHlsImageMediaPlaylistSupport</a> to be <code>true</code> if thumbnail images from the HLS manifest are needed.</p>
|
|
634
|
-
<p>When <a href="MKSourceConfig.html#thumbnailTrack" class="tsd-kind-property">thumbnailTrack</a> are configured, this will have preference over the thumbnails found in the HLS manifest.</p>
|
|
635
|
-
</div>
|
|
636
|
-
<div class="tsd-parameters">
|
|
637
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
638
|
-
<ul class="tsd-parameter-list">
|
|
639
|
-
<li>
|
|
640
|
-
<h5><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5>
|
|
641
|
-
<div class="tsd-comment tsd-typography"><p>the current relative playback time for which the thumbnail should be returned.</p>
|
|
642
|
-
</div>
|
|
643
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
644
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKThumbnail.html" class="tsd-signature-type tsd-kind-interface">MKThumbnail</a></h4><p>A thumbnail if a thumbnails track is configured and a thumbnail exists for the specified time, else null.</p>
|
|
645
|
-
|
|
646
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
647
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getThumbnail">getThumbnail</a></p></aside></li></ul></section>
|
|
648
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getTimeShift" class="tsd-anchor"></a>
|
|
649
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Time<wbr/>Shift</span><a href="#getTimeShift" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
650
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
651
|
-
<li class="tsd-signature tsd-anchor-link" id="getTimeShift.getTimeShift-1"><span class="tsd-kind-call-signature">get<wbr/>Time<wbr/>Shift</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getTimeShift.getTimeShift-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
652
|
-
<li class="tsd-description">
|
|
653
|
-
<div class="tsd-comment tsd-typography"><p>Returns the current time shift offset to the live edge in seconds.</p>
|
|
193
|
+
<p><a href="../enums/MKPlayerType.html#unknown" class="tsd-kind-enum-member">MKPlayerType.Unknown</a> is returned when player type cannot be determined or when the player is not yet ready.</p>
|
|
194
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../enums/MKPlayerType.html" class="tsd-signature-type tsd-kind-enum">MKPlayerType</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getPlayerType</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getseekablerange" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Seekable<wbr/>Range</span><a href="#getseekablerange" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getseekablerange-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSeekableRange</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mode</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/MKTimeMode.html" class="tsd-signature-type tsd-kind-enum">MKTimeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a><a href="#getseekablerange-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the time range that is currently valid for seeking.</p>
|
|
195
|
+
<p><strong>Note</strong> For VOD default mode is <a href="../enums/MKTimeMode.html#relativetime" class="tsd-kind-enum-member">MKTimeMode.RelativeTime</a> and for Live it is <a href="../enums/MKTimeMode.html#absolutetime" class="tsd-kind-enum-member">MKTimeMode.AbsoluteTime</a>.</p>
|
|
196
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mode</span>: <a href="../enums/MKTimeMode.html" class="tsd-signature-type tsd-kind-enum">MKTimeMode</a></span><div class="tsd-comment tsd-typography"><p>The mode to decide if the returned time should be absolute or relative, see <a href="../enums/MKTimeMode.html" class="tsd-kind-enum">MKTimeMode</a>.</p>
|
|
197
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a></h4><p>the current seekable range.</p>
|
|
198
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getSeekableRange</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getsource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Source</span><a href="#getsource" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getsource-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSource</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a><a href="#getsource-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the source that was loaded via a successfully finished load call. Returns null if no source is loaded or a load is in progress.</p>
|
|
199
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a></h4><p>the loaded source or null if no source is loaded</p>
|
|
200
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getSource</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getsourceconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Source<wbr/>Config</span><a href="#getsourceconfig" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getsourceconfig-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSourceConfig</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Object</span><a href="#getsourceconfig-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the current playback SourceConfig value passed to <a href="MKPlayerAPI.html#load" class="tsd-kind-method">load</a></p>
|
|
201
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Object</span></h4><p>current SourceConfig values or <code>null</code> otherwise</p>
|
|
202
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getstreamtype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Stream<wbr/>Type</span><a href="#getstreamtype" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getstreamtype-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getStreamType</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKStreamType.html" class="tsd-signature-type tsd-kind-enum">MKStreamType</a><a href="#getstreamtype-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the currently used streaming technology. See <a href="../enums/MKStreamType.html" class="tsd-kind-enum">MKStreamType</a> for details of the valid values.</p>
|
|
203
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../enums/MKStreamType.html" class="tsd-signature-type tsd-kind-enum">MKStreamType</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getStreamType</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getthumbnail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Thumbnail</span><a href="#getthumbnail" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getthumbnail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getThumbnail</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKThumbnail.html" class="tsd-signature-type tsd-kind-interface">MKThumbnail</a><a href="#getthumbnail-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a thumbnail image for a certain time or null if there is no thumbnail available.</p>
|
|
204
|
+
<p>Requires a configured thumbnails track in <a href="MKSourceConfig.html#thumbnailtrack" class="tsd-kind-property">MKSourceConfig.thumbnailTrack</a> if sideloaded thumbnails are configured.</p>
|
|
205
|
+
<p>Requires <a href="MKPlayerConfig.html#enablehlsimagemediaplaylistsupport" class="tsd-kind-property">MKPlayerConfig.enableHlsImageMediaPlaylistSupport</a> to be <code>true</code> if thumbnail images from the HLS manifest are needed.</p>
|
|
206
|
+
<p>When <a href="MKSourceConfig.html#thumbnailtrack" class="tsd-kind-property">MKSourceConfig.thumbnailTrack</a> are configured, this will have preference over the thumbnails found in the HLS manifest.</p>
|
|
207
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the current relative playback time for which the thumbnail should be returned.</p>
|
|
208
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="MKThumbnail.html" class="tsd-signature-type tsd-kind-interface">MKThumbnail</a></h4><p>A thumbnail if a thumbnails track is configured and a thumbnail exists for the specified time, else null.</p>
|
|
209
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getThumbnail</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="gettimelinemarkers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Timeline<wbr/>Markers</span><a href="#gettimelinemarkers" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="gettimelinemarkers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTimelineMarkers</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a><span class="tsd-signature-symbol">[]</span><a href="#gettimelinemarkers-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the list of all added markers in undefined order.</p>
|
|
210
|
+
<p><strong>Note:</strong> This API is only available when <a href="MKPlayerConfig.html#ui" class="tsd-kind-property">MKPlayerConfig.ui</a> is enabled.</p>
|
|
211
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getTimelineMarkers</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="gettimeshift" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Time<wbr/>Shift</span><a href="#gettimeshift" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="gettimeshift-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTimeShift</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#gettimeshift-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the current time shift offset to the live edge in seconds.</p>
|
|
654
212
|
<p>Is either negative or 0 and applicable to live streams only.</p>
|
|
655
213
|
<p>Offset <code>0</code> indicates the current live edge.</p>
|
|
656
|
-
</div>
|
|
657
|
-
|
|
658
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
659
|
-
<p>Inherited from <a href="
|
|
660
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="
|
|
661
|
-
<
|
|
662
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
663
|
-
<
|
|
664
|
-
<li class="tsd-description">
|
|
665
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
666
|
-
|
|
667
|
-
</div>
|
|
668
|
-
<
|
|
669
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
670
|
-
<p>Inherited from <a href="
|
|
671
|
-
|
|
672
|
-
<
|
|
673
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
674
|
-
<
|
|
675
|
-
<
|
|
676
|
-
|
|
677
|
-
</div>
|
|
678
|
-
|
|
679
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
680
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getTotalStalledTime">getTotalStalledTime</a></p></aside></li></ul></section>
|
|
681
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getVersion" class="tsd-anchor"></a>
|
|
682
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Version</span><a href="#getVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
683
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
684
|
-
<li class="tsd-signature tsd-anchor-link" id="getVersion.getVersion-1"><span class="tsd-kind-call-signature">get<wbr/>Version</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getVersion.getVersion-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
685
|
-
<li class="tsd-description">
|
|
686
|
-
<div class="tsd-comment tsd-typography"><p>Returns current MKPlayer SDK version.</p>
|
|
687
|
-
</div>
|
|
688
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
689
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
690
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getVersion">getVersion</a></p></aside></li></ul></section>
|
|
691
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getVideoContainer" class="tsd-anchor"></a>
|
|
692
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Video<wbr/>Container</span><a href="#getVideoContainer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
693
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
694
|
-
<li class="tsd-signature tsd-anchor-link" id="getVideoContainer.getVideoContainer-1"><span class="tsd-kind-call-signature">get<wbr/>Video<wbr/>Container</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">HTMLElement</span><a href="#getVideoContainer.getVideoContainer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
695
|
-
<li class="tsd-description">
|
|
696
|
-
<div class="tsd-comment tsd-typography"><p>Returns the html element that the player is embedded in, which has been provided in the player constructor.</p>
|
|
697
|
-
</div>
|
|
698
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">HTMLElement</span></h4>
|
|
699
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
700
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getVideoContainer">getVideoContainer</a></p></aside></li></ul></section>
|
|
701
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getVideoElement" class="tsd-anchor"></a>
|
|
702
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Video<wbr/>Element</span><a href="#getVideoElement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
703
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
704
|
-
<li class="tsd-signature tsd-anchor-link" id="getVideoElement.getVideoElement-1"><span class="tsd-kind-call-signature">get<wbr/>Video<wbr/>Element</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLVideoElement</span><a href="#getVideoElement.getVideoElement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
705
|
-
<li class="tsd-description">
|
|
706
|
-
<div class="tsd-comment tsd-typography"><p>Returns the used HTML5 video element.</p>
|
|
707
|
-
</div>
|
|
708
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLVideoElement</span></h4>
|
|
709
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
710
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getVideoElement">getVideoElement</a></p></aside></li></ul></section>
|
|
711
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getVideoQuality" class="tsd-anchor"></a>
|
|
712
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Video<wbr/>Quality</span><a href="#getVideoQuality" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
713
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
714
|
-
<li class="tsd-signature tsd-anchor-link" id="getVideoQuality.getVideoQuality-1"><span class="tsd-kind-call-signature">get<wbr/>Video<wbr/>Quality</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><a href="#getVideoQuality.getVideoQuality-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
715
|
-
<li class="tsd-description">
|
|
716
|
-
<div class="tsd-comment tsd-typography"><p>Returns the currently selected video quality, if the user manually selected one.</p>
|
|
717
|
-
<p>In this case it returns one of the elements of <a href="MKPlayerAPI.html#getAvailableVideoQualities" class="tsd-kind-method">getAvailableVideoQualities</a>.</p>
|
|
718
|
-
</div>
|
|
719
|
-
<h4 class="tsd-returns-title">Returns <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a></h4>
|
|
720
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
721
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getVideoQuality">getVideoQuality</a></p></aside></li></ul></section>
|
|
722
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getViewMode" class="tsd-anchor"></a>
|
|
723
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>View<wbr/>Mode</span><a href="#getViewMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
724
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
725
|
-
<li class="tsd-signature tsd-anchor-link" id="getViewMode.getViewMode-1"><span class="tsd-kind-call-signature">get<wbr/>View<wbr/>Mode</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a><a href="#getViewMode.getViewMode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
726
|
-
<li class="tsd-description">
|
|
727
|
-
<div class="tsd-comment tsd-typography"><p>Gets the active <a href="../enums/MKViewMode.html" class="tsd-kind-enum">MKViewMode</a>.</p>
|
|
728
|
-
</div>
|
|
729
|
-
<h4 class="tsd-returns-title">Returns <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a></h4>
|
|
730
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
731
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getViewMode">getViewMode</a></p></aside></li></ul></section>
|
|
732
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getVolume" class="tsd-anchor"></a>
|
|
733
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Volume</span><a href="#getVolume" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
734
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
735
|
-
<li class="tsd-signature tsd-anchor-link" id="getVolume.getVolume-1"><span class="tsd-kind-call-signature">get<wbr/>Volume</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getVolume.getVolume-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
736
|
-
<li class="tsd-description">
|
|
737
|
-
<div class="tsd-comment tsd-typography"><p>Returns the player’s volume between <code>0</code> (silent) and <code>100</code> (max volume).</p>
|
|
738
|
-
</div>
|
|
739
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
740
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
741
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#getVolume">getVolume</a></p></aside></li></ul></section>
|
|
742
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasEnded" class="tsd-anchor"></a>
|
|
743
|
-
<h3 class="tsd-anchor-link"><span>has<wbr/>Ended</span><a href="#hasEnded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
744
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
745
|
-
<li class="tsd-signature tsd-anchor-link" id="hasEnded.hasEnded-1"><span class="tsd-kind-call-signature">has<wbr/>Ended</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasEnded.hasEnded-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
746
|
-
<li class="tsd-description">
|
|
747
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if the video has ended.</p>
|
|
748
|
-
</div>
|
|
749
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
750
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
751
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#hasEnded">hasEnded</a></p></aside></li></ul></section>
|
|
752
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isAirplayActive" class="tsd-anchor"></a>
|
|
753
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Airplay<wbr/>Active</span><a href="#isAirplayActive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
754
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
755
|
-
<li class="tsd-signature tsd-anchor-link" id="isAirplayActive.isAirplayActive-1"><span class="tsd-kind-call-signature">is<wbr/>Airplay<wbr/>Active</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isAirplayActive.isAirplayActive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
756
|
-
<li class="tsd-description">
|
|
757
|
-
<div class="tsd-comment tsd-typography"><p>Checks if Apple Airplay is enabled.</p>
|
|
758
|
-
</div>
|
|
759
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
760
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
761
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isAirplayActive">isAirplayActive</a></p></aside></li></ul></section>
|
|
762
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isAirplayAvailable" class="tsd-anchor"></a>
|
|
763
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Airplay<wbr/>Available</span><a href="#isAirplayAvailable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
764
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
765
|
-
<li class="tsd-signature tsd-anchor-link" id="isAirplayAvailable.isAirplayAvailable-1"><span class="tsd-kind-call-signature">is<wbr/>Airplay<wbr/>Available</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isAirplayAvailable.isAirplayAvailable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
766
|
-
<li class="tsd-description">
|
|
767
|
-
<div class="tsd-comment tsd-typography"><p>Checks if Apple AirPlay support is available.</p>
|
|
768
|
-
</div>
|
|
769
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
770
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
771
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isAirplayAvailable">isAirplayAvailable</a></p></aside></li></ul></section>
|
|
772
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isCastAvailable" class="tsd-anchor"></a>
|
|
773
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Cast<wbr/>Available</span><a href="#isCastAvailable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
774
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
775
|
-
<li class="tsd-signature tsd-anchor-link" id="isCastAvailable.isCastAvailable-1"><span class="tsd-kind-call-signature">is<wbr/>Cast<wbr/>Available</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isCastAvailable.isCastAvailable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
776
|
-
<li class="tsd-description">
|
|
777
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if casting to another device (such as a ChromeCast) is available, otherwise false.</p>
|
|
778
|
-
<p>Please note that this function only returns true after the <a href="../enums/MKPlayerEvent.html#CastAvailable" class="tsd-kind-enum-member">CastAvailable</a> event has fired.</p>
|
|
779
|
-
</div>
|
|
780
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
781
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
782
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isCastAvailable">isCastAvailable</a></p></aside></li></ul></section>
|
|
783
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isCasting" class="tsd-anchor"></a>
|
|
784
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Casting</span><a href="#isCasting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
785
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
786
|
-
<li class="tsd-signature tsd-anchor-link" id="isCasting.isCasting-1"><span class="tsd-kind-call-signature">is<wbr/>Casting</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isCasting.isCasting-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
787
|
-
<li class="tsd-description">
|
|
788
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if the video is currently casted to a device and not played in the browser, or false if the video is played locally.</p>
|
|
789
|
-
</div>
|
|
790
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
791
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
792
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isCasting">isCasting</a></p></aside></li></ul></section>
|
|
793
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isLinearAdActive" class="tsd-anchor"></a>
|
|
794
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Linear<wbr/>Ad<wbr/>Active</span><a href="#isLinearAdActive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
795
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
796
|
-
<li class="tsd-signature tsd-anchor-link" id="isLinearAdActive.isLinearAdActive-1"><span class="tsd-kind-call-signature">is<wbr/>Linear<wbr/>Ad<wbr/>Active</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isLinearAdActive.isLinearAdActive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
797
|
-
<li class="tsd-description">
|
|
798
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if a linear ad is currently active (playing or paused). Returns false otherwise.
|
|
799
|
-
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">advertising</a> is provided in the PlayerConfig.</p>
|
|
800
|
-
</div>
|
|
801
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
802
|
-
<div class="tsd-comment tsd-typography">
|
|
803
|
-
<h4>Since</h4><p>v8.0</p>
|
|
804
|
-
</div><aside class="tsd-sources">
|
|
805
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isLinearAdActive">isLinearAdActive</a></p></aside></li></ul></section>
|
|
806
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isLive" class="tsd-anchor"></a>
|
|
807
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Live</span><a href="#isLive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
808
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
809
|
-
<li class="tsd-signature tsd-anchor-link" id="isLive.isLive-1"><span class="tsd-kind-call-signature">is<wbr/>Live</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isLive.isLive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
810
|
-
<li class="tsd-description">
|
|
811
|
-
<div class="tsd-comment tsd-typography"><p>Return true if the displayed video is a live stream.</p>
|
|
812
|
-
</div>
|
|
813
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
814
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
815
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isLive">isLive</a></p></aside></li></ul></section>
|
|
816
|
-
<section class="tsd-panel tsd-member"><a id="isLowLatencyPlayback" class="tsd-anchor"></a>
|
|
817
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Low<wbr/>Latency<wbr/>Playback</span><a href="#isLowLatencyPlayback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
818
|
-
<ul class="tsd-signatures">
|
|
819
|
-
<li class="tsd-signature tsd-anchor-link" id="isLowLatencyPlayback.isLowLatencyPlayback-1"><span class="tsd-kind-call-signature">is<wbr/>Low<wbr/>Latency<wbr/>Playback</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isLowLatencyPlayback.isLowLatencyPlayback-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
820
|
-
<li class="tsd-description">
|
|
821
|
-
<div class="tsd-comment tsd-typography"><p>Indicates whether the <code>live</code> playback is in low latency mode.
|
|
822
|
-
Low latency for <code>live</code> playback can be configured using [MKLiveConfigAtSourceLevel.lowLatency].</p>
|
|
823
|
-
</div>
|
|
824
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the live playback is in low latency mode, <code>false</code> otherwise.</p>
|
|
825
|
-
|
|
826
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
827
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isMuted" class="tsd-anchor"></a>
|
|
828
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Muted</span><a href="#isMuted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
829
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
830
|
-
<li class="tsd-signature tsd-anchor-link" id="isMuted.isMuted-1"><span class="tsd-kind-call-signature">is<wbr/>Muted</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isMuted.isMuted-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
831
|
-
<li class="tsd-description">
|
|
832
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if the player has been muted.</p>
|
|
833
|
-
</div>
|
|
834
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
835
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
836
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isMuted">isMuted</a></p></aside></li></ul></section>
|
|
837
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isPauseAdActive" class="tsd-anchor"></a>
|
|
838
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Pause<wbr/>Ad<wbr/>Active</span><a href="#isPauseAdActive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
839
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
840
|
-
<li class="tsd-signature tsd-anchor-link" id="isPauseAdActive.isPauseAdActive-1"><span class="tsd-kind-call-signature">is<wbr/>Pause<wbr/>Ad<wbr/>Active</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isPauseAdActive.isPauseAdActive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
841
|
-
<li class="tsd-description">
|
|
842
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if a pauseAd overlay is currently active; otherwise, returns false.
|
|
214
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getTimeShift</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="gettotalstalledtime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Total<wbr/>Stalled<wbr/>Time</span><a href="#gettotalstalledtime" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="gettotalstalledtime-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getTotalStalledTime</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#gettotalstalledtime-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the stalled time in seconds since playback started.</p>
|
|
215
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getTotalStalledTime</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Version</span><a href="#getversion" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getversion-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getVersion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getversion-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns current MKPlayer SDK version.</p>
|
|
216
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getVersion</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getvideocontainer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Video<wbr/>Container</span><a href="#getvideocontainer" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getvideocontainer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getVideoContainer</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLElement</span><a href="#getvideocontainer-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the html element that the player is embedded in, which has been provided in the player constructor.</p>
|
|
217
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLElement</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getVideoContainer</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getvideoelement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Video<wbr/>Element</span><a href="#getvideoelement" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getvideoelement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getVideoElement</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLVideoElement</span><a href="#getvideoelement-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the used HTML5 video element.</p>
|
|
218
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLVideoElement</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getVideoElement</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getvideoquality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Video<wbr/>Quality</span><a href="#getvideoquality" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getvideoquality-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getVideoQuality</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a><a href="#getvideoquality-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the currently selected video quality, if the user manually selected one.</p>
|
|
219
|
+
<p>In this case it returns one of the elements of <a href="MKPlayerAPI.html#getavailablevideoqualities" class="tsd-kind-method">getAvailableVideoQualities</a>.</p>
|
|
220
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getVideoQuality</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getviewmode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>View<wbr/>Mode</span><a href="#getviewmode" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getviewmode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getViewMode</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a><a href="#getviewmode-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the active <a href="../enums/MKViewMode.html" class="tsd-kind-enum">MKViewMode</a>.</p>
|
|
221
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getViewMode</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="getvolume" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Volume</span><a href="#getvolume" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="getvolume-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getVolume</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#getvolume-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the player’s volume between <code>0</code> (silent) and <code>100</code> (max volume).</p>
|
|
222
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.getVolume</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasended" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Ended</span><a href="#hasended" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="hasended-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hasEnded</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hasended-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if the video has ended.</p>
|
|
223
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.hasEnded</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isairplayactive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Airplay<wbr/>Active</span><a href="#isairplayactive" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="isairplayactive-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isAirplayActive</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isairplayactive-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if Apple Airplay is enabled.</p>
|
|
224
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isAirplayActive</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isairplayavailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Airplay<wbr/>Available</span><a href="#isairplayavailable" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="isairplayavailable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isAirplayAvailable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isairplayavailable-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Checks if Apple AirPlay support is available.</p>
|
|
225
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isAirplayAvailable</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="iscastavailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Cast<wbr/>Available</span><a href="#iscastavailable" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="iscastavailable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isCastAvailable</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#iscastavailable-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if casting to another device (such as a ChromeCast) is available, otherwise false.</p>
|
|
226
|
+
<p>Please note that this function only returns true after the <a href="../enums/MKPlayerEvent.html#castavailable" class="tsd-kind-enum-member">MKPlayerEvent.CastAvailable</a> event has fired.</p>
|
|
227
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isCastAvailable</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="iscasting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Casting</span><a href="#iscasting" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="iscasting-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isCasting</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#iscasting-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if the video is currently casted to a device and not played in the browser, or false if the video is played locally.</p>
|
|
228
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isCasting</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="islinearadactive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Linear<wbr/>Ad<wbr/>Active</span><a href="#islinearadactive" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="islinearadactive-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isLinearAdActive</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#islinearadactive-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if a linear ad is currently active (playing or paused). Returns false otherwise.
|
|
229
|
+
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">MKPlayerConfig.advertising</a> is provided in the PlayerConfig.</p>
|
|
230
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since-4" class="tsd-anchor"></a>Since<a href="#since-4" 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></h4><p>v1.18.0</p>
|
|
231
|
+
</div></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isLinearAdActive</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="islive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Live</span><a href="#islive" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="islive-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isLive</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#islive-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return true if the displayed video is a live stream.</p>
|
|
232
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isLive</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="islowlatencyplayback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Low<wbr/>Latency<wbr/>Playback</span><a href="#islowlatencyplayback" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="islowlatencyplayback-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isLowLatencyPlayback</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#islowlatencyplayback-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates whether the <code>live</code> playback is in low latency mode.
|
|
233
|
+
Low latency for <code>live</code> playback can be configured using <a href="MKLiveConfigAtSourceLevel.html#lowlatency" class="tsd-kind-property">MKLiveConfigAtSourceLevel.lowLatency</a>. For registered sources, it is decided by Mediakind AV Backend.</p>
|
|
234
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the live playback is in low latency mode, <code>false</code> otherwise.</p>
|
|
235
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="ismuted" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Muted</span><a href="#ismuted" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="ismuted-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isMuted</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ismuted-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if the player has been muted.</p>
|
|
236
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isMuted</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="ispauseadactive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Pause<wbr/>Ad<wbr/>Active</span><a href="#ispauseadactive" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="ispauseadactive-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isPauseAdActive</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ispauseadactive-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if a pauseAd overlay is currently active; otherwise, returns false.
|
|
843
237
|
Returns false when pauseAd feature is disabled.</p>
|
|
844
|
-
</div>
|
|
845
|
-
|
|
846
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
847
|
-
<p>Inherited from <a href="
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
851
|
-
|
|
852
|
-
<
|
|
853
|
-
<div class="tsd-comment tsd-typography"><
|
|
854
|
-
</div>
|
|
855
|
-
<
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
<h3 class="tsd-anchor-link"><span>is<
|
|
860
|
-
|
|
861
|
-
<li class="tsd-signature tsd-anchor-link" id="
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
</div>
|
|
865
|
-
|
|
866
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
867
|
-
|
|
868
|
-
<
|
|
869
|
-
<h3 class="tsd-anchor-link"><span>is<
|
|
870
|
-
|
|
871
|
-
<li class="tsd-signature tsd-anchor-link" id="
|
|
872
|
-
<
|
|
873
|
-
<div class="tsd-comment tsd-typography"><p>Returns true if the player is currently stalling due to an empty buffer.</p>
|
|
874
|
-
</div>
|
|
875
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
876
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
877
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isStalled">isStalled</a></p></aside></li></ul></section>
|
|
878
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isViewModeAvailable" class="tsd-anchor"></a>
|
|
879
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>View<wbr/>Mode<wbr/>Available</span><a href="#isViewModeAvailable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
880
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
881
|
-
<li class="tsd-signature tsd-anchor-link" id="isViewModeAvailable.isViewModeAvailable-1"><span class="tsd-kind-call-signature">is<wbr/>View<wbr/>Mode<wbr/>Available</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">viewMode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isViewModeAvailable.isViewModeAvailable-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
882
|
-
<li class="tsd-description">
|
|
883
|
-
<div class="tsd-comment tsd-typography"><p>Tests if a particular ViewMode is available for selection with setViewMode.</p>
|
|
884
|
-
</div>
|
|
885
|
-
<div class="tsd-parameters">
|
|
886
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
887
|
-
<ul class="tsd-parameter-list">
|
|
888
|
-
<li>
|
|
889
|
-
<h5><span class="tsd-kind-parameter">viewMode</span>: <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a></h5>
|
|
890
|
-
<div class="tsd-comment tsd-typography"><p>the view mode to test.</p>
|
|
891
|
-
</div>
|
|
892
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
893
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the tested view mode is available, else <code>false</code>.</p>
|
|
894
|
-
|
|
895
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
896
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#isViewModeAvailable">isViewModeAvailable</a></p></aside></li></ul></section>
|
|
897
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="listAd" class="tsd-anchor"></a>
|
|
898
|
-
<h3 class="tsd-anchor-link"><span>list<wbr/>Ad</span><a href="#listAd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
899
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
900
|
-
<li class="tsd-signature tsd-anchor-link" id="listAd.listAd-1"><span class="tsd-kind-call-signature">list<wbr/>Ad</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span><a href="#listAd.listAd-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
901
|
-
<li class="tsd-description">
|
|
902
|
-
<div class="tsd-comment tsd-typography"><p>Returns all scheduled ad breaks.
|
|
903
|
-
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">advertising</a> is provided in the PlayerConfig.</p>
|
|
904
|
-
</div>
|
|
905
|
-
<h4 class="tsd-returns-title">Returns <a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span></h4><p>Array containing all the scheduled ad breaks.</p>
|
|
906
|
-
|
|
907
|
-
<div class="tsd-comment tsd-typography">
|
|
908
|
-
<h4>Since</h4><p>v8.0</p>
|
|
909
|
-
</div><aside class="tsd-sources">
|
|
910
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#listAd">listAd</a></p></aside></li></ul></section>
|
|
911
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="load" class="tsd-anchor"></a>
|
|
912
|
-
<h3 class="tsd-anchor-link"><span>load</span><a href="#load" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
913
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
914
|
-
<li class="tsd-signature tsd-anchor-link" id="load.load-1"><span class="tsd-kind-call-signature">load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sourceConfig</span>, <span class="tsd-kind-parameter">disableSeeking</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#load.load-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
915
|
-
<li class="tsd-description">
|
|
916
|
-
<div class="tsd-comment tsd-typography"><p>Sets a new video source and returns a promise which resolves when the source has loaded successfully.</p>
|
|
917
|
-
</div>
|
|
918
|
-
<div class="tsd-parameters">
|
|
919
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
920
|
-
<ul class="tsd-parameter-list">
|
|
921
|
-
<li>
|
|
922
|
-
<h5><span class="tsd-kind-parameter">sourceConfig</span>: <a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a></h5>
|
|
923
|
-
<div class="tsd-comment tsd-typography"><p>the source configuration object.</p>
|
|
924
|
-
</div>
|
|
925
|
-
<div class="tsd-comment tsd-typography"></div></li>
|
|
926
|
-
<li>
|
|
927
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">disableSeeking</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
928
|
-
<div class="tsd-comment tsd-typography"><p>If set, seeking will be disabled.</p>
|
|
929
|
-
</div>
|
|
930
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
931
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise which resolves when the source is loaded and rejects when load fails.</p>
|
|
932
|
-
|
|
933
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
934
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#load">load</a></p></aside></li></ul></section>
|
|
935
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="mute" class="tsd-anchor"></a>
|
|
936
|
-
<h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
937
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
938
|
-
<li class="tsd-signature tsd-anchor-link" id="mute.mute-1"><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
939
|
-
<li class="tsd-description">
|
|
940
|
-
<div class="tsd-comment tsd-typography"><p>Mutes the player if an audio track is available. Has no effect if the player is already muted.</p>
|
|
941
|
-
</div>
|
|
942
|
-
<div class="tsd-parameters">
|
|
943
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
944
|
-
<ul class="tsd-parameter-list">
|
|
945
|
-
<li>
|
|
946
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
947
|
-
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
948
|
-
</div>
|
|
949
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
950
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
951
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
952
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#mute">mute</a></p></aside></li></ul></section>
|
|
953
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="off" class="tsd-anchor"></a>
|
|
954
|
-
<h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
955
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
956
|
-
<li class="tsd-signature tsd-anchor-link" id="off.off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
957
|
-
<li class="tsd-description">
|
|
958
|
-
<div class="tsd-comment tsd-typography"><p>Removes a handler for a player event.</p>
|
|
959
|
-
</div>
|
|
960
|
-
<section class="tsd-panel">
|
|
961
|
-
<h4>Type Parameters</h4>
|
|
962
|
-
<ul class="tsd-type-parameter-list">
|
|
963
|
-
<li>
|
|
964
|
-
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="MKPlayerEventBase.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventBase</a></h4></li></ul></section>
|
|
965
|
-
<div class="tsd-parameters">
|
|
966
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
967
|
-
<ul class="tsd-parameter-list">
|
|
968
|
-
<li>
|
|
969
|
-
<h5><span class="tsd-kind-parameter">eventType</span>: <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a></h5>
|
|
970
|
-
<div class="tsd-comment tsd-typography"><p>The event to remove the handler from.</p>
|
|
971
|
-
</div>
|
|
972
|
-
<div class="tsd-comment tsd-typography"></div></li>
|
|
973
|
-
<li>
|
|
974
|
-
<h5><span class="tsd-kind-parameter">callback</span>: <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h5>
|
|
975
|
-
<div class="tsd-comment tsd-typography"><p>The callback handler to remove.</p>
|
|
976
|
-
</div>
|
|
977
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
978
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
979
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
980
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#off">off</a></p></aside></li></ul></section>
|
|
981
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="offAll" class="tsd-anchor"></a>
|
|
982
|
-
<h3 class="tsd-anchor-link"><span>off<wbr/>All</span><a href="#offAll" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
983
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
984
|
-
<li class="tsd-signature tsd-anchor-link" id="offAll.offAll-1"><span class="tsd-kind-call-signature">off<wbr/>All</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#offAll.offAll-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
985
|
-
<li class="tsd-description">
|
|
986
|
-
<div class="tsd-comment tsd-typography"><p>Removes all event handlers registered for the given event type.</p>
|
|
987
|
-
</div>
|
|
988
|
-
<div class="tsd-parameters">
|
|
989
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
990
|
-
<ul class="tsd-parameter-list">
|
|
991
|
-
<li>
|
|
992
|
-
<h5><span class="tsd-kind-parameter">eventType</span>: <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a></h5>
|
|
993
|
-
<div class="tsd-comment tsd-typography"><p>The event for which all event handlers are to be removed.</p>
|
|
994
|
-
</div>
|
|
995
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
996
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
997
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
998
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#offAll">offAll</a></p></aside></li></ul></section>
|
|
999
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="on" class="tsd-anchor"></a>
|
|
1000
|
-
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1001
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1002
|
-
<li class="tsd-signature tsd-anchor-link" id="on.on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1003
|
-
<li class="tsd-description">
|
|
1004
|
-
<div class="tsd-comment tsd-typography"><p>Subscribes an event handler to a player event.</p>
|
|
1005
|
-
</div>
|
|
1006
|
-
<section class="tsd-panel">
|
|
1007
|
-
<h4>Type Parameters</h4>
|
|
1008
|
-
<ul class="tsd-type-parameter-list">
|
|
1009
|
-
<li>
|
|
1010
|
-
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><a href="MKPlayerEventBase.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventBase</a></h4></li></ul></section>
|
|
1011
|
-
<div class="tsd-parameters">
|
|
1012
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1013
|
-
<ul class="tsd-parameter-list">
|
|
1014
|
-
<li>
|
|
1015
|
-
<h5><span class="tsd-kind-parameter">eventType</span>: <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a></h5>
|
|
1016
|
-
<div class="tsd-comment tsd-typography"><p>The type of event to subscribe to.</p>
|
|
1017
|
-
</div>
|
|
1018
|
-
<div class="tsd-comment tsd-typography"></div></li>
|
|
1019
|
-
<li>
|
|
1020
|
-
<h5><span class="tsd-kind-parameter">callback</span>: <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h5>
|
|
1021
|
-
<div class="tsd-comment tsd-typography"><p>The event callback handler that will be called when the event fires.</p>
|
|
1022
|
-
</div>
|
|
1023
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1024
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1025
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1026
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#on">on</a></p></aside></li></ul></section>
|
|
1027
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="pause" class="tsd-anchor"></a>
|
|
1028
|
-
<h3 class="tsd-anchor-link"><span>pause</span><a href="#pause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1029
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1030
|
-
<li class="tsd-signature tsd-anchor-link" id="pause.pause-1"><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#pause.pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1031
|
-
<li class="tsd-description">
|
|
1032
|
-
<div class="tsd-comment tsd-typography"><p>Pauses the video if it is playing. Has no effect if the player is already paused.</p>
|
|
1033
|
-
</div>
|
|
1034
|
-
<div class="tsd-parameters">
|
|
1035
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1036
|
-
<ul class="tsd-parameter-list">
|
|
1037
|
-
<li>
|
|
1038
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1039
|
-
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
1040
|
-
</div>
|
|
1041
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1042
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1043
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1044
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#pause">pause</a></p></aside></li></ul></section>
|
|
1045
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="play" class="tsd-anchor"></a>
|
|
1046
|
-
<h3 class="tsd-anchor-link"><span>play</span><a href="#play" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1047
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1048
|
-
<li class="tsd-signature tsd-anchor-link" id="play.play-1"><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#play.play-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1049
|
-
<li class="tsd-description">
|
|
1050
|
-
<div class="tsd-comment tsd-typography"><p>Starts playback or resumes after being paused.</p>
|
|
1051
|
-
<p>No need to call it if the player is stup with <code>autoplay</code>.</p>
|
|
238
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isPauseAdActive</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="ispaused" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Paused</span><a href="#ispaused" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="ispaused-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isPaused</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#ispaused-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if the player has started playback but is currently paused.</p>
|
|
239
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isPaused</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isplaying" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Playing</span><a href="#isplaying" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="isplaying-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isPlaying</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isplaying-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if the player is currently playing, i.e. has started and is not paused.</p>
|
|
240
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isPlaying</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isstalled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Stalled</span><a href="#isstalled" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="isstalled-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isStalled</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isstalled-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if the player is currently stalling due to an empty buffer.</p>
|
|
241
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isStalled</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="isviewmodeavailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>View<wbr/>Mode<wbr/>Available</span><a href="#isviewmodeavailable" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="isviewmodeavailable-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isViewModeAvailable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">viewMode</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isviewmodeavailable-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Tests if a particular ViewMode is available for selection with setViewMode.</p>
|
|
242
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">viewMode</span>: <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a></span><div class="tsd-comment tsd-typography"><p>the view mode to test.</p>
|
|
243
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the tested view mode is available, else <code>false</code>.</p>
|
|
244
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.isViewModeAvailable</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="listad" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list<wbr/>Ad</span><a href="#listad" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="listad-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">listAd</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span><a href="#listad-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns all scheduled ad breaks. Does not include currently active ad breaks.
|
|
245
|
+
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">MKPlayerConfig.advertising</a> is provided in the PlayerConfig.</p>
|
|
246
|
+
</div><h4 class="tsd-returns-title">Returns <a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span></h4><p>Array containing all the scheduled ad breaks.</p>
|
|
247
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since-5" class="tsd-anchor"></a>Since<a href="#since-5" 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></h4><p>v1.18.0</p>
|
|
248
|
+
</div></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.listAd</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="load" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load</span><a href="#load" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="load-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">load</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sourceConfig</span><span class="tsd-signature-symbol">:</span> <a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">disableSeeking</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#load-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets a new video source and returns a promise which resolves when the source has loaded successfully.</p>
|
|
249
|
+
<p>Note: Promise doesn't reject. If source fails to load (ex: invalid sourceConfig or Mediakind AV Backend request fails), <a href="../enums/MKPlayerEvent.html#error" class="tsd-kind-enum-member">MKPlayerEvent.Error</a> event is fired and promise is resolved.</p>
|
|
250
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">sourceConfig</span>: <a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a></span><div class="tsd-comment tsd-typography"><p>the source the player should load.</p>
|
|
251
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">disableSeeking</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If set, seeking will be disabled.</p>
|
|
252
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise which resolves when the source is loaded and resolves when load fails as well.</p>
|
|
253
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.load</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="mute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="mute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#mute-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mutes the player if an audio track is available. Has no effect if the player is already muted.</p>
|
|
254
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
255
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.mute</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="off-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#offt">T</a> <span class="tsd-signature-keyword">extends</span> <a href="MKPlayerEventBase.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventBase</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#offt">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#off-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes a handler for a player event.</p>
|
|
256
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="offt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="MKPlayerEventBase.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventBase</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventType</span>: <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a></span><div class="tsd-comment tsd-typography"><p>The event to remove the handler from.</p>
|
|
257
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#offt">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The callback handler to remove.</p>
|
|
258
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.off</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="offall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off<wbr/>All</span><a href="#offall" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="offall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">offAll</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#offall-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes all event handlers registered for the given event type.</p>
|
|
259
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventType</span>: <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a></span><div class="tsd-comment tsd-typography"><p>The event for which all event handlers are to be removed.</p>
|
|
260
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.offAll</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="on-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#ont">T</a> <span class="tsd-signature-keyword">extends</span> <a href="MKPlayerEventBase.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventBase</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#ont">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#on-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribes an event handler to a player event.</p>
|
|
261
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="ont" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="MKPlayerEventBase.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventBase</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventType</span>: <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a></span><div class="tsd-comment tsd-typography"><p>The type of event to subscribe to.</p>
|
|
262
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MKPlayerAPI.html#ont">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The event callback handler that will be called when the event fires.</p>
|
|
263
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.on</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="pause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pause</span><a href="#pause" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="pause-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#pause-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Pauses the video if it is playing. Has no effect if the player is already paused.</p>
|
|
264
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
265
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.pause</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="play" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>play</span><a href="#play" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="play-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">play</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#play-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts playback or resumes after being paused.</p>
|
|
266
|
+
<p>No need to call it if the player is setup with <code>autoplay</code>.</p>
|
|
1052
267
|
<p>Calling play has no effect when player is already playing.</p>
|
|
1053
|
-
</div>
|
|
1054
|
-
|
|
1055
|
-
<
|
|
1056
|
-
<ul class="tsd-parameter-
|
|
1057
|
-
<
|
|
1058
|
-
<
|
|
1059
|
-
<
|
|
1060
|
-
</div>
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1065
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#play">play</a></p></aside></li></ul></section>
|
|
1066
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="preload" class="tsd-anchor"></a>
|
|
1067
|
-
<h3 class="tsd-anchor-link"><span>preload</span><a href="#preload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1068
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1069
|
-
<li class="tsd-signature tsd-anchor-link" id="preload.preload-1"><span class="tsd-kind-call-signature">preload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#preload.preload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1070
|
-
<li class="tsd-description">
|
|
1071
|
-
<div class="tsd-comment tsd-typography"><p>Starts preloading the content of the currently loaded source.</p>
|
|
1072
|
-
</div>
|
|
1073
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1074
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1075
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#preload">preload</a></p></aside></li></ul></section>
|
|
1076
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="reload" class="tsd-anchor"></a>
|
|
1077
|
-
<h3 class="tsd-anchor-link"><span>reload</span><a href="#reload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1078
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1079
|
-
<li class="tsd-signature tsd-anchor-link" id="reload.reload-1"><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">startTime</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">startOffset</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reload.reload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1080
|
-
<li class="tsd-description">
|
|
1081
|
-
<div class="tsd-comment tsd-typography"><p>Reloads the current live source from the given program start time.</p>
|
|
1082
|
-
<p>The manifest is reloaded with [startTime] as the new program start.
|
|
1083
|
-
If [startOffset] is provided, playback begins at that position.</p>
|
|
1084
|
-
<p>Listen for <code>onSourceLoaded</code> to be notified when the reload completes.</p>
|
|
1085
|
-
</div>
|
|
1086
|
-
<div class="tsd-parameters">
|
|
1087
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1088
|
-
<ul class="tsd-parameter-list">
|
|
1089
|
-
<li>
|
|
1090
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">startTime</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1091
|
-
<div class="tsd-comment tsd-typography"><p>Program start time in UTC format <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code>.</p>
|
|
1092
|
-
</div>
|
|
1093
|
-
<div class="tsd-comment tsd-typography"></div></li>
|
|
1094
|
-
<li>
|
|
1095
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">startOffset</span>: <span class="tsd-signature-type">number</span></h5>
|
|
1096
|
-
<div class="tsd-comment tsd-typography"><p>Absolute Unix timestamp (seconds) of the desired playback start position.
|
|
1097
|
-
Must be between [startTime] and the live edge. Defaults to <code>0</code> (starts at live edge).</p>
|
|
1098
|
-
</div>
|
|
1099
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1100
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
1101
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1102
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#reload">reload</a></p></aside></li></ul></section>
|
|
1103
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="removeTimelineMarker" class="tsd-anchor"></a>
|
|
1104
|
-
<h3 class="tsd-anchor-link"><span>remove<wbr/>Timeline<wbr/>Marker</span><a href="#removeTimelineMarker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1105
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1106
|
-
<li class="tsd-signature tsd-anchor-link" id="removeTimelineMarker.removeTimelineMarker-1"><span class="tsd-kind-call-signature">remove<wbr/>Timeline<wbr/>Marker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timelineMarker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#removeTimelineMarker.removeTimelineMarker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1107
|
-
<li class="tsd-description">
|
|
1108
|
-
<div class="tsd-comment tsd-typography"><p>Removes a marker from the timeline (by reference) and returns <code>true</code> if the marker has
|
|
268
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the issuer of the API call that will be passed to events triggered by this call.</p>
|
|
269
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>a promise which resolves as soon as playback starts. The promise can reject if the play is blocked by the browser.</p>
|
|
270
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.play</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="preload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>preload</span><a href="#preload" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="preload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">preload</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#preload-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts preloading the content of the currently loaded source.</p>
|
|
271
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.preload</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reload</span><a href="#reload" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="reload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">startTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">startOffset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reload-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reloads the current source.</p>
|
|
272
|
+
<p>For live sources, the manifest is reloaded with <code>startTime</code> as the new program start.
|
|
273
|
+
If <code>startOffset</code> is provided, playback begins at that position. If not provided, <code>startOffset</code> previously specified in <a href="MKSourceOptions.html#startoffset" class="tsd-kind-property">MKSourceOptions.startOffset</a> will be used. Otherwise, playback starts as per player's default behaviour.</p>
|
|
274
|
+
<p>Listen for <a href="../enums/MKPlayerEvent.html#sourceloaded" class="tsd-kind-enum-member">MKPlayerEvent.SourceLoaded</a> to be notified when the reload completes.</p>
|
|
275
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">startTime</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Program start time in UTC format <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code> (applicable only for live sources).</p>
|
|
276
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">startOffset</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>For live sources, absolute UNIX timestamp (seconds) of the desired playback start position, which must be between <code>program start time</code> and the live edge. Defaults to <code>0</code> (starts at live edge). For VoD, relative playback offset (seconds) from beginning of content. Defaults to <code>0</code> (starts from beginning).</p>
|
|
277
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>a promise which resolves as soon as source is reloaded. The promise can reject if no source is loaded or if <code>startTime</code> is passed for non-live source or is not valid date-time.</p>
|
|
278
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.reload</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="removetimelinemarker" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Timeline<wbr/>Marker</span><a href="#removetimelinemarker" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="removetimelinemarker-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">removeTimelineMarker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">timelineMarker</span><span class="tsd-signature-symbol">:</span> <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#removetimelinemarker-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes a marker from the timeline (by reference) and returns <code>true</code> if the marker has
|
|
1109
279
|
been part of the timeline and successfully removed, or <code>false</code> if the marker could not
|
|
1110
280
|
be found and thus not removed.</p>
|
|
1111
|
-
<p><strong>Note:</strong> This API is only available when <a href="MKPlayerConfig.html#ui" class="tsd-kind-property">ui</a> is enabled.</p>
|
|
1112
|
-
</div>
|
|
1113
|
-
|
|
1114
|
-
<
|
|
1115
|
-
<
|
|
1116
|
-
|
|
1117
|
-
<
|
|
1118
|
-
<div class="tsd-comment tsd-typography"><
|
|
1119
|
-
</div>
|
|
1120
|
-
<
|
|
1121
|
-
<
|
|
1122
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1123
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#removeTimelineMarker">removeTimelineMarker</a></p></aside></li></ul></section>
|
|
1124
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="scheduleAd" class="tsd-anchor"></a>
|
|
1125
|
-
<h3 class="tsd-anchor-link"><span>schedule<wbr/>Ad</span><a href="#scheduleAd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1126
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1127
|
-
<li class="tsd-signature tsd-anchor-link" id="scheduleAd.scheduleAd-1"><span class="tsd-kind-call-signature">schedule<wbr/>Ad</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">AdBreakConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#scheduleAd.scheduleAd-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1128
|
-
<li class="tsd-description">
|
|
1129
|
-
<div class="tsd-comment tsd-typography"><p>Schedules resulting ad break(s) of an ad config for playback.
|
|
1130
|
-
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">advertising</a> is provided in the PlayerConfig.</p>
|
|
1131
|
-
</div>
|
|
1132
|
-
<div class="tsd-parameters">
|
|
1133
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1134
|
-
<ul class="tsd-parameter-list">
|
|
1135
|
-
<li>
|
|
1136
|
-
<h5><span class="tsd-kind-parameter">AdBreakConfig</span>: <a href="MKAdBreakConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdBreakConfig</a></h5></li></ul></div>
|
|
1137
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>Promise that resolves with the ad breaks that were scheduled as a result of the given ad config.</p>
|
|
1138
|
-
|
|
1139
|
-
<div class="tsd-comment tsd-typography">
|
|
1140
|
-
<h4>Since</h4><p>v8.0</p>
|
|
1141
|
-
</div><aside class="tsd-sources">
|
|
1142
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#scheduleAd">scheduleAd</a></p></aside></li></ul></section>
|
|
1143
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="seek" class="tsd-anchor"></a>
|
|
1144
|
-
<h3 class="tsd-anchor-link"><span>seek</span><a href="#seek" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1145
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1146
|
-
<li class="tsd-signature tsd-anchor-link" id="seek.seek-1"><span class="tsd-kind-call-signature">seek</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span>, <span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#seek.seek-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1147
|
-
<li class="tsd-description">
|
|
1148
|
-
<div class="tsd-comment tsd-typography"><p>Seeks to the given playback time specified by the parameter time in seconds.</p>
|
|
1149
|
-
<p>The time offset specified must always be a positive value and within the current <a href="MKPlayerAPI.html#getSeekableRange" class="tsd-kind-method">getSeekableRange</a>.</p>
|
|
281
|
+
<p><strong>Note:</strong> This API is only available when <a href="MKPlayerConfig.html#ui" class="tsd-kind-property">MKPlayerConfig.ui</a> is enabled.</p>
|
|
282
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">timelineMarker</span>: <a href="MKTimelineMarker.html" class="tsd-signature-type tsd-kind-interface">MKTimelineMarker</a></span><div class="tsd-comment tsd-typography"><p>the timeline marker to be removed.</p>
|
|
283
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if marker was found and removed or <code>false</code> otherwise.</p>
|
|
284
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.removeTimelineMarker</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="schedulead" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>schedule<wbr/>Ad</span><a href="#schedulead" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="schedulead-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">scheduleAd</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">adConfig</span><span class="tsd-signature-symbol">:</span> <a href="MKAdConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdConfig</a> <span class="tsd-signature-symbol">|</span> <a href="MKAdBreakConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdBreakConfig</a> <span class="tsd-signature-symbol">|</span> <a href="MKAdTagConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdTagConfig</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#schedulead-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Schedules resulting ad break(s) of an ad config for playback.
|
|
285
|
+
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">MKPlayerConfig.advertising</a> is provided in the PlayerConfig.</p>
|
|
286
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">adConfig</span>: <a href="MKAdConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdConfig</a> <span class="tsd-signature-symbol">|</span> <a href="MKAdBreakConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdBreakConfig</a> <span class="tsd-signature-symbol">|</span> <a href="MKAdTagConfig.html" class="tsd-signature-type tsd-kind-interface">MKAdTagConfig</a></span><div class="tsd-comment tsd-typography"><p>The ad configuration used to schedule one or more ad breaks.</p>
|
|
287
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="MKAdBreak.html" class="tsd-signature-type tsd-kind-interface">MKAdBreak</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>Promise that resolves with the ad breaks that were scheduled as a result of the given ad config.</p>
|
|
288
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since-6" class="tsd-anchor"></a>Since<a href="#since-6" 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></h4><p>v1.18.0</p>
|
|
289
|
+
</div></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.scheduleAd</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="seek" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>seek</span><a href="#seek" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="seek-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">seek</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#seek-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Seeks to the given playback time specified by the parameter time in seconds.</p>
|
|
290
|
+
<p>The time offset specified must always be a positive value and within the current <a href="MKPlayerAPI.html#getseekablerange" class="tsd-kind-method">MKPlayerAPI.getSeekableRange</a>.</p>
|
|
291
|
+
<p>For VoD, if MKPlayerConfig.excludePrerollFromVodDuration is enabled, then duration of any preroll ads is added for seeks once preroll ad has completed playing.</p>
|
|
1150
292
|
<p>For Live and Events the specified time either be relative or absolute offset.</p>
|
|
1151
293
|
<ul>
|
|
1152
294
|
<li>Calling <code>seek(0)</code> will take you to the start of the live window</li>
|
|
1153
|
-
<li>Calling <code>seek(getSeekableRange().end)</code> will take you near the current live edge. You can also call <a href="MKPlayerAPI.html#
|
|
295
|
+
<li>Calling <code>seek(getSeekableRange().end)</code> will take you near the current live edge. You can also call <a href="MKPlayerAPI.html#seektoliveedge" class="tsd-kind-method">MKPlayerAPI.seekToLiveEdge</a> to jump to current live edge easily.</li>
|
|
1154
296
|
</ul>
|
|
1155
|
-
</div>
|
|
1156
|
-
<div class="tsd-
|
|
1157
|
-
|
|
1158
|
-
<ul class="tsd-parameter-
|
|
1159
|
-
<li>
|
|
1160
|
-
<h5><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5>
|
|
1161
|
-
<div class="tsd-comment tsd-typography"><p>The time to seek to in seconds.</p>
|
|
1162
|
-
</div>
|
|
1163
|
-
<div class="tsd-comment tsd-typography"></div></li>
|
|
1164
|
-
<li>
|
|
1165
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1166
|
-
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
1167
|
-
</div>
|
|
1168
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1169
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> when successful.</p>
|
|
1170
|
-
|
|
1171
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1172
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#seek">seek</a></p></aside></li></ul></section>
|
|
1173
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="seekToLiveEdge" class="tsd-anchor"></a>
|
|
1174
|
-
<h3 class="tsd-anchor-link"><span>seek<wbr/>To<wbr/>Live<wbr/>Edge</span><a href="#seekToLiveEdge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1175
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1176
|
-
<li class="tsd-signature tsd-anchor-link" id="seekToLiveEdge.seekToLiveEdge-1"><span class="tsd-kind-call-signature">seek<wbr/>To<wbr/>Live<wbr/>Edge</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#seekToLiveEdge.seekToLiveEdge-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1177
|
-
<li class="tsd-description">
|
|
1178
|
-
<div class="tsd-comment tsd-typography"><p>Seeks to the current live edge.</p>
|
|
297
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The time to seek to in seconds.</p>
|
|
298
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
299
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> when successful. For Live and Events this is always <code>true</code>.</p>
|
|
300
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.seek</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="seektoliveedge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>seek<wbr/>To<wbr/>Live<wbr/>Edge</span><a href="#seektoliveedge" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="seektoliveedge-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">seekToLiveEdge</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#seektoliveedge-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Seeks to the current live edge.</p>
|
|
1179
301
|
<p>Applicable only for live sources.</p>
|
|
1180
|
-
</div>
|
|
1181
|
-
<div class="tsd-
|
|
1182
|
-
<
|
|
1183
|
-
|
|
1184
|
-
<li>
|
|
1185
|
-
|
|
1186
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
1187
|
-
</
|
|
1188
|
-
<div class="tsd-comment tsd-typography"
|
|
1189
|
-
|
|
1190
|
-
<
|
|
1191
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#seekToLiveEdge">seekToLiveEdge</a></p></aside></li></ul></section>
|
|
1192
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setAnalyticsCustomData" class="tsd-anchor"></a>
|
|
1193
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Analytics<wbr/>Custom<wbr/>Data</span><a href="#setAnalyticsCustomData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1194
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1195
|
-
<li class="tsd-signature tsd-anchor-link" id="setAnalyticsCustomData.setAnalyticsCustomData-1"><span class="tsd-kind-call-signature">set<wbr/>Analytics<wbr/>Custom<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAnalyticsCustomData.setAnalyticsCustomData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1196
|
-
<li class="tsd-description">
|
|
1197
|
-
<div class="tsd-comment tsd-typography"><p>Set the customData that needs to be sent to the Bitmovin dashboard during runtime.</p>
|
|
1198
|
-
</div>
|
|
1199
|
-
<div class="tsd-parameters">
|
|
1200
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1201
|
-
<ul class="tsd-parameter-list">
|
|
1202
|
-
<li>
|
|
1203
|
-
<h5><span class="tsd-kind-parameter">customData</span>: <a href="MKAnalyticsConfig.html" class="tsd-signature-type tsd-kind-interface">MKAnalyticsConfig</a></h5>
|
|
1204
|
-
<div class="tsd-comment tsd-typography"><p>The customData parameter should be of type <a href="MKAnalyticsConfig.html" class="tsd-kind-interface">MKAnalyticsConfig</a></p>
|
|
1205
|
-
</div>
|
|
1206
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1207
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1208
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1209
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setAnalyticsCustomData">setAnalyticsCustomData</a></p></aside></li></ul></section>
|
|
1210
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setAspectRatio" class="tsd-anchor"></a>
|
|
1211
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Aspect<wbr/>Ratio</span><a href="#setAspectRatio" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1212
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1213
|
-
<li class="tsd-signature tsd-anchor-link" id="setAspectRatio.setAspectRatio-1"><span class="tsd-kind-call-signature">set<wbr/>Aspect<wbr/>Ratio</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aspectratio</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAspectRatio.setAspectRatio-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1214
|
-
<li class="tsd-description">
|
|
1215
|
-
<div class="tsd-comment tsd-typography"><p>Modifies the current aspect ratio of the player.</p>
|
|
1216
|
-
</div>
|
|
1217
|
-
<div class="tsd-parameters">
|
|
1218
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1219
|
-
<ul class="tsd-parameter-list">
|
|
1220
|
-
<li>
|
|
1221
|
-
<h5><span class="tsd-kind-parameter">aspectratio</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
|
1222
|
-
<div class="tsd-comment tsd-typography"><p>The desired aspect ratio for the player. It can be a string (e.g. '16:9' or '16/9'), or a number (e.g 1.6 for 16:10).</p>
|
|
1223
|
-
</div>
|
|
1224
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1225
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1226
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1227
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setAspectRatio">setAspectRatio</a></p></aside></li></ul></section>
|
|
1228
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setAudio" class="tsd-anchor"></a>
|
|
1229
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Audio</span><a href="#setAudio" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1230
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1231
|
-
<li class="tsd-signature tsd-anchor-link" id="setAudio.setAudio-1"><span class="tsd-kind-call-signature">set<wbr/>Audio</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trackID</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAudio.setAudio-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1232
|
-
<li class="tsd-description">
|
|
1233
|
-
<div class="tsd-comment tsd-typography"><p>Sets the audio track to the ID specified by trackID.</p>
|
|
1234
|
-
<p>Available tracks can be retrieved with <a href="MKPlayerAPI.html#getAvailableAudio" class="tsd-kind-method">getAvailableAudio</a>.</p>
|
|
1235
|
-
</div>
|
|
1236
|
-
<div class="tsd-parameters">
|
|
1237
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1238
|
-
<ul class="tsd-parameter-list">
|
|
1239
|
-
<li>
|
|
1240
|
-
<h5><span class="tsd-kind-parameter">trackID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1241
|
-
<div class="tsd-comment tsd-typography"><p>The ID of the audio track to activate.</p>
|
|
1242
|
-
</div>
|
|
1243
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1244
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1245
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1246
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setAudio">setAudio</a></p></aside></li></ul></section>
|
|
1247
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setAudioQuality" class="tsd-anchor"></a>
|
|
1248
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Audio<wbr/>Quality</span><a href="#setAudioQuality" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1249
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1250
|
-
<li class="tsd-signature tsd-anchor-link" id="setAudioQuality.setAudioQuality-1"><span class="tsd-kind-call-signature">set<wbr/>Audio<wbr/>Quality</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">audioQualityID</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAudioQuality.setAudioQuality-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1251
|
-
<li class="tsd-description">
|
|
1252
|
-
<div class="tsd-comment tsd-typography"><p>Manually sets the audio stream to a fixed quality, identified by ID.</p>
|
|
1253
|
-
<p>Has to be an ID defined in the MPD or the keyword 'auto'.</p>
|
|
302
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
303
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.seekToLiveEdge</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setanalyticscustomdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Analytics<wbr/>Custom<wbr/>Data</span><a href="#setanalyticscustomdata" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setanalyticscustomdata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setAnalyticsCustomData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">:</span> <a href="MKAnalyticsConfig.html" class="tsd-signature-type tsd-kind-interface">MKAnalyticsConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setanalyticscustomdata-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the customData that needs to be sent to the Bitmovin dashboard during runtime.</p>
|
|
304
|
+
<p><strong>Note:</strong> This API is not available when <code>analytics</code> is disabled.</p>
|
|
305
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">customData</span>: <a href="MKAnalyticsConfig.html" class="tsd-signature-type tsd-kind-interface">MKAnalyticsConfig</a></span><div class="tsd-comment tsd-typography"><p>The customData parameter should be of type <a href="MKAnalyticsConfig.html" class="tsd-kind-interface">MKAnalyticsConfig</a></p>
|
|
306
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setAnalyticsCustomData</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setaspectratio" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Aspect<wbr/>Ratio</span><a href="#setaspectratio" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setaspectratio-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setAspectRatio</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aspectratio</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setaspectratio-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Modifies the current aspect ratio of the player.</p>
|
|
307
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">aspectratio</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The desired aspect ratio for the player. It can be a string (e.g. '16:9' or '16/9'), or a number (e.g 1.6 for 16:10).</p>
|
|
308
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setAspectRatio</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setaudio" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Audio</span><a href="#setaudio" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setaudio-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setAudio</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">trackID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setaudio-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the audio track to the ID specified by trackID.</p>
|
|
309
|
+
<p>Available tracks can be retrieved with <a href="MKPlayerAPI.html#getavailableaudio" class="tsd-kind-method">getAvailableAudio</a>.</p>
|
|
310
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">trackID</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the audio track to activate.</p>
|
|
311
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setAudio</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setaudioquality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Audio<wbr/>Quality</span><a href="#setaudioquality" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setaudioquality-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setAudioQuality</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">audioQualityID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setaudioquality-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Manually sets the audio stream to a fixed quality, identified by ID.</p>
|
|
312
|
+
<p>Has to be an ID defined in the MPD or the keyword 'auto'.</p>
|
|
1254
313
|
<p>Auto resets to dynamic switching.</p>
|
|
1255
|
-
<p>A list with valid IDs can be retrieved by calling <a href="MKPlayerAPI.html#
|
|
1256
|
-
</div>
|
|
1257
|
-
<div class="tsd-
|
|
1258
|
-
|
|
1259
|
-
<ul class="tsd-parameter-
|
|
1260
|
-
<li>
|
|
1261
|
-
<h5><span class="tsd-kind-parameter">audioQualityID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1262
|
-
<div class="tsd-comment tsd-typography"><p>The ID of the desired audio quality or 'auto' for dynamic switching.</p>
|
|
1263
|
-
</div>
|
|
1264
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1265
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1266
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1267
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setAudioQuality">setAudioQuality</a></p></aside></li></ul></section>
|
|
1268
|
-
<section class="tsd-panel tsd-member"><a id="setCloudIdConfig" class="tsd-anchor"></a>
|
|
1269
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Cloud<wbr/>Id<wbr/>Config</span><a href="#setCloudIdConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1270
|
-
<ul class="tsd-signatures">
|
|
1271
|
-
<li class="tsd-signature tsd-anchor-link" id="setCloudIdConfig.setCloudIdConfig-1"><span class="tsd-kind-call-signature">set<wbr/>Cloud<wbr/>Id<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cloudIdInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setCloudIdConfig.setCloudIdConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1272
|
-
<li class="tsd-description">
|
|
1273
|
-
<div class="tsd-comment tsd-typography"><p>Sets the base64-encoded CloudId configuration to be included as <code>cloudIdInfo</code> in the roll request payload.</p>
|
|
1274
|
-
</div>
|
|
1275
|
-
<div class="tsd-parameters">
|
|
1276
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1277
|
-
<ul class="tsd-parameter-list">
|
|
1278
|
-
<li>
|
|
1279
|
-
<h5><span class="tsd-kind-parameter">cloudIdInfo</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
|
1280
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1281
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1282
|
-
<section class="tsd-panel tsd-member"><a id="setGeoComplyLocationProvider" class="tsd-anchor"></a>
|
|
1283
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Geo<wbr/>Comply<wbr/>Location<wbr/>Provider</span><a href="#setGeoComplyLocationProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1284
|
-
<ul class="tsd-signatures">
|
|
1285
|
-
<li class="tsd-signature tsd-anchor-link" id="setGeoComplyLocationProvider.setGeoComplyLocationProvider-1"><span class="tsd-kind-call-signature">set<wbr/>Geo<wbr/>Comply<wbr/>Location<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">provider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setGeoComplyLocationProvider.setGeoComplyLocationProvider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1286
|
-
<li class="tsd-description">
|
|
1287
|
-
<div class="tsd-comment tsd-typography"><p>Registers a callback for attaching a GeoComply-style signed location JWT to the
|
|
314
|
+
<p>A list with valid IDs can be retrieved by calling <a href="MKPlayerAPI.html#getavailableaudioqualities" class="tsd-kind-method">getAvailableAudioQualities</a>.</p>
|
|
315
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">audioQualityID</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the desired audio quality or 'auto' for dynamic switching.</p>
|
|
316
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setAudioQuality</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setcloudidconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Cloud<wbr/>Id<wbr/>Config</span><a href="#setcloudidconfig" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setcloudidconfig-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setCloudIdConfig</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cloudIdInfo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setcloudidconfig-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the base64-encoded CloudId configuration to be included as <code>cloudIdInfo</code> in the roll request payload.</p>
|
|
317
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">cloudIdInfo</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the base64-encoded CloudId configuration or <code>null</code> to remove.</p>
|
|
318
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setgeocomplylocationprovider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Geo<wbr/>Comply<wbr/>Location<wbr/>Provider</span><a href="#setgeocomplylocationprovider" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setgeocomplylocationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setGeoComplyLocationProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">provider</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setgeocomplylocationprovider-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Registers a callback for attaching a GeoComply-style signed location JWT to the
|
|
1288
319
|
Azuki roll request.</p>
|
|
1289
320
|
<p>Note: this is applicable only for registered source streams. The callback is called
|
|
1290
321
|
synchronously, on demand, immediately before each roll request is built. If it
|
|
1291
322
|
returns <code>undefined</code>, the roll simply goes out without a location header.</p>
|
|
1292
323
|
<p>A registered (non-null) provider is itself the enable signal; there is no separate
|
|
1293
324
|
flag to enable/disable this feature.</p>
|
|
1294
|
-
</div>
|
|
1295
|
-
<div class="tsd-parameters">
|
|
1296
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1297
|
-
<ul class="tsd-parameter-list">
|
|
1298
|
-
<li>
|
|
1299
|
-
<h5><span class="tsd-kind-parameter">provider</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></h5>
|
|
1300
|
-
<div class="tsd-comment tsd-typography"><p>function returning the current location JWT, or <code>undefined</code> if none
|
|
325
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">provider</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>function returning the current location JWT, or <code>undefined</code> if none
|
|
1301
326
|
is available yet; pass <code>null</code> to unregister.</p>
|
|
1302
|
-
</div>
|
|
1303
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1304
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1305
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1306
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setHttpHeaders" class="tsd-anchor"></a>
|
|
1307
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Http<wbr/>Headers</span><a href="#setHttpHeaders" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1308
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1309
|
-
<li class="tsd-signature tsd-anchor-link" id="setHttpHeaders.setHttpHeaders-1"><span class="tsd-kind-call-signature">set<wbr/>Http<wbr/>Headers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">headers</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setHttpHeaders.setHttpHeaders-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1310
|
-
<li class="tsd-description">
|
|
1311
|
-
<div class="tsd-comment tsd-typography"><p>Set HTTP headers.</p>
|
|
327
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sethttpheaders" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Http<wbr/>Headers</span><a href="#sethttpheaders" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="sethttpheaders-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setHttpHeaders</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/MKHeaders.html" class="tsd-signature-type tsd-kind-type-alias">MKHeaders</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#sethttpheaders-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set HTTP headers.</p>
|
|
1312
328
|
<p>Use this to pass your HTTP headers for all player/playback manifest requests.</p>
|
|
1313
329
|
<p><strong>Note:</strong> It is recommended to call this method before calling <a href="MKPlayerAPI.html#load" class="tsd-kind-method">load</a>.</p>
|
|
1314
|
-
</div>
|
|
1315
|
-
<div class="tsd-
|
|
1316
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1317
|
-
<ul class="tsd-parameter-list">
|
|
1318
|
-
<li>
|
|
1319
|
-
<h5><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../types/MKHeaders.html" class="tsd-signature-type tsd-kind-type-alias">MKHeaders</a></h5>
|
|
1320
|
-
<div class="tsd-comment tsd-typography"><p>HTTP headers to be used with requests and when <code>null</code> is passed the set headers will be cleared.</p>
|
|
1321
|
-
</div>
|
|
1322
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1323
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1324
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1325
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setHttpHeaders">setHttpHeaders</a></p></aside></li></ul></section>
|
|
1326
|
-
<section class="tsd-panel tsd-member"><a id="setInhomeStatus" class="tsd-anchor"></a>
|
|
1327
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Inhome<wbr/>Status</span><a href="#setInhomeStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1328
|
-
<ul class="tsd-signatures">
|
|
1329
|
-
<li class="tsd-signature tsd-anchor-link" id="setInhomeStatus.setInhomeStatus-1"><span class="tsd-kind-call-signature">set<wbr/>Inhome<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inhomeStatus</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setInhomeStatus.setInhomeStatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1330
|
-
<li class="tsd-description">
|
|
1331
|
-
<div class="tsd-comment tsd-typography"><p>Set inhome status.</p>
|
|
330
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">headers</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/MKHeaders.html" class="tsd-signature-type tsd-kind-type-alias">MKHeaders</a></span><div class="tsd-comment tsd-typography"><p>HTTP headers to be used with requests (merged with previously set headers) and when <code>null</code> is passed the set headers will be cleared.</p>
|
|
331
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setHttpHeaders</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setinhomestatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Inhome<wbr/>Status</span><a href="#setinhomestatus" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setinhomestatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setInhomeStatus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inhomeStatus</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setinhomestatus-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set inhome status.</p>
|
|
1332
332
|
<p>Note: this is applicable only for registered source streams.</p>
|
|
1333
|
-
<p>This setting will only be applied when the next playback session starts. So it is expected to call this before calling <a href="MKPlayerAPI.html#load" class="tsd-kind-method">load</a
|
|
1334
|
-
</div>
|
|
1335
|
-
<div class="tsd-
|
|
1336
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1337
|
-
<ul class="tsd-parameter-list">
|
|
1338
|
-
<li>
|
|
1339
|
-
<h5><span class="tsd-kind-parameter">inhomeStatus</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
1340
|
-
<div class="tsd-comment tsd-typography"><p>the new inhome status value.</p>
|
|
1341
|
-
</div>
|
|
1342
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1343
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1344
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1345
|
-
<section class="tsd-panel tsd-member"><a id="setLocationDetail" class="tsd-anchor"></a>
|
|
1346
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Location<wbr/>Detail</span><a href="#setLocationDetail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1347
|
-
<ul class="tsd-signatures">
|
|
1348
|
-
<li class="tsd-signature tsd-anchor-link" id="setLocationDetail.setLocationDetail-1"><span class="tsd-kind-call-signature">set<wbr/>Location<wbr/>Detail</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">locationDetail</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setLocationDetail.setLocationDetail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1349
|
-
<li class="tsd-description">
|
|
1350
|
-
<div class="tsd-comment tsd-typography"><p>Set/Remove location detail information.</p>
|
|
333
|
+
<p>This setting will only be applied when the next playback session starts. So it is expected to call this before calling <a href="MKPlayerAPI.html#load" class="tsd-kind-method">load</a> so that this value is sent to Mediakind AV Backend.</p>
|
|
334
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">inhomeStatus</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>the new inhome status value.</p>
|
|
335
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setlocationdetail" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Location<wbr/>Detail</span><a href="#setlocationdetail" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setlocationdetail-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setLocationDetail</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">locationDetail</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setlocationdetail-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set/Remove location detail information.</p>
|
|
1351
336
|
<p>Note: this is applicable only for registered source streams.</p>
|
|
1352
337
|
<p>This setting will only be applied when the next playback session starts. So it is expected to call this before calling <a href="MKPlayerAPI.html#load" class="tsd-kind-method">load</a>.</p>
|
|
1353
338
|
<p>Also if needed to remove the old location detail, pass null or empty string.</p>
|
|
1354
|
-
</div>
|
|
1355
|
-
<div class="tsd-
|
|
1356
|
-
|
|
1357
|
-
<ul class="tsd-parameter-
|
|
1358
|
-
<li>
|
|
1359
|
-
<h5><span class="tsd-kind-parameter">locationDetail</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
1360
|
-
<div class="tsd-comment tsd-typography"><p>the new location details as base64 encoded string or null / '' to remove old one.</p>
|
|
1361
|
-
</div>
|
|
1362
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1363
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1364
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1365
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setLogLevel" class="tsd-anchor"></a>
|
|
1366
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Log<wbr/>Level</span><a href="#setLogLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1367
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1368
|
-
<li class="tsd-signature tsd-anchor-link" id="setLogLevel.setLogLevel-1"><span class="tsd-kind-call-signature">set<wbr/>Log<wbr/>Level</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setLogLevel.setLogLevel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1369
|
-
<li class="tsd-description">
|
|
1370
|
-
<div class="tsd-comment tsd-typography"><p>Sets the level of player log outputs.</p>
|
|
1371
|
-
</div>
|
|
1372
|
-
<div class="tsd-parameters">
|
|
1373
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1374
|
-
<ul class="tsd-parameter-list">
|
|
1375
|
-
<li>
|
|
1376
|
-
<h5><span class="tsd-kind-parameter">level</span>: <a href="../enums/MKLogLevel.html" class="tsd-signature-type tsd-kind-enum">MKLogLevel</a></h5>
|
|
1377
|
-
<div class="tsd-comment tsd-typography"><p>Log level, allowed values are "debug", "log", "warn", "error" and "off"</p>
|
|
1378
|
-
</div>
|
|
1379
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1380
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1381
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1382
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setLogLevel">setLogLevel</a></p></aside></li></ul></section>
|
|
1383
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setPlaybackSpeed" class="tsd-anchor"></a>
|
|
1384
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Playback<wbr/>Speed</span><a href="#setPlaybackSpeed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1385
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1386
|
-
<li class="tsd-signature tsd-anchor-link" id="setPlaybackSpeed.setPlaybackSpeed-1"><span class="tsd-kind-call-signature">set<wbr/>Playback<wbr/>Speed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">speed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setPlaybackSpeed.setPlaybackSpeed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1387
|
-
<li class="tsd-description">
|
|
1388
|
-
<div class="tsd-comment tsd-typography"><p>Sets the playback speed of the player. </p>
|
|
339
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">locationDetail</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the new location details as base64 encoded string or null / '' to remove old one.</p>
|
|
340
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setloglevel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Log<wbr/>Level</span><a href="#setloglevel" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setloglevel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setLogLevel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKLogLevel.html" class="tsd-signature-type tsd-kind-enum">MKLogLevel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setloglevel-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the level of player log outputs.</p>
|
|
341
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">level</span>: <a href="../enums/MKLogLevel.html" class="tsd-signature-type tsd-kind-enum">MKLogLevel</a></span><div class="tsd-comment tsd-typography"><p>Log level, allowed values are "debug", "log", "warn", "error" and "off"</p>
|
|
342
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setLogLevel</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setplaybackspeed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Playback<wbr/>Speed</span><a href="#setplaybackspeed" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setplaybackspeed-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setPlaybackSpeed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">speed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setplaybackspeed-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the playback speed of the player.</p>
|
|
1389
343
|
<p>Available only for HTML5 player.</p>
|
|
1390
344
|
<p>Fast forward as well as slow motion is supported.</p>
|
|
1391
345
|
<p>Slow motion is used by values between <code>0</code> and <code>1</code>, fast forward by values greater than <code>1</code>.</p>
|
|
1392
|
-
</div>
|
|
1393
|
-
<div class="tsd-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
<li>
|
|
1397
|
-
<
|
|
1398
|
-
<
|
|
1399
|
-
|
|
1400
|
-
<
|
|
1401
|
-
|
|
1402
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1403
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setPlaybackSpeed">setPlaybackSpeed</a></p></aside></li></ul></section>
|
|
1404
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setPosterImage" class="tsd-anchor"></a>
|
|
1405
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Poster<wbr/>Image</span><a href="#setPosterImage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1406
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1407
|
-
<li class="tsd-signature tsd-anchor-link" id="setPosterImage.setPosterImage-1"><span class="tsd-kind-call-signature">set<wbr/>Poster<wbr/>Image</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span>, <span class="tsd-kind-parameter">keepPersistent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setPosterImage.setPosterImage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1408
|
-
<li class="tsd-description">
|
|
1409
|
-
<div class="tsd-comment tsd-typography"><p>Sets a poster image. Will be displayed immediately, even if a video stream is playing.</p>
|
|
1410
|
-
</div>
|
|
1411
|
-
<div class="tsd-parameters">
|
|
1412
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1413
|
-
<ul class="tsd-parameter-list">
|
|
1414
|
-
<li>
|
|
1415
|
-
<h5><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1416
|
-
<div class="tsd-comment tsd-typography"><p>The URL to the poster image.</p>
|
|
1417
|
-
</div>
|
|
1418
|
-
<div class="tsd-comment tsd-typography"></div></li>
|
|
1419
|
-
<li>
|
|
1420
|
-
<h5><span class="tsd-kind-parameter">keepPersistent</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
1421
|
-
<div class="tsd-comment tsd-typography"><p>Flag to set the poster image persistent so it is also displayed during playback (useful for audio-only playback).</p>
|
|
1422
|
-
</div>
|
|
1423
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1424
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1425
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1426
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setPosterImage">setPosterImage</a></p></aside></li></ul></section>
|
|
1427
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setSubtitleStyle" class="tsd-anchor"></a>
|
|
1428
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Subtitle<wbr/>Style</span><a href="#setSubtitleStyle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1429
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1430
|
-
<li class="tsd-signature tsd-anchor-link" id="setSubtitleStyle.setSubtitleStyle-1"><span class="tsd-kind-call-signature">set<wbr/>Subtitle<wbr/>Style</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">styleOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSubtitleStyle.setSubtitleStyle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1431
|
-
<li class="tsd-description">
|
|
1432
|
-
<div class="tsd-comment tsd-typography"><p>Set the subtitle styling dynamically during runtime.</p>
|
|
346
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">speed</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A playback speed factor greater than <code>0</code>.</p>
|
|
347
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setPlaybackSpeed</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setposterimage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Poster<wbr/>Image</span><a href="#setposterimage" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setposterimage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setPosterImage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">keepPersistent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setposterimage-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets a poster image. Will be displayed immediately, even if a video stream is playing.</p>
|
|
348
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The URL to the poster image.</p>
|
|
349
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">keepPersistent</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Flag to set the poster image persistent so it is also displayed during playback (useful for audio-only playback).</p>
|
|
350
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setPosterImage</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setsubtitlestyle" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Subtitle<wbr/>Style</span><a href="#setsubtitlestyle" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setsubtitlestyle-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setSubtitleStyle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">styleOptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setsubtitlestyle-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the subtitle styling dynamically during runtime.</p>
|
|
351
|
+
<p>Note:</p>
|
|
352
|
+
<ul>
|
|
353
|
+
<li>This applies to only text-based subtitles in MKPlayer subtitle overlay.</li>
|
|
354
|
+
<li>Feature not available when <a href="MKPlayerConfig.html#ui" class="tsd-kind-property">MKPlayerConfig.ui</a> is enabled.</li>
|
|
355
|
+
</ul>
|
|
1433
356
|
<p>Supported subtitle style options:</p>
|
|
1434
357
|
<ol>
|
|
1435
|
-
<li
|
|
358
|
+
<li>
|
|
359
|
+
<p>fontSize</p>
|
|
1436
360
|
<ul>
|
|
1437
361
|
<li>Supported range: "1" to "100"</li>
|
|
1438
362
|
</ul>
|
|
1439
363
|
</li>
|
|
1440
|
-
<li
|
|
364
|
+
<li>
|
|
365
|
+
<p>fontStyle</p>
|
|
1441
366
|
<ul>
|
|
1442
367
|
<li>Supported values: "normal", "italic", "bold"</li>
|
|
1443
368
|
</ul>
|
|
1444
369
|
</li>
|
|
1445
|
-
<li
|
|
370
|
+
<li>
|
|
371
|
+
<p>fontFamily</p>
|
|
1446
372
|
<ul>
|
|
1447
|
-
<li>Supported values: "Times New Roman"
|
|
373
|
+
<li>Supported values: "Times New Roman", "fantasy", "cursive", "serif", "monospace", "normal"</li>
|
|
1448
374
|
</ul>
|
|
1449
375
|
</li>
|
|
1450
|
-
<li
|
|
376
|
+
<li>
|
|
377
|
+
<p>fontColor</p>
|
|
1451
378
|
<ul>
|
|
1452
379
|
<li>Supported values: "normal", "white", "black", "red", "green", "blue", "cyan", "yellow", "magenta"</li>
|
|
1453
380
|
</ul>
|
|
1454
381
|
</li>
|
|
1455
|
-
<li
|
|
382
|
+
<li>
|
|
383
|
+
<p>fontOpacity</p>
|
|
1456
384
|
<ul>
|
|
1457
385
|
<li>Supported range: "0" to "100"</li>
|
|
1458
386
|
</ul>
|
|
1459
387
|
</li>
|
|
1460
|
-
<li
|
|
388
|
+
<li>
|
|
389
|
+
<p>backgroundColor</p>
|
|
1461
390
|
<ul>
|
|
1462
391
|
<li>Supported values: "normal", "white", "black", "red", "green", "blue", "cyan", "yellow", "magenta"</li>
|
|
1463
392
|
</ul>
|
|
@@ -1466,512 +395,43 @@ is available yet; pass <code>null</code> to unregister.</p>
|
|
|
1466
395
|
<p>Example:</p>
|
|
1467
396
|
<pre><code><span class="hl-0">styleOptions</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-0">fontSize:</span><span class="hl-1"> </span><span class="hl-11">"50"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">fontStyle:</span><span class="hl-1"> </span><span class="hl-11">"normal"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">fontFamily:</span><span class="hl-1"> </span><span class="hl-11">"normal"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">fontColor:</span><span class="hl-1"> </span><span class="hl-11">"white"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">fontOpacity:</span><span class="hl-1"> </span><span class="hl-11">"75"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">backgroundColor:</span><span class="hl-1"> </span><span class="hl-11">"black"</span><span class="hl-1">,</span><br/><span class="hl-1">};</span>
|
|
1468
397
|
</code><button>Copy</button></pre>
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
<
|
|
1473
|
-
|
|
1474
|
-
<
|
|
1475
|
-
<div class="tsd-comment tsd-typography"><p>the styleOptions parameters for subtitle styling</p>
|
|
1476
|
-
</div>
|
|
1477
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1478
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1479
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1480
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setSubtitleStyle">setSubtitleStyle</a></p></aside></li></ul></section>
|
|
1481
|
-
<section class="tsd-panel tsd-member"><a id="setUserEngagementData" class="tsd-anchor"></a>
|
|
1482
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Engagement<wbr/>Data</span><a href="#setUserEngagementData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1483
|
-
<ul class="tsd-signatures">
|
|
1484
|
-
<li class="tsd-signature tsd-anchor-link" id="setUserEngagementData.setUserEngagementData-1"><span class="tsd-kind-call-signature">set<wbr/>User<wbr/>Engagement<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userEngagementData</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setUserEngagementData.setUserEngagementData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1485
|
-
<li class="tsd-description">
|
|
1486
|
-
<div class="tsd-comment tsd-typography"><p>Used to set the user Engagement data From the Application</p>
|
|
1487
|
-
</div>
|
|
1488
|
-
<div class="tsd-parameters">
|
|
1489
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1490
|
-
<ul class="tsd-parameter-list">
|
|
1491
|
-
<li>
|
|
1492
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">userEngagementData</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../types/MKUserEngagement.html" class="tsd-signature-type tsd-kind-type-alias">MKUserEngagement</a></h5>
|
|
1493
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1494
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1495
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1496
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setVideoElement" class="tsd-anchor"></a>
|
|
1497
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Video<wbr/>Element</span><a href="#setVideoElement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1498
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1499
|
-
<li class="tsd-signature tsd-anchor-link" id="setVideoElement.setVideoElement-1"><span class="tsd-kind-call-signature">set<wbr/>Video<wbr/>Element</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setVideoElement.setVideoElement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1500
|
-
<li class="tsd-description">
|
|
1501
|
-
<div class="tsd-comment tsd-typography"><p>Passes an HTML video element to the player, which should be used in case of Html5 or Native playback.</p>
|
|
398
|
+
|
|
399
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">styleOptions</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>the styleOptions parameters for subtitle styling</p>
|
|
400
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setSubtitleStyle</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setuserengagementdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>User<wbr/>Engagement<wbr/>Data</span><a href="#setuserengagementdata" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setuserengagementdata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setUserEngagementData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userEngagementData</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/MKUserEngagement.html" class="tsd-signature-type tsd-kind-type-alias">MKUserEngagement</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setuserengagementdata-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Used to set the userEngagement data.</p>
|
|
401
|
+
<p>Note: this is applicable only for registered source streams so this value is sent to Mediakind AV Backend.</p>
|
|
402
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">userEngagementData</span>: <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/MKUserEngagement.html" class="tsd-signature-type tsd-kind-type-alias">MKUserEngagement</a></span><div class="tsd-comment tsd-typography"><p><a href="../types/MKUserEngagement.html" class="tsd-kind-type-alias">MKUserEngagement</a> to report to backend or <code>null</code> to remove previously set data</p>
|
|
403
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setvideoelement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Video<wbr/>Element</span><a href="#setvideoelement" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setvideoelement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setVideoElement</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoElement</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLVideoElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setvideoelement-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Passes an HTML video element to the player, which should be used in case of Html5 or Native playback.</p>
|
|
1502
404
|
<p>For this to take effect you must call this function before calling <a href="MKPlayerAPI.html#load" class="tsd-kind-method">load</a>.</p>
|
|
1503
|
-
<p>When no video element is set on the player, the player will create one for use internally. You may call <a href="MKPlayerAPI.html#
|
|
405
|
+
<p>When no video element is set on the player, the player will create one for use internally. You may call <a href="MKPlayerAPI.html#getvideoelement" class="tsd-kind-method">getVideoElement</a> to get hold of the video element in use by the player.</p>
|
|
1504
406
|
<p>Also the video element should be contained within the video container element that was passed as part of player creation.</p>
|
|
1505
407
|
<p>Example:</p>
|
|
1506
|
-
<pre><code><span class="hl-
|
|
408
|
+
<pre><code><span class="hl-1"><!-- </span><span class="hl-0">In</span><span class="hl-1"> </span><span class="hl-0">the</span><span class="hl-1"> </span><span class="hl-9">HTML</span><span class="hl-1"> </span><span class="hl-0">body</span><span class="hl-1"> --></span><br/><span class="hl-1"><</span><span class="hl-0">div</span><span class="hl-1"> </span><span class="hl-0">id</span><span class="hl-1">=</span><span class="hl-11">"videoContainer"</span><span class="hl-1">></span><br/><span class="hl-1"> <</span><span class="hl-0">video</span><span class="hl-1"> </span><span class="hl-0">id</span><span class="hl-1">=</span><span class="hl-11">"videoElement"</span><span class="hl-1">></</span><span class="hl-15">video</span><span class="hl-1">></span><br/><span class="hl-1"></</span><span class="hl-0">div</span><span class="hl-1">></span><br/><br/><span class="hl-6">// In the script</span><br/><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">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">"videoContainer"</span><span class="hl-1">);</span><br/><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">videoElement</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">"videoElement"</span><span class="hl-1">);</span><br/><span class="hl-8">let</span><span class="hl-1"> </span><span class="hl-0">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">"<license_key>"</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">autoplay:</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">muted:</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">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><br/><span class="hl-0">player</span><span class="hl-1">.</span><span class="hl-10">setVideoElement</span><span class="hl-1">(</span><span class="hl-0">videoElement</span><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>
|
|
1507
409
|
</code><button>Copy</button></pre>
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
<
|
|
1512
|
-
<li>
|
|
1513
|
-
<h5><span class="tsd-kind-parameter">videoElement</span>: <span class="tsd-signature-type ">HTMLVideoElement</span></h5>
|
|
1514
|
-
<div class="tsd-comment tsd-typography"><p>the video element to set.</p>
|
|
1515
|
-
</div>
|
|
1516
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1517
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1518
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1519
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setVideoElement">setVideoElement</a></p></aside></li></ul></section>
|
|
1520
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setVideoQuality" class="tsd-anchor"></a>
|
|
1521
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Video<wbr/>Quality</span><a href="#setVideoQuality" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1522
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1523
|
-
<li class="tsd-signature tsd-anchor-link" id="setVideoQuality.setVideoQuality-1"><span class="tsd-kind-call-signature">set<wbr/>Video<wbr/>Quality</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoQualityID</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setVideoQuality.setVideoQuality-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1524
|
-
<li class="tsd-description">
|
|
1525
|
-
<div class="tsd-comment tsd-typography"><p>Manually sets the video stream to a fixed quality, identified by ID.</p>
|
|
1526
|
-
<p>Has to be an ID defined in the Manifest/MPD or the keyword 'auto'.</p>
|
|
410
|
+
|
|
411
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">videoElement</span>: <span class="tsd-signature-type">HTMLVideoElement</span></span><div class="tsd-comment tsd-typography"><p>the video element to set.</p>
|
|
412
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setVideoElement</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setvideoquality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Video<wbr/>Quality</span><a href="#setvideoquality" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setvideoquality-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setVideoQuality</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">videoQualityID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setvideoquality-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Manually sets the video stream to a fixed quality, identified by ID.</p>
|
|
413
|
+
<p>Has to be an ID defined in the Manifest/MPD or the keyword 'auto'.</p>
|
|
1527
414
|
<p>Auto resets to dynamic switching.</p>
|
|
1528
|
-
<p>A list with valid IDs can be retrieved by calling <a href="MKPlayerAPI.html#
|
|
1529
|
-
</div>
|
|
1530
|
-
<div class="tsd-
|
|
1531
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1532
|
-
<ul class="tsd-parameter-list">
|
|
1533
|
-
<li>
|
|
1534
|
-
<h5><span class="tsd-kind-parameter">videoQualityID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1535
|
-
<div class="tsd-comment tsd-typography"><p>ID defined in the Manifest/MPD or 'auto'.</p>
|
|
1536
|
-
</div>
|
|
1537
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1538
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1539
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1540
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setVideoQuality">setVideoQuality</a></p></aside></li></ul></section>
|
|
1541
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setViewMode" class="tsd-anchor"></a>
|
|
1542
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>View<wbr/>Mode</span><a href="#setViewMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1543
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1544
|
-
<li class="tsd-signature tsd-anchor-link" id="setViewMode.setViewMode-1"><span class="tsd-kind-call-signature">set<wbr/>View<wbr/>Mode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">viewMode</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setViewMode.setViewMode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1545
|
-
<li class="tsd-description">
|
|
1546
|
-
<div class="tsd-comment tsd-typography"><p>Sets the player to a particular ViewMode.</p>
|
|
415
|
+
<p>A list with valid IDs can be retrieved by calling <a href="MKPlayerAPI.html#getavailablevideoqualities" class="tsd-kind-method">getAvailableVideoQualities</a>.</p>
|
|
416
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">videoQualityID</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>ID defined in the Manifest/MPD or 'auto'.</p>
|
|
417
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setVideoQuality</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setviewmode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>View<wbr/>Mode</span><a href="#setviewmode" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setviewmode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setViewMode</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">viewMode</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="MKViewModeOptions.html" class="tsd-signature-type tsd-kind-interface">MKViewModeOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setviewmode-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the player to a particular ViewMode.</p>
|
|
1547
418
|
<p>Will only work if the selected view mode is available and isViewModeAvailable returns true, else this call will be ignored.</p>
|
|
1548
|
-
<p>If successful, a <a href="../enums/MKPlayerEvent.html#
|
|
1549
|
-
</div>
|
|
1550
|
-
<div class="tsd-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
<
|
|
1555
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
1556
|
-
</div>
|
|
1557
|
-
|
|
1558
|
-
<li>
|
|
1559
|
-
|
|
1560
|
-
<div class="tsd-comment tsd-typography"><p>
|
|
1561
|
-
</div>
|
|
1562
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1563
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1564
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1565
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setViewMode">setViewMode</a></p></aside></li></ul></section>
|
|
1566
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setVolume" class="tsd-anchor"></a>
|
|
1567
|
-
<h3 class="tsd-anchor-link"><span>set<wbr/>Volume</span><a href="#setVolume" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1568
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1569
|
-
<li class="tsd-signature tsd-anchor-link" id="setVolume.setVolume-1"><span class="tsd-kind-call-signature">set<wbr/>Volume</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">volume</span>, <span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setVolume.setVolume-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1570
|
-
<li class="tsd-description">
|
|
1571
|
-
<div class="tsd-comment tsd-typography"><p>Sets the player’s volume in the range of 0 (silent) to 100 (max volume). Unmutes a muted player.</p>
|
|
1572
|
-
</div>
|
|
1573
|
-
<div class="tsd-parameters">
|
|
1574
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1575
|
-
<ul class="tsd-parameter-list">
|
|
1576
|
-
<li>
|
|
1577
|
-
<h5><span class="tsd-kind-parameter">volume</span>: <span class="tsd-signature-type">number</span></h5>
|
|
1578
|
-
<div class="tsd-comment tsd-typography"><p>The volume to set between <code>0</code> and <code>100</code>.</p>
|
|
1579
|
-
</div>
|
|
1580
|
-
<div class="tsd-comment tsd-typography"></div></li>
|
|
1581
|
-
<li>
|
|
1582
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1583
|
-
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
1584
|
-
</div>
|
|
1585
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1586
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1587
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1588
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#setVolume">setVolume</a></p></aside></li></ul></section>
|
|
1589
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="showAirplayTargetPicker" class="tsd-anchor"></a>
|
|
1590
|
-
<h3 class="tsd-anchor-link"><span>show<wbr/>Airplay<wbr/>Target<wbr/>Picker</span><a href="#showAirplayTargetPicker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1591
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1592
|
-
<li class="tsd-signature tsd-anchor-link" id="showAirplayTargetPicker.showAirplayTargetPicker-1"><span class="tsd-kind-call-signature">show<wbr/>Airplay<wbr/>Target<wbr/>Picker</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#showAirplayTargetPicker.showAirplayTargetPicker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1593
|
-
<li class="tsd-description">
|
|
1594
|
-
<div class="tsd-comment tsd-typography"><p>Shows the airplay playback target picker.</p>
|
|
1595
|
-
</div>
|
|
1596
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1597
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1598
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#showAirplayTargetPicker">showAirplayTargetPicker</a></p></aside></li></ul></section>
|
|
1599
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="skipAd" class="tsd-anchor"></a>
|
|
1600
|
-
<h3 class="tsd-anchor-link"><span>skip<wbr/>Ad</span><a href="#skipAd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1601
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1602
|
-
<li class="tsd-signature tsd-anchor-link" id="skipAd.skipAd-1"><span class="tsd-kind-call-signature">skip<wbr/>Ad</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#skipAd.skipAd-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1603
|
-
<li class="tsd-description">
|
|
1604
|
-
<div class="tsd-comment tsd-typography"><p>Skips the current ad. Has no effect if the ad is not skippable, if no ad is active or if the IMA module is used (disabled by IMA in version <a href="https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/history">3.607.0</a>).
|
|
1605
|
-
Only applicable in case of Client-Side Ad Insertion (CSAI) and available when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">advertising</a> is provided in the PlayerConfig.</p>
|
|
1606
|
-
</div>
|
|
1607
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise that resolves when the ad has been skipped and the ad player is done with cleanup of events and states.</p>
|
|
1608
|
-
|
|
1609
|
-
<div class="tsd-comment tsd-typography">
|
|
1610
|
-
<h4>Since</h4><p>v8.0</p>
|
|
1611
|
-
</div><aside class="tsd-sources">
|
|
1612
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#skipAd">skipAd</a></p></aside></li></ul></section>
|
|
1613
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="unload" class="tsd-anchor"></a>
|
|
1614
|
-
<h3 class="tsd-anchor-link"><span>unload</span><a href="#unload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1615
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1616
|
-
<li class="tsd-signature tsd-anchor-link" id="unload.unload-1"><span class="tsd-kind-call-signature">unload</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#unload.unload-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1617
|
-
<li class="tsd-description">
|
|
1618
|
-
<div class="tsd-comment tsd-typography"><p>Unloads the current video source.</p>
|
|
1619
|
-
</div>
|
|
1620
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
1621
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1622
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#unload">unload</a></p></aside></li></ul></section>
|
|
1623
|
-
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="unmute" class="tsd-anchor"></a>
|
|
1624
|
-
<h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1625
|
-
<ul class="tsd-signatures tsd-is-inherited">
|
|
1626
|
-
<li class="tsd-signature tsd-anchor-link" id="unmute.unmute-1"><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1627
|
-
<li class="tsd-description">
|
|
1628
|
-
<div class="tsd-comment tsd-typography"><p>Unmutes the player if muted.</p>
|
|
1629
|
-
</div>
|
|
1630
|
-
<div class="tsd-parameters">
|
|
1631
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1632
|
-
<ul class="tsd-parameter-list">
|
|
1633
|
-
<li>
|
|
1634
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1635
|
-
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
1636
|
-
</div>
|
|
1637
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1638
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1639
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
1640
|
-
<p>Inherited from <a href="MKPlayerCoreAPI.html">MKPlayerCoreAPI</a>.<a href="MKPlayerCoreAPI.html#unmute">unmute</a></p></aside></li></ul></section>
|
|
1641
|
-
<section class="tsd-panel tsd-member"><a id="updateAuthToken" class="tsd-anchor"></a>
|
|
1642
|
-
<h3 class="tsd-anchor-link"><span>update<wbr/>Auth<wbr/>Token</span><a href="#updateAuthToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1643
|
-
<ul class="tsd-signatures">
|
|
1644
|
-
<li class="tsd-signature tsd-anchor-link" id="updateAuthToken.updateAuthToken-1"><span class="tsd-kind-call-signature">update<wbr/>Auth<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authToken</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#updateAuthToken.updateAuthToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1645
|
-
<li class="tsd-description">
|
|
1646
|
-
<div class="tsd-comment tsd-typography"><p>Update STS authToken during an ongoing playback session.</p>
|
|
419
|
+
<p>If successful, a <a href="../enums/MKPlayerEvent.html#viewmodechanged" class="tsd-kind-enum-member">MKPlayerEvent.ViewModeChanged</a> will be fired.</p>
|
|
420
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">viewMode</span>: <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a></span><div class="tsd-comment tsd-typography"><p>the view mode to switch the player into.</p>
|
|
421
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="MKViewModeOptions.html" class="tsd-signature-type tsd-kind-interface">MKViewModeOptions</a></span><div class="tsd-comment tsd-typography"><p>additional optional parameters for view modes.</p>
|
|
422
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setViewMode</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="setvolume" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Volume</span><a href="#setvolume" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="setvolume-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setVolume</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">volume</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setvolume-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the player’s volume in the range of 0 (silent) to 100 (max volume). Unmutes a muted player.</p>
|
|
423
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">volume</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The volume to set between <code>0</code> and <code>100</code>.</p>
|
|
424
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
425
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.setVolume</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="showairplaytargetpicker" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show<wbr/>Airplay<wbr/>Target<wbr/>Picker</span><a href="#showairplaytargetpicker" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="showairplaytargetpicker-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">showAirplayTargetPicker</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#showairplaytargetpicker-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Shows the airplay playback target picker.</p>
|
|
426
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.showAirplayTargetPicker</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="skipad" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>skip<wbr/>Ad</span><a href="#skipad" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="skipad-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">skipAd</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">isCSAI</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#skipad-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Skips the current ad. Has no effect if no ad is active or if ad's end is out of seekableRange <a href="MKPlayerAPI.html#getseekablerange" class="tsd-kind-method">MKPlayerAPI.getSeekableRange</a>.</p>
|
|
427
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">isCSAI</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>whether the current ad is a client side ad. Skipping the current client-side (CSAI) ad is only applicable when <a href="MKPlayerConfig.html#advertising" class="tsd-kind-property">MKPlayerConfig.advertising</a> is provided in the PlayerConfig. Has no effect if the ad is not skippable, if no ad is active or if the IMA module is used (disabled by IMA in version <a href="https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/history">3.607.0</a>). Defaults to <code>false</code> (server side ad).</p>
|
|
428
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>Promise that resolves when the ad skip is triggered.</p>
|
|
429
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides MKPlayerCoreAPI.skipAd</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="skipadbreak" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>skip<wbr/>Ad<wbr/>Break</span><a href="#skipadbreak" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="skipadbreak-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">skipAdBreak</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#skipadbreak-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Skips the current server-side (SSAI) adBreak. Has no effect if no adBreak is active or if adBreak's end is out of seekableRange <a href="MKPlayerAPI.html#getseekablerange" class="tsd-kind-method">MKPlayerAPI.getSeekableRange</a>.</p>
|
|
430
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unload</span><a href="#unload" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="unload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unload</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#unload-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unloads the current video source.</p>
|
|
431
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.unload</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unmute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" 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><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-is-inherited"><div class="tsd-signature tsd-anchor-link"><a id="unmute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">issuer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#unmute-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmutes the player if muted.</p>
|
|
432
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
433
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from MKPlayerCoreAPI.unmute</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="updateauthtoken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Auth<wbr/>Token</span><a href="#updateauthtoken" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="updateauthtoken-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updateAuthToken</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authToken</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updateauthtoken-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update STS authToken during an ongoing playback session.</p>
|
|
1647
434
|
<p>Note: this is applicable only for registered source streams and during an ongoing playback session to update an authorization token that is about to expire (token refresh).</p>
|
|
1648
|
-
<p>Setting this before calling <a href="MKPlayerAPI.html#load" class="tsd-kind-method">load</a> will have no effect and it is expected to have the updated authorization token as part of the
|
|
1649
|
-
</div>
|
|
1650
|
-
<div class="tsd-parameters">
|
|
1651
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1652
|
-
<ul class="tsd-parameter-list">
|
|
1653
|
-
<li>
|
|
1654
|
-
<h5><span class="tsd-kind-parameter">authToken</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1655
|
-
<div class="tsd-comment tsd-typography"><p>the new authorization token.</p>
|
|
1656
|
-
</div>
|
|
1657
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1658
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1659
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></section></section></div>
|
|
1660
|
-
<div class="col-sidebar">
|
|
1661
|
-
<div class="page-menu">
|
|
1662
|
-
<div class="tsd-navigation settings">
|
|
1663
|
-
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1664
|
-
<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>
|
|
1665
|
-
<div class="tsd-accordion-details">
|
|
1666
|
-
<div class="tsd-filter-visibility">
|
|
1667
|
-
<h4 class="uppercase">Member Visibility</h4><form>
|
|
1668
|
-
<ul id="tsd-filter-options">
|
|
1669
|
-
<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>
|
|
1670
|
-
<div class="tsd-theme-toggle">
|
|
1671
|
-
<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>
|
|
1672
|
-
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1673
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1674
|
-
<div class="tsd-accordion-details">
|
|
1675
|
-
<ul>
|
|
1676
|
-
<li><a href="#adaptation" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>adaptation</span></a></li>
|
|
1677
|
-
<li><a href="#buffer" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>buffer</span></a></li>
|
|
1678
|
-
<li><a href="#drm" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>drm</span></a></li>
|
|
1679
|
-
<li><a href="#lowlatency" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>lowlatency</span></a></li>
|
|
1680
|
-
<li><a href="#manifest" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>manifest</span></a></li>
|
|
1681
|
-
<li><a href="#subtitles" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>subtitles</span></a></li>
|
|
1682
|
-
<li><a href="#addCastMetadata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Cast<wbr/>Metadata</span></a></li>
|
|
1683
|
-
<li><a href="#addTimelineMarker" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Timeline<wbr/>Marker</span></a></li>
|
|
1684
|
-
<li><a href="#castStop" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>cast<wbr/>Stop</span></a></li>
|
|
1685
|
-
<li><a href="#castVideo" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>cast<wbr/>Video</span></a></li>
|
|
1686
|
-
<li><a href="#destroy" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li>
|
|
1687
|
-
<li><a href="#discardAdBreak" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>discard<wbr/>Ad<wbr/>Break</span></a></li>
|
|
1688
|
-
<li><a href="#dismissPauseAd" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>dismiss<wbr/>Pause<wbr/>Ad</span></a></li>
|
|
1689
|
-
<li><a href="#getActiveAd" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Active<wbr/>Ad</span></a></li>
|
|
1690
|
-
<li><a href="#getActiveAdBreak" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Active<wbr/>Ad<wbr/>Break</span></a></li>
|
|
1691
|
-
<li><a href="#getAspectRatio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Aspect<wbr/>Ratio</span></a></li>
|
|
1692
|
-
<li><a href="#getAudio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Audio</span></a></li>
|
|
1693
|
-
<li><a href="#getAudioQuality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Quality</span></a></li>
|
|
1694
|
-
<li><a href="#getAvailableAudio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Audio</span></a></li>
|
|
1695
|
-
<li><a href="#getAvailableAudioQualities" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Audio<wbr/>Qualities</span></a></li>
|
|
1696
|
-
<li><a href="#getAvailableSegments" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Segments</span></a></li>
|
|
1697
|
-
<li><a href="#getAvailableVideoQualities" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Video<wbr/>Qualities</span></a></li>
|
|
1698
|
-
<li><a href="#getBufferedRanges" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Buffered<wbr/>Ranges</span></a></li>
|
|
1699
|
-
<li><a href="#getConfig" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Config</span></a></li>
|
|
1700
|
-
<li><a href="#getCurrentTime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Time</span></a></li>
|
|
1701
|
-
<li><a href="#getDownloadedAudioData" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Downloaded<wbr/>Audio<wbr/>Data</span></a></li>
|
|
1702
|
-
<li><a href="#getDownloadedVideoData" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Downloaded<wbr/>Video<wbr/>Data</span></a></li>
|
|
1703
|
-
<li><a href="#getDroppedVideoFrames" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Dropped<wbr/>Video<wbr/>Frames</span></a></li>
|
|
1704
|
-
<li><a href="#getDuration" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Duration</span></a></li>
|
|
1705
|
-
<li><a href="#getLiveLatency" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Live<wbr/>Latency</span></a></li>
|
|
1706
|
-
<li><a href="#getMaxTimeShift" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Time<wbr/>Shift</span></a></li>
|
|
1707
|
-
<li><a href="#getModuleInfo" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Module<wbr/>Info</span></a></li>
|
|
1708
|
-
<li><a href="#getPlaybackAudioData" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Audio<wbr/>Data</span></a></li>
|
|
1709
|
-
<li><a href="#getPlaybackSpeed" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Speed</span></a></li>
|
|
1710
|
-
<li><a href="#getPlaybackVideoData" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Video<wbr/>Data</span></a></li>
|
|
1711
|
-
<li><a href="#getPlayerType" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Player<wbr/>Type</span></a></li>
|
|
1712
|
-
<li><a href="#getSeekableRange" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Seekable<wbr/>Range</span></a></li>
|
|
1713
|
-
<li><a href="#getSource" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Source</span></a></li>
|
|
1714
|
-
<li><a href="#getSourceConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Source<wbr/>Config</span></a></li>
|
|
1715
|
-
<li><a href="#getStreamType" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Stream<wbr/>Type</span></a></li>
|
|
1716
|
-
<li><a href="#getThumbnail" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Thumbnail</span></a></li>
|
|
1717
|
-
<li><a href="#getTimeShift" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Time<wbr/>Shift</span></a></li>
|
|
1718
|
-
<li><a href="#getTimelineMarkers" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Timeline<wbr/>Markers</span></a></li>
|
|
1719
|
-
<li><a href="#getTotalStalledTime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Stalled<wbr/>Time</span></a></li>
|
|
1720
|
-
<li><a href="#getVersion" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Version</span></a></li>
|
|
1721
|
-
<li><a href="#getVideoContainer" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Container</span></a></li>
|
|
1722
|
-
<li><a href="#getVideoElement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Element</span></a></li>
|
|
1723
|
-
<li><a href="#getVideoQuality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Quality</span></a></li>
|
|
1724
|
-
<li><a href="#getViewMode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>View<wbr/>Mode</span></a></li>
|
|
1725
|
-
<li><a href="#getVolume" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Volume</span></a></li>
|
|
1726
|
-
<li><a href="#hasEnded" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Ended</span></a></li>
|
|
1727
|
-
<li><a href="#isAirplayActive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Airplay<wbr/>Active</span></a></li>
|
|
1728
|
-
<li><a href="#isAirplayAvailable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Airplay<wbr/>Available</span></a></li>
|
|
1729
|
-
<li><a href="#isCastAvailable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Cast<wbr/>Available</span></a></li>
|
|
1730
|
-
<li><a href="#isCasting" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Casting</span></a></li>
|
|
1731
|
-
<li><a href="#isLinearAdActive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Linear<wbr/>Ad<wbr/>Active</span></a></li>
|
|
1732
|
-
<li><a href="#isLive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Live</span></a></li>
|
|
1733
|
-
<li><a href="#isLowLatencyPlayback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Low<wbr/>Latency<wbr/>Playback</span></a></li>
|
|
1734
|
-
<li><a href="#isMuted" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Muted</span></a></li>
|
|
1735
|
-
<li><a href="#isPauseAdActive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Pause<wbr/>Ad<wbr/>Active</span></a></li>
|
|
1736
|
-
<li><a href="#isPaused" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Paused</span></a></li>
|
|
1737
|
-
<li><a href="#isPlaying" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Playing</span></a></li>
|
|
1738
|
-
<li><a href="#isStalled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Stalled</span></a></li>
|
|
1739
|
-
<li><a href="#isViewModeAvailable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>View<wbr/>Mode<wbr/>Available</span></a></li>
|
|
1740
|
-
<li><a href="#listAd" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Ad</span></a></li>
|
|
1741
|
-
<li><a href="#load" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load</span></a></li>
|
|
1742
|
-
<li><a href="#mute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a></li>
|
|
1743
|
-
<li><a href="#off" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li>
|
|
1744
|
-
<li><a href="#offAll" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off<wbr/>All</span></a></li>
|
|
1745
|
-
<li><a href="#on" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
|
|
1746
|
-
<li><a href="#pause" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a></li>
|
|
1747
|
-
<li><a href="#play" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>play</span></a></li>
|
|
1748
|
-
<li><a href="#preload" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>preload</span></a></li>
|
|
1749
|
-
<li><a href="#reload" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reload</span></a></li>
|
|
1750
|
-
<li><a href="#removeTimelineMarker" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Timeline<wbr/>Marker</span></a></li>
|
|
1751
|
-
<li><a href="#scheduleAd" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>schedule<wbr/>Ad</span></a></li>
|
|
1752
|
-
<li><a href="#seek" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>seek</span></a></li>
|
|
1753
|
-
<li><a href="#seekToLiveEdge" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>seek<wbr/>To<wbr/>Live<wbr/>Edge</span></a></li>
|
|
1754
|
-
<li><a href="#setAnalyticsCustomData" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Analytics<wbr/>Custom<wbr/>Data</span></a></li>
|
|
1755
|
-
<li><a href="#setAspectRatio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Aspect<wbr/>Ratio</span></a></li>
|
|
1756
|
-
<li><a href="#setAudio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Audio</span></a></li>
|
|
1757
|
-
<li><a href="#setAudioQuality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Audio<wbr/>Quality</span></a></li>
|
|
1758
|
-
<li><a href="#setCloudIdConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Cloud<wbr/>Id<wbr/>Config</span></a></li>
|
|
1759
|
-
<li><a href="#setGeoComplyLocationProvider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Geo<wbr/>Comply<wbr/>Location<wbr/>Provider</span></a></li>
|
|
1760
|
-
<li><a href="#setHttpHeaders" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Http<wbr/>Headers</span></a></li>
|
|
1761
|
-
<li><a href="#setInhomeStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Inhome<wbr/>Status</span></a></li>
|
|
1762
|
-
<li><a href="#setLocationDetail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Location<wbr/>Detail</span></a></li>
|
|
1763
|
-
<li><a href="#setLogLevel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Log<wbr/>Level</span></a></li>
|
|
1764
|
-
<li><a href="#setPlaybackSpeed" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Playback<wbr/>Speed</span></a></li>
|
|
1765
|
-
<li><a href="#setPosterImage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Poster<wbr/>Image</span></a></li>
|
|
1766
|
-
<li><a href="#setSubtitleStyle" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Subtitle<wbr/>Style</span></a></li>
|
|
1767
|
-
<li><a href="#setUserEngagementData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Engagement<wbr/>Data</span></a></li>
|
|
1768
|
-
<li><a href="#setVideoElement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Element</span></a></li>
|
|
1769
|
-
<li><a href="#setVideoQuality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Quality</span></a></li>
|
|
1770
|
-
<li><a href="#setViewMode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>View<wbr/>Mode</span></a></li>
|
|
1771
|
-
<li><a href="#setVolume" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Volume</span></a></li>
|
|
1772
|
-
<li><a href="#showAirplayTargetPicker" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>show<wbr/>Airplay<wbr/>Target<wbr/>Picker</span></a></li>
|
|
1773
|
-
<li><a href="#skipAd" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>skip<wbr/>Ad</span></a></li>
|
|
1774
|
-
<li><a href="#unload" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unload</span></a></li>
|
|
1775
|
-
<li><a href="#unmute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a></li>
|
|
1776
|
-
<li><a href="#updateAuthToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Auth<wbr/>Token</span></a></li></ul></div></details></div>
|
|
1777
|
-
<div class="site-menu">
|
|
1778
|
-
<nav class="tsd-navigation"><a href="../modules.html"><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>
|
|
1779
|
-
<ul class="tsd-small-nested-navigation">
|
|
1780
|
-
<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>
|
|
1781
|
-
<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>
|
|
1782
|
-
<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>
|
|
1783
|
-
<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>
|
|
1784
|
-
<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>
|
|
1785
|
-
<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>
|
|
1786
|
-
<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>
|
|
1787
|
-
<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>
|
|
1788
|
-
<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>
|
|
1789
|
-
<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>
|
|
1790
|
-
<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>
|
|
1791
|
-
<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>
|
|
1792
|
-
<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>
|
|
1793
|
-
<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>
|
|
1794
|
-
<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>
|
|
1795
|
-
<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>
|
|
1796
|
-
<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>
|
|
1797
|
-
<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>
|
|
1798
|
-
<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>
|
|
1799
|
-
<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>
|
|
1800
|
-
<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>
|
|
1801
|
-
<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>
|
|
1802
|
-
<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>
|
|
1803
|
-
<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>
|
|
1804
|
-
<li><a href="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>
|
|
1805
|
-
<li><a href="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>
|
|
1806
|
-
<li><a href="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>
|
|
1807
|
-
<li><a href="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>
|
|
1808
|
-
<li><a href="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>
|
|
1809
|
-
<li><a href="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>
|
|
1810
|
-
<li><a href="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>
|
|
1811
|
-
<li><a href="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>
|
|
1812
|
-
<li><a href="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>
|
|
1813
|
-
<li><a href="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>
|
|
1814
|
-
<li><a href="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>
|
|
1815
|
-
<li><a href="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>
|
|
1816
|
-
<li><a href="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>
|
|
1817
|
-
<li><a href="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>
|
|
1818
|
-
<li><a href="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>
|
|
1819
|
-
<li><a href="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>
|
|
1820
|
-
<li><a href="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>
|
|
1821
|
-
<li><a href="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>
|
|
1822
|
-
<li><a href="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>
|
|
1823
|
-
<li><a href="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>
|
|
1824
|
-
<li><a href="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>
|
|
1825
|
-
<li><a href="MKAdaptationAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAdaptationAPI</span></a></li>
|
|
1826
|
-
<li><a href="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>
|
|
1827
|
-
<li><a href="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>
|
|
1828
|
-
<li><a href="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>
|
|
1829
|
-
<li><a href="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>
|
|
1830
|
-
<li><a href="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>
|
|
1831
|
-
<li><a href="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>
|
|
1832
|
-
<li><a href="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>
|
|
1833
|
-
<li><a href="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>
|
|
1834
|
-
<li><a href="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>
|
|
1835
|
-
<li><a href="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>
|
|
1836
|
-
<li><a href="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>
|
|
1837
|
-
<li><a href="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>
|
|
1838
|
-
<li><a href="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>
|
|
1839
|
-
<li><a href="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>
|
|
1840
|
-
<li><a href="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>
|
|
1841
|
-
<li><a href="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>
|
|
1842
|
-
<li><a href="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>
|
|
1843
|
-
<li><a href="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>
|
|
1844
|
-
<li><a href="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>
|
|
1845
|
-
<li><a href="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>
|
|
1846
|
-
<li><a href="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>
|
|
1847
|
-
<li><a href="MKBufferAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKBufferAPI</span></a></li>
|
|
1848
|
-
<li><a href="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>
|
|
1849
|
-
<li><a href="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>
|
|
1850
|
-
<li><a href="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>
|
|
1851
|
-
<li><a href="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>
|
|
1852
|
-
<li><a href="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>
|
|
1853
|
-
<li><a href="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>
|
|
1854
|
-
<li><a href="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>
|
|
1855
|
-
<li><a href="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>
|
|
1856
|
-
<li><a href="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>
|
|
1857
|
-
<li><a href="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>
|
|
1858
|
-
<li><a href="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>
|
|
1859
|
-
<li><a href="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>
|
|
1860
|
-
<li><a href="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>
|
|
1861
|
-
<li><a href="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>
|
|
1862
|
-
<li><a href="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>
|
|
1863
|
-
<li><a href="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>
|
|
1864
|
-
<li><a href="MKDrmAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKDrmAPI</span></a></li>
|
|
1865
|
-
<li><a href="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>
|
|
1866
|
-
<li><a href="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>
|
|
1867
|
-
<li><a href="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>
|
|
1868
|
-
<li><a href="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>
|
|
1869
|
-
<li><a href="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>
|
|
1870
|
-
<li><a href="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>
|
|
1871
|
-
<li><a href="MKError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKError</span></a></li>
|
|
1872
|
-
<li><a href="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>
|
|
1873
|
-
<li><a href="MKFMTSASiDEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKFMTSASiDEvent</span></a></li>
|
|
1874
|
-
<li><a href="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>
|
|
1875
|
-
<li><a href="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>
|
|
1876
|
-
<li><a href="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>
|
|
1877
|
-
<li><a href="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>
|
|
1878
|
-
<li><a href="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>
|
|
1879
|
-
<li><a href="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>
|
|
1880
|
-
<li><a href="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>
|
|
1881
|
-
<li><a href="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>
|
|
1882
|
-
<li><a href="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>
|
|
1883
|
-
<li><a href="MKManifestAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKManifestAPI</span></a></li>
|
|
1884
|
-
<li><a href="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>
|
|
1885
|
-
<li><a href="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>
|
|
1886
|
-
<li><a href="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>
|
|
1887
|
-
<li><a href="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>
|
|
1888
|
-
<li><a href="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>
|
|
1889
|
-
<li><a href="MKMetadata.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKMetadata</span></a></li>
|
|
1890
|
-
<li><a href="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>
|
|
1891
|
-
<li><a href="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>
|
|
1892
|
-
<li><a href="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>
|
|
1893
|
-
<li><a href="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>
|
|
1894
|
-
<li><a href="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>
|
|
1895
|
-
<li><a href="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>
|
|
1896
|
-
<li><a href="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>
|
|
1897
|
-
<li><a href="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>
|
|
1898
|
-
<li><a href="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>
|
|
1899
|
-
<li><a href="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>
|
|
1900
|
-
<li><a href="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>
|
|
1901
|
-
<li><a href="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>
|
|
1902
|
-
<li><a href="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>
|
|
1903
|
-
<li><a href="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>
|
|
1904
|
-
<li><a href="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>
|
|
1905
|
-
<li><a href="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>
|
|
1906
|
-
<li><a href="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>
|
|
1907
|
-
<li><a href="MKPlayerAPI.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKPlayerAPI</span></a></li>
|
|
1908
|
-
<li><a href="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>
|
|
1909
|
-
<li><a href="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>
|
|
1910
|
-
<li><a href="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>
|
|
1911
|
-
<li><a href="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>
|
|
1912
|
-
<li><a href="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>
|
|
1913
|
-
<li><a href="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>
|
|
1914
|
-
<li><a href="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>
|
|
1915
|
-
<li><a href="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>
|
|
1916
|
-
<li><a href="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>
|
|
1917
|
-
<li><a href="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>
|
|
1918
|
-
<li><a href="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>
|
|
1919
|
-
<li><a href="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>
|
|
1920
|
-
<li><a href="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>
|
|
1921
|
-
<li><a href="MKQuality.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKQuality</span></a></li>
|
|
1922
|
-
<li><a href="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>
|
|
1923
|
-
<li><a href="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>
|
|
1924
|
-
<li><a href="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>
|
|
1925
|
-
<li><a href="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>
|
|
1926
|
-
<li><a href="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>
|
|
1927
|
-
<li><a href="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>
|
|
1928
|
-
<li><a href="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>
|
|
1929
|
-
<li><a href="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>
|
|
1930
|
-
<li><a href="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>
|
|
1931
|
-
<li><a href="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>
|
|
1932
|
-
<li><a href="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>
|
|
1933
|
-
<li><a href="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>
|
|
1934
|
-
<li><a href="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>
|
|
1935
|
-
<li><a href="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>
|
|
1936
|
-
<li><a href="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>
|
|
1937
|
-
<li><a href="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>
|
|
1938
|
-
<li><a href="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>
|
|
1939
|
-
<li><a href="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>
|
|
1940
|
-
<li><a href="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>
|
|
1941
|
-
<li><a href="MKSubtitlesAPI.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSubtitlesAPI</span></a></li>
|
|
1942
|
-
<li><a href="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>
|
|
1943
|
-
<li><a href="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>
|
|
1944
|
-
<li><a href="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>
|
|
1945
|
-
<li><a href="MKThumbnail.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKThumbnail</span></a></li>
|
|
1946
|
-
<li><a href="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>
|
|
1947
|
-
<li><a href="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>
|
|
1948
|
-
<li><a href="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>
|
|
1949
|
-
<li><a href="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>
|
|
1950
|
-
<li><a href="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>
|
|
1951
|
-
<li><a href="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>
|
|
1952
|
-
<li><a href="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>
|
|
1953
|
-
<li><a href="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>
|
|
1954
|
-
<li><a href="MKVTTProperties.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKVTTProperties</span></a></li>
|
|
1955
|
-
<li><a href="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>
|
|
1956
|
-
<li><a href="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>
|
|
1957
|
-
<li><a href="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>
|
|
1958
|
-
<li><a href="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>
|
|
1959
|
-
<li><a href="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>
|
|
1960
|
-
<li><a href="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>
|
|
1961
|
-
<li><a href="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>
|
|
1962
|
-
<li><a href="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>
|
|
1963
|
-
<li><a href="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>
|
|
1964
|
-
<li><a href="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>
|
|
1965
|
-
<li><a href="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>
|
|
1966
|
-
<li><a href="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>
|
|
1967
|
-
<li><a href="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>
|
|
1968
|
-
<li><a href="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>
|
|
1969
|
-
<li><a href="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>
|
|
1970
|
-
<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>
|
|
1971
|
-
<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>
|
|
1972
|
-
<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>
|
|
1973
|
-
<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>
|
|
1974
|
-
<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>
|
|
1975
|
-
<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>
|
|
1976
|
-
<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>
|
|
1977
|
-
<div class="overlay"></div></body></html>
|
|
435
|
+
<p>Setting this before calling <a href="MKPlayerAPI.html#load" class="tsd-kind-method">load</a> will have no effect and it is expected to have the updated authorization token as part of the <a href="MKRegisteredSource.html#environmentconfig" class="tsd-kind-property">MKRegisteredSource.environmentConfig</a> in the <a href="MKSourceConfig.html" class="tsd-kind-interface">MKSourceConfig</a> object passed to start playback of a next source.</p>
|
|
436
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">authToken</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the new authorization token.</p>
|
|
437
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section></section></details></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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#adaptation" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>adaptation</span></a><a href="#buffer" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>buffer</span></a><a href="#drm" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>drm</span></a><a href="#lowlatency" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>lowlatency</span></a><a href="#manifest" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>manifest</span></a><a href="#subtitles" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subtitles</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addcastmetadata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Cast<wbr/>Metadata</span></a><a href="#addtimelinemarker" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Timeline<wbr/>Marker</span></a><a href="#caststop" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cast<wbr/>Stop</span></a><a href="#castvideo" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cast<wbr/>Video</span></a><a href="#destroy" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#discardadbreak" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>discard<wbr/>Ad<wbr/>Break</span></a><a href="#dismisspausead" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dismiss<wbr/>Pause<wbr/>Ad</span></a><a href="#getactivead" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Active<wbr/>Ad</span></a><a href="#getactiveadbreak" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Active<wbr/>Ad<wbr/>Break</span></a><a href="#getaspectratio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Aspect<wbr/>Ratio</span></a><a href="#getaudio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Audio</span></a><a href="#getaudioquality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Quality</span></a><a href="#getavailableaudio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Audio</span></a><a href="#getavailableaudioqualities" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Audio<wbr/>Qualities</span></a><a href="#getavailablesegments" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Segments</span></a><a href="#getavailablevideoqualities" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Video<wbr/>Qualities</span></a><a href="#getbufferedranges" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Buffered<wbr/>Ranges</span></a><a href="#getconfig" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Config</span></a><a href="#getcurrenttime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Time</span></a><a href="#getdownloadedaudiodata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Downloaded<wbr/>Audio<wbr/>Data</span></a><a href="#getdownloadedvideodata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Downloaded<wbr/>Video<wbr/>Data</span></a><a href="#getdroppedvideoframes" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Dropped<wbr/>Video<wbr/>Frames</span></a><a href="#getduration" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Duration</span></a><a href="#getlivelatency" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Live<wbr/>Latency</span></a><a href="#getmaxtimeshift" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Time<wbr/>Shift</span></a><a href="#getmoduleinfo" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Module<wbr/>Info</span></a><a href="#getplaybackaudiodata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Audio<wbr/>Data</span></a><a href="#getplaybackspeed" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Speed</span></a><a href="#getplaybackvideodata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Video<wbr/>Data</span></a><a href="#getplayertype" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Player<wbr/>Type</span></a><a href="#getseekablerange" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Seekable<wbr/>Range</span></a><a href="#getsource" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Source</span></a><a href="#getsourceconfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Source<wbr/>Config</span></a><a href="#getstreamtype" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Stream<wbr/>Type</span></a><a href="#getthumbnail" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Thumbnail</span></a><a href="#gettimelinemarkers" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Timeline<wbr/>Markers</span></a><a href="#gettimeshift" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Time<wbr/>Shift</span></a><a href="#gettotalstalledtime" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Total<wbr/>Stalled<wbr/>Time</span></a><a href="#getversion" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Version</span></a><a href="#getvideocontainer" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Container</span></a><a href="#getvideoelement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Element</span></a><a href="#getvideoquality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Quality</span></a><a href="#getviewmode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>View<wbr/>Mode</span></a><a href="#getvolume" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Volume</span></a><a href="#hasended" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Ended</span></a><a href="#isairplayactive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Airplay<wbr/>Active</span></a><a href="#isairplayavailable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Airplay<wbr/>Available</span></a><a href="#iscastavailable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Cast<wbr/>Available</span></a><a href="#iscasting" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Casting</span></a><a href="#islinearadactive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Linear<wbr/>Ad<wbr/>Active</span></a><a href="#islive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Live</span></a><a href="#islowlatencyplayback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Low<wbr/>Latency<wbr/>Playback</span></a><a href="#ismuted" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Muted</span></a><a href="#ispauseadactive" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Pause<wbr/>Ad<wbr/>Active</span></a><a href="#ispaused" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Paused</span></a><a href="#isplaying" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Playing</span></a><a href="#isstalled" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Stalled</span></a><a href="#isviewmodeavailable" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>View<wbr/>Mode<wbr/>Available</span></a><a href="#listad" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Ad</span></a><a href="#load" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>load</span></a><a href="#mute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute</span></a><a href="#off" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#offall" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off<wbr/>All</span></a><a href="#on" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#pause" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pause</span></a><a href="#play" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play</span></a><a href="#preload" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>preload</span></a><a href="#reload" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a><a href="#removetimelinemarker" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Timeline<wbr/>Marker</span></a><a href="#schedulead" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>schedule<wbr/>Ad</span></a><a href="#seek" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>seek</span></a><a href="#seektoliveedge" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>seek<wbr/>To<wbr/>Live<wbr/>Edge</span></a><a href="#setanalyticscustomdata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Analytics<wbr/>Custom<wbr/>Data</span></a><a href="#setaspectratio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Aspect<wbr/>Ratio</span></a><a href="#setaudio" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Audio</span></a><a href="#setaudioquality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Audio<wbr/>Quality</span></a><a href="#setcloudidconfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Cloud<wbr/>Id<wbr/>Config</span></a><a href="#setgeocomplylocationprovider" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Geo<wbr/>Comply<wbr/>Location<wbr/>Provider</span></a><a href="#sethttpheaders" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Http<wbr/>Headers</span></a><a href="#setinhomestatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Inhome<wbr/>Status</span></a><a href="#setlocationdetail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Location<wbr/>Detail</span></a><a href="#setloglevel" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Log<wbr/>Level</span></a><a href="#setplaybackspeed" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Playback<wbr/>Speed</span></a><a href="#setposterimage" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Poster<wbr/>Image</span></a><a href="#setsubtitlestyle" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Subtitle<wbr/>Style</span></a><a href="#setuserengagementdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>User<wbr/>Engagement<wbr/>Data</span></a><a href="#setvideoelement" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Element</span></a><a href="#setvideoquality" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Quality</span></a><a href="#setviewmode" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>View<wbr/>Mode</span></a><a href="#setvolume" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Volume</span></a><a href="#showairplaytargetpicker" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Airplay<wbr/>Target<wbr/>Picker</span></a><a href="#skipad" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>skip<wbr/>Ad</span></a><a href="#skipadbreak" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>skip<wbr/>Ad<wbr/>Break</span></a><a href="#unload" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unload</span></a><a href="#unmute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute</span></a><a href="#updateauthtoken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Auth<wbr/>Token</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">MKPlayer - v1.48.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>
|