@mediakind/mkplayer 1.17.0 → 1.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mediakind/mkplayer",
-    "version": "1.17.0",
+    "version": "1.18.0",
     "description": "MediaKind HTML5 player SDK for HLS and DASH streams.",
     "author": "MediaKind",
     "license": "©2024 Copyright Mediakind Ltd. All Rights Reserved. Including All Downloadable Materials.",
@@ -21,7 +21,7 @@
     "main": "mkplayer.js",
     "types": "types/index.d.ts",
     "dependencies": {
-        "bitmovin-player": "8.185.0",
+        "bitmovin-player": "8.193.0",
         "bitmovin-player-ui": "^3.52.0"
     }
 }

package/types/classes/player/MKPlayer.d.ts

@@ -1,6 +1,6 @@
 import { MKEventBase } from "../common";
 import { MKLogLevel, MKPlayerType, MKStreamType, MKTimeMode, MKViewMode } from "../../enums";
-import { MKAdaptationAPI, MKAnalyticsConfig, MKAudioQuality, MKAudioTrack, MKDownloadedAudioData, MKDownloadedVideoData, MKDrmAPI, MKLowLatencyAPI, MKPlayerAPI, MKBufferAPI, MKPlayerConfig, MKManifestAPI, MKSubtitlesAPI, MKSegmentMap, MKSourceConfig, MKSourceOptions, MKThumbnail, MKTimeRange, MKVideoQuality, MKViewModeOptions, MKTimelineMarker } from "../../interfaces";
+import { MKAdaptationAPI, MKAnalyticsConfig, MKAudioQuality, MKAudioTrack, MKDownloadedAudioData, MKDownloadedVideoData, MKDrmAPI, MKLowLatencyAPI, MKPlayerAPI, MKBufferAPI, MKPlayerConfig, MKManifestAPI, MKSubtitlesAPI, MKSegmentMap, MKSourceConfig, MKSourceOptions, MKThumbnail, MKTimeRange, MKVideoQuality, MKViewModeOptions, MKTimelineMarker, MKAdBreakConfig, MKModuleInfo, MKAdBreak, MKAd } from "../../interfaces";
 import { MKHeaders } from "../../alias";
 export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
     readonly adaptation: MKAdaptationAPI;
@@ -29,6 +29,14 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
     addCastMetadata(metadata: any): boolean;
     addTimelineMarker(timelineMarker: MKTimelineMarker): void;
     castStop(): void;
+    scheduleAd(AdBreakConfig: MKAdBreakConfig): Promise<MKAdBreak[] | undefined>;
+    skipAd(): Promise<void>;
+    discardAdBreak(adBreakId: string): void;
+    getActiveAd(): MKAd;
+    getActiveAdBreak(): MKAdBreak;
+    getModuleInfo(): MKModuleInfo;
+    isLinearAdActive(): boolean;
+    listAd(): MKAdBreak[];
     castVideo(): void;
     destroy(): Promise<void>;
     getAspectRatio(): number;

package/types/constants/MKVersion.d.ts

@@ -1 +1 @@
-export declare const version = "1.17.0";
+export declare const version = "1.18.0";

package/types/enums/MKPlayerEvent.d.ts

