@mediakind/mkplayer 1.42.0 → 1.44.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.
Files changed (204) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/docs/assets/search.js +1 -1
  3. package/docs/enums/MKAdQuartile.html +5 -3
  4. package/docs/enums/MKAdType.html +5 -3
  5. package/docs/enums/MKAdaptationLogicType.html +5 -3
  6. package/docs/enums/MKAssetType.html +5 -3
  7. package/docs/enums/MKBufferType.html +5 -3
  8. package/docs/enums/MKDrmType.html +5 -3
  9. package/docs/enums/MKErrorCode.html +5 -3
  10. package/docs/enums/MKHttpRequestType.html +5 -3
  11. package/docs/enums/MKHttpResponseType.html +5 -3
  12. package/docs/enums/MKLatencyMode.html +5 -3
  13. package/docs/enums/MKLiveSynchronizationMethod.html +5 -3
  14. package/docs/enums/MKLogLevel.html +5 -3
  15. package/docs/enums/MKMediaType.html +5 -3
  16. package/docs/enums/MKMetadataType.html +5 -3
  17. package/docs/enums/MKPlatformType.html +5 -3
  18. package/docs/enums/MKPlayerEngineType.html +5 -3
  19. package/docs/enums/MKPlayerEvent.html +24 -16
  20. package/docs/enums/MKPlayerType.html +5 -3
  21. package/docs/enums/MKProgramRestrictionType.html +5 -3
  22. package/docs/enums/MKRttEstimationMethod.html +5 -3
  23. package/docs/enums/MKStartOffsetTimelineReference.html +5 -3
  24. package/docs/enums/MKStreamType.html +5 -3
  25. package/docs/enums/MKTimeMode.html +5 -3
  26. package/docs/enums/MKViewMode.html +5 -3
  27. package/docs/index.html +6 -4
  28. package/docs/interfaces/MKAd.html +5 -3
  29. package/docs/interfaces/MKAdBreak.html +5 -3
  30. package/docs/interfaces/MKAdBreakConfig.html +5 -3
  31. package/docs/interfaces/MKAdBreakEvent.html +5 -3
  32. package/docs/interfaces/MKAdBreakFinishedEvent.html +5 -3
  33. package/docs/interfaces/MKAdBreakSkippedEvent.html +274 -0
  34. package/docs/interfaces/MKAdBreakStartedEvent.html +5 -3
  35. package/docs/interfaces/MKAdClickThroughEvent.html +5 -3
  36. package/docs/interfaces/MKAdClickedEvent.html +5 -3
  37. package/docs/interfaces/MKAdCompanionEvent.html +5 -3
  38. package/docs/interfaces/MKAdConfig.html +5 -3
  39. package/docs/interfaces/MKAdEvent.html +5 -3
  40. package/docs/interfaces/MKAdFinishedEvent.html +5 -3
  41. package/docs/interfaces/MKAdInteractionEvent.html +5 -3
  42. package/docs/interfaces/MKAdLinearityChangedEvent.html +5 -3
  43. package/docs/interfaces/MKAdManifestLoadedEvent.html +5 -3
  44. package/docs/interfaces/MKAdMarkerEvent.html +5 -3
  45. package/docs/interfaces/MKAdQuartileEvent.html +5 -3
  46. package/docs/interfaces/MKAdSkippedEvent.html +331 -0
  47. package/docs/interfaces/MKAdStartedEvent.html +5 -3
  48. package/docs/interfaces/MKAdVerificationEvent.html +5 -3
  49. package/docs/interfaces/MKAdaptationAPI.html +5 -3
  50. package/docs/interfaces/MKAdaptationConfig.html +5 -3
  51. package/docs/interfaces/MKAdaptationData.html +5 -3
  52. package/docs/interfaces/MKAdaptationEvent.html +5 -3
  53. package/docs/interfaces/MKAdaptationPlatformConfig.html +5 -3
  54. package/docs/interfaces/MKAdobePrimetimeConfig.html +5 -3
  55. package/docs/interfaces/MKAdvertisingConfig.html +5 -3
  56. package/docs/interfaces/MKAirplayChangedEvent.html +5 -3
  57. package/docs/interfaces/MKAnalyticsConfig.html +5 -3
  58. package/docs/interfaces/MKAspectRatioChangedEvent.html +5 -3
  59. package/docs/interfaces/MKAudioAdaptationData.html +5 -3
  60. package/docs/interfaces/MKAudioAdaptationEvent.html +5 -3
  61. package/docs/interfaces/MKAudioChangedEvent.html +5 -3
  62. package/docs/interfaces/MKAudioDownloadQualityChangeEvent.html +5 -3
  63. package/docs/interfaces/MKAudioDownloadQualityChangedEvent.html +5 -3
  64. package/docs/interfaces/MKAudioPlaybackQualityChangedEvent.html +5 -3
  65. package/docs/interfaces/MKAudioQuality.html +5 -3
  66. package/docs/interfaces/MKAudioQualityChangedEvent.html +5 -3
  67. package/docs/interfaces/MKAudioQualityEvent.html +5 -3
  68. package/docs/interfaces/MKAudioTrack.html +5 -3
  69. package/docs/interfaces/MKAudioTrackEvent.html +5 -3
  70. package/docs/interfaces/MKBitrateLimitationConfig.html +5 -3
  71. package/docs/interfaces/MKBufferAPI.html +5 -3
  72. package/docs/interfaces/MKBufferConfig.html +8 -3
  73. package/docs/interfaces/MKBufferLevel.html +5 -3
  74. package/docs/interfaces/MKBufferMediaTypeConfig.html +5 -3
  75. package/docs/interfaces/MKCastAvailableEvent.html +5 -3
  76. package/docs/interfaces/MKCastConfig.html +5 -3
  77. package/docs/interfaces/MKCastStartedEvent.html +5 -3
  78. package/docs/interfaces/MKCastWaitingForDeviceEvent.html +5 -3
  79. package/docs/interfaces/MKCdnOptions.html +5 -3
  80. package/docs/interfaces/MKClearKeyDRMConfig.html +5 -3
  81. package/docs/interfaces/MKClearKeyDRMConfigEntry.html +5 -3
  82. package/docs/interfaces/MKClearKeyDRMServerConfig.html +5 -3
  83. package/docs/interfaces/MKDownloadFinishedEvent.html +5 -3
  84. package/docs/interfaces/MKDownloadTiming.html +5 -3
  85. package/docs/interfaces/MKDownloadedAudioData.html +5 -3
  86. package/docs/interfaces/MKDownloadedData.html +5 -3
  87. package/docs/interfaces/MKDownloadedVideoData.html +5 -3
  88. package/docs/interfaces/MKDrmAPI.html +5 -3
  89. package/docs/interfaces/MKDrmConfig.html +5 -3
  90. package/docs/interfaces/MKDrmLicense.html +5 -3
  91. package/docs/interfaces/MKDrmLicenseAddedEvent.html +5 -3
  92. package/docs/interfaces/MKDurationChangedEvent.html +5 -3
  93. package/docs/interfaces/MKDynamicAdaptationConfig.html +5 -3
  94. package/docs/interfaces/MKEnvironmentConfig.html +5 -3
  95. package/docs/interfaces/MKError.html +5 -3
  96. package/docs/interfaces/MKErrorEvent.html +5 -3
  97. package/docs/interfaces/MKFMTSASiDEvent.html +5 -3
  98. package/docs/interfaces/MKFairplayDrmConfig.html +5 -3
  99. package/docs/interfaces/MKHttpRequestOptions.html +5 -3
  100. package/docs/interfaces/MKHttpResponse.html +5 -3
  101. package/docs/interfaces/MKLatencyModeChangedEvent.html +5 -3
  102. package/docs/interfaces/MKLiveConfigAtSourceLevel.html +5 -3
  103. package/docs/interfaces/MKLogConfig.html +5 -3
  104. package/docs/interfaces/MKLowLatencyAPI.html +5 -3
  105. package/docs/interfaces/MKLowLatencyConfig.html +5 -3
  106. package/docs/interfaces/MKLowLatencySyncConfig.html +5 -3
  107. package/docs/interfaces/MKManifestAPI.html +5 -3
  108. package/docs/interfaces/MKMediaPlaybackQualityChangeEvent.html +5 -3
  109. package/docs/interfaces/MKMediaQualityChangeEvent.html +5 -3
  110. package/docs/interfaces/MKMediaQualityEvent.html +5 -3
  111. package/docs/interfaces/MKMediaTrack.html +5 -3
  112. package/docs/interfaces/MKMediaTrackRole.html +5 -3
  113. package/docs/interfaces/MKMetadata.html +5 -3
  114. package/docs/interfaces/MKMetadataChangedEvent.html +5 -3
  115. package/docs/interfaces/MKMetadataEvent.html +5 -3
  116. package/docs/interfaces/MKMetadataParsedEvent.html +5 -3
  117. package/docs/interfaces/MKModuleInfo.html +5 -3
  118. package/docs/interfaces/MKPeriodContentInformation.html +5 -3
  119. package/docs/interfaces/MKPeriodInformation.html +5 -3
  120. package/docs/interfaces/MKPeriodSwitchObject.html +5 -3
  121. package/docs/interfaces/MKPeriodSwitchedEvent.html +5 -3
  122. package/docs/interfaces/MKPlayReadyDrmConfig.html +5 -3
  123. package/docs/interfaces/MKPlayStation5Tweaks.html +5 -3
  124. package/docs/interfaces/MKPlaybackConfig.html +8 -3
  125. package/docs/interfaces/MKPlaybackEvent.html +5 -3
  126. package/docs/interfaces/MKPlaybackSpeedChangedEvent.html +5 -3
  127. package/docs/interfaces/MKPlayerAPI.html +31 -3
  128. package/docs/interfaces/MKPlayerAdvertisingAPI.html +5 -3
  129. package/docs/interfaces/MKPlayerConfig.html +5 -3
  130. package/docs/interfaces/MKPlayerCoreAPI.html +5 -3
  131. package/docs/interfaces/MKPlayerEventBase.html +7 -3
  132. package/docs/interfaces/MKPlayerEventCallback.html +5 -3
  133. package/docs/interfaces/MKPlayerEventConfig.html +5 -3
  134. package/docs/interfaces/MKPlayerResizedEvent.html +5 -3
  135. package/docs/interfaces/MKPlayerTechnology.html +5 -3
  136. package/docs/interfaces/MKPreferredTechnology.html +5 -3
  137. package/docs/interfaces/MKProgramRestrictions.html +5 -3
  138. package/docs/interfaces/MKProgramRestrictionsEvent.html +5 -3
  139. package/docs/interfaces/MKProgramTimeChangedEvent.html +5 -3
  140. package/docs/interfaces/MKProgressiveSource.html +5 -3
  141. package/docs/interfaces/MKQuality.html +5 -3
  142. package/docs/interfaces/MKQualityMetadata.html +5 -3
  143. package/docs/interfaces/MKRegisteredSource.html +5 -3
  144. package/docs/interfaces/MKSeekEvent.html +5 -3
  145. package/docs/interfaces/MKSegmentInfo.html +5 -3
  146. package/docs/interfaces/MKSegmentMap.html +5 -3
  147. package/docs/interfaces/MKSegmentPlaybackEvent.html +5 -3
  148. package/docs/interfaces/MKSegmentQualityMap.html +5 -3
  149. package/docs/interfaces/MKSegmentRequestFinishedEvent.html +5 -3
  150. package/docs/interfaces/MKSourceConfig.html +5 -3
  151. package/docs/interfaces/MKSourceLabelingConfig.html +5 -3
  152. package/docs/interfaces/MKSourceLabelingStreamTypeConfig.html +5 -3
  153. package/docs/interfaces/MKSourceOptions.html +5 -3
  154. package/docs/interfaces/MKStyleConfig.html +5 -3
  155. package/docs/interfaces/MKSubtitleCueEvent.html +5 -3
  156. package/docs/interfaces/MKSubtitleCuePosition.html +5 -3
  157. package/docs/interfaces/MKSubtitleEvent.html +5 -3
  158. package/docs/interfaces/MKSubtitleTrack.html +5 -3
  159. package/docs/interfaces/MKSubtitlesAPI.html +5 -3
  160. package/docs/interfaces/MKSynchronizationConfigEntry.html +5 -3
  161. package/docs/interfaces/MKTargetLatencyChangedEvent.html +5 -3
  162. package/docs/interfaces/MKTextTrack.html +5 -3
  163. package/docs/interfaces/MKThumbnail.html +5 -3
  164. package/docs/interfaces/MKThumbnailTrack.html +5 -3
  165. package/docs/interfaces/MKTimeChangedEvent.html +5 -3
  166. package/docs/interfaces/MKTimeRange.html +5 -3
  167. package/docs/interfaces/MKTimelineMarker.html +5 -3
  168. package/docs/interfaces/MKTrackMetadata.html +5 -3
  169. package/docs/interfaces/MKTweaksConfig.html +11 -8
  170. package/docs/interfaces/MKUserInteractionEvent.html +5 -3
  171. package/docs/interfaces/MKVSPPSessionIdEvent.html +5 -3
  172. package/docs/interfaces/MKVTTProperties.html +5 -3
  173. package/docs/interfaces/MKVTTRegionProperties.html +5 -3
  174. package/docs/interfaces/MKVideoAdaptationData.html +5 -3
  175. package/docs/interfaces/MKVideoAdaptationEvent.html +5 -3
  176. package/docs/interfaces/MKVideoDownloadQualityChangeEvent.html +5 -3
  177. package/docs/interfaces/MKVideoDownloadQualityChangedEvent.html +5 -3
  178. package/docs/interfaces/MKVideoPlaybackQualityChangedEvent.html +5 -3
  179. package/docs/interfaces/MKVideoQuality.html +5 -3
  180. package/docs/interfaces/MKVideoQualityChangedEvent.html +5 -3
  181. package/docs/interfaces/MKVideoQualityEvent.html +5 -3
  182. package/docs/interfaces/MKVideoSizeLimitationConfig.html +5 -3
  183. package/docs/interfaces/MKVideoTrack.html +5 -3
  184. package/docs/interfaces/MKViewModeChangedEvent.html +5 -3
  185. package/docs/interfaces/MKViewModeOptions.html +5 -3
  186. package/docs/interfaces/MKVolumeChangedEvent.html +5 -3
  187. package/docs/interfaces/MKWidevineModularDrmConfig.html +5 -3
  188. package/docs/modules.html +8 -4
  189. package/docs/types/MKBitrate.html +5 -3
  190. package/docs/types/MKHeaders.html +5 -3
  191. package/docs/types/MKHttpMethod.html +5 -3
  192. package/docs/types/MKRequestBody.html +5 -3
  193. package/docs/types/MKRequestQueryParams.html +5 -3
  194. package/docs/types/MKUserEngagement.html +5 -3
  195. package/docs/types/MKWishAbrConfig.html +5 -3
  196. package/mkplayer.js +1 -1
  197. package/package.json +1 -1
  198. package/types/classes/player/MKPlayer.d.ts +14 -1
  199. package/types/constants/MKVersion.d.ts +1 -1
  200. package/types/enums/MKPlayerEvent.d.ts +1 -0
  201. package/types/interfaces/MKPlayerAPI.d.ts +1 -0
  202. package/types/interfaces/events/MKAdBreakSkippedEvent.d.ts +4 -0
  203. package/types/interfaces/events/MKAdSkippedEvent.d.ts +12 -0
  204. package/types/interfaces/events/index.d.ts +2 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mediakind/mkplayer",
