@mediakind/mkplayer 1.6.0 → 1.7.0

package/types/interfaces/MKRegisteredSource.d.ts

@@ -5,6 +5,6 @@ export interface MKRegisteredSource {
     adobePrimetimeConfig?: MKAdobePrimetimeConfig;
     environmentConfig: MKEnvironmentConfig;
     applicationToken?: string;
-    catchupStartTime?: string;
+    startTime?: string;
     isDvrFromRollingBuffer?: boolean;
 }

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

@@ -0,0 +1,6 @@
+import { MKPlayerEventBase } from "./MKPlayerEventBase";
+import { MKAdVerification } from "../MKAdVerification";
+export interface MKAdVerificationEvent extends MKPlayerEventBase {
+    id: string;
+    adVerification: MKAdVerification;
+}

package/types/interfaces/events/MKAdVerificationEvent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MKAdVerificationEvent.js.map

package/types/interfaces/events/MKAdVerificationEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MKAdVerificationEvent.js","sourceRoot":"","sources":["../../../../../src/interfaces/events/MKAdVerificationEvent.ts"],"names":[],"mappings":""}

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

@@ -20,6 +20,7 @@ export { MKCastAvailableEvent } from "./MKCastAvailableEvent";
 export { MKCastStartedEvent } from "./MKCastStartedEvent";
 export { MKCastWaitingForDeviceEvent } from "./MKCastWaitingForDeviceEvent";
 export { MKAdCompanionEvent } from "./MKAdCompanionEvent";
+export { MKAdVerificationEvent } from "./MKAdVerificationEvent";
 export { MKCueEnterEvent } from "./MKCueEnterEvent";
 export { MKCueExitEvent } from "./MKCueExitEvent";
 export { MKCueParsedEvent } from "./MKCueParsedEvent";

package/types/interfaces/index.d.ts

@@ -3,8 +3,9 @@ export { MKAdaptationConfig } from "./MKAdaptationConfig";
 export { MKAdaptationData } from "./MKAdaptationData";
 export { MKAdaptationPlatformConfig } from "./MKAdaptationPlatformConfig";
 export { MKAdobePrimetimeConfig } from "./MKAdobePrimetimeConfig";
-export { MKAnalyticsConfig } from "./MKAnalyticsConfig";
 export { MKAdCompanion } from "./MKAdCompanion";
+export { MKAdVerification } from "./MKAdVerification";
+export { MKAnalyticsConfig } from "./MKAnalyticsConfig";
 export { MKAudioAdaptationData } from "./MKAudioAdaptationData";
 export { MKAudioQuality } from "./MKAudioQuality";
 export { MKAudioTrack } from "./MKAudioTrack";

package/types/plugins/omsdk/MKOMSDKConfig.d.ts

@@ -0,0 +1,6 @@
+export interface MKOmSdkConfig {
+    partnerName: string;
+    partnerVersion: string;
+    serviceScriptUrl?: string;
+    validationScriptUrl?: string;
+}

package/types/plugins/omsdk/MKOMSDKConstants.d.ts

