@gcorevideo/player 2.26.9 → 2.28.0

package/src/Player.ts

@@ -17,6 +17,7 @@ import type {
 } from './internal.types.js'
 import type {
   ContainerSize,
+  PlayerMediaSource,
   PlayerMediaSourceDesc,
   PlayerPluginConstructor,
 } from './types.js'
@@ -24,6 +25,7 @@ import { PlayerConfig, PlayerEvent } from './types.js'
 import { buildMediaSourcesList, wrapSource } from './utils/mediaSources.js'
 import { registerPlaybacks } from './playback/index.js'
 import { PlaybackError, TimePosition } from './playback.types.js'
+import { SourceController } from './plugins/source-controller/SourceController.js'
 
 /**
  * @public
@@ -246,6 +248,32 @@ export class Player {
     return this.player?.isPlaying() ?? false
   }
 
+  /**
+   * Loads new media source
+   * @param mediaSources - list of media sources to use
+   * @beta
+   */
+  load(mediaSources: PlayerMediaSource[]) {
+    if (mediaSources.length === 0) {
+      throw new Error('No media sources provided')
+    }
+    const ms = mediaSources.map((s) => wrapSource(s))
+    const sourceController = this.player?.core.activePlayback.getPlugin(
+      'source_controller',
+    ) as SourceController
+    if (sourceController) {
+      sourceController.setMediaSource(ms)
+      return
+    }
+    if (this.player) {
+      this.player.load(ms, ms[0].mimeType ?? '')
+      return
+    }
+    this.configure({
+      sources: mediaSources,
+    })
+  }
+
   /**
    * Mutes the sound of the video.
    */