3
- "version": "1.42.0",
3
+ "version": "1.44.0",
4
4
  "description": "MediaKind HTML5 player SDK for HLS and DASH streams.",
5
5
  "author": "MediaKind",
6
6
  "license": "©2025 Copyright Mediakind Ltd. All Rights Reserved. Including All Downloadable Materials.",
@@ -36,6 +36,16 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
36
36
  private lowLatencyAnalyticsInterval;
37
37
  private clientPrefersLowLatencyPlayback;
38
38
  private llCustomDataFieldDef;
39
+ private adBreakInProgressDuration;
40
+ private adInProgressDuration;
41
+ private adBreakStartTime;
42
+ private adStartTime;
43
+ private adSkipSeek;
44
+ private adBreakSkipSeek;
45
+ private adStartedEventData;
46
+ private adBreakStartedEventData;
47
+ private skippedAdInfo;
48
+ private pendingAdEndEvent;
39
49
  constructor(videoContainer: HTMLElement, playerConfig: MKPlayerConfig);
40
50
  private setCustomData;
41
51
  addCastMetadata(metadata: any): boolean;
@@ -43,7 +53,6 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
43
53
  addTimelineMarker(timelineMarker: MKTimelineMarker): void;
44
54
  castStop(): void;
45
55
  scheduleAd(AdBreakConfig: MKAdBreakConfig): Promise<MKAdBreak[] | undefined>;
