@mediakind/mkplayer 1.9.0 → 1.10.1

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.
Files changed (188) hide show
  1. package/CHANGELOG.md +182 -0
  2. package/docs/.nojekyll +1 -0
  3. package/docs/assets/highlight.css +148 -0
  4. package/docs/assets/main.js +58 -0
  5. package/docs/assets/search.js +1 -0
  6. package/docs/assets/style.css +1367 -0
  7. package/docs/enums/MKAdQuartile.html +247 -0
  8. package/docs/enums/MKAdType.html +255 -0
  9. package/docs/enums/MKAdaptationLogicType.html +256 -0
  10. package/docs/enums/MKAssetType.html +263 -0
  11. package/docs/enums/MKBufferType.html +235 -0
  12. package/docs/enums/MKDrmType.html +263 -0
  13. package/docs/enums/MKErrorCode.html +910 -0
  14. package/docs/enums/MKHttpRequestType.html +318 -0
  15. package/docs/enums/MKHttpResponseType.html +248 -0
  16. package/docs/enums/MKLatencyMode.html +255 -0
  17. package/docs/enums/MKLiveSynchronizationMethod.html +247 -0
  18. package/docs/enums/MKLogLevel.html +249 -0
  19. package/docs/enums/MKMediaType.html +229 -0
  20. package/docs/enums/MKMetadataType.html +283 -0
  21. package/docs/enums/MKPlatformType.html +229 -0
  22. package/docs/enums/MKPlayerEvent.html +1021 -0
  23. package/docs/enums/MKPlayerType.html +255 -0
  24. package/docs/enums/MKProgramRestrictionType.html +359 -0
  25. package/docs/enums/MKRttEstimationMethod.html +236 -0
  26. package/docs/enums/MKStartOffsetTimelineReference.html +239 -0
  27. package/docs/enums/MKStreamType.html +271 -0
  28. package/docs/enums/MKTimeMode.html +239 -0
  29. package/docs/enums/MKViewMode.html +238 -0
  30. package/docs/index.html +266 -0
  31. package/docs/interfaces/MKAdBreakFinishedEvent.html +255 -0
  32. package/docs/interfaces/MKAdBreakStartedEvent.html +287 -0
  33. package/docs/interfaces/MKAdClickThroughEvent.html +271 -0
  34. package/docs/interfaces/MKAdCompanionEvent.html +264 -0
  35. package/docs/interfaces/MKAdFinishedEvent.html +255 -0
  36. package/docs/interfaces/MKAdMarkerEvent.html +255 -0
  37. package/docs/interfaces/MKAdQuartileEvent.html +263 -0
  38. package/docs/interfaces/MKAdStartedEvent.html +312 -0
  39. package/docs/interfaces/MKAdVerificationEvent.html +272 -0
  40. package/docs/interfaces/MKAdaptationAPI.html +258 -0
  41. package/docs/interfaces/MKAdaptationConfig.html +393 -0
  42. package/docs/interfaces/MKAdaptationData.html +253 -0
  43. package/docs/interfaces/MKAdaptationEvent.html +258 -0
  44. package/docs/interfaces/MKAdaptationPlatformConfig.html +243 -0
  45. package/docs/interfaces/MKAdobePrimetimeConfig.html +307 -0
  46. package/docs/interfaces/MKAirplayChangedEvent.html +274 -0
  47. package/docs/interfaces/MKAnalyticsConfig.html +434 -0
  48. package/docs/interfaces/MKAspectRatioChangedEvent.html +263 -0
  49. package/docs/interfaces/MKAudioAdaptationData.html +254 -0
  50. package/docs/interfaces/MKAudioAdaptationEvent.html +256 -0
  51. package/docs/interfaces/MKAudioChangedEvent.html +282 -0
  52. package/docs/interfaces/MKAudioDownloadQualityChangeEvent.html +283 -0
  53. package/docs/interfaces/MKAudioDownloadQualityChangedEvent.html +283 -0
  54. package/docs/interfaces/MKAudioPlaybackQualityChangedEvent.html +265 -0
  55. package/docs/interfaces/MKAudioQuality.html +272 -0
  56. package/docs/interfaces/MKAudioQualityChangedEvent.html +283 -0
  57. package/docs/interfaces/MKAudioQualityEvent.html +253 -0
  58. package/docs/interfaces/MKAudioTrack.html +276 -0
  59. package/docs/interfaces/MKAudioTrackEvent.html +274 -0
  60. package/docs/interfaces/MKBitrateLimitationConfig.html +259 -0
  61. package/docs/interfaces/MKBufferAPI.html +276 -0
  62. package/docs/interfaces/MKBufferConfig.html +243 -0
  63. package/docs/interfaces/MKBufferLevel.html +255 -0
  64. package/docs/interfaces/MKBufferMediaTypeConfig.html +246 -0
  65. package/docs/interfaces/MKCastAvailableEvent.html +256 -0
  66. package/docs/interfaces/MKCastConfig.html +281 -0
  67. package/docs/interfaces/MKCastStartedEvent.html +263 -0
  68. package/docs/interfaces/MKCastWaitingForDeviceEvent.html +263 -0
  69. package/docs/interfaces/MKCdnOptions.html +245 -0
  70. package/docs/interfaces/MKClearKeyDRMConfig.html +219 -0
  71. package/docs/interfaces/MKClearKeyDRMConfigEntry.html +240 -0
  72. package/docs/interfaces/MKClearKeyDRMServerConfig.html +281 -0
  73. package/docs/interfaces/MKDownloadFinishedEvent.html +327 -0
  74. package/docs/interfaces/MKDownloadedAudioData.html +256 -0
  75. package/docs/interfaces/MKDownloadedData.html +254 -0
  76. package/docs/interfaces/MKDownloadedVideoData.html +272 -0
  77. package/docs/interfaces/MKDrmAPI.html +278 -0
  78. package/docs/interfaces/MKDrmConfig.html +296 -0
  79. package/docs/interfaces/MKDrmLicense.html +238 -0
  80. package/docs/interfaces/MKDrmLicenseAddedEvent.html +255 -0
  81. package/docs/interfaces/MKDurationChangedEvent.html +263 -0
  82. package/docs/interfaces/MKDynamicAdaptationConfig.html +259 -0
  83. package/docs/interfaces/MKEnvironmentConfig.html +265 -0
  84. package/docs/interfaces/MKError.html +258 -0
  85. package/docs/interfaces/MKErrorEvent.html +276 -0
  86. package/docs/interfaces/MKFMTSASiDEvent.html +263 -0
  87. package/docs/interfaces/MKFairplayDrmConfig.html +443 -0
  88. package/docs/interfaces/MKHttpRequestOptions.html +268 -0
  89. package/docs/interfaces/MKHttpResponse.html +320 -0
  90. package/docs/interfaces/MKLatencyModeChangedEvent.html +263 -0
  91. package/docs/interfaces/MKLiveConfig.html +240 -0
  92. package/docs/interfaces/MKLogConfig.html +235 -0
  93. package/docs/interfaces/MKLowLatencyAPI.html +316 -0
  94. package/docs/interfaces/MKLowLatencyConfig.html +251 -0
  95. package/docs/interfaces/MKLowLatencySyncConfig.html +251 -0
  96. package/docs/interfaces/MKManifestAPI.html +234 -0
  97. package/docs/interfaces/MKMediaPlaybackQualityChangeEvent.html +271 -0
  98. package/docs/interfaces/MKMediaQualityChangeEvent.html +286 -0
  99. package/docs/interfaces/MKMediaQualityEvent.html +255 -0
  100. package/docs/interfaces/MKMediaTrack.html +251 -0
  101. package/docs/interfaces/MKMediaTrackRole.html +245 -0
  102. package/docs/interfaces/MKMetadata.html +255 -0
  103. package/docs/interfaces/MKMetadataChangedEvent.html +284 -0
  104. package/docs/interfaces/MKMetadataEvent.html +283 -0
  105. package/docs/interfaces/MKMetadataParsedEvent.html +284 -0
  106. package/docs/interfaces/MKPeriodContentInformation.html +247 -0
  107. package/docs/interfaces/MKPeriodInformation.html +239 -0
  108. package/docs/interfaces/MKPeriodSwitchObject.html +231 -0
  109. package/docs/interfaces/MKPeriodSwitchedEvent.html +263 -0
  110. package/docs/interfaces/MKPlayReadyDrmConfig.html +310 -0
  111. package/docs/interfaces/MKPlayStation5Tweaks.html +270 -0
  112. package/docs/interfaces/MKPlaybackConfig.html +369 -0
  113. package/docs/interfaces/MKPlaybackEvent.html +270 -0
  114. package/docs/interfaces/MKPlaybackSpeedChangedEvent.html +263 -0
  115. package/docs/interfaces/MKPlayerAPI.html +1612 -0
  116. package/docs/interfaces/MKPlayerConfig.html +361 -0
  117. package/docs/interfaces/MKPlayerCoreAPI.html +1469 -0
  118. package/docs/interfaces/MKPlayerEventBase.html +281 -0
  119. package/docs/interfaces/MKPlayerEventCallback.html +228 -0
  120. package/docs/interfaces/MKPlayerEventConfig.html +212 -0
  121. package/docs/interfaces/MKPlayerResizedEvent.html +263 -0
  122. package/docs/interfaces/MKPlayerTechnology.html +247 -0
  123. package/docs/interfaces/MKPreferredTechnology.html +257 -0
  124. package/docs/interfaces/MKProgramRestrictions.html +252 -0
  125. package/docs/interfaces/MKProgramRestrictionsEvent.html +255 -0
  126. package/docs/interfaces/MKProgramTimeChangedEvent.html +255 -0
  127. package/docs/interfaces/MKProgressiveSource.html +267 -0
  128. package/docs/interfaces/MKQuality.html +268 -0
  129. package/docs/interfaces/MKQualityMetadata.html +279 -0
  130. package/docs/interfaces/MKRegisteredSource.html +288 -0
  131. package/docs/interfaces/MKSeekEvent.html +273 -0
  132. package/docs/interfaces/MKSegmentInfo.html +251 -0
  133. package/docs/interfaces/MKSegmentMap.html +216 -0
  134. package/docs/interfaces/MKSegmentPlaybackEvent.html +361 -0
  135. package/docs/interfaces/MKSegmentQualityMap.html +216 -0
  136. package/docs/interfaces/MKSegmentRequestFinishedEvent.html +311 -0
  137. package/docs/interfaces/MKSourceConfig.html +409 -0
  138. package/docs/interfaces/MKSourceLabelingConfig.html +299 -0
  139. package/docs/interfaces/MKSourceLabelingStreamTypeConfig.html +243 -0
  140. package/docs/interfaces/MKSourceOptions.html +394 -0
  141. package/docs/interfaces/MKSubtitleCueEvent.html +335 -0
  142. package/docs/interfaces/MKSubtitleCuePosition.html +243 -0
  143. package/docs/interfaces/MKSubtitleEvent.html +255 -0
  144. package/docs/interfaces/MKSubtitleTrack.html +306 -0
  145. package/docs/interfaces/MKSubtitlesAPI.html +355 -0
  146. package/docs/interfaces/MKSynchronizationConfigEntry.html +239 -0
  147. package/docs/interfaces/MKTargetLatencyChangedEvent.html +263 -0
  148. package/docs/interfaces/MKTextTrack.html +286 -0
  149. package/docs/interfaces/MKThumbnail.html +291 -0
  150. package/docs/interfaces/MKThumbnailTrack.html +235 -0
  151. package/docs/interfaces/MKTimeChangedEvent.html +266 -0
  152. package/docs/interfaces/MKTimeRange.html +239 -0
  153. package/docs/interfaces/MKTimelineMarker.html +277 -0
  154. package/docs/interfaces/MKTrackMetadata.html +247 -0
  155. package/docs/interfaces/MKTweaksConfig.html +567 -0
  156. package/docs/interfaces/MKUserInteractionEvent.html +260 -0
  157. package/docs/interfaces/MKVSPPSessionIdEvent.html +255 -0
  158. package/docs/interfaces/MKVTTProperties.html +312 -0
  159. package/docs/interfaces/MKVTTRegionProperties.html +295 -0
  160. package/docs/interfaces/MKVideoAdaptationData.html +254 -0
  161. package/docs/interfaces/MKVideoAdaptationEvent.html +256 -0
  162. package/docs/interfaces/MKVideoDownloadQualityChangeEvent.html +283 -0
  163. package/docs/interfaces/MKVideoDownloadQualityChangedEvent.html +283 -0
  164. package/docs/interfaces/MKVideoPlaybackQualityChangedEvent.html +265 -0
  165. package/docs/interfaces/MKVideoQuality.html +296 -0
  166. package/docs/interfaces/MKVideoQualityChangedEvent.html +283 -0
  167. package/docs/interfaces/MKVideoQualityEvent.html +253 -0
  168. package/docs/interfaces/MKVideoSizeLimitationConfig.html +263 -0
  169. package/docs/interfaces/MKVideoTrack.html +268 -0
  170. package/docs/interfaces/MKViewModeChangedEvent.html +271 -0
  171. package/docs/interfaces/MKViewModeOptions.html +235 -0
  172. package/docs/interfaces/MKVolumeChangedEvent.html +273 -0
  173. package/docs/interfaces/MKWidevineModularDrmConfig.html +364 -0
  174. package/docs/modules.html +386 -0
  175. package/docs/types/MKBitrate.html +206 -0
  176. package/docs/types/MKHeaders.html +211 -0
  177. package/docs/types/MKHttpMethod.html +206 -0
  178. package/docs/types/MKRequestBody.html +211 -0
  179. package/docs/types/MKRequestQueryParams.html +211 -0
  180. package/docs/types/MKWishAbrConfig.html +242 -0
  181. package/mkplayer.js +1 -1
  182. package/package.json +1 -1
  183. package/types/classes/player/MKPlayer.d.ts +4 -1
  184. package/types/constants/MKVersion.d.ts +1 -1
  185. package/types/interfaces/MKPlayerCoreAPI.d.ts +4 -0
  186. package/types/interfaces/MKSourceConfig.d.ts +2 -0
  187. package/types/interfaces/MKTimelineMarker.d.ts +7 -0
  188. package/types/interfaces/index.d.ts +1 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mediakind/mkplayer",
