@mediakind/mkplayer 1.0.23 → 1.1.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/README.md +84 -121
- package/bin/mkplayer-ui.css +12 -0
- package/bin/mkplayer.js +1 -0
- package/docs/.nojekyll +1 -0
- package/docs/assets/highlight.css +141 -0
- package/docs/assets/main.js +58 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1367 -0
- package/docs/enums/MKAdQuartile.html +219 -0
- package/docs/enums/MKAdType.html +227 -0
- package/docs/enums/MKBufferType.html +207 -0
- package/docs/enums/MKDrmType.html +227 -0
- package/docs/enums/MKHttpRequestType.html +290 -0
- package/docs/enums/MKHttpResponseType.html +220 -0
- package/docs/enums/MKLatencyMode.html +227 -0
- package/docs/enums/MKLiveSynchronizationMethod.html +219 -0
- package/docs/enums/MKLogLevel.html +221 -0
- package/docs/enums/MKMediaType.html +201 -0
- package/docs/enums/MKMetadataType.html +255 -0
- package/docs/enums/MKPlatformType.html +201 -0
- package/docs/enums/MKPlayerEvent.html +945 -0
- package/docs/enums/MKProgramRestrictionType.html +259 -0
- package/docs/enums/MKRttEstimationMethod.html +208 -0
- package/docs/enums/MKSourceType.html +235 -0
- package/docs/enums/MKStartOffsetTimelineReference.html +211 -0
- package/docs/enums/MKStreamType.html +227 -0
- package/docs/enums/MKTimeMode.html +209 -0
- package/docs/enums/MKViewMode.html +210 -0
- package/docs/index.html +224 -0
- package/docs/interfaces/MKAdBreakFinishedEvent.html +227 -0
- package/docs/interfaces/MKAdBreakStartedEvent.html +259 -0
- package/docs/interfaces/MKAdClickThrough.html +243 -0
- package/docs/interfaces/MKAdCompanion.html +185 -0
- package/docs/interfaces/MKAdCompanionEvent.html +235 -0
- package/docs/interfaces/MKAdFinishedEvent.html +227 -0
- package/docs/interfaces/MKAdMarkerEvent.html +227 -0
- package/docs/interfaces/MKAdQuartileEvent.html +235 -0
- package/docs/interfaces/MKAdStartedEvent.html +284 -0
- package/docs/interfaces/MKAdaptationConfig.html +339 -0
- package/docs/interfaces/MKAdaptationData.html +225 -0
- package/docs/interfaces/MKAdaptationEvent.html +230 -0
- package/docs/interfaces/MKAdaptationPlatformConfig.html +215 -0
- package/docs/interfaces/MKAirplayChangedEvent.html +246 -0
- package/docs/interfaces/MKAnalyticsConfig.html +383 -0
- package/docs/interfaces/MKAspectRatioChangedEvent.html +235 -0
- package/docs/interfaces/MKAudioAdaptationData.html +226 -0
- package/docs/interfaces/MKAudioAdaptationEvent.html +228 -0
- package/docs/interfaces/MKAudioChangedEvent.html +254 -0
- package/docs/interfaces/MKAudioDownloadQualityChangeEvent.html +255 -0
- package/docs/interfaces/MKAudioDownloadQualityChangedEvent.html +255 -0
- package/docs/interfaces/MKAudioPlaybackQualityChangedEvent.html +237 -0
- package/docs/interfaces/MKAudioQuality.html +244 -0
- package/docs/interfaces/MKAudioQualityChangedEvent.html +255 -0
- package/docs/interfaces/MKAudioQualityEvent.html +225 -0
- package/docs/interfaces/MKAudioTrack.html +248 -0
- package/docs/interfaces/MKAudioTrackEvent.html +246 -0
- package/docs/interfaces/MKAzukiConfig.html +235 -0
- package/docs/interfaces/MKBitrateLimitationConfig.html +231 -0
- package/docs/interfaces/MKBufferConfig.html +215 -0
- package/docs/interfaces/MKBufferLevel.html +227 -0
- package/docs/interfaces/MKBufferMediaTypeConfig.html +218 -0
- package/docs/interfaces/MKCastAvailableEvent.html +228 -0
- package/docs/interfaces/MKCastConfig.html +231 -0
- package/docs/interfaces/MKCastStartedEvent.html +235 -0
- package/docs/interfaces/MKCastWaitingForDeviceEvent.html +235 -0
- package/docs/interfaces/MKCdnOptions.html +212 -0
- package/docs/interfaces/MKCueEnterEvent.html +313 -0
- package/docs/interfaces/MKCueExitEvent.html +313 -0
- package/docs/interfaces/MKCueParsedEvent.html +313 -0
- package/docs/interfaces/MKCueUpdateEvent.html +313 -0
- package/docs/interfaces/MKDownloadFinishedEvent.html +299 -0
- package/docs/interfaces/MKDownloadedAudioData.html +228 -0
- package/docs/interfaces/MKDownloadedData.html +226 -0
- package/docs/interfaces/MKDownloadedVideoData.html +244 -0
- package/docs/interfaces/MKDrmConfig.html +223 -0
- package/docs/interfaces/MKDrmLicense.html +210 -0
- package/docs/interfaces/MKDrmLicenseAddedEvent.html +227 -0
- package/docs/interfaces/MKDurationChangedEvent.html +235 -0
- package/docs/interfaces/MKError.html +229 -0
- package/docs/interfaces/MKErrorEvent.html +247 -0
- package/docs/interfaces/MKFairplayDrmConfig.html +428 -0
- package/docs/interfaces/MKHttpRequestOptions.html +231 -0
- package/docs/interfaces/MKLatencyModeChangedEvent.html +235 -0
- package/docs/interfaces/MKLiveConfig.html +212 -0
- package/docs/interfaces/MKLogConfig.html +207 -0
- package/docs/interfaces/MKLowLatencyConfig.html +223 -0
- package/docs/interfaces/MKLowLatencySyncConfig.html +223 -0
- package/docs/interfaces/MKMediaPlaybackQualityChangeEvent.html +238 -0
- package/docs/interfaces/MKMediaQualityChangeEvent.html +258 -0
- package/docs/interfaces/MKMediaQualityEvent.html +227 -0
- package/docs/interfaces/MKMediaTrack.html +223 -0
- package/docs/interfaces/MKMediaTrackRole.html +217 -0
- package/docs/interfaces/MKMetadata.html +227 -0
- package/docs/interfaces/MKMetadataChangedEvent.html +256 -0
- package/docs/interfaces/MKMetadataEvent.html +255 -0
- package/docs/interfaces/MKMetadataParsedEvent.html +256 -0
- package/docs/interfaces/MKPeriodContentInformation.html +219 -0
- package/docs/interfaces/MKPeriodInformation.html +211 -0
- package/docs/interfaces/MKPeriodSwitchObject.html +203 -0
- package/docs/interfaces/MKPeriodSwitchedEvent.html +235 -0
- package/docs/interfaces/MKPlayReadyDrmConfig.html +282 -0
- package/docs/interfaces/MKPlaybackConfig.html +320 -0
- package/docs/interfaces/MKPlaybackEvent.html +242 -0
- package/docs/interfaces/MKPlaybackSpeedChangedEvent.html +235 -0
- package/docs/interfaces/MKPlayerAPI.html +1459 -0
- package/docs/interfaces/MKPlayerConfig.html +304 -0
- package/docs/interfaces/MKPlayerEventBase.html +253 -0
- package/docs/interfaces/MKPlayerEventCallback.html +196 -0
- package/docs/interfaces/MKPlayerEventConfig.html +184 -0
- package/docs/interfaces/MKPlayerResizedEvent.html +235 -0
- package/docs/interfaces/MKProgramRestrictions.html +224 -0
- package/docs/interfaces/MKProgramRestrictionsEvent.html +227 -0
- package/docs/interfaces/MKProgramTimeChangedEvent.html +227 -0
- package/docs/interfaces/MKQuality.html +240 -0
- package/docs/interfaces/MKRegisteredSource.html +234 -0
- package/docs/interfaces/MKSeekEvent.html +245 -0
- package/docs/interfaces/MKSegmentPlaybackEvent.html +333 -0
- package/docs/interfaces/MKSegmentRequestFinishedEvent.html +283 -0
- package/docs/interfaces/MKSourceConfig.html +334 -0
- package/docs/interfaces/MKSourceOptions.html +365 -0
- package/docs/interfaces/MKSubtitleCue.html +287 -0
- package/docs/interfaces/MKSubtitleCuePosition.html +215 -0
- package/docs/interfaces/MKSubtitleEvent.html +227 -0
- package/docs/interfaces/MKSubtitleTrack.html +278 -0
- package/docs/interfaces/MKSynchronizationConfigEntry.html +211 -0
- package/docs/interfaces/MKTargetLatencyChangedEvent.html +235 -0
- package/docs/interfaces/MKTextTrack.html +258 -0
- package/docs/interfaces/MKThumbnail.html +263 -0
- package/docs/interfaces/MKThumbnailTrack.html +207 -0
- package/docs/interfaces/MKTimeChangedEvent.html +238 -0
- package/docs/interfaces/MKTimeRange.html +211 -0
- package/docs/interfaces/MKULLSource.html +215 -0
- package/docs/interfaces/MKUserInteractionEvent.html +232 -0
- package/docs/interfaces/MKVTTProperties.html +284 -0
- package/docs/interfaces/MKVTTRegionProperties.html +267 -0
- package/docs/interfaces/MKVideoAdaptationData.html +226 -0
- package/docs/interfaces/MKVideoAdaptationEvent.html +228 -0
- package/docs/interfaces/MKVideoDownloadQualityChangeEvent.html +255 -0
- package/docs/interfaces/MKVideoDownloadQualityChangedEvent.html +255 -0
- package/docs/interfaces/MKVideoPlaybackQualityChangedEvent.html +237 -0
- package/docs/interfaces/MKVideoQuality.html +268 -0
- package/docs/interfaces/MKVideoQualityChangedEvent.html +255 -0
- package/docs/interfaces/MKVideoQualityEvent.html +225 -0
- package/docs/interfaces/MKVideoSizeLimitationConfig.html +235 -0
- package/docs/interfaces/MKVideoTrack.html +240 -0
- package/docs/interfaces/MKViewModeChangedEvent.html +243 -0
- package/docs/interfaces/MKViewModeOptions.html +207 -0
- package/docs/interfaces/MKVolumeChangedEvent.html +245 -0
- package/docs/interfaces/MKWidevineModularDrmConfig.html +336 -0
- package/docs/modules.html +330 -0
- package/docs/types/MKBitrate.html +178 -0
- package/docs/types/MKRequestBodyParams.html +183 -0
- package/docs/types/MKRequestHeaders.html +183 -0
- package/docs/types/MKRequestQueryParams.html +183 -0
- package/package.json +15 -49
- package/samples/basic_playback.html +133 -0
- package/azure-pipelines.yml +0 -19
- package/dist/BufferLevel.d.ts +0 -4
- package/dist/LabelConfig.d.ts +0 -9
- package/dist/Logger.d.ts +0 -9
- package/dist/MKPlayer.d.ts +0 -31
- package/dist/MKPlayerConfiguration.d.ts +0 -15
- package/dist/MKStream.d.ts +0 -34
- package/dist/SubtitleTrack.d.ts +0 -4
- package/dist/URLHelper.d.ts +0 -5
- package/dist/events/MKEvent.d.ts +0 -16
- package/dist/events/MKPlayerEventCallback.d.ts +0 -4
- package/dist/events/UrlType.d.ts +0 -4
- package/dist/index.d.ts +0 -6
- package/dist/lib/BufferLevel.d.ts +0 -4
- package/dist/lib/BufferLevel.js +0 -3
- package/dist/lib/BufferLevel.js.map +0 -1
- package/dist/lib/LabelConfig.d.ts +0 -9
- package/dist/lib/LabelConfig.js +0 -3
- package/dist/lib/LabelConfig.js.map +0 -1
- package/dist/lib/Logger.d.ts +0 -9
- package/dist/lib/Logger.js +0 -72
- package/dist/lib/Logger.js.map +0 -1
- package/dist/lib/MKPlayer.d.ts +0 -31
- package/dist/lib/MKPlayer.js +0 -301
- package/dist/lib/MKPlayer.js.map +0 -1
- package/dist/lib/MKPlayerConfiguration.d.ts +0 -15
- package/dist/lib/MKPlayerConfiguration.js +0 -3
- package/dist/lib/MKPlayerConfiguration.js.map +0 -1
- package/dist/lib/MKStream.d.ts +0 -34
- package/dist/lib/MKStream.js +0 -126
- package/dist/lib/MKStream.js.map +0 -1
- package/dist/lib/SubtitleTrack.d.ts +0 -4
- package/dist/lib/SubtitleTrack.js +0 -3
- package/dist/lib/SubtitleTrack.js.map +0 -1
- package/dist/lib/URLHelper.d.ts +0 -5
- package/dist/lib/URLHelper.js +0 -63
- package/dist/lib/URLHelper.js.map +0 -1
- package/dist/lib/events/MKEvent.d.ts +0 -16
- package/dist/lib/events/MKEvent.js +0 -21
- package/dist/lib/events/MKEvent.js.map +0 -1
- package/dist/lib/events/MKPlayerEventCallback.d.ts +0 -4
- package/dist/lib/events/MKPlayerEventCallback.js +0 -3
- package/dist/lib/events/MKPlayerEventCallback.js.map +0 -1
- package/dist/lib/events/UrlType.d.ts +0 -4
- package/dist/lib/events/UrlType.js +0 -9
- package/dist/lib/events/UrlType.js.map +0 -1
- package/dist/lib/index.d.ts +0 -6
- package/dist/lib/index.js +0 -10
- package/dist/lib/index.js.map +0 -1
- package/dist/lib-esm/BufferLevel.d.ts +0 -4
- package/dist/lib-esm/BufferLevel.js +0 -2
- package/dist/lib-esm/BufferLevel.js.map +0 -1
- package/dist/lib-esm/LabelConfig.d.ts +0 -9
- package/dist/lib-esm/LabelConfig.js +0 -2
- package/dist/lib-esm/LabelConfig.js.map +0 -1
- package/dist/lib-esm/Logger.d.ts +0 -9
- package/dist/lib-esm/Logger.js +0 -69
- package/dist/lib-esm/Logger.js.map +0 -1
- package/dist/lib-esm/MKPlayer.d.ts +0 -31
- package/dist/lib-esm/MKPlayer.js +0 -298
- package/dist/lib-esm/MKPlayer.js.map +0 -1
- package/dist/lib-esm/MKPlayerConfiguration.d.ts +0 -15
- package/dist/lib-esm/MKPlayerConfiguration.js +0 -2
- package/dist/lib-esm/MKPlayerConfiguration.js.map +0 -1
- package/dist/lib-esm/MKStream.d.ts +0 -34
- package/dist/lib-esm/MKStream.js +0 -123
- package/dist/lib-esm/MKStream.js.map +0 -1
- package/dist/lib-esm/SubtitleTrack.d.ts +0 -4
- package/dist/lib-esm/SubtitleTrack.js +0 -2
- package/dist/lib-esm/SubtitleTrack.js.map +0 -1
- package/dist/lib-esm/URLHelper.d.ts +0 -5
- package/dist/lib-esm/URLHelper.js +0 -60
- package/dist/lib-esm/URLHelper.js.map +0 -1
- package/dist/lib-esm/events/MKEvent.d.ts +0 -16
- package/dist/lib-esm/events/MKEvent.js +0 -18
- package/dist/lib-esm/events/MKEvent.js.map +0 -1
- package/dist/lib-esm/events/MKPlayerEventCallback.d.ts +0 -4
- package/dist/lib-esm/events/MKPlayerEventCallback.js +0 -2
- package/dist/lib-esm/events/MKPlayerEventCallback.js.map +0 -1
- package/dist/lib-esm/events/UrlType.d.ts +0 -4
- package/dist/lib-esm/events/UrlType.js +0 -6
- package/dist/lib-esm/events/UrlType.js.map +0 -1
- package/dist/lib-esm/index.d.ts +0 -6
- package/dist/lib-esm/index.js +0 -4
- package/dist/lib-esm/index.js.map +0 -1
- package/dist/mkplayer.js +0 -1
- package/doc/assets/css/main.css +0 -1
- package/doc/assets/images/icons.png +0 -0
- package/doc/assets/images/icons@2x.png +0 -0
- package/doc/assets/images/widgets.png +0 -0
- package/doc/assets/images/widgets@2x.png +0 -0
- package/doc/assets/js/main.js +0 -51
- package/doc/assets/js/search.json +0 -1
- package/doc/classes/mkplayer.html +0 -677
- package/doc/enums/mkevent.html +0 -348
- package/doc/enums/urltype.html +0 -180
- package/doc/globals.html +0 -150
- package/doc/index.html +0 -347
- package/doc/interfaces/bufferlevel.html +0 -143
- package/doc/interfaces/labelconfig.html +0 -198
- package/doc/interfaces/mkplayereventcallback.html +0 -170
- package/doc/interfaces/subtitletrack.html +0 -198
- package/index.html +0 -575
- package/mk_logo.png +0 -0
- package/mkplayer-ui.min.css +0 -2
- package/multi-camera.html +0 -391
- package/src/BufferLevel.ts +0 -7
- package/src/LabelConfig.ts +0 -20
- package/src/Logger.ts +0 -51
- package/src/MKPlayer.ts +0 -402
- package/src/MKPlayerConfiguration.ts +0 -51
- package/src/MKStream.ts +0 -154
- package/src/SubtitleTrack.ts +0 -14
- package/src/URLHelper.ts +0 -71
- package/src/events/MKEvent.ts +0 -19
- package/src/events/MKPlayerEventCallback.ts +0 -8
- package/src/events/UrlType.ts +0 -7
- package/src/index.ts +0 -6
- package/tsconfig.json +0 -20
- package/tslint.json +0 -72
- package/typedoc.json +0 -11
- /package/{favicon.ico → samples/favicon.ico} +0 -0
|
@@ -0,0 +1,1459 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MKPlayerAPI | MKPlayer - v1.1.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/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container">
|
|
3
|
+
<div class="table-cell" id="tsd-search" data-base="..">
|
|
4
|
+
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
5
|
+
<div class="field">
|
|
6
|
+
<div id="tsd-toolbar-links"></div></div>
|
|
7
|
+
<ul class="results">
|
|
8
|
+
<li class="state loading">Preparing search index...</li>
|
|
9
|
+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">MKPlayer - v1.1.0</a></div>
|
|
10
|
+
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
11
|
+
<div class="container container-main">
|
|
12
|
+
<div class="col-content">
|
|
13
|
+
<div class="tsd-page-title">
|
|
14
|
+
<ul class="tsd-breadcrumb">
|
|
15
|
+
<li><a href="../modules.html">MKPlayer</a></li>
|
|
16
|
+
<li><a href="MKPlayerAPI.html">MKPlayerAPI</a></li></ul>
|
|
17
|
+
<h1>Interface MKPlayerAPI</h1></div>
|
|
18
|
+
<section class="tsd-panel tsd-comment">
|
|
19
|
+
<div class="tsd-comment tsd-typography"><p>MKPlayer API.</p>
|
|
20
|
+
</div>
|
|
21
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
22
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
23
|
+
<h4>Hierarchy</h4>
|
|
24
|
+
<ul class="tsd-hierarchy">
|
|
25
|
+
<li><span class="target">MKPlayerAPI</span></li></ul></section>
|
|
26
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
27
|
+
<section class="tsd-panel tsd-index-panel">
|
|
28
|
+
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
29
|
+
<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"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
30
|
+
<div class="tsd-accordion-details">
|
|
31
|
+
<section class="tsd-index-section">
|
|
32
|
+
<h3 class="tsd-index-heading">Methods</h3>
|
|
33
|
+
<div class="tsd-index-list"><a href="MKPlayerAPI.html#addCastMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>add<wbr/>Cast<wbr/>Metadata</span></a>
|
|
34
|
+
<a href="MKPlayerAPI.html#addSubtitle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Subtitle</span></a>
|
|
35
|
+
<a href="MKPlayerAPI.html#castStop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>cast<wbr/>Stop</span></a>
|
|
36
|
+
<a href="MKPlayerAPI.html#castVideo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>cast<wbr/>Video</span></a>
|
|
37
|
+
<a href="MKPlayerAPI.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a>
|
|
38
|
+
<a href="MKPlayerAPI.html#disableSubtitle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disable<wbr/>Subtitle</span></a>
|
|
39
|
+
<a href="MKPlayerAPI.html#enableSubtitle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Subtitle</span></a>
|
|
40
|
+
<a href="MKPlayerAPI.html#getAspectRatio" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Aspect<wbr/>Ratio</span></a>
|
|
41
|
+
<a href="MKPlayerAPI.html#getAudio" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Audio</span></a>
|
|
42
|
+
<a href="MKPlayerAPI.html#getAudioQuality" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Quality</span></a>
|
|
43
|
+
<a href="MKPlayerAPI.html#getAvailableAudio" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Audio</span></a>
|
|
44
|
+
<a href="MKPlayerAPI.html#getAvailableAudioQualities" class="tsd-index-link"><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>
|
|
45
|
+
<a href="MKPlayerAPI.html#getAvailableSubtitles" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Subtitles</span></a>
|
|
46
|
+
<a href="MKPlayerAPI.html#getAvailableVideoQualities" class="tsd-index-link"><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>
|
|
47
|
+
<a href="MKPlayerAPI.html#getBufferLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Buffer<wbr/>Level</span></a>
|
|
48
|
+
<a href="MKPlayerAPI.html#getBufferedRanges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Buffered<wbr/>Ranges</span></a>
|
|
49
|
+
<a href="MKPlayerAPI.html#getCatchupConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Catchup<wbr/>Config</span></a>
|
|
50
|
+
<a href="MKPlayerAPI.html#getCurrentTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Current<wbr/>Time</span></a>
|
|
51
|
+
<a href="MKPlayerAPI.html#getDownloadedAudioData" class="tsd-index-link"><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>
|
|
52
|
+
<a href="MKPlayerAPI.html#getDownloadedVideoData" class="tsd-index-link"><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>
|
|
53
|
+
<a href="MKPlayerAPI.html#getDroppedVideoFrames" class="tsd-index-link"><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>
|
|
54
|
+
<a href="MKPlayerAPI.html#getDuration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Duration</span></a>
|
|
55
|
+
<a href="MKPlayerAPI.html#getFallbackConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Fallback<wbr/>Config</span></a>
|
|
56
|
+
<a href="MKPlayerAPI.html#getLatency" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Latency</span></a>
|
|
57
|
+
<a href="MKPlayerAPI.html#getMaxTimeShift" class="tsd-index-link"><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>
|
|
58
|
+
<a href="MKPlayerAPI.html#getPlaybackAudioData" class="tsd-index-link"><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>
|
|
59
|
+
<a href="MKPlayerAPI.html#getPlaybackSpeed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Playback<wbr/>Speed</span></a>
|
|
60
|
+
<a href="MKPlayerAPI.html#getPlaybackVideoData" class="tsd-index-link"><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>
|
|
61
|
+
<a href="MKPlayerAPI.html#getSeekableRange" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Seekable<wbr/>Range</span></a>
|
|
62
|
+
<a href="MKPlayerAPI.html#getTargetLatency" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Target<wbr/>Latency</span></a>
|
|
63
|
+
<a href="MKPlayerAPI.html#getThumbnail" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Thumbnail</span></a>
|
|
64
|
+
<a href="MKPlayerAPI.html#getTimeShift" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Time<wbr/>Shift</span></a>
|
|
65
|
+
<a href="MKPlayerAPI.html#getTotalStalledTime" class="tsd-index-link"><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>
|
|
66
|
+
<a href="MKPlayerAPI.html#getVideoContainer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Container</span></a>
|
|
67
|
+
<a href="MKPlayerAPI.html#getVideoElement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Element</span></a>
|
|
68
|
+
<a href="MKPlayerAPI.html#getVideoQuality" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Video<wbr/>Quality</span></a>
|
|
69
|
+
<a href="MKPlayerAPI.html#getViewMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>View<wbr/>Mode</span></a>
|
|
70
|
+
<a href="MKPlayerAPI.html#getVolume" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Volume</span></a>
|
|
71
|
+
<a href="MKPlayerAPI.html#hasEnded" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Ended</span></a>
|
|
72
|
+
<a href="MKPlayerAPI.html#isAirplayActive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Airplay<wbr/>Active</span></a>
|
|
73
|
+
<a href="MKPlayerAPI.html#isAirplayAvailable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Airplay<wbr/>Available</span></a>
|
|
74
|
+
<a href="MKPlayerAPI.html#isCastAvailable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Cast<wbr/>Available</span></a>
|
|
75
|
+
<a href="MKPlayerAPI.html#isCasting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Casting</span></a>
|
|
76
|
+
<a href="MKPlayerAPI.html#isLive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Live</span></a>
|
|
77
|
+
<a href="MKPlayerAPI.html#isMuted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Muted</span></a>
|
|
78
|
+
<a href="MKPlayerAPI.html#isPaused" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Paused</span></a>
|
|
79
|
+
<a href="MKPlayerAPI.html#isPlaying" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Playing</span></a>
|
|
80
|
+
<a href="MKPlayerAPI.html#isStalled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Stalled</span></a>
|
|
81
|
+
<a href="MKPlayerAPI.html#isViewModeAvailable" class="tsd-index-link"><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>
|
|
82
|
+
<a href="MKPlayerAPI.html#load" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load</span></a>
|
|
83
|
+
<a href="MKPlayerAPI.html#mute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a>
|
|
84
|
+
<a href="MKPlayerAPI.html#off" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a>
|
|
85
|
+
<a href="MKPlayerAPI.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
|
|
86
|
+
<a href="MKPlayerAPI.html#pause" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a>
|
|
87
|
+
<a href="MKPlayerAPI.html#play" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>play</span></a>
|
|
88
|
+
<a href="MKPlayerAPI.html#preload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>preload</span></a>
|
|
89
|
+
<a href="MKPlayerAPI.html#removeSubtitle" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Subtitle</span></a>
|
|
90
|
+
<a href="MKPlayerAPI.html#seek" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>seek</span></a>
|
|
91
|
+
<a href="MKPlayerAPI.html#seekToLiveEdge" class="tsd-index-link"><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>
|
|
92
|
+
<a href="MKPlayerAPI.html#setAspectRatio" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Aspect<wbr/>Ratio</span></a>
|
|
93
|
+
<a href="MKPlayerAPI.html#setAudio" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Audio</span></a>
|
|
94
|
+
<a href="MKPlayerAPI.html#setAudioQuality" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Audio<wbr/>Quality</span></a>
|
|
95
|
+
<a href="MKPlayerAPI.html#setAuthorizationToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Authorization<wbr/>Token</span></a>
|
|
96
|
+
<a href="MKPlayerAPI.html#setCatchupConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Catchup<wbr/>Config</span></a>
|
|
97
|
+
<a href="MKPlayerAPI.html#setFallbackConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Fallback<wbr/>Config</span></a>
|
|
98
|
+
<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>
|
|
99
|
+
<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>
|
|
100
|
+
<a href="MKPlayerAPI.html#setLogLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Log<wbr/>Level</span></a>
|
|
101
|
+
<a href="MKPlayerAPI.html#setPlaybackSpeed" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Playback<wbr/>Speed</span></a>
|
|
102
|
+
<a href="MKPlayerAPI.html#setPosterImage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Poster<wbr/>Image</span></a>
|
|
103
|
+
<a href="MKPlayerAPI.html#setTargetBufferLevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Target<wbr/>Buffer<wbr/>Level</span></a>
|
|
104
|
+
<a href="MKPlayerAPI.html#setTargetLatency" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Target<wbr/>Latency</span></a>
|
|
105
|
+
<a href="MKPlayerAPI.html#setVideoElement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Element</span></a>
|
|
106
|
+
<a href="MKPlayerAPI.html#setVideoQuality" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Video<wbr/>Quality</span></a>
|
|
107
|
+
<a href="MKPlayerAPI.html#setViewMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>View<wbr/>Mode</span></a>
|
|
108
|
+
<a href="MKPlayerAPI.html#setVolume" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Volume</span></a>
|
|
109
|
+
<a href="MKPlayerAPI.html#showAirplayTargetPicker" class="tsd-index-link"><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>
|
|
110
|
+
<a href="MKPlayerAPI.html#unload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unload</span></a>
|
|
111
|
+
<a href="MKPlayerAPI.html#unmute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a>
|
|
112
|
+
</div></section></div></details></section></section>
|
|
113
|
+
<section class="tsd-panel-group tsd-member-group">
|
|
114
|
+
<h2>Methods</h2>
|
|
115
|
+
<section class="tsd-panel tsd-member"><a id="addCastMetadata" class="tsd-anchor"></a>
|
|
116
|
+
<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"><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>
|
|
117
|
+
<ul class="tsd-signatures">
|
|
118
|
+
<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>
|
|
119
|
+
<li class="tsd-description">
|
|
120
|
+
<div class="tsd-comment tsd-typography"><p>Sends custom metadata to a remote receiver app (e.g. Chromecast).</p>
|
|
121
|
+
</div>
|
|
122
|
+
<div class="tsd-parameters">
|
|
123
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
124
|
+
<ul class="tsd-parameter-list">
|
|
125
|
+
<li>
|
|
126
|
+
<h5><span class="tsd-kind-parameter">metadata</span>: <span class="tsd-signature-type">any</span></h5>
|
|
127
|
+
<div class="tsd-comment tsd-typography"><p>the custom metadata to send to the receiver.</p>
|
|
128
|
+
</div>
|
|
129
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
130
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if it was successful.</p>
|
|
131
|
+
|
|
132
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
133
|
+
<section class="tsd-panel tsd-member"><a id="addSubtitle" class="tsd-anchor"></a>
|
|
134
|
+
<h3 class="tsd-anchor-link"><span>add<wbr/>Subtitle</span><a href="#addSubtitle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
135
|
+
<ul class="tsd-signatures">
|
|
136
|
+
<li class="tsd-signature tsd-anchor-link" id="addSubtitle.addSubtitle-1"><span class="tsd-kind-call-signature">add<wbr/>Subtitle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subtitleTrack</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addSubtitle.addSubtitle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
137
|
+
<li class="tsd-description">
|
|
138
|
+
<div class="tsd-comment tsd-typography"><p>Adds a subtitle track.</p>
|
|
139
|
+
<p><a href="MKSubtitleTrack.html#isFragmented" class="tsd-kind-property">isFragmented</a> type of subtitle tracks are not supported when added via this method.</p>
|
|
140
|
+
</div>
|
|
141
|
+
<div class="tsd-parameters">
|
|
142
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
143
|
+
<ul class="tsd-parameter-list">
|
|
144
|
+
<li>
|
|
145
|
+
<h5><span class="tsd-kind-parameter">subtitleTrack</span>: <a href="MKSubtitleTrack.html" class="tsd-signature-type tsd-kind-interface">MKSubtitleTrack</a></h5></li></ul></div>
|
|
146
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
147
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
148
|
+
<section class="tsd-panel tsd-member"><a id="castStop" class="tsd-anchor"></a>
|
|
149
|
+
<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>
|
|
150
|
+
<ul class="tsd-signatures">
|
|
151
|
+
<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>
|
|
152
|
+
<li class="tsd-description">
|
|
153
|
+
<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>
|
|
154
|
+
<p>Has no effect if <a href="MKPlayerAPI.html#isCasting" class="tsd-kind-method">isCasting</a> returns false.</p>
|
|
155
|
+
</div>
|
|
156
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
157
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
158
|
+
<section class="tsd-panel tsd-member"><a id="castVideo" class="tsd-anchor"></a>
|
|
159
|
+
<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>
|
|
160
|
+
<ul class="tsd-signatures">
|
|
161
|
+
<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>
|
|
162
|
+
<li class="tsd-description">
|
|
163
|
+
<div class="tsd-comment tsd-typography"><p>Initiates casting the current video to a Cast-compatible device.</p>
|
|
164
|
+
<p>The user has to choose the target device.</p>
|
|
165
|
+
</div>
|
|
166
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
167
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
168
|
+
<section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a>
|
|
169
|
+
<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>
|
|
170
|
+
<ul class="tsd-signatures">
|
|
171
|
+
<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>
|
|
172
|
+
<li class="tsd-description">
|
|
173
|
+
<div class="tsd-comment tsd-typography"><p>Unloads the player and removes all inserted HTML elements and event handlers.</p>
|
|
174
|
+
</div>
|
|
175
|
+
<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>
|
|
176
|
+
|
|
177
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
178
|
+
<section class="tsd-panel tsd-member"><a id="disableSubtitle" class="tsd-anchor"></a>
|
|
179
|
+
<h3 class="tsd-anchor-link"><span>disable<wbr/>Subtitle</span><a href="#disableSubtitle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
180
|
+
<ul class="tsd-signatures">
|
|
181
|
+
<li class="tsd-signature tsd-anchor-link" id="disableSubtitle.disableSubtitle-1"><span class="tsd-kind-call-signature">disable<wbr/>Subtitle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subtitleID</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#disableSubtitle.disableSubtitle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
182
|
+
<li class="tsd-description">
|
|
183
|
+
<div class="tsd-comment tsd-typography"><p>Disables an already enabled subtitle track.</p>
|
|
184
|
+
</div>
|
|
185
|
+
<div class="tsd-parameters">
|
|
186
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
187
|
+
<ul class="tsd-parameter-list">
|
|
188
|
+
<li>
|
|
189
|
+
<h5><span class="tsd-kind-parameter">subtitleID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
190
|
+
<div class="tsd-comment tsd-typography"><p>the subtitle track identifier.</p>
|
|
191
|
+
</div>
|
|
192
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
193
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
194
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
195
|
+
<section class="tsd-panel tsd-member"><a id="enableSubtitle" class="tsd-anchor"></a>
|
|
196
|
+
<h3 class="tsd-anchor-link"><span>enable<wbr/>Subtitle</span><a href="#enableSubtitle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
197
|
+
<ul class="tsd-signatures">
|
|
198
|
+
<li class="tsd-signature tsd-anchor-link" id="enableSubtitle.enableSubtitle-1"><span class="tsd-kind-call-signature">enable<wbr/>Subtitle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subtitleID</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#enableSubtitle.enableSubtitle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
199
|
+
<li class="tsd-description">
|
|
200
|
+
<div class="tsd-comment tsd-typography"><p>Enables a subtitle track.</p>
|
|
201
|
+
</div>
|
|
202
|
+
<div class="tsd-parameters">
|
|
203
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
204
|
+
<ul class="tsd-parameter-list">
|
|
205
|
+
<li>
|
|
206
|
+
<h5><span class="tsd-kind-parameter">subtitleID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
207
|
+
<div class="tsd-comment tsd-typography"><p>the subtitle track identifier.</p>
|
|
208
|
+
</div>
|
|
209
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
210
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
211
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
212
|
+
<section class="tsd-panel tsd-member"><a id="getAspectRatio" class="tsd-anchor"></a>
|
|
213
|
+
<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>
|
|
214
|
+
<ul class="tsd-signatures">
|
|
215
|
+
<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>
|
|
216
|
+
<li class="tsd-description">
|
|
217
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current aspect ratio of the player, or 0 if there is no style module.</p>
|
|
218
|
+
<p>Note: the default player aspect ratio is 16:9.</p>
|
|
219
|
+
</div>
|
|
220
|
+
<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>
|
|
221
|
+
|
|
222
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
223
|
+
<section class="tsd-panel tsd-member"><a id="getAudio" class="tsd-anchor"></a>
|
|
224
|
+
<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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
225
|
+
<ul class="tsd-signatures">
|
|
226
|
+
<li class="tsd-signature tsd-anchor-link" id="getAudio.getAudio-1"><span class="tsd-kind-call-signature">get<wbr/>Audio</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="MKAudioTrack.html" class="tsd-signature-type tsd-kind-interface">MKAudioTrack</a><a href="#getAudio.getAudio-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
227
|
+
<li class="tsd-description">
|
|
228
|
+
<div class="tsd-comment tsd-typography"><p>Returns the currently used audio track, or null if no track is active.</p>
|
|
229
|
+
</div>
|
|
230
|
+
<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>
|
|
231
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
232
|
+
<section class="tsd-panel tsd-member"><a id="getAudioQuality" class="tsd-anchor"></a>
|
|
233
|
+
<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>
|
|
234
|
+
<ul class="tsd-signatures">
|
|
235
|
+
<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><span class="tsd-signature-type">null</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>
|
|
236
|
+
<li class="tsd-description">
|
|
237
|
+
<div class="tsd-comment tsd-typography"><p>Returns the currently selected audio quality.</p>
|
|
238
|
+
<p>One of the elements of <a href="MKPlayerAPI.html#getAvailableAudioQualities" class="tsd-kind-method">getAvailableAudioQualities</a>.</p>
|
|
239
|
+
</div>
|
|
240
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a></h4>
|
|
241
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
242
|
+
<section class="tsd-panel tsd-member"><a id="getAvailableAudio" class="tsd-anchor"></a>
|
|
243
|
+
<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>
|
|
244
|
+
<ul class="tsd-signatures">
|
|
245
|
+
<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>
|
|
246
|
+
<li class="tsd-description">
|
|
247
|
+
<div class="tsd-comment tsd-typography"><p>Returns an array of all available audio tracks.</p>
|
|
248
|
+
</div>
|
|
249
|
+
<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>
|
|
250
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
251
|
+
<section class="tsd-panel tsd-member"><a id="getAvailableAudioQualities" class="tsd-anchor"></a>
|
|
252
|
+
<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>
|
|
253
|
+
<ul class="tsd-signatures">
|
|
254
|
+
<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>
|
|
255
|
+
<li class="tsd-description">
|
|
256
|
+
<div class="tsd-comment tsd-typography"><p>Returns an array of all available audio qualities the player can adapt between.</p>
|
|
257
|
+
</div>
|
|
258
|
+
<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>
|
|
259
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
260
|
+
<section class="tsd-panel tsd-member"><a id="getAvailableSubtitles" class="tsd-anchor"></a>
|
|
261
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Available<wbr/>Subtitles</span><a href="#getAvailableSubtitles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
262
|
+
<ul class="tsd-signatures">
|
|
263
|
+
<li class="tsd-signature tsd-anchor-link" id="getAvailableSubtitles.getAvailableSubtitles-1"><span class="tsd-kind-call-signature">get<wbr/>Available<wbr/>Subtitles</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MKSubtitleTrack.html" class="tsd-signature-type tsd-kind-interface">MKSubtitleTrack</a><span class="tsd-signature-symbol">[]</span><a href="#getAvailableSubtitles.getAvailableSubtitles-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
264
|
+
<li class="tsd-description">
|
|
265
|
+
<div class="tsd-comment tsd-typography"><p>Get list of all available subtitle tracks.</p>
|
|
266
|
+
</div>
|
|
267
|
+
<h4 class="tsd-returns-title">Returns <a href="MKSubtitleTrack.html" class="tsd-signature-type tsd-kind-interface">MKSubtitleTrack</a><span class="tsd-signature-symbol">[]</span></h4><p>list of available subtitle tracks when available or an empty array when not available.</p>
|
|
268
|
+
|
|
269
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
270
|
+
<section class="tsd-panel tsd-member"><a id="getAvailableVideoQualities" class="tsd-anchor"></a>
|
|
271
|
+
<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>
|
|
272
|
+
<ul class="tsd-signatures">
|
|
273
|
+
<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>
|
|
274
|
+
<li class="tsd-description">
|
|
275
|
+
<div class="tsd-comment tsd-typography"><p>Returns an array containing all available video qualities the player can adapt between.</p>
|
|
276
|
+
</div>
|
|
277
|
+
<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>
|
|
278
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
279
|
+
<section class="tsd-panel tsd-member"><a id="getBufferLevel" class="tsd-anchor"></a>
|
|
280
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Buffer<wbr/>Level</span><a href="#getBufferLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
281
|
+
<ul class="tsd-signatures">
|
|
282
|
+
<li class="tsd-signature tsd-anchor-link" id="getBufferLevel.getBufferLevel-1"><span class="tsd-kind-call-signature">get<wbr/>Buffer<wbr/>Level</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">media</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="MKBufferLevel.html" class="tsd-signature-type tsd-kind-interface">MKBufferLevel</a><a href="#getBufferLevel.getBufferLevel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
283
|
+
<li class="tsd-description">
|
|
284
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current and target buffer level for the given buffer type and media type.</p>
|
|
285
|
+
</div>
|
|
286
|
+
<div class="tsd-parameters">
|
|
287
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
288
|
+
<ul class="tsd-parameter-list">
|
|
289
|
+
<li>
|
|
290
|
+
<h5><span class="tsd-kind-parameter">type</span>: <a href="../enums/MKBufferType.html" class="tsd-signature-type tsd-kind-enum">MKBufferType</a></h5>
|
|
291
|
+
<div class="tsd-comment tsd-typography"><p>the buffer type for which to get the buffer level for.</p>
|
|
292
|
+
</div>
|
|
293
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
294
|
+
<li>
|
|
295
|
+
<h5><span class="tsd-kind-parameter">media</span>: <a href="../enums/MKMediaType.html" class="tsd-signature-type tsd-kind-enum">MKMediaType</a></h5>
|
|
296
|
+
<div class="tsd-comment tsd-typography"><p>the media type for which to get the buffer level for.</p>
|
|
297
|
+
</div>
|
|
298
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
299
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKBufferLevel.html" class="tsd-signature-type tsd-kind-interface">MKBufferLevel</a></h4><p>the buffer level object or null in case of error.</p>
|
|
300
|
+
|
|
301
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
302
|
+
<section class="tsd-panel tsd-member"><a id="getBufferedRanges" class="tsd-anchor"></a>
|
|
303
|
+
<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>
|
|
304
|
+
<ul class="tsd-signatures">
|
|
305
|
+
<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>
|
|
306
|
+
<li class="tsd-description">
|
|
307
|
+
<div class="tsd-comment tsd-typography"><p>Returns the currently buffered time ranges of the video element.</p>
|
|
308
|
+
</div>
|
|
309
|
+
<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>
|
|
310
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
311
|
+
<section class="tsd-panel tsd-member"><a id="getCatchupConfig" class="tsd-anchor"></a>
|
|
312
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Catchup<wbr/>Config</span><a href="#getCatchupConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
313
|
+
<ul class="tsd-signatures">
|
|
314
|
+
<li class="tsd-signature tsd-anchor-link" id="getCatchupConfig.getCatchupConfig-1"><span class="tsd-kind-call-signature">get<wbr/>Catchup<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><a href="MKLowLatencySyncConfig.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencySyncConfig</a><a href="#getCatchupConfig.getCatchupConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
315
|
+
<li class="tsd-description">
|
|
316
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current latency sync configuration for catchup.</p>
|
|
317
|
+
</div>
|
|
318
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKLowLatencySyncConfig.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencySyncConfig</a></h4><p>the catchup sync configuration.</p>
|
|
319
|
+
|
|
320
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
321
|
+
<section class="tsd-panel tsd-member"><a id="getCurrentTime" class="tsd-anchor"></a>
|
|
322
|
+
<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>
|
|
323
|
+
<ul class="tsd-signatures">
|
|
324
|
+
<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>
|
|
325
|
+
<li class="tsd-description">
|
|
326
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current playback time in seconds of the video.</p>
|
|
327
|
+
</div>
|
|
328
|
+
<div class="tsd-parameters">
|
|
329
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
330
|
+
<ul class="tsd-parameter-list">
|
|
331
|
+
<li>
|
|
332
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">mode</span>: <a href="../enums/MKTimeMode.html" class="tsd-signature-type tsd-kind-enum">MKTimeMode</a></h5>
|
|
333
|
+
<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>
|
|
334
|
+
<p>Default mode is absolute.</p>
|
|
335
|
+
</div>
|
|
336
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
337
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
338
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
339
|
+
<section class="tsd-panel tsd-member"><a id="getDownloadedAudioData" class="tsd-anchor"></a>
|
|
340
|
+
<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>
|
|
341
|
+
<ul class="tsd-signatures">
|
|
342
|
+
<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><span class="tsd-signature-type">null</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>
|
|
343
|
+
<li class="tsd-description">
|
|
344
|
+
<div class="tsd-comment tsd-typography"><p>Returns data about the last downloaded audio segment.</p>
|
|
345
|
+
</div>
|
|
346
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKDownloadedAudioData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedAudioData</a></h4>
|
|
347
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
348
|
+
<section class="tsd-panel tsd-member"><a id="getDownloadedVideoData" class="tsd-anchor"></a>
|
|
349
|
+
<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>
|
|
350
|
+
<ul class="tsd-signatures">
|
|
351
|
+
<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><span class="tsd-signature-type">null</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>
|
|
352
|
+
<li class="tsd-description">
|
|
353
|
+
<div class="tsd-comment tsd-typography"><p>Returns data about the last downloaded video segment.</p>
|
|
354
|
+
</div>
|
|
355
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKDownloadedVideoData.html" class="tsd-signature-type tsd-kind-interface">MKDownloadedVideoData</a></h4>
|
|
356
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
357
|
+
<section class="tsd-panel tsd-member"><a id="getDroppedVideoFrames" class="tsd-anchor"></a>
|
|
358
|
+
<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>
|
|
359
|
+
<ul class="tsd-signatures">
|
|
360
|
+
<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>
|
|
361
|
+
<li class="tsd-description">
|
|
362
|
+
<div class="tsd-comment tsd-typography"><p>Returns the total number of dropped video frames since playback started.</p>
|
|
363
|
+
</div>
|
|
364
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
365
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
366
|
+
<section class="tsd-panel tsd-member"><a id="getDuration" class="tsd-anchor"></a>
|
|
367
|
+
<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>
|
|
368
|
+
<ul class="tsd-signatures">
|
|
369
|
+
<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>
|
|
370
|
+
<li class="tsd-description">
|
|
371
|
+
<div class="tsd-comment tsd-typography"><p>Returns the total duration in seconds of the current video.</p>
|
|
372
|
+
</div>
|
|
373
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
374
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
375
|
+
<section class="tsd-panel tsd-member"><a id="getFallbackConfig" class="tsd-anchor"></a>
|
|
376
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Fallback<wbr/>Config</span><a href="#getFallbackConfig" 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">
|
|
378
|
+
<li class="tsd-signature tsd-anchor-link" id="getFallbackConfig.getFallbackConfig-1"><span class="tsd-kind-call-signature">get<wbr/>Fallback<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><a href="MKLowLatencySyncConfig.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencySyncConfig</a><a href="#getFallbackConfig.getFallbackConfig-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 the current latency sync configuration for fallback.</p>
|
|
381
|
+
</div>
|
|
382
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKLowLatencySyncConfig.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencySyncConfig</a></h4><p>the fallback sync configuration.</p>
|
|
383
|
+
|
|
384
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
385
|
+
<section class="tsd-panel tsd-member"><a id="getLatency" class="tsd-anchor"></a>
|
|
386
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Latency</span><a href="#getLatency" 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">
|
|
388
|
+
<li class="tsd-signature tsd-anchor-link" id="getLatency.getLatency-1"><span class="tsd-kind-call-signature">get<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="#getLatency.getLatency-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 the current latency in seconds.</p>
|
|
391
|
+
</div>
|
|
392
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>the current latency in seconds.</p>
|
|
393
|
+
|
|
394
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
395
|
+
<section class="tsd-panel tsd-member"><a id="getMaxTimeShift" class="tsd-anchor"></a>
|
|
396
|
+
<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>
|
|
397
|
+
<ul class="tsd-signatures">
|
|
398
|
+
<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>
|
|
399
|
+
<li class="tsd-description">
|
|
400
|
+
<div class="tsd-comment tsd-typography"><p>Returns the limit in seconds for time shift. Is either negative or 0 and applicable to live streams only.</p>
|
|
401
|
+
</div>
|
|
402
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
403
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
404
|
+
<section class="tsd-panel tsd-member"><a id="getPlaybackAudioData" class="tsd-anchor"></a>
|
|
405
|
+
<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>
|
|
406
|
+
<ul class="tsd-signatures">
|
|
407
|
+
<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><span class="tsd-signature-type">null</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>
|
|
408
|
+
<li class="tsd-description">
|
|
409
|
+
<div class="tsd-comment tsd-typography"><p>Returns data about the currently playing audio segment.</p>
|
|
410
|
+
</div>
|
|
411
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKAudioQuality.html" class="tsd-signature-type tsd-kind-interface">MKAudioQuality</a></h4>
|
|
412
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
413
|
+
<section class="tsd-panel tsd-member"><a id="getPlaybackSpeed" class="tsd-anchor"></a>
|
|
414
|
+
<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>
|
|
415
|
+
<ul class="tsd-signatures">
|
|
416
|
+
<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>
|
|
417
|
+
<li class="tsd-description">
|
|
418
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current playback speed of the player.</p>
|
|
419
|
+
<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>
|
|
420
|
+
<p>Values less or equal zero are ignored.</p>
|
|
421
|
+
</div>
|
|
422
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
423
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
424
|
+
<section class="tsd-panel tsd-member"><a id="getPlaybackVideoData" class="tsd-anchor"></a>
|
|
425
|
+
<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>
|
|
426
|
+
<ul class="tsd-signatures">
|
|
427
|
+
<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><span class="tsd-signature-type">null</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>
|
|
428
|
+
<li class="tsd-description">
|
|
429
|
+
<div class="tsd-comment tsd-typography"><p>Returns data about the currently playing video segment.</p>
|
|
430
|
+
</div>
|
|
431
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a></h4>
|
|
432
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
433
|
+
<section class="tsd-panel tsd-member"><a id="getSeekableRange" class="tsd-anchor"></a>
|
|
434
|
+
<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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
435
|
+
<ul class="tsd-signatures">
|
|
436
|
+
<li class="tsd-signature tsd-anchor-link" id="getSeekableRange.getSeekableRange-1"><span class="tsd-kind-call-signature">get<wbr/>Seekable<wbr/>Range</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">null</span><span class="tsd-signature-symbol"> | </span><a href="MKTimeRange.html" class="tsd-signature-type tsd-kind-interface">MKTimeRange</a><a href="#getSeekableRange.getSeekableRange-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
437
|
+
<li class="tsd-description">
|
|
438
|
+
<div class="tsd-comment tsd-typography"><p>Returns the time range that is currently valid for seeking.</p>
|
|
439
|
+
<p><strong>Note</strong> For VOD default mode is <a href="../enums/MKTimeMode.html#RelativeTime" class="tsd-kind-enum-member">RelativeTime</a> and for Live it is <a href="../enums/MKTimeMode.html#AbsoluteTime" class="tsd-kind-enum-member">AbsoluteTime</a>.</p>
|
|
440
|
+
</div>
|
|
441
|
+
<div class="tsd-parameters">
|
|
442
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
443
|
+
<ul class="tsd-parameter-list">
|
|
444
|
+
<li>
|
|
445
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">mode</span>: <a href="../enums/MKTimeMode.html" class="tsd-signature-type tsd-kind-enum">MKTimeMode</a></h5>
|
|
446
|
+
<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>
|
|
447
|
+
</div>
|
|
448
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
449
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><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>
|
|
450
|
+
|
|
451
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
452
|
+
<section class="tsd-panel tsd-member"><a id="getTargetLatency" class="tsd-anchor"></a>
|
|
453
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Target<wbr/>Latency</span><a href="#getTargetLatency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
454
|
+
<ul class="tsd-signatures">
|
|
455
|
+
<li class="tsd-signature tsd-anchor-link" id="getTargetLatency.getTargetLatency-1"><span class="tsd-kind-call-signature">get<wbr/>Target<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="#getTargetLatency.getTargetLatency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
456
|
+
<li class="tsd-description">
|
|
457
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current target latency in seconds.</p>
|
|
458
|
+
</div>
|
|
459
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>target latency in seconds.</p>
|
|
460
|
+
|
|
461
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
462
|
+
<section class="tsd-panel tsd-member"><a id="getThumbnail" class="tsd-anchor"></a>
|
|
463
|
+
<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>
|
|
464
|
+
<ul class="tsd-signatures">
|
|
465
|
+
<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>
|
|
466
|
+
<li class="tsd-description">
|
|
467
|
+
<div class="tsd-comment tsd-typography"><p>Returns a thumbnail image for a certain time or null if there is no thumbnail available.</p>
|
|
468
|
+
<p>Requires a configured thumbnails track in <a href="MKSourceConfig.html#thumbnailTrack" class="tsd-kind-property">thumbnailTrack</a> if sideloaded thumbnails are configured.</p>
|
|
469
|
+
<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>
|
|
470
|
+
<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>
|
|
471
|
+
</div>
|
|
472
|
+
<div class="tsd-parameters">
|
|
473
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
474
|
+
<ul class="tsd-parameter-list">
|
|
475
|
+
<li>
|
|
476
|
+
<h5><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5>
|
|
477
|
+
<div class="tsd-comment tsd-typography"><p>the media time for which the thumbnail should be returned.</p>
|
|
478
|
+
</div>
|
|
479
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
480
|
+
<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>
|
|
481
|
+
|
|
482
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
483
|
+
<section class="tsd-panel tsd-member"><a id="getTimeShift" class="tsd-anchor"></a>
|
|
484
|
+
<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>
|
|
485
|
+
<ul class="tsd-signatures">
|
|
486
|
+
<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>
|
|
487
|
+
<li class="tsd-description">
|
|
488
|
+
<div class="tsd-comment tsd-typography"><p>Returns the current time shift offset to the live edge in seconds. Only applicable to live streams.</p>
|
|
489
|
+
</div>
|
|
490
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
491
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
492
|
+
<section class="tsd-panel tsd-member"><a id="getTotalStalledTime" class="tsd-anchor"></a>
|
|
493
|
+
<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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
494
|
+
<ul class="tsd-signatures">
|
|
495
|
+
<li class="tsd-signature tsd-anchor-link" id="getTotalStalledTime.getTotalStalledTime-1"><span class="tsd-kind-call-signature">get<wbr/>Total<wbr/>Stalled<wbr/>Time</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="#getTotalStalledTime.getTotalStalledTime-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
496
|
+
<li class="tsd-description">
|
|
497
|
+
<div class="tsd-comment tsd-typography"><p>Returns the stalled time in seconds since playback started.</p>
|
|
498
|
+
</div>
|
|
499
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
500
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
501
|
+
<section class="tsd-panel tsd-member"><a id="getVideoContainer" class="tsd-anchor"></a>
|
|
502
|
+
<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>
|
|
503
|
+
<ul class="tsd-signatures">
|
|
504
|
+
<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>
|
|
505
|
+
<li class="tsd-description">
|
|
506
|
+
<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>
|
|
507
|
+
</div>
|
|
508
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">HTMLElement</span></h4>
|
|
509
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
510
|
+
<section class="tsd-panel tsd-member"><a id="getVideoElement" class="tsd-anchor"></a>
|
|
511
|
+
<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>
|
|
512
|
+
<ul class="tsd-signatures">
|
|
513
|
+
<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>
|
|
514
|
+
<li class="tsd-description">
|
|
515
|
+
<div class="tsd-comment tsd-typography"><p>Returns the used HTML5 video element.</p>
|
|
516
|
+
</div>
|
|
517
|
+
<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>
|
|
518
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
519
|
+
<section class="tsd-panel tsd-member"><a id="getVideoQuality" class="tsd-anchor"></a>
|
|
520
|
+
<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>
|
|
521
|
+
<ul class="tsd-signatures">
|
|
522
|
+
<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><span class="tsd-signature-type">null</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>
|
|
523
|
+
<li class="tsd-description">
|
|
524
|
+
<div class="tsd-comment tsd-typography"><p>Returns the currently selected video quality, if the user manually selected one.</p>
|
|
525
|
+
<p>In this case it returns one of the elements of <a href="MKPlayerAPI.html#getAvailableVideoQualities" class="tsd-kind-method">getAvailableVideoQualities</a>.</p>
|
|
526
|
+
</div>
|
|
527
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="MKVideoQuality.html" class="tsd-signature-type tsd-kind-interface">MKVideoQuality</a></h4>
|
|
528
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
529
|
+
<section class="tsd-panel tsd-member"><a id="getViewMode" class="tsd-anchor"></a>
|
|
530
|
+
<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>
|
|
531
|
+
<ul class="tsd-signatures">
|
|
532
|
+
<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><span class="tsd-signature-type">null</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>
|
|
533
|
+
<li class="tsd-description">
|
|
534
|
+
<div class="tsd-comment tsd-typography"><p>Gets the active <a href="../enums/MKViewMode.html" class="tsd-kind-enum">MKViewMode</a>.</p>
|
|
535
|
+
</div>
|
|
536
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a></h4>
|
|
537
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
538
|
+
<section class="tsd-panel tsd-member"><a id="getVolume" class="tsd-anchor"></a>
|
|
539
|
+
<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>
|
|
540
|
+
<ul class="tsd-signatures">
|
|
541
|
+
<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>
|
|
542
|
+
<li class="tsd-description">
|
|
543
|
+
<div class="tsd-comment tsd-typography"><p>Returns the player’s volume between <code>0</code> (silent) and <code>100</code> (max volume).</p>
|
|
544
|
+
</div>
|
|
545
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
546
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
547
|
+
<section class="tsd-panel tsd-member"><a id="hasEnded" class="tsd-anchor"></a>
|
|
548
|
+
<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>
|
|
549
|
+
<ul class="tsd-signatures">
|
|
550
|
+
<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>
|
|
551
|
+
<li class="tsd-description">
|
|
552
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the video has ended.</p>
|
|
553
|
+
</div>
|
|
554
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
555
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
556
|
+
<section class="tsd-panel tsd-member"><a id="isAirplayActive" class="tsd-anchor"></a>
|
|
557
|
+
<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>
|
|
558
|
+
<ul class="tsd-signatures">
|
|
559
|
+
<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>
|
|
560
|
+
<li class="tsd-description">
|
|
561
|
+
<div class="tsd-comment tsd-typography"><p>Checks if Apple Airplay is enabled.</p>
|
|
562
|
+
</div>
|
|
563
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
564
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
565
|
+
<section class="tsd-panel tsd-member"><a id="isAirplayAvailable" class="tsd-anchor"></a>
|
|
566
|
+
<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>
|
|
567
|
+
<ul class="tsd-signatures">
|
|
568
|
+
<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>
|
|
569
|
+
<li class="tsd-description">
|
|
570
|
+
<div class="tsd-comment tsd-typography"><p>Checks if Apple AirPlay support is available.</p>
|
|
571
|
+
</div>
|
|
572
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
573
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
574
|
+
<section class="tsd-panel tsd-member"><a id="isCastAvailable" class="tsd-anchor"></a>
|
|
575
|
+
<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>
|
|
576
|
+
<ul class="tsd-signatures">
|
|
577
|
+
<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>
|
|
578
|
+
<li class="tsd-description">
|
|
579
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if casting to another device (such as a ChromeCast) is available, otherwise false.</p>
|
|
580
|
+
<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>
|
|
581
|
+
</div>
|
|
582
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
583
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
584
|
+
<section class="tsd-panel tsd-member"><a id="isCasting" class="tsd-anchor"></a>
|
|
585
|
+
<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>
|
|
586
|
+
<ul class="tsd-signatures">
|
|
587
|
+
<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>
|
|
588
|
+
<li class="tsd-description">
|
|
589
|
+
<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>
|
|
590
|
+
</div>
|
|
591
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
592
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
593
|
+
<section class="tsd-panel tsd-member"><a id="isLive" class="tsd-anchor"></a>
|
|
594
|
+
<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>
|
|
595
|
+
<ul class="tsd-signatures">
|
|
596
|
+
<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>
|
|
597
|
+
<li class="tsd-description">
|
|
598
|
+
<div class="tsd-comment tsd-typography"><p>Return true if the displayed video is a live stream.</p>
|
|
599
|
+
</div>
|
|
600
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
601
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
602
|
+
<section class="tsd-panel tsd-member"><a id="isMuted" class="tsd-anchor"></a>
|
|
603
|
+
<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>
|
|
604
|
+
<ul class="tsd-signatures">
|
|
605
|
+
<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>
|
|
606
|
+
<li class="tsd-description">
|
|
607
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the player has been muted.</p>
|
|
608
|
+
</div>
|
|
609
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
610
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
611
|
+
<section class="tsd-panel tsd-member"><a id="isPaused" class="tsd-anchor"></a>
|
|
612
|
+
<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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
613
|
+
<ul class="tsd-signatures">
|
|
614
|
+
<li class="tsd-signature tsd-anchor-link" id="isPaused.isPaused-1"><span class="tsd-kind-call-signature">is<wbr/>Paused</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="#isPaused.isPaused-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
615
|
+
<li class="tsd-description">
|
|
616
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the player has started playback but is currently paused.</p>
|
|
617
|
+
</div>
|
|
618
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
619
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
620
|
+
<section class="tsd-panel tsd-member"><a id="isPlaying" class="tsd-anchor"></a>
|
|
621
|
+
<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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
622
|
+
<ul class="tsd-signatures">
|
|
623
|
+
<li class="tsd-signature tsd-anchor-link" id="isPlaying.isPlaying-1"><span class="tsd-kind-call-signature">is<wbr/>Playing</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="#isPlaying.isPlaying-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
624
|
+
<li class="tsd-description">
|
|
625
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the player is currently playing, i.e. has started and is not paused.</p>
|
|
626
|
+
</div>
|
|
627
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
628
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
629
|
+
<section class="tsd-panel tsd-member"><a id="isStalled" class="tsd-anchor"></a>
|
|
630
|
+
<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"><use href="#icon-anchor"></use></svg></a></h3>
|
|
631
|
+
<ul class="tsd-signatures">
|
|
632
|
+
<li class="tsd-signature tsd-anchor-link" id="isStalled.isStalled-1"><span class="tsd-kind-call-signature">is<wbr/>Stalled</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="#isStalled.isStalled-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
633
|
+
<li class="tsd-description">
|
|
634
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the player is currently stalling due to an empty buffer.</p>
|
|
635
|
+
</div>
|
|
636
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
637
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
638
|
+
<section class="tsd-panel tsd-member"><a id="isViewModeAvailable" class="tsd-anchor"></a>
|
|
639
|
+
<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>
|
|
640
|
+
<ul class="tsd-signatures">
|
|
641
|
+
<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>
|
|
642
|
+
<li class="tsd-description">
|
|
643
|
+
<div class="tsd-comment tsd-typography"><p>Tests if a particular ViewMode is available for selection with setViewMode.</p>
|
|
644
|
+
</div>
|
|
645
|
+
<div class="tsd-parameters">
|
|
646
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
647
|
+
<ul class="tsd-parameter-list">
|
|
648
|
+
<li>
|
|
649
|
+
<h5><span class="tsd-kind-parameter">viewMode</span>: <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a></h5>
|
|
650
|
+
<div class="tsd-comment tsd-typography"><p>the view mode to test.</p>
|
|
651
|
+
</div>
|
|
652
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
653
|
+
<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>
|
|
654
|
+
|
|
655
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
656
|
+
<section class="tsd-panel tsd-member"><a id="load" class="tsd-anchor"></a>
|
|
657
|
+
<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>
|
|
658
|
+
<ul class="tsd-signatures">
|
|
659
|
+
<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>
|
|
660
|
+
<li class="tsd-description">
|
|
661
|
+
<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>
|
|
662
|
+
</div>
|
|
663
|
+
<div class="tsd-parameters">
|
|
664
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
665
|
+
<ul class="tsd-parameter-list">
|
|
666
|
+
<li>
|
|
667
|
+
<h5><span class="tsd-kind-parameter">sourceConfig</span>: <a href="MKSourceConfig.html" class="tsd-signature-type tsd-kind-interface">MKSourceConfig</a></h5>
|
|
668
|
+
<div class="tsd-comment tsd-typography"><p>the source configuration object.</p>
|
|
669
|
+
</div>
|
|
670
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
671
|
+
<li>
|
|
672
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">disableSeeking</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
673
|
+
<div class="tsd-comment tsd-typography"><p>If set, seeking will be disabled.</p>
|
|
674
|
+
</div>
|
|
675
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
676
|
+
<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>
|
|
677
|
+
|
|
678
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
679
|
+
<section class="tsd-panel tsd-member"><a id="mute" class="tsd-anchor"></a>
|
|
680
|
+
<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>
|
|
681
|
+
<ul class="tsd-signatures">
|
|
682
|
+
<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>
|
|
683
|
+
<li class="tsd-description">
|
|
684
|
+
<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>
|
|
685
|
+
</div>
|
|
686
|
+
<div class="tsd-parameters">
|
|
687
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
688
|
+
<ul class="tsd-parameter-list">
|
|
689
|
+
<li>
|
|
690
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
691
|
+
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
692
|
+
</div>
|
|
693
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
694
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
695
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
696
|
+
<section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a>
|
|
697
|
+
<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>
|
|
698
|
+
<ul class="tsd-signatures">
|
|
699
|
+
<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-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>
|
|
700
|
+
<li class="tsd-description">
|
|
701
|
+
<div class="tsd-comment tsd-typography"><p>Removes a handler for a player event.</p>
|
|
702
|
+
</div>
|
|
703
|
+
<div class="tsd-parameters">
|
|
704
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
705
|
+
<ul class="tsd-parameter-list">
|
|
706
|
+
<li>
|
|
707
|
+
<h5><span class="tsd-kind-parameter">eventType</span>: <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a></h5>
|
|
708
|
+
<div class="tsd-comment tsd-typography"><p>The event to remove the handler from.</p>
|
|
709
|
+
</div>
|
|
710
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
711
|
+
<li>
|
|
712
|
+
<h5><span class="tsd-kind-parameter">callback</span>: <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a></h5>
|
|
713
|
+
<div class="tsd-comment tsd-typography"><p>The callback handler to remove.</p>
|
|
714
|
+
</div>
|
|
715
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
716
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
717
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
718
|
+
<section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a>
|
|
719
|
+
<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>
|
|
720
|
+
<ul class="tsd-signatures">
|
|
721
|
+
<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-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>
|
|
722
|
+
<li class="tsd-description">
|
|
723
|
+
<div class="tsd-comment tsd-typography"><p>Subscribes an event handler to a player event.</p>
|
|
724
|
+
</div>
|
|
725
|
+
<div class="tsd-parameters">
|
|
726
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
727
|
+
<ul class="tsd-parameter-list">
|
|
728
|
+
<li>
|
|
729
|
+
<h5><span class="tsd-kind-parameter">eventType</span>: <a href="../enums/MKPlayerEvent.html" class="tsd-signature-type tsd-kind-enum">MKPlayerEvent</a></h5>
|
|
730
|
+
<div class="tsd-comment tsd-typography"><p>The type of event to subscribe to.</p>
|
|
731
|
+
</div>
|
|
732
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
733
|
+
<li>
|
|
734
|
+
<h5><span class="tsd-kind-parameter">callback</span>: <a href="MKPlayerEventCallback.html" class="tsd-signature-type tsd-kind-interface">MKPlayerEventCallback</a></h5>
|
|
735
|
+
<div class="tsd-comment tsd-typography"><p>The event callback handler that will be called when the event fires.</p>
|
|
736
|
+
</div>
|
|
737
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
738
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
739
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
740
|
+
<section class="tsd-panel tsd-member"><a id="pause" class="tsd-anchor"></a>
|
|
741
|
+
<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>
|
|
742
|
+
<ul class="tsd-signatures">
|
|
743
|
+
<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>
|
|
744
|
+
<li class="tsd-description">
|
|
745
|
+
<div class="tsd-comment tsd-typography"><p>Pauses the video if it is playing. Has no effect if the player is already paused.</p>
|
|
746
|
+
</div>
|
|
747
|
+
<div class="tsd-parameters">
|
|
748
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
749
|
+
<ul class="tsd-parameter-list">
|
|
750
|
+
<li>
|
|
751
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
752
|
+
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
753
|
+
</div>
|
|
754
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
755
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
756
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
757
|
+
<section class="tsd-panel tsd-member"><a id="play" class="tsd-anchor"></a>
|
|
758
|
+
<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>
|
|
759
|
+
<ul class="tsd-signatures">
|
|
760
|
+
<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>
|
|
761
|
+
<li class="tsd-description">
|
|
762
|
+
<div class="tsd-comment tsd-typography"><p>Starts playback or resumes after being paused.</p>
|
|
763
|
+
<p>No need to call it if the player is stup with <code>autoplay</code>.</p>
|
|
764
|
+
<p>Calling play has no effect when player is already playing.</p>
|
|
765
|
+
</div>
|
|
766
|
+
<div class="tsd-parameters">
|
|
767
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
768
|
+
<ul class="tsd-parameter-list">
|
|
769
|
+
<li>
|
|
770
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
771
|
+
<div class="tsd-comment tsd-typography"><p>the issuer of the API call that will be passed to events triggered by this call.</p>
|
|
772
|
+
</div>
|
|
773
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
774
|
+
<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>
|
|
775
|
+
|
|
776
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
777
|
+
<section class="tsd-panel tsd-member"><a id="preload" class="tsd-anchor"></a>
|
|
778
|
+
<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>
|
|
779
|
+
<ul class="tsd-signatures">
|
|
780
|
+
<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>
|
|
781
|
+
<li class="tsd-description">
|
|
782
|
+
<div class="tsd-comment tsd-typography"><p>Starts preloading the content of the currently loaded source.</p>
|
|
783
|
+
</div>
|
|
784
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
785
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
786
|
+
<section class="tsd-panel tsd-member"><a id="removeSubtitle" class="tsd-anchor"></a>
|
|
787
|
+
<h3 class="tsd-anchor-link"><span>remove<wbr/>Subtitle</span><a href="#removeSubtitle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
788
|
+
<ul class="tsd-signatures">
|
|
789
|
+
<li class="tsd-signature tsd-anchor-link" id="removeSubtitle.removeSubtitle-1"><span class="tsd-kind-call-signature">remove<wbr/>Subtitle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subtitleID</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeSubtitle.removeSubtitle-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
790
|
+
<li class="tsd-description">
|
|
791
|
+
<div class="tsd-comment tsd-typography"><p>Removes a subtitle track.</p>
|
|
792
|
+
<p>Disables it in case it's enabled before removal.</p>
|
|
793
|
+
</div>
|
|
794
|
+
<div class="tsd-parameters">
|
|
795
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
796
|
+
<ul class="tsd-parameter-list">
|
|
797
|
+
<li>
|
|
798
|
+
<h5><span class="tsd-kind-parameter">subtitleID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
799
|
+
<div class="tsd-comment tsd-typography"><p>the identifier of the subtitle track to remove.</p>
|
|
800
|
+
</div>
|
|
801
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
802
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
803
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
804
|
+
<section class="tsd-panel tsd-member"><a id="seek" class="tsd-anchor"></a>
|
|
805
|
+
<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>
|
|
806
|
+
<ul class="tsd-signatures">
|
|
807
|
+
<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>
|
|
808
|
+
<li class="tsd-description">
|
|
809
|
+
<div class="tsd-comment tsd-typography"><p>Seeks to the given playback time specified by the parameter time in seconds.</p>
|
|
810
|
+
<p>Must not be greater than the total duration of the video. Has no effect when watching a live stream as seeking is not possible.</p>
|
|
811
|
+
</div>
|
|
812
|
+
<div class="tsd-parameters">
|
|
813
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
814
|
+
<ul class="tsd-parameter-list">
|
|
815
|
+
<li>
|
|
816
|
+
<h5><span class="tsd-kind-parameter">time</span>: <span class="tsd-signature-type">number</span></h5>
|
|
817
|
+
<div class="tsd-comment tsd-typography"><p>The time to seek to.</p>
|
|
818
|
+
</div>
|
|
819
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
820
|
+
<li>
|
|
821
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
822
|
+
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
823
|
+
</div>
|
|
824
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
825
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> when successful.</p>
|
|
826
|
+
|
|
827
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
828
|
+
<section class="tsd-panel tsd-member"><a id="seekToLiveEdge" class="tsd-anchor"></a>
|
|
829
|
+
<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>
|
|
830
|
+
<ul class="tsd-signatures">
|
|
831
|
+
<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>
|
|
832
|
+
<li class="tsd-description">
|
|
833
|
+
<div class="tsd-comment tsd-typography"><p>Seeks to the current live edge.</p>
|
|
834
|
+
<p>Applicable only for live sources.</p>
|
|
835
|
+
</div>
|
|
836
|
+
<div class="tsd-parameters">
|
|
837
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
838
|
+
<ul class="tsd-parameter-list">
|
|
839
|
+
<li>
|
|
840
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
841
|
+
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
842
|
+
</div>
|
|
843
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
844
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
845
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
846
|
+
<section class="tsd-panel tsd-member"><a id="setAspectRatio" class="tsd-anchor"></a>
|
|
847
|
+
<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>
|
|
848
|
+
<ul class="tsd-signatures">
|
|
849
|
+
<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>
|
|
850
|
+
<li class="tsd-description">
|
|
851
|
+
<div class="tsd-comment tsd-typography"><p>Modifies the current aspect ratio of the player.</p>
|
|
852
|
+
</div>
|
|
853
|
+
<div class="tsd-parameters">
|
|
854
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
855
|
+
<ul class="tsd-parameter-list">
|
|
856
|
+
<li>
|
|
857
|
+
<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>
|
|
858
|
+
<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>
|
|
859
|
+
</div>
|
|
860
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
861
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
862
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
863
|
+
<section class="tsd-panel tsd-member"><a id="setAudio" class="tsd-anchor"></a>
|
|
864
|
+
<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>
|
|
865
|
+
<ul class="tsd-signatures">
|
|
866
|
+
<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>
|
|
867
|
+
<li class="tsd-description">
|
|
868
|
+
<div class="tsd-comment tsd-typography"><p>Sets the audio track to the ID specified by trackID.</p>
|
|
869
|
+
<p>Available tracks can be retrieved with <a href="MKPlayerAPI.html#getAvailableAudio" class="tsd-kind-method">getAvailableAudio</a>.</p>
|
|
870
|
+
</div>
|
|
871
|
+
<div class="tsd-parameters">
|
|
872
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
873
|
+
<ul class="tsd-parameter-list">
|
|
874
|
+
<li>
|
|
875
|
+
<h5><span class="tsd-kind-parameter">trackID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
876
|
+
<div class="tsd-comment tsd-typography"><p>The ID of the audio track to activate.</p>
|
|
877
|
+
</div>
|
|
878
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
879
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
880
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
881
|
+
<section class="tsd-panel tsd-member"><a id="setAudioQuality" class="tsd-anchor"></a>
|
|
882
|
+
<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>
|
|
883
|
+
<ul class="tsd-signatures">
|
|
884
|
+
<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>
|
|
885
|
+
<li class="tsd-description">
|
|
886
|
+
<div class="tsd-comment tsd-typography"><p>Manually sets the audio stream to a fixed quality, identified by ID.</p>
|
|
887
|
+
<p>Has to be an ID defined in the MPD or the keyword 'auto'.</p>
|
|
888
|
+
<p>Auto resets to dynamic switching.</p>
|
|
889
|
+
<p>A list with valid IDs can be retrieved by calling <a href="MKPlayerAPI.html#getAvailableAudioQualities" class="tsd-kind-method">getAvailableAudioQualities</a>.</p>
|
|
890
|
+
</div>
|
|
891
|
+
<div class="tsd-parameters">
|
|
892
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
893
|
+
<ul class="tsd-parameter-list">
|
|
894
|
+
<li>
|
|
895
|
+
<h5><span class="tsd-kind-parameter">audioQualityID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
896
|
+
<div class="tsd-comment tsd-typography"><p>The ID of the desired audio quality or 'auto' for dynamic switching.</p>
|
|
897
|
+
</div>
|
|
898
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
899
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
900
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
901
|
+
<section class="tsd-panel tsd-member"><a id="setAuthorizationToken" class="tsd-anchor"></a>
|
|
902
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Authorization<wbr/>Token</span><a href="#setAuthorizationToken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
903
|
+
<ul class="tsd-signatures">
|
|
904
|
+
<li class="tsd-signature tsd-anchor-link" id="setAuthorizationToken.setAuthorizationToken-1"><span class="tsd-kind-call-signature">set<wbr/>Authorization<wbr/>Token</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">authorizationToken</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAuthorizationToken.setAuthorizationToken-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
905
|
+
<li class="tsd-description">
|
|
906
|
+
<div class="tsd-comment tsd-typography"><p>Set authorization token.</p>
|
|
907
|
+
<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). 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 azuki config in the registered source config object passed to start playback of a next source.</p>
|
|
908
|
+
</div>
|
|
909
|
+
<div class="tsd-parameters">
|
|
910
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
911
|
+
<ul class="tsd-parameter-list">
|
|
912
|
+
<li>
|
|
913
|
+
<h5><span class="tsd-kind-parameter">authorizationToken</span>: <span class="tsd-signature-type">string</span></h5>
|
|
914
|
+
<div class="tsd-comment tsd-typography"><p>the new authorization token.</p>
|
|
915
|
+
</div>
|
|
916
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
917
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
918
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
919
|
+
<section class="tsd-panel tsd-member"><a id="setCatchupConfig" class="tsd-anchor"></a>
|
|
920
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Catchup<wbr/>Config</span><a href="#setCatchupConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
921
|
+
<ul class="tsd-signatures">
|
|
922
|
+
<li class="tsd-signature tsd-anchor-link" id="setCatchupConfig.setCatchupConfig-1"><span class="tsd-kind-call-signature">set<wbr/>Catchup<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setCatchupConfig.setCatchupConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
923
|
+
<li class="tsd-description">
|
|
924
|
+
<div class="tsd-comment tsd-typography"><p>Sets the configuration specifying parameters for latency catchup.</p>
|
|
925
|
+
</div>
|
|
926
|
+
<div class="tsd-parameters">
|
|
927
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
928
|
+
<ul class="tsd-parameter-list">
|
|
929
|
+
<li>
|
|
930
|
+
<h5><span class="tsd-kind-parameter">config</span>: <a href="MKLowLatencySyncConfig.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencySyncConfig</a></h5>
|
|
931
|
+
<div class="tsd-comment tsd-typography"><p>the sync configuration for latency catchup.</p>
|
|
932
|
+
</div>
|
|
933
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
934
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
935
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
936
|
+
<section class="tsd-panel tsd-member"><a id="setFallbackConfig" class="tsd-anchor"></a>
|
|
937
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Fallback<wbr/>Config</span><a href="#setFallbackConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
938
|
+
<ul class="tsd-signatures">
|
|
939
|
+
<li class="tsd-signature tsd-anchor-link" id="setFallbackConfig.setFallbackConfig-1"><span class="tsd-kind-call-signature">set<wbr/>Fallback<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setFallbackConfig.setFallbackConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
940
|
+
<li class="tsd-description">
|
|
941
|
+
<div class="tsd-comment tsd-typography"><p>Sets the configuration specifying parameters for latency fallback.</p>
|
|
942
|
+
</div>
|
|
943
|
+
<div class="tsd-parameters">
|
|
944
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
945
|
+
<ul class="tsd-parameter-list">
|
|
946
|
+
<li>
|
|
947
|
+
<h5><span class="tsd-kind-parameter">config</span>: <a href="MKLowLatencySyncConfig.html" class="tsd-signature-type tsd-kind-interface">MKLowLatencySyncConfig</a></h5>
|
|
948
|
+
<div class="tsd-comment tsd-typography"><p>the sync configuration for latency fallback.</p>
|
|
949
|
+
</div>
|
|
950
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
951
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
952
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
953
|
+
<section class="tsd-panel tsd-member"><a id="setInhomeStatus" class="tsd-anchor"></a>
|
|
954
|
+
<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>
|
|
955
|
+
<ul class="tsd-signatures">
|
|
956
|
+
<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>
|
|
957
|
+
<li class="tsd-description">
|
|
958
|
+
<div class="tsd-comment tsd-typography"><p>Set inhome status.</p>
|
|
959
|
+
<p>Note: this is applicable only for registered source streams. 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>
|
|
960
|
+
</div>
|
|
961
|
+
<div class="tsd-parameters">
|
|
962
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
963
|
+
<ul class="tsd-parameter-list">
|
|
964
|
+
<li>
|
|
965
|
+
<h5><span class="tsd-kind-parameter">inhomeStatus</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
966
|
+
<div class="tsd-comment tsd-typography"><p>the new inhome status value.</p>
|
|
967
|
+
</div>
|
|
968
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
969
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
970
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
971
|
+
<section class="tsd-panel tsd-member"><a id="setLocationDetail" class="tsd-anchor"></a>
|
|
972
|
+
<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>
|
|
973
|
+
<ul class="tsd-signatures">
|
|
974
|
+
<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>
|
|
975
|
+
<li class="tsd-description">
|
|
976
|
+
<div class="tsd-comment tsd-typography"><p>Set location detail information.</p>
|
|
977
|
+
<p>Note: this is applicable only for registered source streams. 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>
|
|
978
|
+
</div>
|
|
979
|
+
<div class="tsd-parameters">
|
|
980
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
981
|
+
<ul class="tsd-parameter-list">
|
|
982
|
+
<li>
|
|
983
|
+
<h5><span class="tsd-kind-parameter">locationDetail</span>: <span class="tsd-signature-type">string</span></h5>
|
|
984
|
+
<div class="tsd-comment tsd-typography"><p>the new location details as base64 encoded string.</p>
|
|
985
|
+
</div>
|
|
986
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
987
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
988
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
989
|
+
<section class="tsd-panel tsd-member"><a id="setLogLevel" class="tsd-anchor"></a>
|
|
990
|
+
<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>
|
|
991
|
+
<ul class="tsd-signatures">
|
|
992
|
+
<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>
|
|
993
|
+
<li class="tsd-description">
|
|
994
|
+
<div class="tsd-comment tsd-typography"><p>Sets the level of player log outputs.</p>
|
|
995
|
+
</div>
|
|
996
|
+
<div class="tsd-parameters">
|
|
997
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
998
|
+
<ul class="tsd-parameter-list">
|
|
999
|
+
<li>
|
|
1000
|
+
<h5><span class="tsd-kind-parameter">level</span>: <a href="../enums/MKLogLevel.html" class="tsd-signature-type tsd-kind-enum">MKLogLevel</a></h5>
|
|
1001
|
+
<div class="tsd-comment tsd-typography"><p>Log level, allowed values are "debug", "log", "warn", "error" and "off"</p>
|
|
1002
|
+
</div>
|
|
1003
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1004
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1005
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1006
|
+
<section class="tsd-panel tsd-member"><a id="setPlaybackSpeed" class="tsd-anchor"></a>
|
|
1007
|
+
<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>
|
|
1008
|
+
<ul class="tsd-signatures">
|
|
1009
|
+
<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>
|
|
1010
|
+
<li class="tsd-description">
|
|
1011
|
+
<div class="tsd-comment tsd-typography"><p>Sets the playback speed of the player. </p>
|
|
1012
|
+
<p>Available only for HTML5 player.</p>
|
|
1013
|
+
<p>Fast forward as well as slow motion is supported.</p>
|
|
1014
|
+
<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>
|
|
1015
|
+
</div>
|
|
1016
|
+
<div class="tsd-parameters">
|
|
1017
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1018
|
+
<ul class="tsd-parameter-list">
|
|
1019
|
+
<li>
|
|
1020
|
+
<h5><span class="tsd-kind-parameter">speed</span>: <span class="tsd-signature-type">number</span></h5>
|
|
1021
|
+
<div class="tsd-comment tsd-typography"><p>A playback speed factor greater than <code>0</code>.</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></li></ul></section>
|
|
1026
|
+
<section class="tsd-panel tsd-member"><a id="setPosterImage" class="tsd-anchor"></a>
|
|
1027
|
+
<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>
|
|
1028
|
+
<ul class="tsd-signatures">
|
|
1029
|
+
<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>
|
|
1030
|
+
<li class="tsd-description">
|
|
1031
|
+
<div class="tsd-comment tsd-typography"><p>Sets a poster image. Will be displayed immediately, even if a video stream is playing.</p>
|
|
1032
|
+
</div>
|
|
1033
|
+
<div class="tsd-parameters">
|
|
1034
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1035
|
+
<ul class="tsd-parameter-list">
|
|
1036
|
+
<li>
|
|
1037
|
+
<h5><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1038
|
+
<div class="tsd-comment tsd-typography"><p>The URL to the poster image.</p>
|
|
1039
|
+
</div>
|
|
1040
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1041
|
+
<li>
|
|
1042
|
+
<h5><span class="tsd-kind-parameter">keepPersistent</span>: <span class="tsd-signature-type">boolean</span></h5>
|
|
1043
|
+
<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>
|
|
1044
|
+
</div>
|
|
1045
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1046
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1047
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1048
|
+
<section class="tsd-panel tsd-member"><a id="setTargetBufferLevel" class="tsd-anchor"></a>
|
|
1049
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Target<wbr/>Buffer<wbr/>Level</span><a href="#setTargetBufferLevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1050
|
+
<ul class="tsd-signatures">
|
|
1051
|
+
<li class="tsd-signature tsd-anchor-link" id="setTargetBufferLevel.setTargetBufferLevel-1"><span class="tsd-kind-call-signature">set<wbr/>Target<wbr/>Buffer<wbr/>Level</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">media</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setTargetBufferLevel.setTargetBufferLevel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1052
|
+
<li class="tsd-description">
|
|
1053
|
+
<div class="tsd-comment tsd-typography"><p>Sets the target buffer level for the chosen buffer and media type.</p>
|
|
1054
|
+
</div>
|
|
1055
|
+
<div class="tsd-parameters">
|
|
1056
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1057
|
+
<ul class="tsd-parameter-list">
|
|
1058
|
+
<li>
|
|
1059
|
+
<h5><span class="tsd-kind-parameter">type</span>: <a href="../enums/MKBufferType.html" class="tsd-signature-type tsd-kind-enum">MKBufferType</a></h5>
|
|
1060
|
+
<div class="tsd-comment tsd-typography"><p>the buffer type to change the target buffer level for.</p>
|
|
1061
|
+
</div>
|
|
1062
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1063
|
+
<li>
|
|
1064
|
+
<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">number</span></h5>
|
|
1065
|
+
<div class="tsd-comment tsd-typography"><p>the value to set.</p>
|
|
1066
|
+
</div>
|
|
1067
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1068
|
+
<li>
|
|
1069
|
+
<h5><span class="tsd-kind-parameter">media</span>: <a href="../enums/MKMediaType.html" class="tsd-signature-type tsd-kind-enum">MKMediaType</a></h5>
|
|
1070
|
+
<div class="tsd-comment tsd-typography"><p>the media type to change the target buffer level for.</p>
|
|
1071
|
+
</div>
|
|
1072
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1073
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1074
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1075
|
+
<section class="tsd-panel tsd-member"><a id="setTargetLatency" class="tsd-anchor"></a>
|
|
1076
|
+
<h3 class="tsd-anchor-link"><span>set<wbr/>Target<wbr/>Latency</span><a href="#setTargetLatency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
1077
|
+
<ul class="tsd-signatures">
|
|
1078
|
+
<li class="tsd-signature tsd-anchor-link" id="setTargetLatency.setTargetLatency-1"><span class="tsd-kind-call-signature">set<wbr/>Target<wbr/>Latency</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">latency</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setTargetLatency.setTargetLatency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
1079
|
+
<li class="tsd-description">
|
|
1080
|
+
<div class="tsd-comment tsd-typography"><p>Sets the target latency to be maintained during playback.</p>
|
|
1081
|
+
<p>Causes firing a <a href="../enums/MKPlayerEvent.html#TargetLatencyChanged" class="tsd-kind-enum-member">TargetLatencyChanged</a> event.</p>
|
|
1082
|
+
</div>
|
|
1083
|
+
<div class="tsd-parameters">
|
|
1084
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1085
|
+
<ul class="tsd-parameter-list">
|
|
1086
|
+
<li>
|
|
1087
|
+
<h5><span class="tsd-kind-parameter">latency</span>: <span class="tsd-signature-type">number</span></h5>
|
|
1088
|
+
<div class="tsd-comment tsd-typography"><p>the target latency in seconds.</p>
|
|
1089
|
+
</div>
|
|
1090
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1091
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1092
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1093
|
+
<section class="tsd-panel tsd-member"><a id="setVideoElement" class="tsd-anchor"></a>
|
|
1094
|
+
<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>
|
|
1095
|
+
<ul class="tsd-signatures">
|
|
1096
|
+
<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>
|
|
1097
|
+
<li class="tsd-description">
|
|
1098
|
+
<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>
|
|
1099
|
+
<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>
|
|
1100
|
+
<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>
|
|
1101
|
+
<p>Also the video element should be contained within the video container element that was passed as part of player creation.</p>
|
|
1102
|
+
<p>Example:</p>
|
|
1103
|
+
<pre><code><span class="hl-10">' In the HTML bod</span><span class="hl-15">y</span><br/><span class="hl-5"><</span><span class="hl-9">div</span><span class="hl-5"> </span><span class="hl-9">id</span><span class="hl-5">=</span><span class="hl-10">"videoContainer"</span><span class="hl-5">></span><br/><span class="hl-5"> <</span><span class="hl-9">video</span><span class="hl-5"> </span><span class="hl-9">id</span><span class="hl-5">=</span><span class="hl-10">"videoElement"</span><span class="hl-5">></</span><span class="hl-16">video</span><span class="hl-5">></span><br/><span class="hl-5"></</span><span class="hl-9">div</span><span class="hl-5">></span><br/><br/><span class="hl-10">' In the scrip</span><span class="hl-15">t</span><br/><span class="hl-7">let</span><span class="hl-5"> </span><span class="hl-9">videoContainer</span><span class="hl-5"> = </span><span class="hl-9">document</span><span class="hl-5">.</span><span class="hl-11">getElementById</span><span class="hl-5">(</span><span class="hl-10">"videoContainer"</span><span class="hl-5">);</span><br/><span class="hl-7">let</span><span class="hl-5"> </span><span class="hl-9">videoElement</span><span class="hl-5"> = </span><span class="hl-9">document</span><span class="hl-5">.</span><span class="hl-11">getElementById</span><span class="hl-5">(</span><span class="hl-10">"videoElement"</span><span class="hl-5">);</span><br/><span class="hl-7">let</span><span class="hl-5"> </span><span class="hl-9">playerConfig</span><span class="hl-5"> = {</span><br/><span class="hl-5"> </span><span class="hl-9">key:</span><span class="hl-5"> </span><span class="hl-10">"<license_key>"</span><span class="hl-5">,</span><br/><span class="hl-5"> </span><span class="hl-9">playback:</span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-9">autoplay:</span><span class="hl-5"> </span><span class="hl-7">true</span><span class="hl-5">,</span><br/><span class="hl-5"> </span><span class="hl-9">muted:</span><span class="hl-5"> </span><span class="hl-7">true</span><br/><span class="hl-5"> }</span><br/><span class="hl-5">};</span><br/><br/><span class="hl-7">let</span><span class="hl-5"> </span><span class="hl-9">player</span><span class="hl-5"> = </span><span class="hl-7">new</span><span class="hl-5"> </span><span class="hl-9">mkplayer</span><span class="hl-5">.</span><span class="hl-11">MKPlayer</span><span class="hl-5">(</span><span class="hl-9">playerConfig</span><span class="hl-5">, </span><span class="hl-9">videoContainer</span><span class="hl-5">);</span><br/><span class="hl-9">player</span><span class="hl-5">.</span><span class="hl-11">setVideoElement</span><span class="hl-5">(</span><span class="hl-9">videoElement</span><span class="hl-5">);</span><br/><span class="hl-9">player</span><span class="hl-5">.</span><span class="hl-11">load</span><span class="hl-5">(</span><span class="hl-9">sourceConfig</span><span class="hl-5">);</span>
|
|
1104
|
+
</code><button>Copy</button></pre>
|
|
1105
|
+
</div>
|
|
1106
|
+
<div class="tsd-parameters">
|
|
1107
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1108
|
+
<ul class="tsd-parameter-list">
|
|
1109
|
+
<li>
|
|
1110
|
+
<h5><span class="tsd-kind-parameter">videoElement</span>: <span class="tsd-signature-type ">HTMLVideoElement</span></h5>
|
|
1111
|
+
<div class="tsd-comment tsd-typography"><p>the video element to set.</p>
|
|
1112
|
+
</div>
|
|
1113
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1114
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1115
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1116
|
+
<section class="tsd-panel tsd-member"><a id="setVideoQuality" class="tsd-anchor"></a>
|
|
1117
|
+
<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>
|
|
1118
|
+
<ul class="tsd-signatures">
|
|
1119
|
+
<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>
|
|
1120
|
+
<li class="tsd-description">
|
|
1121
|
+
<div class="tsd-comment tsd-typography"><p>Manually sets the video stream to a fixed quality, identified by ID.</p>
|
|
1122
|
+
<p>Has to be an ID defined in the Manifest/MPD or the keyword 'auto'.</p>
|
|
1123
|
+
<p>Auto resets to dynamic switching.</p>
|
|
1124
|
+
<p>A list with valid IDs can be retrieved by calling <a href="MKPlayerAPI.html#getAvailableVideoQualities" class="tsd-kind-method">getAvailableVideoQualities</a>.</p>
|
|
1125
|
+
</div>
|
|
1126
|
+
<div class="tsd-parameters">
|
|
1127
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1128
|
+
<ul class="tsd-parameter-list">
|
|
1129
|
+
<li>
|
|
1130
|
+
<h5><span class="tsd-kind-parameter">videoQualityID</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1131
|
+
<div class="tsd-comment tsd-typography"><p>ID defined in the Manifest/MPD or 'auto'.</p>
|
|
1132
|
+
</div>
|
|
1133
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1134
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1135
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1136
|
+
<section class="tsd-panel tsd-member"><a id="setViewMode" class="tsd-anchor"></a>
|
|
1137
|
+
<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>
|
|
1138
|
+
<ul class="tsd-signatures">
|
|
1139
|
+
<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>
|
|
1140
|
+
<li class="tsd-description">
|
|
1141
|
+
<div class="tsd-comment tsd-typography"><p>Sets the player to a particular ViewMode.</p>
|
|
1142
|
+
<p>Will only work if the selected view mode is available and isViewModeAvailable returns true, else this call will be ignored.</p>
|
|
1143
|
+
<p>If successful, a <a href="../enums/MKPlayerEvent.html#ViewModeChanged" class="tsd-kind-enum-member">ViewModeChanged</a> will be fired.</p>
|
|
1144
|
+
</div>
|
|
1145
|
+
<div class="tsd-parameters">
|
|
1146
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1147
|
+
<ul class="tsd-parameter-list">
|
|
1148
|
+
<li>
|
|
1149
|
+
<h5><span class="tsd-kind-parameter">viewMode</span>: <a href="../enums/MKViewMode.html" class="tsd-signature-type tsd-kind-enum">MKViewMode</a></h5>
|
|
1150
|
+
<div class="tsd-comment tsd-typography"><p>the view mode to switch the player into.</p>
|
|
1151
|
+
</div>
|
|
1152
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1153
|
+
<li>
|
|
1154
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="MKViewModeOptions.html" class="tsd-signature-type tsd-kind-interface">MKViewModeOptions</a></h5>
|
|
1155
|
+
<div class="tsd-comment tsd-typography"><p>additional optional parameters for view modes.</p>
|
|
1156
|
+
</div>
|
|
1157
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1158
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1159
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1160
|
+
<section class="tsd-panel tsd-member"><a id="setVolume" class="tsd-anchor"></a>
|
|
1161
|
+
<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>
|
|
1162
|
+
<ul class="tsd-signatures">
|
|
1163
|
+
<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>
|
|
1164
|
+
<li class="tsd-description">
|
|
1165
|
+
<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>
|
|
1166
|
+
</div>
|
|
1167
|
+
<div class="tsd-parameters">
|
|
1168
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1169
|
+
<ul class="tsd-parameter-list">
|
|
1170
|
+
<li>
|
|
1171
|
+
<h5><span class="tsd-kind-parameter">volume</span>: <span class="tsd-signature-type">number</span></h5>
|
|
1172
|
+
<div class="tsd-comment tsd-typography"><p>The volume to set between <code>0</code> and <code>100</code>.</p>
|
|
1173
|
+
</div>
|
|
1174
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
1175
|
+
<li>
|
|
1176
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1177
|
+
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
1178
|
+
</div>
|
|
1179
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1180
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1181
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1182
|
+
<section class="tsd-panel tsd-member"><a id="showAirplayTargetPicker" class="tsd-anchor"></a>
|
|
1183
|
+
<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>
|
|
1184
|
+
<ul class="tsd-signatures">
|
|
1185
|
+
<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>
|
|
1186
|
+
<li class="tsd-description">
|
|
1187
|
+
<div class="tsd-comment tsd-typography"><p>Shows the airplay playback target picker.</p>
|
|
1188
|
+
</div>
|
|
1189
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1190
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1191
|
+
<section class="tsd-panel tsd-member"><a id="unload" class="tsd-anchor"></a>
|
|
1192
|
+
<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>
|
|
1193
|
+
<ul class="tsd-signatures">
|
|
1194
|
+
<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>
|
|
1195
|
+
<li class="tsd-description">
|
|
1196
|
+
<div class="tsd-comment tsd-typography"><p>Unloads the current video source.</p>
|
|
1197
|
+
</div>
|
|
1198
|
+
<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>
|
|
1199
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section>
|
|
1200
|
+
<section class="tsd-panel tsd-member"><a id="unmute" class="tsd-anchor"></a>
|
|
1201
|
+
<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>
|
|
1202
|
+
<ul class="tsd-signatures">
|
|
1203
|
+
<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>
|
|
1204
|
+
<li class="tsd-description">
|
|
1205
|
+
<div class="tsd-comment tsd-typography"><p>Unmutes the player if muted.</p>
|
|
1206
|
+
</div>
|
|
1207
|
+
<div class="tsd-parameters">
|
|
1208
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
1209
|
+
<ul class="tsd-parameter-list">
|
|
1210
|
+
<li>
|
|
1211
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">issuer</span>: <span class="tsd-signature-type">string</span></h5>
|
|
1212
|
+
<div class="tsd-comment tsd-typography"><p>The issuer of the API call that will be passed to events triggered by this call.</p>
|
|
1213
|
+
</div>
|
|
1214
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
1215
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
1216
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></section></section></div>
|
|
1217
|
+
<div class="col-sidebar">
|
|
1218
|
+
<div class="page-menu">
|
|
1219
|
+
<div class="tsd-navigation settings">
|
|
1220
|
+
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
1221
|
+
<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>
|
|
1222
|
+
<div class="tsd-accordion-details">
|
|
1223
|
+
<div class="tsd-filter-visibility">
|
|
1224
|
+
<h4 class="uppercase">Member Visibility</h4><form>
|
|
1225
|
+
<ul id="tsd-filter-options">
|
|
1226
|
+
<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>
|
|
1227
|
+
<div class="tsd-theme-toggle">
|
|
1228
|
+
<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>
|
|
1229
|
+
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
1230
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
1231
|
+
<div class="tsd-accordion-details">
|
|
1232
|
+
<ul>
|
|
1233
|
+
<li><a href="#addCastMetadata" class=""><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>
|
|
1234
|
+
<li><a href="#addSubtitle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Subtitle</span></a></li>
|
|
1235
|
+
<li><a href="#castStop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>cast<wbr/>Stop</span></a></li>
|
|
1236
|
+
<li><a href="#castVideo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>cast<wbr/>Video</span></a></li>
|
|
1237
|
+
<li><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li>
|
|
1238
|
+
<li><a href="#disableSubtitle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disable<wbr/>Subtitle</span></a></li>
|
|
1239
|
+
<li><a href="#enableSubtitle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Subtitle</span></a></li>
|
|
1240
|
+
<li><a href="#getAspectRatio" class=""><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>
|
|
1241
|
+
<li><a href="#getAudio" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Audio</span></a></li>
|
|
1242
|
+
<li><a href="#getAudioQuality" class=""><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>
|
|
1243
|
+
<li><a href="#getAvailableAudio" class=""><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>
|
|
1244
|
+
<li><a href="#getAvailableAudioQualities" class=""><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>
|
|
1245
|
+
<li><a href="#getAvailableSubtitles" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Available<wbr/>Subtitles</span></a></li>
|
|
1246
|
+
<li><a href="#getAvailableVideoQualities" class=""><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>
|
|
1247
|
+
<li><a href="#getBufferLevel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Buffer<wbr/>Level</span></a></li>
|
|
1248
|
+
<li><a href="#getBufferedRanges" class=""><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>
|
|
1249
|
+
<li><a href="#getCatchupConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Catchup<wbr/>Config</span></a></li>
|
|
1250
|
+
<li><a href="#getCurrentTime" class=""><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>
|
|
1251
|
+
<li><a href="#getDownloadedAudioData" class=""><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>
|
|
1252
|
+
<li><a href="#getDownloadedVideoData" class=""><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>
|
|
1253
|
+
<li><a href="#getDroppedVideoFrames" class=""><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>
|
|
1254
|
+
<li><a href="#getDuration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Duration</span></a></li>
|
|
1255
|
+
<li><a href="#getFallbackConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Fallback<wbr/>Config</span></a></li>
|
|
1256
|
+
<li><a href="#getLatency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Latency</span></a></li>
|
|
1257
|
+
<li><a href="#getMaxTimeShift" class=""><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>
|
|
1258
|
+
<li><a href="#getPlaybackAudioData" class=""><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>
|
|
1259
|
+
<li><a href="#getPlaybackSpeed" class=""><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>
|
|
1260
|
+
<li><a href="#getPlaybackVideoData" class=""><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>
|
|
1261
|
+
<li><a href="#getSeekableRange" class=""><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>
|
|
1262
|
+
<li><a href="#getTargetLatency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Target<wbr/>Latency</span></a></li>
|
|
1263
|
+
<li><a href="#getThumbnail" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Thumbnail</span></a></li>
|
|
1264
|
+
<li><a href="#getTimeShift" class=""><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>
|
|
1265
|
+
<li><a href="#getTotalStalledTime" class=""><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>
|
|
1266
|
+
<li><a href="#getVideoContainer" class=""><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>
|
|
1267
|
+
<li><a href="#getVideoElement" class=""><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>
|
|
1268
|
+
<li><a href="#getVideoQuality" class=""><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>
|
|
1269
|
+
<li><a href="#getViewMode" class=""><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>
|
|
1270
|
+
<li><a href="#getVolume" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Volume</span></a></li>
|
|
1271
|
+
<li><a href="#hasEnded" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Ended</span></a></li>
|
|
1272
|
+
<li><a href="#isAirplayActive" class=""><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>
|
|
1273
|
+
<li><a href="#isAirplayAvailable" class=""><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>
|
|
1274
|
+
<li><a href="#isCastAvailable" class=""><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>
|
|
1275
|
+
<li><a href="#isCasting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Casting</span></a></li>
|
|
1276
|
+
<li><a href="#isLive" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Live</span></a></li>
|
|
1277
|
+
<li><a href="#isMuted" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Muted</span></a></li>
|
|
1278
|
+
<li><a href="#isPaused" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Paused</span></a></li>
|
|
1279
|
+
<li><a href="#isPlaying" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Playing</span></a></li>
|
|
1280
|
+
<li><a href="#isStalled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Stalled</span></a></li>
|
|
1281
|
+
<li><a href="#isViewModeAvailable" class=""><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>
|
|
1282
|
+
<li><a href="#load" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>load</span></a></li>
|
|
1283
|
+
<li><a href="#mute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a></li>
|
|
1284
|
+
<li><a href="#off" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li>
|
|
1285
|
+
<li><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
|
|
1286
|
+
<li><a href="#pause" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a></li>
|
|
1287
|
+
<li><a href="#play" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>play</span></a></li>
|
|
1288
|
+
<li><a href="#preload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>preload</span></a></li>
|
|
1289
|
+
<li><a href="#removeSubtitle" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Subtitle</span></a></li>
|
|
1290
|
+
<li><a href="#seek" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>seek</span></a></li>
|
|
1291
|
+
<li><a href="#seekToLiveEdge" class=""><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>
|
|
1292
|
+
<li><a href="#setAspectRatio" class=""><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>
|
|
1293
|
+
<li><a href="#setAudio" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Audio</span></a></li>
|
|
1294
|
+
<li><a href="#setAudioQuality" class=""><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>
|
|
1295
|
+
<li><a href="#setAuthorizationToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Authorization<wbr/>Token</span></a></li>
|
|
1296
|
+
<li><a href="#setCatchupConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Catchup<wbr/>Config</span></a></li>
|
|
1297
|
+
<li><a href="#setFallbackConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Fallback<wbr/>Config</span></a></li>
|
|
1298
|
+
<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>
|
|
1299
|
+
<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>
|
|
1300
|
+
<li><a href="#setLogLevel" class=""><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>
|
|
1301
|
+
<li><a href="#setPlaybackSpeed" class=""><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>
|
|
1302
|
+
<li><a href="#setPosterImage" class=""><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>
|
|
1303
|
+
<li><a href="#setTargetBufferLevel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Target<wbr/>Buffer<wbr/>Level</span></a></li>
|
|
1304
|
+
<li><a href="#setTargetLatency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Target<wbr/>Latency</span></a></li>
|
|
1305
|
+
<li><a href="#setVideoElement" class=""><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>
|
|
1306
|
+
<li><a href="#setVideoQuality" class=""><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>
|
|
1307
|
+
<li><a href="#setViewMode" class=""><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>
|
|
1308
|
+
<li><a href="#setVolume" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Volume</span></a></li>
|
|
1309
|
+
<li><a href="#showAirplayTargetPicker" class=""><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>
|
|
1310
|
+
<li><a href="#unload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unload</span></a></li>
|
|
1311
|
+
<li><a href="#unmute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a></li></ul></div></details></div>
|
|
1312
|
+
<div class="site-menu">
|
|
1313
|
+
<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.1.0</span></a>
|
|
1314
|
+
<ul class="tsd-small-nested-navigation">
|
|
1315
|
+
<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>
|
|
1316
|
+
<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>
|
|
1317
|
+
<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>
|
|
1318
|
+
<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>
|
|
1319
|
+
<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>
|
|
1320
|
+
<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>
|
|
1321
|
+
<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>
|
|
1322
|
+
<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>
|
|
1323
|
+
<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>
|
|
1324
|
+
<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>
|
|
1325
|
+
<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>
|
|
1326
|
+
<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>
|
|
1327
|
+
<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>
|
|
1328
|
+
<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>
|
|
1329
|
+
<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>
|
|
1330
|
+
<li><a href="../enums/MKSourceType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>MKSource<wbr/>Type</span></a></li>
|
|
1331
|
+
<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>
|
|
1332
|
+
<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>
|
|
1333
|
+
<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>
|
|
1334
|
+
<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>
|
|
1335
|
+
<li><a href="MKAdBreakFinishedEvent.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<wbr/>Break<wbr/>Finished<wbr/>Event</span></a></li>
|
|
1336
|
+
<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>
|
|
1337
|
+
<li><a href="MKAdClickThrough.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Click<wbr/>Through</span></a></li>
|
|
1338
|
+
<li><a href="MKAdCompanion.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAd<wbr/>Companion</span></a></li>
|
|
1339
|
+
<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>
|
|
1340
|
+
<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>
|
|
1341
|
+
<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>
|
|
1342
|
+
<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>
|
|
1343
|
+
<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>
|
|
1344
|
+
<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>
|
|
1345
|
+
<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>
|
|
1346
|
+
<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>
|
|
1347
|
+
<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>
|
|
1348
|
+
<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>
|
|
1349
|
+
<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>
|
|
1350
|
+
<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>
|
|
1351
|
+
<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>
|
|
1352
|
+
<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>
|
|
1353
|
+
<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>
|
|
1354
|
+
<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>
|
|
1355
|
+
<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>
|
|
1356
|
+
<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>
|
|
1357
|
+
<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>
|
|
1358
|
+
<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>
|
|
1359
|
+
<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>
|
|
1360
|
+
<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>
|
|
1361
|
+
<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>
|
|
1362
|
+
<li><a href="MKAzukiConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKAzuki<wbr/>Config</span></a></li>
|
|
1363
|
+
<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>
|
|
1364
|
+
<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>
|
|
1365
|
+
<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>
|
|
1366
|
+
<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>
|
|
1367
|
+
<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>
|
|
1368
|
+
<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>
|
|
1369
|
+
<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>
|
|
1370
|
+
<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>
|
|
1371
|
+
<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>
|
|
1372
|
+
<li><a href="MKCueEnterEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCue<wbr/>Enter<wbr/>Event</span></a></li>
|
|
1373
|
+
<li><a href="MKCueExitEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCue<wbr/>Exit<wbr/>Event</span></a></li>
|
|
1374
|
+
<li><a href="MKCueParsedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCue<wbr/>Parsed<wbr/>Event</span></a></li>
|
|
1375
|
+
<li><a href="MKCueUpdateEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKCue<wbr/>Update<wbr/>Event</span></a></li>
|
|
1376
|
+
<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>
|
|
1377
|
+
<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>
|
|
1378
|
+
<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>
|
|
1379
|
+
<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>
|
|
1380
|
+
<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>
|
|
1381
|
+
<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>
|
|
1382
|
+
<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>
|
|
1383
|
+
<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>
|
|
1384
|
+
<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>
|
|
1385
|
+
<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>
|
|
1386
|
+
<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>
|
|
1387
|
+
<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>
|
|
1388
|
+
<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>
|
|
1389
|
+
<li><a href="MKLiveConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKLive<wbr/>Config</span></a></li>
|
|
1390
|
+
<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>
|
|
1391
|
+
<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>
|
|
1392
|
+
<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>
|
|
1393
|
+
<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>
|
|
1394
|
+
<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>
|
|
1395
|
+
<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>
|
|
1396
|
+
<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>
|
|
1397
|
+
<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>
|
|
1398
|
+
<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>
|
|
1399
|
+
<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>
|
|
1400
|
+
<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>
|
|
1401
|
+
<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>
|
|
1402
|
+
<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>
|
|
1403
|
+
<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>
|
|
1404
|
+
<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>
|
|
1405
|
+
<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>
|
|
1406
|
+
<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>
|
|
1407
|
+
<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>
|
|
1408
|
+
<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>
|
|
1409
|
+
<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>
|
|
1410
|
+
<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>
|
|
1411
|
+
<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>
|
|
1412
|
+
<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>
|
|
1413
|
+
<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>
|
|
1414
|
+
<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>
|
|
1415
|
+
<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>
|
|
1416
|
+
<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>
|
|
1417
|
+
<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>
|
|
1418
|
+
<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>
|
|
1419
|
+
<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>
|
|
1420
|
+
<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>
|
|
1421
|
+
<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>
|
|
1422
|
+
<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>
|
|
1423
|
+
<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>
|
|
1424
|
+
<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>
|
|
1425
|
+
<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>
|
|
1426
|
+
<li><a href="MKSubtitleCue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKSubtitle<wbr/>Cue</span></a></li>
|
|
1427
|
+
<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>
|
|
1428
|
+
<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>
|
|
1429
|
+
<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>
|
|
1430
|
+
<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>
|
|
1431
|
+
<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>
|
|
1432
|
+
<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>
|
|
1433
|
+
<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>
|
|
1434
|
+
<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>
|
|
1435
|
+
<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>
|
|
1436
|
+
<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>
|
|
1437
|
+
<li><a href="MKULLSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>MKULLSource</span></a></li>
|
|
1438
|
+
<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>
|
|
1439
|
+
<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>
|
|
1440
|
+
<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>
|
|
1441
|
+
<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>
|
|
1442
|
+
<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>
|
|
1443
|
+
<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>
|
|
1444
|
+
<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>
|
|
1445
|
+
<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>
|
|
1446
|
+
<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>
|
|
1447
|
+
<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>
|
|
1448
|
+
<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>
|
|
1449
|
+
<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>
|
|
1450
|
+
<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>
|
|
1451
|
+
<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>
|
|
1452
|
+
<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>
|
|
1453
|
+
<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>
|
|
1454
|
+
<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>
|
|
1455
|
+
<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>
|
|
1456
|
+
<li><a href="../types/MKRequestBodyParams.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>MKRequest<wbr/>Body<wbr/>Params</span></a></li>
|
|
1457
|
+
<li><a href="../types/MKRequestHeaders.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>MKRequest<wbr/>Headers</span></a></li>
|
|
1458
|
+
<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></ul></nav></div></div></div>
|
|
1459
|
+
<div class="overlay"></div></body></html>
|