feat(FEC-13507): Doc entry methods

docs/api.md

@@ -2592,6 +2592,10 @@ Returns **[boolean][476]** true if sources contain youtube source
 
 returns true if sources contain image source
 
+## hasDocumentSource
+
+returns true if sources contain document source
+
 ### Parameters
 
 - `sources` **PKSourcesConfigObject** thr sources object

src/common/playlist/playlist-item.ts

@@ -4,7 +4,7 @@ import {
   SourcesConfig,
   KPPlaylistItemConfigObject
 } from '../../types';
-const formats = ['hls', 'dash', 'progressive', 'image'];
+const formats = ['hls', 'dash', 'progressive', 'image', 'document'];
 /**
  * @class PlaylistItem
  * @param {PKSourcesConfigObject} [sources] - The item sources

src/common/playlist/playlist-manager.ts

@@ -44,7 +44,12 @@ class PlaylistManager {
     this._player = player;
     this._eventManager = new EventManager();
     this._playlist = new Playlist();
-    this._options = { autoContinue: true, loop: false, imageDuration: 5 };
+    this._options = {
+      autoContinue: true,
+      loop: false,
+      imageDuration: 5,
+      documentDuration: 5
+    };
     this._countdown = { duration: 10, showing: true };
     this._mediaInfoList = [];
     this._playerOptions = options;
@@ -281,6 +286,8 @@ class PlaylistManager {
       // @ts-ignore
       items: playlistData.items.map((item, index) => {
         const itemData = Utils.Object.copyDeep(item);
+        // keep original media source data
+        itemData.sources.mediaEntryType = item?.sources?.type;
         ['sources.dvr', 'sources.type'].forEach((omitKey) => {
           // use medias source data instead of playlist source data
           Utils.Object.deletePropertyPath(itemData, omitKey);
@@ -348,6 +355,12 @@ class PlaylistManager {
         // @ts-ignore
         sources: { duration: this._options.imageDuration }
       });
+    } else if (this._player.isDocument()) {
+      this._player.configure({
+        // eslint-disable-next-line  @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        sources: { duration: this._options.documentDuration }
+      });
     }
   }
 

src/common/utils/setup-helpers.ts

@@ -889,6 +889,9 @@ function maybeSetStreamPriority(
   if (sources && hasImageSource(sources)) {
     return addEngineToStreamPriority(player, 'image', 'image');
   }
+  if (sources && hasDocumentSource(sources)) {
+    return addEngineToStreamPriority(player, 'document', 'document');
+  }
   return null;
 }
 
@@ -914,6 +917,18 @@ function hasImageSource(sources: PKSourcesConfigObject): boolean {
   return !!(source && source[0]);
 }
 
+/**
+ * returns true if sources contain document source
+ * @param {PKSourcesConfigObject} sources - thr sources object
+ * @returns {boolean} - true if sources contain document source
+ */
+function hasDocumentSource(sources: PKSourcesConfigObject): boolean {
+  // eslint-disable-next-line  @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  const source = sources && sources.document;
+  return !!(source && source[0]);
+}
+
 /**
  * Maybe set inBrowserFullscreen config based on the plugins.
  * @private
@@ -1018,6 +1033,7 @@ export {
   maybeSetStreamPriority,
   hasYoutubeSource,
   hasImageSource,
+  hasDocumentSource,
   mergeProviderPluginsConfig,
   getServerUIConf,
   initializeStorageManagers,

src/kaltura-player.ts

@@ -60,6 +60,7 @@ import { PlaylistManager } from './common/playlist/playlist-manager';
 import { RemotePlayerManager } from './common/cast/remote-player-manager';
 import {
   hasImageSource,
+  hasDocumentSource,
   hasYoutubeSource,
   maybeSetStreamPriority,
   mergeProviderPluginsConfig,
@@ -229,14 +230,18 @@ export class KalturaPlayer extends FakeEventTarget {
       playerConfig.plugins[name] = playerConfig.plugins[name] || {};
     });
     this.configure({ session: mediaConfig.session });
-    if (!hasYoutubeSource(sources) && !hasImageSource(sources)) {
+    if (
+      hasYoutubeSource(sources) ||
+      hasImageSource(sources) ||
+      hasDocumentSource(sources)
+    ) {
+      this._thumbnailManager = null;
+    } else {
       this._thumbnailManager = new ThumbnailManager(
         this,
         this.config.ui,
         mediaConfig
       );
-    } else {
-      this._thumbnailManager = null;
     }
     this.updateKalturaPoster(
       sources,
@@ -470,10 +475,24 @@ export class KalturaPlayer extends FakeEventTarget {
     );
   }
 
+  public isUntimedDocument(): boolean {
+    return (
+      hasDocumentSource(this.sources) &&
+      !(
+        typeof this.config.sources.duration === 'number' &&
+        this.config.sources.duration > 0
+      )
+    );
+  }
+
   public isImage(): boolean {
     return hasImageSource(this.sources);
   }
 
+  public isDocument(): boolean {
+    return hasDocumentSource(this.sources);
+  }
+
   public isAudio(): boolean {
     return this._localPlayer.isAudio();
   }

src/types/playlist/playlist-options.ts

@@ -7,4 +7,5 @@ export interface PlaylistOptions {
   autoContinue: boolean;
   loop: boolean;
   imageDuration: number;
+  documentDuration: number;
 }