3
- "version": "1.9.0",
3
+ "version": "1.10.1",
4
4
  "description": "MediaKind HTML5 player SDK for HLS and DASH streams.",
5
5
  "author": "MediaKind",
6
6
  "license": "©2024 Copyright Mediakind Ltd. All Rights Reserved. Including All Downloadable Materials.",
@@ -1,6 +1,6 @@
1
1
  import { MKEventBase } from "../common";
2
2
  import { MKLogLevel, MKPlayerType, MKStreamType, MKTimeMode, MKViewMode } from "../../enums";
3
- import { MKAdaptationAPI, MKAudioQuality, MKAudioTrack, MKDownloadedAudioData, MKDownloadedVideoData, MKDrmAPI, MKLowLatencyAPI, MKPlayerAPI, MKBufferAPI, MKPlayerConfig, MKManifestAPI, MKSubtitlesAPI, MKSegmentMap, MKSourceConfig, MKSourceOptions, MKThumbnail, MKTimeRange, MKVideoQuality, MKViewModeOptions } from "../../interfaces";
3
+ import { MKAdaptationAPI, MKAudioQuality, MKAudioTrack, MKDownloadedAudioData, MKDownloadedVideoData, MKDrmAPI, MKLowLatencyAPI, MKPlayerAPI, MKBufferAPI, MKPlayerConfig, MKManifestAPI, MKSubtitlesAPI, MKSegmentMap, MKSourceConfig, MKSourceOptions, MKThumbnail, MKTimeRange, MKVideoQuality, MKViewModeOptions, MKTimelineMarker } from "../../interfaces";
4
4
  import { MKHeaders } from "../../alias";
