feat(FEC-11875): Related Entries - by context (#523)

Update player type signature to support usage in related entries plugin Resolves FEC-11875 Related PRs: kaltura/playkit-js-related#4 kaltura/playkit-js-providers#171
kaltura · Mar 2, 2022 · 86fe909 · 86fe909
1 parent 5ec5cb2
commit 86fe909
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 5 deletions.
diff --git a/ts-typed/base-plugin.d.ts b/ts-typed/base-plugin.d.ts
@@ -5,6 +5,9 @@ declare namespace KalturaPlayerTypes {
     config: any;
     logger: KalturaPlayerTypes.Logger;
     getName(): string;
-    destroy();
+    destroy(): void;
+    dispatchEvent(name: string, payload: any): void;
+    loadMedia(): void;
+    updateConfig(update: Object): void;
   }
 }
diff --git a/ts-typed/kaltura-player.d.ts b/ts-typed/kaltura-player.d.ts
@@ -4,6 +4,7 @@ declare module 'global' {
       providers: {
         RequestBuilder: any;
         ResponseTypes: any;
+        ProviderParser: any;
       };
       ui: {
         EventType: Record<string, string>;
@@ -44,6 +45,7 @@ declare module 'global' {
         FakeEvent: any;
         Error: any;
         StateType: Record<string, string>;
+        MediaType: Record<string, string>;
         registerPlugin(name: string, component: any): void;
         BasePlugin: {
           new (...args: any[]): KalturaPlayerTypes.BasePlugin;

diff --git a/ts-typed/player-config.d.ts b/ts-typed/player-config.d.ts
@@ -28,7 +28,7 @@ declare namespace KalturaPlayerTypes {
 
   export enum EntryTypes {
     Vod = 'Vod',
-    Live = 'Live',
+    Live = 'Live'
   }
 
   export interface ABR {
@@ -187,4 +187,24 @@ declare namespace KalturaPlayerTypes {
     debug?: boolean;
     log?: Log;
   }
+
+  export interface MediaInfo {
+    entryId?: string;
+    referenceId?: string;
+    ks?: string;
+  }
+
+  export interface OVPMediaInfo extends MediaInfo {}
+
+  export interface OTTMediaInfo extends MediaInfo {
+    mediaType: string;
+    contextType: string;
+    protocol?: string;
+    fileIds?: string;
+    streamerType?: string;
+    urlType?: string;
+    adapterData?: any;
+    assetReferenceType?: string;
+    formats?: Array<string>;
+  }
 }
diff --git a/ts-typed/player.d.ts b/ts-typed/player.d.ts
@@ -24,7 +24,8 @@ declare namespace KalturaPlayerTypes {
     paused: boolean;
     seeking: boolean;
     isOnLiveEdge: () => boolean;
-    loadMedia: (options: {entryId: string; ks?: string}) => void;
+    loadMedia: (mediaInfo: KalturaPlayerTypes.MediaInfo, mediaOptions?: KalturaPlayerTypes.Sources) => Promise<any>;
+    setMedia: (options: any) => void;
     getVideoElement(): HTMLVideoElement;
     addEventListener(type: string, listener: CoreEventListener): void;
     removeEventListener: (type: string, listener: CoreEventListener) => void;
@@ -43,12 +44,14 @@ declare namespace KalturaPlayerTypes {
     ready: () => Promise<any>;
     sources: KalturaPlayerTypes.Sources;
     src?: string;
-    getThumbnail: (time: number) => {
+    getThumbnail: (
+      time: number
+    ) => {
       height: number;
       url: string;
       width: number;
       x: number;
       y: number;
-    }
+    };
   }
 }