46
- skipAd(): Promise<void>;
47
56
  discardAdBreak(adBreakId: string): void;
48
57
  getActiveAd(): MKAd;
49
58
  getActiveAdBreak(): MKAdBreak;
@@ -114,6 +123,7 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
114
123
  setHttpHeaders(headers: MKHeaders | null): void;
115
124
  setInhomeStatus(inhomeStatus: boolean): void;
116
125
  setLocationDetail(locationDetail: string | null): void;
126
+ setGeoComplyLocationProvider(provider: (() => string | undefined) | null): void;
117
127
  setLogLevel(level: MKLogLevel): void;
118
128
  setPlaybackSpeed(speed: number): void;
119
129
  setPosterImage(url: string, keepPersistent: boolean): void;
@@ -126,6 +136,8 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
126
136
  setSubtitleStyle(styleOptions: any): void;
127
137
  setCloudIdConfig(cloudIdInfo: string | null): void;
128
138
  showAirplayTargetPicker(): void;
139
+ skipAd(isCSAI?: boolean): Promise<void>;
140
+ skipAdBreak(): void;
129
141
  unload(): Promise<void>;
130
142
  unmute(issuer?: string): void;
131
143
  updateAuthToken(authToken: string): void;
@@ -139,4 +151,5 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
139
151
  private onSessionConcurrencyNotificationError;