@@ -0,0 +1,152 @@
+export declare const AdEventType: {
+    IMPRESSION: string;
+    LOADED: string;
+    GEOMETRY_CHANGE: string;
+    SESSION_START: string;
+    SESSION_ERROR: string;
+    SESSION_FINISH: string;
+    MEDIA: string;
+    VIDEO: string;
+    START: string;
+    FIRST_QUARTILE: string;
+    MIDPOINT: string;
+    THIRD_QUARTILE: string;
+    COMPLETE: string;
+    PAUSE: string;
+    RESUME: string;
+    BUFFER_START: string;
+    BUFFER_FINISH: string;
+    SKIPPED: string;
+    VOLUME_CHANGE: string;
+    PLAYER_STATE_CHANGE: string;
+    AD_USER_INTERACTION: string;
+    STATE_CHANGE: string;
+};
+export declare const MediaEventType: {
+    LOADED: string;
+    START: string;
+    FIRST_QUARTILE: string;
+    MIDPOINT: string;
+    THIRD_QUARTILE: string;
+    COMPLETE: string;
+    PAUSE: string;
+    RESUME: string;
+    BUFFER_START: string;
+    BUFFER_FINISH: string;
+    SKIPPED: string;
+    VOLUME_CHANGE: string;
+    PLAYER_STATE_CHANGE: string;
+    AD_USER_INTERACTION: string;
+};
+export declare const ImpressionType: {
+    DEFINED_BY_JAVASCRIPT: string;
+    UNSPECIFIED: string;
+    LOADED: string;
+    BEGIN_TO_RENDER: string;
+    ONE_PIXEL: string;
+    VIEWABLE: string;
+    AUDIBLE: string;
+    OTHER: string;
+};
+export declare const ErrorType: {
+    GENERIC: string;
+    VIDEO: string;
+    MEDIA: string;
+};
+export declare const AdSessionType: {
+    NATIVE: string;
+    HTML: string;
+    JAVASCRIPT: string;
+};
+export declare const EventOwner: {
+    NATIVE: string;
+    JAVASCRIPT: string;
+    NONE: string;
+};
+export declare const AccessMode: {
+    FULL: string;
+    DOMAIN: string;
+    LIMITED: string;
+};
+export declare const AppState: {
+    BACKGROUNDED: string;
+    FOREGROUNDED: string;
+};
+export declare const Environment: {
+    APP: string;
+    WEB: string;
+};
+export declare const InteractionType: {
+    CLICK: string;
+    INVITATION_ACCEPT: string;
+};
+export declare const CreativeType: {
+    DEFINED_BY_JAVASCRIPT: string;
+    HTML_DISPLAY: string;
+    NATIVE_DISPLAY: string;
+    VIDEO: string;
+    AUDIO: string;
+};
+export declare const MediaType: {
+    DISPLAY: string;
+    VIDEO: string;
+};
+export declare const Reason: {
+    NOT_FOUND: string;
+    HIDDEN: string;
+    BACKGROUNDED: string;
+    VIEWPORT: string;
+    OBSTRUCTED: string;
+    CLIPPED: string;
+    UNMEASURABLE: string;
+    NO_WINDOW_FOCUS: string;
+};
+export declare const SupportedFeatures: {
+    CONTAINER: string;
+    VIDEO: string;
+};
+export declare const VideoPosition: {
+    PREROLL: string;
+    MIDROLL: string;
+    POSTROLL: string;
+    STANDALONE: string;
+};
+export declare const VideoPlayerState: {
+    MINIMIZED: string;
+    COLLAPSED: string;
+    NORMAL: string;
+    EXPANDED: string;
+    FULLSCREEN: string;
+};
+export declare const NativeViewKeys: {
+    X: string;
+    LEFT: string;
+    Y: string;
+    TOP: string;
+    WIDTH: string;
+    HEIGHT: string;
+    AD_SESSION_ID: string;
+    IS_FRIENDLY_OBSTRUCTION_FOR: string;
+    CLIPS_TO_BOUNDS: string;
+    CHILD_VIEWS: string;
+    END_X: string;
+    END_Y: string;
+    OBSTRUCTIONS: string;
+    OBSTRUCTION_CLASS: string;
+    OBSTRUCTION_PURPOSE: string;
+    OBSTRUCTION_REASON: string;
+    PIXELS: string;
+    HAS_WINDOW_FOCUS: string;
+};
+export declare const MeasurementStateChangeSource: {
+    CONTAINER: string;
+    CREATIVE: string;
+};
+export declare const ElementMarkup: {
+    OMID_ELEMENT_CLASS_NAME: string;
+};
+export declare const CommunicationType: {
+    NONE: string;
+    DIRECT: string;
+    POST_MESSAGE: string;
+};

package/types/plugins/omsdk/MKOMSDKController.d.ts

@@ -0,0 +1,58 @@
+import { MKOmSdkConfig } from './MKOMSDKConfig';
+import { MKPlayerAPI } from "../../src/interfaces";
+export interface omsdkErrorDataType {
+    errorCode: string;
+    errorMessage: string;
+    timestamp: number;
+}
+export interface omsdkErrorCallbackType {
+    (errorData: omsdkErrorDataType): void;
+}
+export declare class MKOMSDKController {
+    private static readonly SETUP_ERROR_CODE;
+    readonly TAG: string;
+    readonly omSDKconfig: MKOmSdkConfig;
+    readonly functionMap: any;
+    readonly autoLoad: boolean;
+    private SessionClient;
+    private player;
+    private videoElement;
+    private errorCallback;
+    private errorData;
+    private verificationSettings;
+    private omsdkServiceScript;
+    private omsdkVerificationScript;
+    private adSession;
+    private adEvents;
+    private mediaEvents;
+    private adVerificationStarted;
+    private adDuration;
+    private playerPaused;
+    private playerFullscreen;
+    constructor(player: MKPlayerAPI, callback: omsdkErrorCallbackType, config: MKOmSdkConfig, autoLoadScript?: boolean);
+    private createSessionClient;
+    private _loadOmsdkLibrary;
+    private _unloadOmsdkLibrary;
+    private addPlayerEventListners;
+    private removePlayerEventListners;
+    private onAdBreakStarted;
+    private onAdStarted;
+    private onAdVerification;
+    private onAdQuartile;
+    private onAdFinished;
+    private onAdBreakFinished;
+    private onVolumeChanged;
+    private onPlayerPaused;
+    private onPlayerResumed;
+    private onPlayerBufferingStarted;
+    private onPlayerBufferingStopped;
+    private onPlayerResized;
+    private onStop;
+    private initializeOmSDKSession;
+    private createAdSession;
+    private dispatchOMEvents;
+    private cleanUp;
+    private finish;
+    tearDown(): void;
+}
+export default MKOMSDKController;