5
5
  export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
6
6
  readonly adaptation: MKAdaptationAPI;
@@ -27,6 +27,7 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
27
27
  private currentSourceInfo;
28
28
  constructor(videoContainer: HTMLElement, playerConfig: MKPlayerConfig);
29
29
  addCastMetadata(metadata: any): boolean;
30
+ addTimelineMarker(timelineMarker: MKTimelineMarker): void;
30
31
  castStop(): void;
31
32
  castVideo(): void;
32
33
  destroy(): Promise<void>;
@@ -53,6 +54,7 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
53
54
  getStreamType(): MKStreamType;
54
55
  getThumbnail(time: number): MKThumbnail | null;
55
56
  getTimeShift(): number;
57
+ getTimelineMarkers(): MKTimelineMarker[];
56
58
  getTotalStalledTime(): number;
57
59
  getVersion(): string;
58
60
  getVideoContainer(): HTMLElement;
@@ -77,6 +79,7 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
77
79
  play(issuer?: string): Promise<void>;
78
80
  preload(): void;
79
81
  reload(start?: string, sourceOptions?: MKSourceOptions): Promise<void>;
82
+ removeTimelineMarker(timelineMarker: MKTimelineMarker): boolean;
80
83
  seek(time: number, issuer?: string): boolean;
