@mediakind/mkplayer 1.33.0 → 1.35.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mediakind/mkplayer",
-    "version": "1.33.0",
+    "version": "1.35.0",
     "description": "MediaKind HTML5 player SDK for HLS and DASH streams.",
     "author": "MediaKind",
     "license": "©2025 Copyright Mediakind Ltd. All Rights Reserved. Including All Downloadable Materials.",

package/types/alias/index.d.ts

@@ -2,6 +2,9 @@ export type MKBitrate = string | number;
 export type MKHeaders = {
     [key: string]: string;
 };
+export type MKUserEngagement = {
+    [key: string]: string;
+};
 export type MKRequestBody = {
     [key: string]: any;
 };

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

@@ -1,7 +1,7 @@
 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, MKAdBreakConfig, MKModuleInfo, MKAdBreak, MKAd } from "../../interfaces";
-import { MKHeaders } from "../../alias";
+import { MKHeaders, MKUserEngagement } from "../../alias";
 import { MKPlayerEngineType } from "../../enums/MKPlayerEngineType";
 export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
     readonly adaptation: MKAdaptationAPI;
@@ -60,6 +60,7 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
     getAvailableSegments(): MKSegmentMap;
     getAvailableVideoQualities(): MKVideoQuality[];
     getBufferedRanges(): MKTimeRange[];
+    getConfig(mergedConfig?: boolean): MKPlayerConfig;
     getCurrentTime(mode?: MKTimeMode): number;
     getDownloadedAudioData(): MKDownloadedAudioData;
     getDownloadedVideoData(): MKDownloadedVideoData;
@@ -73,6 +74,7 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
     getPlayerType(): MKPlayerType;
     getPlayerEngine(type: MKPlayerEngineType): any;
     getSeekableRange(mode?: MKTimeMode): MKTimeRange;
+    getSource(): MKSourceConfig | null;
     getSourceConfig(): MKSourceConfig | undefined;
     getStreamType(): MKStreamType;
     getThumbnail(time: number): MKThumbnail | null;
@@ -115,6 +117,7 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
     setLogLevel(level: MKLogLevel): void;
     setPlaybackSpeed(speed: number): void;
     setPosterImage(url: string, keepPersistent: boolean): void;
+    setUserEngagementData(userEngagementData?: MKUserEngagement | null): void;
     setVideoElement(videoElement: HTMLVideoElement): void;
     setVideoQuality(videoQualityID: string): void;
     setViewMode(viewMode: MKViewMode, options?: MKViewModeOptions): void;

package/types/constants/MKVersion.d.ts

@@ -1 +1 @@
-export declare const version = "1.33.0";
+export declare const version = "1.35.0";

package/types/enums/MKErrorCode.d.ts