package/types/plugins/omsdk/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./MKOMSDKController";
+export * from "./MKOMSDKConfig";

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

@@ -16,6 +16,7 @@ export declare class MKPlayer extends MKEventBase implements MKPlayerAPI {
     private sessionManager?;
     private adobeSessionConcurrencyRequest?;
     private headers;
+    private analyticsConfig?;
     constructor(videoContainer: HTMLElement, playerConfig: MKPlayerConfig);
     addCastMetadata(metadata: any): boolean;
     addSubtitle(subtitleTrack: MKSubtitleTrack): void;

package/types/src/classes/player/MKStubPlayer.d.ts

@@ -0,0 +1 @@
+export {};

package/types/src/enums/MKPlayerEvent.d.ts

@@ -7,6 +7,7 @@ export declare enum MKPlayerEvent {
     AdBreakFinished = "adbreakfinished",
     AdClickThrough = "adclickthrough",
     AdCompanion = "adcompanion",
+    AdVerification = "adverification",
     AirplayAvailable = "airplayavailable",
     AirplayChanged = "airplaychanged",
     AspectRatioChanged = "aspectratiochanged",

package/types/src/interfaces/MKAdVerification.d.ts

@@ -0,0 +1,5 @@
+export interface MKAdVerification {
+    adVerVendor: string;
+    adVerJS: string;
+    adVerParams: string;
+}

package/types/src/interfaces/MKPlayerConfig.d.ts

@@ -21,4 +21,5 @@ export interface MKPlayerConfig {
     enableSubtitleOverlay?: boolean;
     cast?: MKCastConfig;
     appId?: string;
+    skipEmsgBoxes?: boolean | false;
 }

package/types/src/interfaces/MKRegisteredSource.d.ts

@@ -5,6 +5,6 @@ export interface MKRegisteredSource {
     adobePrimetimeConfig?: MKAdobePrimetimeConfig;
     environmentConfig: MKEnvironmentConfig;
     applicationToken?: string;
-    catchupStartTime?: string;
+    startTime?: string;
     isDvrFromRollingBuffer?: boolean;
 }

package/types/src/interfaces/events/MKAdVerificationEvent.d.ts

@@ -0,0 +1,6 @@
+import { MKPlayerEventBase } from "./MKPlayerEventBase";
+import { MKAdVerification } from "../MKAdVerification";
+export interface MKAdVerificationEvent extends MKPlayerEventBase {
+    id: string;
+    adVerification: MKAdVerification;
+}

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

@@ -20,6 +20,7 @@ export { MKCastAvailableEvent } from "./MKCastAvailableEvent";
 export { MKCastStartedEvent } from "./MKCastStartedEvent";
 export { MKCastWaitingForDeviceEvent } from "./MKCastWaitingForDeviceEvent";
 export { MKAdCompanionEvent } from "./MKAdCompanionEvent";
+export { MKAdVerificationEvent } from "./MKAdVerificationEvent";
 export { MKCueEnterEvent } from "./MKCueEnterEvent";
 export { MKCueExitEvent } from "./MKCueExitEvent";
 export { MKCueParsedEvent } from "./MKCueParsedEvent";

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

@@ -3,8 +3,9 @@ export { MKAdaptationConfig } from "./MKAdaptationConfig";
 export { MKAdaptationData } from "./MKAdaptationData";
 export { MKAdaptationPlatformConfig } from "./MKAdaptationPlatformConfig";
 export { MKAdobePrimetimeConfig } from "./MKAdobePrimetimeConfig";
-export { MKAnalyticsConfig } from "./MKAnalyticsConfig";
 export { MKAdCompanion } from "./MKAdCompanion";
+export { MKAdVerification } from "./MKAdVerification";
+export { MKAnalyticsConfig } from "./MKAnalyticsConfig";
 export { MKAudioAdaptationData } from "./MKAudioAdaptationData";
 export { MKAudioQuality } from "./MKAudioQuality";
 export { MKAudioTrack } from "./MKAudioTrack";