140
152
  private setLowLatencyConfig;
141
153
  private clearLowLatencyInterval;
154
+ private onSSAIAdSkipped;
142
155
  }
@@ -1 +1 @@
1
- export declare const version = "1.42.0";
1
+ export declare const version = "1.44.0";
@@ -5,6 +5,7 @@ export declare enum MKPlayerEvent {
5
5
  AdError = "aderror",
6
6
  AdClicked = "adclicked",
7
7
  AdSkipped = "adskipped",
8
+ AdBreakSkipped = "adbreakskipped",
8
9
  AdMarker = "admarker",
9
10
  AdBreakStarted = "adbreakstarted",
10
11
  AdStarted = "adstarted",
@@ -8,4 +8,5 @@ export interface MKPlayerAPI extends MKPlayerCoreAPI {
8
8
  setUserEngagementData(userEngagementData?: MKUserEngagement | null): void;
9
9
  getSourceConfig(): Object | null;
10
10
  setCloudIdConfig(cloudIdInfo: string): void;
11
+ setGeoComplyLocationProvider(provider: (() => string | undefined) | null): void;
11
12
  }
@@ -0,0 +1,4 @@
1
+ import { MKPlayerEventBase } from "./MKPlayerEventBase";
2
+ export interface MKAdBreakSkippedEvent extends MKPlayerEventBase {
3
+ id: string;
4
+ }
@@ -0,0 +1,12 @@
1
+ import { MKTimeRange } from "../MKTimeRange";
2
+ import { MKPlayerEventBase } from "./MKPlayerEventBase";
3
+ export interface MKAdSkippedEvent extends MKPlayerEventBase {
4
+ id: string;
5
+ adIndex: string | number;
6
+ duration: number;
7
+ offset: MKTimeRange;
8
+ title?: string;
9
+ system?: string;
10
+ creativeId?: string;
11
+ creativeAdId?: string;
12
+ }
@@ -1,11 +1,13 @@
1
1
  export { MKAdaptationEvent } from "./MKAdaptationEvent";
2
2
  export { MKAdBreakFinishedEvent } from "./MKAdBreakFinishedEvent";
3
3
  export { MKAdBreakStartedEvent } from "./MKAdBreakStartedEvent";
4
+ export { MKAdBreakSkippedEvent } from "./MKAdBreakSkippedEvent";
4
5
  export { MKAdClickThroughEvent } from "./MKAdClickThroughEvent";
5
6
  export { MKAdFinishedEvent } from "./MKAdFinishedEvent";
6
7
  export { MKAdMarkerEvent } from "./MKAdMarkerEvent";
7
8
  export { MKAdQuartileEvent } from "./MKAdQuartileEvent";
8
9
  export { MKAdStartedEvent } from "./MKAdStartedEvent";
10
+ export { MKAdSkippedEvent } from "./MKAdSkippedEvent";
9
11
  export { MKAirplayChangedEvent } from "./MKAirplayChangedEvent";
10
12
  export { MKAspectRatioChangedEvent } from "./MKAspectRatioChangedEvent";
11
13
  export { MKAudioAdaptationEvent } from "./MKAudioAdaptationEvent";