@@ -367,7 +395,9 @@ export class Player {
    * @param name - name of the plugin
    */
   static unregisterPlugin(name: string) {
-    Player.corePlugins = Player.corePlugins.filter((p) => p.prototype.name !== name)
+    Player.corePlugins = Player.corePlugins.filter(
+      (p) => p.prototype.name !== name,
+    )
     Loader.unregisterPlugin(name)
   }
 

package/src/playback/HTML5Video.ts

@@ -48,6 +48,7 @@ export default class HTML5Video extends BasePlayback {
   }
 
   override _handleBufferingEvents() {
+    // TODO use the logic from the base class to detect if it's stalled or resumed, because in the latter case the current behavior is not correct
     if (!this.stallTimerId) {
       this.stallTimerId = setTimeout(() => {
         this.stallTimerId = null

package/src/plugins/cmcd-config/CmcdConfig.ts

@@ -92,16 +92,17 @@ export class CmcdConfig extends CorePlugin {
   constructor(core: Core) {
     super(core)
     this.sid = this.options.cmcd?.sessionId ?? generateSessionId()
-    this.cid = this.options.cmcd?.contentId ?? this.generateContentId()
+    this.setContentId()
   }
 
   /**
    * @internal
    */
   override bindEvents() {
-    this.listenTo(this.core, Events.CORE_CONTAINERS_CREATED, () =>
-      this.updateSettings(this.core.containers[0]),
-    )
+    this.listenTo(this.core, Events.CORE_CONTAINERS_CREATED, () => {
+      this.setContentId()
+      this.updateSettings(this.core.containers[0])
+    })
   }
 
   /**
@@ -128,7 +129,7 @@ export class CmcdConfig extends CorePlugin {
                 sid: this.sid,
                 cid: this.cid,
               },
-            }
+            },
           },
         })
         break
@@ -153,4 +154,8 @@ export class CmcdConfig extends CorePlugin {
       this.core.options.source ?? this.core.options.sources[0].source,
     ).pathname.slice(0, 64)
   }
+
+  private setContentId() {
+    this.cid = this.options.cmcd?.contentId ?? this.generateContentId()
+  }
 }

package/src/plugins/source-controller/SourceController.ts

@@ -69,9 +69,6 @@ function noSync(cb: () => void) {
  *
  * ```
  *
- * This plugin does not expose any public methods apart from required by the Clappr plugin interface.
- * It is supposed to work autonomously.
- *
  * @example
  * ```ts
  * import { SourceController } from '@gcorevideo/player'
@@ -156,11 +153,25 @@ export class SourceController extends CorePlugin {
     if (this.core.options.source !== undefined) {
       // prevent Clappr from loading all sources simultaneously
       this.core.options.sources = [this.core.options.source]
+      this.core.options.source = undefined // TODO test
     } else {
       this.core.options.sources = this.core.options.sources.slice(0, 1)
     }
   }
 
+  /**
+   * Set new media source.
+   *
+   * @param sourcesList - The list of new media source URLs
+   * @beta
+   * @remarks
+   * Triggers a reload of the playback module, container and all container plugins.
+   */
+  setMediaSource(sourcesList: PlayerMediaSourceDesc[]) {
+    this.sourcesList = sourcesList
+    this.core.load(sourcesList, this.core.options.mimeType)
+  }
+
   /**
    * @internal
    */

package/temp/player.api.json

@@ -5587,6 +5587,59 @@
               "isAbstract": false,
               "name": "isPlaying"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!Player#load:member(1)",
+              "docComment": "/**\n * Loads new media source\n *\n * @param mediaSources - list of media sources to use\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "load(mediaSources: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerMediaSource",
+                  "canonicalReference": "@gcorevideo/player!PlayerMediaSource:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 5
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "mediaSources",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "load"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@gcorevideo/player!Player#mute:member(1)",
@@ -8501,7 +8554,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@gcorevideo/player!SourceController:class",
-          "docComment": "/**\n * `PLUGIN` that is managing the automatic failover between media sources.\n *\n * @remarks\n *\n * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details on how sources ordering and selection works. Below is a simplified diagram:\n * ```markdown\n * sources_list:\n *       - a.mpd  |    +--------------------+\n *       - b.m3u8 |--->|         init       |\n *       - ...    |    |--------------------|\n *                     | current_source = 0 |\n *                     +--------------------+\n *                            |\n *                            |  source = a.mpd\n *                            |  playback = dash.js\n *                            v\n *                      +------------------+\n *                  +-->|   load source    |\n *                  |   +---------|--------+\n *                  |             v\n *                  |   +------------------+\n *                  |   |       play       |\n *                  |   +---------|--------+\n *                  |             |\n *                  |             v\n *                  |   +-----------------------+\n *                  |   |  on playback_error    |\n *                  |   |-----------------------|\n *                  |   | current_source =      |\n *                  |   |  (current_source + 1) |\n *                  |   |  % len sources_list   |\n *                  |   |                       |\n *                  |   | delay 1..3s           |\n *                  |   +---------------|-------+\n *                  |                   |\n *                  |   source=b.m3u8   |\n *                  |   playback=hls.js |\n *                  +-------------------+\n *\n * ```\n *\n * This plugin does not expose any public methods apart from required by the Clappr plugin interface. It is supposed to work autonomously.\n *\n * @example\n * ```ts\n * import { SourceController } from '@gcorevideo/player'\n *\n * Player.registerPlugin(SourceController)\n * ```\n *\n * @public\n */\n",
+          "docComment": "/**\n * `PLUGIN` that is managing the automatic failover between media sources.\n *\n * @remarks\n *\n * Have a look at the {@link https://miro.com/app/board/uXjVLiN15tY=/?share_link_id=390327585787 | source failover diagram} for the details on how sources ordering and selection works. Below is a simplified diagram:\n * ```markdown\n * sources_list:\n *       - a.mpd  |    +--------------------+\n *       - b.m3u8 |--->|         init       |\n *       - ...    |    |--------------------|\n *                     | current_source = 0 |\n *                     +--------------------+\n *                            |\n *                            |  source = a.mpd\n *                            |  playback = dash.js\n *                            v\n *                      +------------------+\n *                  +-->|   load source    |\n *                  |   +---------|--------+\n *                  |             v\n *                  |   +------------------+\n *                  |   |       play       |\n *                  |   +---------|--------+\n *                  |             |\n *                  |             v\n *                  |   +-----------------------+\n *                  |   |  on playback_error    |\n *                  |   |-----------------------|\n *                  |   | current_source =      |\n *                  |   |  (current_source + 1) |\n *                  |   |  % len sources_list   |\n *                  |   |                       |\n *                  |   | delay 1..3s           |\n *                  |   +---------------|-------+\n *                  |                   |\n *                  |   source=b.m3u8   |\n *                  |   playback=hls.js |\n *                  +-------------------+\n *\n * ```\n *\n * @example\n * ```ts\n * import { SourceController } from '@gcorevideo/player'\n *\n * Player.registerPlugin(SourceController)\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -8555,6 +8608,59 @@
                   "isOptional": false
                 }
               ]
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@gcorevideo/player!SourceController#setMediaSource:member(1)",
+              "docComment": "/**\n * Set new media source.\n *\n * @remarks\n *\n * Triggers a reload of the playback module, container and all container plugins.\n *\n * @param sourcesList - The list of new media source URLs\n *\n * @beta\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setMediaSource(sourcesList: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PlayerMediaSourceDesc",
+                  "canonicalReference": "@gcorevideo/player!PlayerMediaSourceDesc:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 4,
+                "endIndex": 5
+              },
+              "releaseTag": "Beta",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "sourcesList",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 3
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setMediaSource"
             }
           ],
           "extendsTokenRange": {