fix(FEC-14000): Decoupling Plugins from Audio Player

demo/player-ovp.html

@@ -20,14 +20,14 @@
         provider: {
           partnerId: 242,
           env: {
-            cdnUrl: 'https://api.nvq2.ovp.kaltura.com',
+            cdnUrl: 'https://cfvod.nvq2.ovp.kaltura.com',
             serviceUrl: 'https://api.nvq2.ovp.kaltura.com/api_v3'
           }
-        }
+        },
       };
 
       const player = KalturaPlayer.setup(config);
-      player.loadMedia({ entryId: '0_sv5tx4d8' });
+      player.loadMedia({ entryId: '0_bfj8lg0f' });
     </script>
   </body>
 </html>

src/common/plugins/base-plugin.ts

@@ -40,6 +40,22 @@ export class BasePlugin {
    * @member
    */
   protected static defaultConfig: any = {};
+  /**
+   * The display name of the plugin.
+   * Inherited plugins should override this property.
+   * @type {string}
+   * @static
+   * @member
+   */
+  public displayName!: string;
+  /**
+   * The svg icon metadata of the plugin.
+   * Inherited plugins should override this property.
+   * @type {svgUrl: string, viewBox: string}
+   * @static
+   * @member
+   */
+  public symbol!: { svgUrl: string; viewBox: string };
 
   /**
    * Returns under what conditions the plugin is valid.
@@ -112,6 +128,16 @@ export class BasePlugin {
    */
   public loadMedia(): void {}
 
+  /**
+   * should to overridden by a plugin which open overlay once activated
+   * @public
+   * @virtual
+   * @returns {void}
+   */
+  public open(): void {
+    throw new Error(Error.Severity.CRITICAL, Error.Category.PLAYER, Error.Code.RUNTIME_ERROR_METHOD_NOT_IMPLEMENTED, 'showOverlay()');
+  }
+
   /**
    * Runs the destroy logic of the plugin.
    * plugin must implement this method.