@@ -7,14 +7,25 @@ export declare enum MKErrorCode {
     TVP_ROLL_GENERAL_ERROR = "4-62-33",
     TVP_ROLL_INVALID_DEVICE_PROFILE = "4-62-42",
     TVP_ROLL_MISSING_DEVICE_PROFILE = "4-62-43",
+    TVP_ROLL_HTTP_DRM_ERROR = "4-62-125",
     TVP_ROLL_MISSING_MEDIA_ID = "4-62-400",
     TVP_ROLL_INVALID_MEDIA_ID = "4-62-411",
-    TVP_ROLL_INVALID_SESSION_ID = "4-62-564",
     TVP_ROLL_INVALID_OWNER_OR_APPLICATION_TOKEN = "4-62-505",
-    TVP_ROLL_INVALID_STS_TOKEN = "4-61-3003",
-    TVP_ROLL_HTTP_ERROR = "4-61-125",
+    TVP_ROLL_INVALID_SESSION_ID = "4-62-564",
+    TVP_ROLL_MAX_SESSIONS_EXCEEDED = "4-62-2413",
+    TVP_ROLL_INVALID_STS_TOKEN = "4-62-3003",
+    TVP_ROLL_HTTP_ERROR = "4-62-3067",
+    TVP_ROLL_CHANNEL_NOT_IN_SERVICE_OR_CHANNEL_NOT_FOUND = "4-62-3097",
+    TVP_ROLL_CONTENT_RESTRICTED_GEOLOCATION = "4-62-3312",
+    TVP_ROLL_PLAYBACK_DENIED_GEOLOCATION = "4-62-3318",
+    TVP_ROLL_OUT_OF_COUNTRY_PLAYBACK_REGION = "4-62-7027",
+    TVP_ROLL_OUT_OF_COUNTRY_PLAYBACK_LIMIT_EXCEEDED = "4-62-7028",
+    TVP_BEACON_SESSION_MARKED_FOR_DELETION = "4-63-2430",
+    TVP_BEACON_TIME_LIMITED_OFFER_EXPIRY = "4-63-3736",
     PLAYER_UNKNOWN_ERROR = "4-70-1000",
     PLAYER_API_NOT_AVAILABLE = "4-70-1001",
+    PLAYER_LICENSE_KEY_NOT_FOUND = "4-70-1002",
+    PLAYER_LICENSE_AUTHENTICATION_FAILED = "4-70-1003",
     GENERAL_SETUP_EEROR = "4-70-1100",
     PLAYER_SETUP_NO_HTML_ELEMENT = "4-70-1101",
     PLAYER_SETUP_MISSING_CONFIGURATION = "4-70-1102",
@@ -41,15 +52,20 @@ export declare enum MKErrorCode {
     PLAYER_SOURCE_PROGRESSIVE_STREAM_ERROR = "4-71-1209",
     PLAYER_SOURCE_HLS_STREAM_ERROR = "4-71-1210",
     PLAYER_SOURCE_ENCRYPTION_METHOD_NOT_SUPPORTED = "4-71-1211",
+    PLAYER_GENERAL_SOURCE_ERROR = "4-71-2001",
     PLAYER_PLAYBACK_ERROR = "4-72-1300",
     PLAYER_PLAYBACK_VIDEO_DECODING_ERROR = "4-72-1301",
     PLAYER_PLAYBACK_FLASH_RENDER_ERROR = "4-72-1302",
     PLAYER_PLAYBACK_HLS_COULD_NOT_LOAD_TRANSMUXER = "4-72-1304",
+    PLAYER_PLAYBACK_FAILED = "4-72-2101",
+    PLAYER_GENERAL_NETWORK_ERROR = "4-73-1009",
+    PLAYER_GENERAL_NETWORK_ERROR_HTTP_REQUEST_ERROR_OR_TIMEOUT = "4-73-1200",
     NETWORK_ERROR = "4-73-1400",
     PLAYER_NETWORK_MANIFEST_DOWNLOAD_TIMEOUT = "4-73-1401",
     PLAYER_NETWORK_SEGMENT_DOWNLOAD_TIMEOUT = "4-73-1402",
     PLAYER_NETWORK_PROGRESSIVE_STREAM_DOWNLOAD_TIMEOUT = "4-73-1403",
     PLAYER_NETWORK_FAILED_CERTIFICATE_REQUEST = "4-73-1404",
+    PLAYER_MANIFEST_DOWNLOAD_FAILED = "4-73-2202",
     PLAYER_DRM_ERROR = "4-74-2000",
     PLAYER_DRM_MISSING_CONFIGURATION = "4-74-2001",
     PLAYER_DRM_NO_LICENSE_SERVER_URL_PROVIDED = "4-74-2002",
@@ -66,8 +82,19 @@ export declare enum MKErrorCode {
     PLAYER_DRM_RESTRICTED_OUTPUT = "4-74-2013",
     PLAYER_DRM_FLASH_RENDER_ERROR = "4-74-2014",
     PLAYER_DRM_INIT_DATA_MISSING = "4-74-2015",
+    PLAYER_GENERAL_DRM_ERROR = "4-74-2301",
+    PLAYER_DRM_CONFIGURATION_MISSING = "4-74-2302",
+    PLAYER_NO_DRM_LICENSE_SERVER_URL_PROVIDED = "4-74-2303",
+    PLAYER_DRM_LICENSE_REQUEST_FAILED = "4-74-2306",
     PLAYER_VR_ERROR = "4-75-2100",
-    PLAYER_VR_INCOMPATIBLE_PLAYER_TECHNOLOGY = "4-75-2101",
+    PLAYER_GENERAL_ERROR = "4-75-3001",
+    PLAYER_DOWNLOAD_FAILED = "4-75-3002",
+    PLAYER_INSUFFICIENT_STORAGE = "4-75-3003",
+    PLAYER_FAILED_PERSISTING_DRM_LICENSE = "4-75-3004",
+    PLAYER_UNSUPPORTED_SOURCE_CONFIGURATION = "4-75-3009",
+    PLAYER_CONTENT_URL_MIGRATION_FAILED = "4-75-3010",
+    PLAYER_SEGMENT_PSSH_DATA_MISSING = "4-75-4000",
+    PLAYER_VR_INCOMPATIBLE_PLAYER_TECHNOLOGY = "4-76-2101",
     PLAYER_MODULE_ERROR = "4-76-3000",
     PLAYER_MODULE_INVALID_DEFINITION = "4-76-3001",
     PLAYER_MODULE_INVALID_DEFINITION_DEPENDENCY = "4-76-3002",
@@ -75,16 +102,16 @@ export declare enum MKErrorCode {
     PLAYER_MODULE_DEPENDENCY_MISSING = "4-76-3004",
     PLAYER_MODULE_REMOVED = "4-76-3005",
     PLAYER_MODULE_ADVERTISING_ERROR = "4-77-3100",
+    PROGRAM_RESTRICTION_WIFI = "4-80-100",
+    PROGRAM_RESTRICTION_CELLULAR = "4-80-101",
     PROGRAM_RESTRICTION_PHONE = "4-80-102",
     PROGRAM_RESTRICTION_TABLET = "4-80-103",
     PROGRAM_RESTRICTION_STB = "4-80-104",
+    PROGRAM_RESTRICTION_JAILBROKEN = "4-80-105",
     PROGRAM_RESTRICTION_OUT_OF_HOME = "4-80-106",
     PROGRAM_RESTRICTION_IOS = "4-80-107",
     PROGRAM_RESTRICTION_ANDROID = "4-80-108",
     PROGRAM_RESTRICTION_DESKTOP = "4-80-109",
-    PROGRAM_RESTRICTION_EXTENDED_DISPLAY = "4-80-300",
-    PROGRAM_RESTRICTION_AIRPLAY = "4-80-301",
-    PROGRAM_RESTRICTION_CAST = "4-80-302",
     REWIND_BLOCKED = "4-80-200",
     FASTFORWARD_BLOCKED = "4-80-201",
     PAUSE_BLOCKED = "4-80-202",
@@ -94,5 +121,8 @@ export declare enum MKErrorCode {
     RESTART_BLOCKED = "4-80-206",
     TIMESHIFT_BLOCKED = "4-80-207",
     SEEKSKIP_BLOCKED = "4-80-208",
-    CATCHUP_BLOCKED = "4-80-209"
+    CATCHUP_BLOCKED = "4-80-209",
+    PROGRAM_RESTRICTION_EXTENDED_DISPLAY = "4-80-300",
+    PROGRAM_RESTRICTION_AIRPLAY = "4-80-301",
+    PROGRAM_RESTRICTION_CAST = "4-80-302"
 }

package/types/interfaces/MKPlayerAPI.d.ts

@@ -1,9 +1,11 @@
 import { MKPlayerCoreAPI } from "./MKPlayerCoreAPI";
 import { MKSourceConfig } from "./MKSourceConfig";
+import { MKUserEngagement } from "../alias";
 export interface MKPlayerAPI extends MKPlayerCoreAPI {
     updateAuthToken(authToken: string): void;
     setInhomeStatus(inhomeStatus: boolean): void;
     setLocationDetail(locationDetail: string | null): void;
     isLowLatencyPlayback(): boolean;
     getSourceConfig(): MKSourceConfig | undefined;
+    setUserEngagementData(userEngagementData?: MKUserEngagement | null): void;
 }

package/types/interfaces/MKPlayerConfig.d.ts

@@ -26,7 +26,6 @@ export interface MKPlayerConfig {
     tweaks?: MKTweaksConfig;
     enableGooglePal?: boolean;
     enableWidevineEncryption?: boolean;
-    enableBrandBrigade?: boolean;
     enableSecureUrl?: boolean;
     style?: MKStyleConfig;
 }

package/types/interfaces/MKPlayerCoreAPI.d.ts

@@ -25,6 +25,7 @@ import { MKAd } from "./MKAd";
 import { MKModuleInfo } from "./MKPlayerAdvertisingAPI";
 import { MKAdBreakConfig } from "./MKAdBreakConfig";
 import { MKAdBreak } from "./MKAdBreak";
+import { MKPlayerConfig } from "./MKPlayerConfig";
 export interface MKPlayerCoreAPI {
     readonly adaptation: MKAdaptationAPI;
     readonly buffer: MKBufferAPI;
@@ -53,6 +54,7 @@ export interface MKPlayerCoreAPI {
     getAvailableSegments(): MKSegmentMap;
     getAvailableVideoQualities(): MKVideoQuality[];
     getBufferedRanges(): MKTimeRange[];
+    getConfig(mergedConfig?: boolean): MKPlayerConfig;
     getCurrentTime(mode?: MKTimeMode): number;
     getDownloadedAudioData(): MKDownloadedAudioData;
     getDownloadedVideoData(): MKDownloadedVideoData;
@@ -65,6 +67,7 @@ export interface MKPlayerCoreAPI {
     getPlaybackVideoData(): MKVideoQuality;
     getPlayerType(): MKPlayerType;
     getSeekableRange(mode?: MKTimeMode): MKTimeRange;
+    getSource(): MKSourceConfig | null;
     getStreamType(): MKStreamType;
     getThumbnail(time: number): MKThumbnail | null;
     getTimeShift(): number;

package/types/interfaces/MKSourceConfig.d.ts

@@ -33,4 +33,6 @@ export interface MKSourceConfig {
     enableLowLatency?: boolean;
     message_id?: string;
     live?: MKLiveConfigAtSourceLevel;
+    externalSourceLicenseUrl?: string;
+    externalSourceCertificateUrl?: string;
 }