81
84
  seekToLiveEdge(issuer?: string): void;
82
85
  setAspectRatio(aspectratio: string | number): void;
@@ -1 +1 @@
1
- export declare const version = "1.9.0";
1
+ export declare const version = "1.10.1";
@@ -19,6 +19,7 @@ import { MKLowLatencyAPI } from "./MKLowLatencyAPI";
19
19
  import { MKSegmentMap } from "./MKSegmentMap";
20
20
  import { MKManifestAPI } from "./MKManifestAPI";
21
21
  import { MKPlayerEventBase } from "./events";
22
+ import { MKTimelineMarker } from "./MKTimelineMarker";
22
23
  export interface MKPlayerCoreAPI {
23
24
  readonly adaptation: MKAdaptationAPI;
24
25
  readonly buffer: MKBufferAPI;
@@ -27,6 +28,7 @@ export interface MKPlayerCoreAPI {
27
28
  readonly manifest: MKManifestAPI;
28
29
  readonly subtitles: MKSubtitlesAPI;
29
30
  addCastMetadata(metadata: any): boolean;
31
+ addTimelineMarker(timelineMarker: MKTimelineMarker): void;
30
32
  castStop(): void;
31
33
  castVideo(): void;
32
34
  destroy(): Promise<void>;
@@ -53,6 +55,7 @@ export interface MKPlayerCoreAPI {
53
55
  getStreamType(): MKStreamType;
54
56
  getThumbnail(time: number): MKThumbnail | null;
55
57
  getTimeShift(): number;
58
+ getTimelineMarkers(): MKTimelineMarker[];
56
59
  getTotalStalledTime(): number;
57
60
  getVersion(): string;
58
61
  getVideoContainer(): HTMLElement;
@@ -80,6 +83,7 @@ export interface MKPlayerCoreAPI {
80
83
  play(issuer?: string): Promise<void>;
81
84
  preload(): void;
82
85
  reload(start?: string, sourceOptions?: MKSourceOptions): Promise<void>;
86
+ removeTimelineMarker(timelineMarker: MKTimelineMarker): boolean;
83
87
  seek(time: number, issuer?: string): boolean;
84
88
  seekToLiveEdge(issuer?: string): void;
85
89
  setAspectRatio(aspectratio: string | number): void;
@@ -8,6 +8,7 @@ import { MKAnalyticsConfig } from "./MKAnalyticsConfig";
8
8
  import { MKRegisteredSource } from "./MKRegisteredSource";
9
9
  import { MKProgressiveSource } from "./MKProgressiveSource";
10
10
  import { MKSourceLabelingStreamTypeConfig } from "./MKSourceLabelingStreamTypeConfig";
11
+ import { MKTimelineMarker } from "./MKTimelineMarker";
11
12
  export interface MKSourceConfig {
12
13
  title?: string;
13
14
  description?: string;
@@ -27,4 +28,5 @@ export interface MKSourceConfig {
27
28
  analytics?: MKAnalyticsConfig;
28
29
  subtitleTracks?: MKSubtitleTrack[];
29
30
  thumbnailTrack?: MKThumbnailTrack;
31
+ timelineMarkers?: MKTimelineMarker[];
30
32
  }
@@ -0,0 +1,7 @@
1
+ export interface MKTimelineMarker {
2
+ time: number;
3
+ duration?: number;
4
+ title?: string;
5
+ imageUrl?: string;
6
+ cssClasses?: string[];
7
+ }
@@ -74,6 +74,7 @@ export { MKSynchronizationConfigEntry } from "./MKSynchronizationConfigEntry";
74
74
  export { MKTextTrack } from "./MKTextTrack";
75
75
  export { MKThumbnail } from "./MKThumbnail";
76
76
  export { MKThumbnailTrack } from "./MKThumbnailTrack";
77
+ export { MKTimelineMarker } from "./MKTimelineMarker";
77
78
  export { MKTimeRange } from "./MKTimeRange";
78
79
  export { MKTrackMetadata } from "./MKTrackMetadata";
79
80
  export { MKTweaksConfig } from "./MKTweaksConfig";