@@ -1,4 +1,10 @@
 export declare enum MKPlayerEvent {
+    AdLinearityChanged = "adlinearitychanged",
+    AdManifestLoaded = "admanifestloaded",
+    AdInteraction = "adinteraction",
+    AdError = "aderror",
+    AdClicked = "adclicked",
+    AdSkipped = "adskipped",
     AdMarker = "admarker",
     AdBreakStarted = "adbreakstarted",
     AdStarted = "adstarted",

package/types/interfaces/MKAd.d.ts

@@ -0,0 +1,32 @@
+export interface MKAd {
+    isLinear: boolean;
+    width: number;
+    height: number;
+    id?: string;
+    mediaFileUrl?: string;
+    companionAds?: MKCompanionAd[];
+    verifications?: any[];
+    extensions?: MKVastAdExtension[];
+    clickThroughUrl?: string;
+    clickThroughUrlOpened?: () => void;
+    data?: MKAdData;
+}
+export interface MKCompanionAd {
+    width: number;
+    height: number;
+}
+export interface MKVastAdExtension {
+    attributes: MKVastAdExtensionAttributes;
+    children: MKVastAdExtension[];
+    name: string;
+    value: string;
+}
+export interface MKVastAdExtensionAttributes {
+    [key: string]: string;
+}
+export interface MKAdData {
+    mimeType?: string;
+    bitrate?: number;
+    minBitrate?: number;
+    maxBitrate?: number;
+}

package/types/interfaces/MKAdBreak.d.ts

@@ -0,0 +1,7 @@
+import { MKAd } from "./MKAd";
+import { MKAdConfig } from "./MKAdConfig";
+export interface MKAdBreak extends MKAdConfig {
+    id: string;
+    scheduleTime: number;
+    ads?: MKAd[];
+}

package/types/interfaces/MKAdBreakConfig.d.ts

@@ -0,0 +1,30 @@
+import { AdTagType } from "bitmovin-player";
+import { MKAdConfig } from "./MKAdConfig";
+export interface MKAdBreakConfig extends MKAdTagConfig {
+    id: string;
+    position: string;
+    preloadOffset?: number;
+    skippableAfter?: number;
+}
+export interface MKAdTagConfig extends MKAdConfig {
+    tag: MKAdTag;
+    persistent?: boolean;
+    discardAfterPlayback?: boolean;
+    fallbackTags?: MKAdTag[];
+    linearAdUiConfig?: MKLinearAdUiConfig;
+}
+export interface MKAdTag {
+    url: string;
+    type: AdTagType;
+}
+export interface MKLinearAdUiConfig {
+    requestsUi?: boolean;
+    message?: string;
+    untilSkippableMessage?: string;
+    skippableMessage?: string;
+}
+export declare enum MKAdTagType {
+    VAST = "vast",
+    VMAP = "vmap",
+    VPAID = "vpaid"
+}

package/types/interfaces/MKAdConfig.d.ts

@@ -0,0 +1,3 @@
+export interface MKAdConfig {
+    replaceContentDuration?: number;
+}

package/types/interfaces/MKAdvertisingConfig.d.ts

@@ -0,0 +1,27 @@
+import { MKAdBreak } from "./MKAdBreak";
+import { MKAdBreakConfig } from "./MKAdBreakConfig";
+export interface MKAdvertisingConfig {
+    adBreaks?: MKAdBreakConfig[];
+    videoLoadTimeout?: number;
+    strategy?: RestrictStrategy;
+    withCredentials?: boolean;
+    adContainer?: () => HTMLElement;
+    companionAdContainers?: () => HTMLElement[];
+    placeholders?: AdTagPlaceholders;
+    disableStorageApi?: boolean;
+}
+export interface RestrictStrategy {
+    shouldPlayAdBreak: (toPlay: MKAdBreak) => boolean;
+    shouldPlaySkippedAdBreaks: (skipped: MKAdBreak[], from: number, to: number) => MKAdBreak[];
+}
+export interface AdTagPlaceholders {
+    playbackTime?: string[];
+    height?: string[];
+    width?: string[];
+    domain?: string[];
+    page?: string[];
+    referrer?: string[];
+    assetUrl?: string[];
+    random?: string[];
+    timestamp?: string[];
+}

package/types/interfaces/MKDownloadTiming.d.ts

@@ -0,0 +1,4 @@
+export interface MKDownloadTiming {
+    downloadTime: number;
+    timeToFirstByte?: number;
+}

package/types/interfaces/MKPlayerAdvertisingAPI.d.ts

@@ -0,0 +1,17 @@
+import { MKAd } from "./MKAd";
+import { MKAdBreak } from "./MKAdBreak";
+import { MKAdConfig } from "./MKAdConfig";
+export interface MKPlayerAdvertisingAPI {
+    schedule(adConfig: MKAdConfig): Promise<MKAdBreak[]>;
+    skip(): Promise<void>;
+    list(): MKAdBreak[];
+    getActiveAdBreak(): MKAdBreak;
+    getActiveAd(): MKAd;
+    discardAdBreak(adBreakId: string): void;
+    isLinearAdActive(): boolean;
+    getModuleInfo(): MKModuleInfo;
+}
+export interface MKModuleInfo {
+    name: string;
+    version: string;
+}

package/types/interfaces/MKPlayerConfig.d.ts

@@ -7,8 +7,10 @@ import { MKPlayerEventConfig } from "./MKPlayerEventConfig";
 import { MKAnalyticsConfig } from "./MKAnalyticsConfig";
 import { MKCastConfig } from "./MKCastConfig";
 import { MKTweaksConfig } from "./MKTweaksConfig";
+import { MKAdvertisingConfig } from "./MKAdvertisingConfig";
 export interface MKPlayerConfig {
     key?: string;
+    advertising?: MKAdvertisingConfig;
     ui?: boolean;
     log?: MKLogConfig;
     live?: MKLiveConfig;

package/types/interfaces/MKPlayerCoreAPI.d.ts

@@ -21,6 +21,10 @@ import { MKManifestAPI } from "./MKManifestAPI";
 import { MKPlayerEventBase } from "./events";
 import { MKTimelineMarker } from "./MKTimelineMarker";
 import { MKAnalyticsConfig } from "./MKAnalyticsConfig";
+import { MKAd } from "./MKAd";
+import { MKModuleInfo } from "./MKPlayerAdvertisingAPI";
+import { MKAdBreakConfig } from "./MKAdBreakConfig";
+import { MKAdBreak } from "./MKAdBreak";
 export interface MKPlayerCoreAPI {
     readonly adaptation: MKAdaptationAPI;
     readonly buffer: MKBufferAPI;
@@ -29,6 +33,14 @@ export interface MKPlayerCoreAPI {
     readonly manifest: MKManifestAPI;
     readonly subtitles: MKSubtitlesAPI;
     addCastMetadata(metadata: any): boolean;
+    scheduleAd(AdBreakConfig: MKAdBreakConfig): Promise<MKAdBreak[] | undefined>;
+    skipAd(): Promise<void>;
+    listAd(): MKAdBreak[];
+    getActiveAdBreak(): MKAdBreak;
+    getActiveAd(): MKAd;
+    discardAdBreak(adBreakId: string): void;
+    isLinearAdActive(): boolean;
+    getModuleInfo(): MKModuleInfo;
     addTimelineMarker(timelineMarker: MKTimelineMarker): void;
     castStop(): void;
     castVideo(): void;

package/types/interfaces/events/MKAdBreakEvent.d.ts

@@ -0,0 +1,5 @@
+import { MKAdBreak } from "../MKAdBreak";
+import { MKPlayerEventBase } from "./MKPlayerEventBase";
+export interface MKAdBreakEvent extends MKPlayerEventBase {
+    adBreak: MKAdBreak;
+}

package/types/interfaces/events/MKAdClickedEvent.d.ts

@@ -0,0 +1,4 @@
+import { MKPlayerEventBase } from "./MKPlayerEventBase";
+export interface MKAdClickedEvent extends MKPlayerEventBase {
+    clickThroughUrl: string;
+}

package/types/interfaces/events/MKAdEvent.d.ts

@@ -0,0 +1,5 @@
+import { MKPlayerEventBase } from ".";
+import { MKAd } from "../MKAd";
+export interface MKAdEvent extends MKPlayerEventBase {
+    ad: MKAd;
+}

package/types/interfaces/events/MKAdInteractionEvent.d.ts

@@ -0,0 +1,8 @@
+import { MKPlayerEventBase } from "./MKPlayerEventBase";
+export interface MKAdInteractionEvent extends MKPlayerEventBase {
+    id?: string;
+    interactionType: MKAdInteractionType;
+}
+export declare enum MKAdInteractionType {
+    Vpaid = "vpaid"
+}

package/types/interfaces/events/MKAdLinearityChangedEvent.d.ts

@@ -0,0 +1,4 @@
+import { MKPlayerEventBase } from "./MKPlayerEventBase";
+export interface MKAdLinearityChangedEvent extends MKPlayerEventBase {
+    isLinear: boolean;
+}

package/types/interfaces/events/MKAdManifestLoadedEvent.d.ts

@@ -0,0 +1,7 @@
+import { MKAdConfig } from "../MKAdConfig";
+import { MKDownloadTiming } from "../MKDownloadTiming";
+import { MKAdBreakEvent } from "./MKAdBreakEvent";
+export interface MKAdManifestLoadedEvent extends MKAdBreakEvent {
+    adConfig: MKAdConfig;
+    downloadTiming: MKDownloadTiming;
+}

package/types/interfaces/events/MKAdQuartileEvent.d.ts

@@ -1,6 +1,8 @@
-import { MKAdQuartile } from "../../enums";
+import { MKAdQuartile, MKPlayerEvent } from "../../enums";
 import { MKPlayerEventBase } from "./MKPlayerEventBase";
 export interface MKAdQuartileEvent extends MKPlayerEventBase {
     id: string;
     quartile: MKAdQuartile;
+    type: MKPlayerEvent;
+    timestamp: number;
 }

package/types/interfaces/events/MKErrorEvent.d.ts

@@ -1,4 +1,9 @@
 import { MKError } from "../MKError";
 import { MKPlayerEventBase } from "./MKPlayerEventBase";
 export interface MKErrorEvent extends MKPlayerEventBase, MKError {
+    data?: {
+        [key: string]: any;
+    };
+    sourceIdentifier?: string;
+    troubleShootLink?: string;
 }

package/types/interfaces/events/index.d.ts

@@ -57,3 +57,9 @@ export { MKVideoQualityEvent } from "./MKVideoQualityEvent";
 export { MKViewModeChangedEvent } from "./MKViewModeChangedEvent";
 export { MKVolumeChangedEvent } from "./MKVolumeChangedEvent";
 export { MKVSPPSessionIdEvent } from "./MKVSPPSessionIdEvent";
+export { MKAdBreakEvent } from "./MKAdBreakEvent";
+export { MKAdClickedEvent } from "./MKAdClickedEvent";
+export { MKAdEvent } from "./MKAdEvent";
+export { MKAdInteractionEvent } from "./MKAdInteractionEvent";
+export { MKAdLinearityChangedEvent } from "./MKAdLinearityChangedEvent";
+export { MKAdManifestLoadedEvent } from "./MKAdManifestLoadedEvent";

package/types/interfaces/index.d.ts

@@ -87,3 +87,11 @@ export { MKVTTRegionProperties } from "./MKVTTRegionProperties";
 export { MKViewModeOptions } from "./MKViewModeOptions";
 export { MKWidevineModularDrmConfig } from "./MKWidevineModularDrmConfig";
 export { MKCastConfig } from "./MKCastConfig";
+export { MKAd } from "./MKAd";
+export { MKAdBreak } from "./MKAdBreak";
+export { MKAdBreakConfig } from "./MKAdBreakConfig";
+export { MKAdConfig } from "./MKAdConfig";
+export { MKAdvertisingConfig } from "./MKAdvertisingConfig";
+export { MKDownloadTiming } from "./MKDownloadTiming";
+export { MKPlayerAdvertisingAPI } from "./MKPlayerAdvertisingAPI";
+export { MKModuleInfo } from "./MKPlayerAdvertisingAPI";