@playkit-js/playkit-js-ui 0.78.0 → 0.78.1-canary.0-6f60446

package/dist/playkit-js-ui.d.ts

@@ -2,7 +2,6 @@ import { AbrMode } from '@playkit-js/playkit-js';
 import { ActionCreatorsMapObject } from 'redux';
 import { AudioTrack } from '@playkit-js/playkit-js';
 import { BaseMiddleware } from '@playkit-js/playkit-js';
-import { BaseProvider } from '@playkit-js/playkit-js-providers';
 import { Component } from 'preact';
 import { ComponentChild } from 'preact';
 import { ComponentChildren } from 'preact';
@@ -15,10 +14,10 @@ import { FakeEvent } from '@playkit-js/playkit-js';
 import { FakeEventTarget } from '@playkit-js/playkit-js';
 import { FunctionalComponent } from 'preact';
 import { h } from 'preact';
+import { KPUIAddComponent as KPUIAddComponent_2 } from '@playkit-js/playkit-js-ui';
+import { KPUIRemoveComponent as KPUIRemoveComponent_2 } from '@playkit-js/playkit-js-ui';
 import { LoggerLevels } from '@playkit-js/playkit-js';
 import { MediaType } from '@playkit-js/playkit-js';
-import { OTTProviderMediaInfoObject } from '@playkit-js/playkit-js-providers';
-import { OVPProviderMediaInfoObject } from '@playkit-js/playkit-js-providers';
 import { PKAbrConfigObject } from '@playkit-js/playkit-js';
 import { PKDimensionsConfig } from '@playkit-js/playkit-js';
 import { PKDrmDataObject } from '@playkit-js/playkit-js';
@@ -34,14 +33,15 @@ import { PKTextTrack } from '@playkit-js/playkit-js';
 import * as preact_2 from 'preact';
 import * as preactHooks from 'preact/hooks';
 import * as preacti18n from 'preact-i18n';
-import { ProviderEntryListObject } from '@playkit-js/playkit-js-providers';
-import { ProviderMediaConfigSessionObject } from '@playkit-js/playkit-js-providers';
-import { ProviderMediaConfigSourcesObject } from '@playkit-js/playkit-js-providers';
-import { ProviderMediaInfoObject } from '@playkit-js/playkit-js-providers';
-import { ProviderOptionsObject } from '@playkit-js/playkit-js-providers';
-import { ProviderPlaylistInfoObject } from '@playkit-js/playkit-js-providers';
-import { ProviderPlaylistMetadataObject } from '@playkit-js/playkit-js-providers';
-import { ProviderPlaylistObject } from '@playkit-js/playkit-js-providers';
+import { Provider } from '@playkit-js/playkit-js-providers/ovp-provider';
+import { ProviderEntryListObject } from '@playkit-js/playkit-js-providers/types';
+import { ProviderMediaConfigSessionObject } from '@playkit-js/playkit-js-providers/types';
+import { ProviderMediaConfigSourcesObject } from '@playkit-js/playkit-js-providers/types';
+import { ProviderMediaInfoObject } from '@playkit-js/playkit-js-providers/types';
+import { ProviderOptionsObject } from '@playkit-js/playkit-js-providers/types';
+import { ProviderPlaylistInfoObject } from '@playkit-js/playkit-js-providers/types';
+import { ProviderPlaylistMetadataObject } from '@playkit-js/playkit-js-providers/types';
+import { ProviderPlaylistObject } from '@playkit-js/playkit-js-providers/types';
 import * as redux from 'react-redux';
 import { RefObject } from 'preact';
 import { RenderableProps } from 'preact';
@@ -997,7 +997,7 @@ declare class BaseComponent extends Component<any, any> {
  * Other plugins should extend this class.
  * @classdesc
  */
-declare class BasePlugin implements IPlugin {
+declare class BasePlugin {
     protected logger: any;
     /**
      * The runtime configuration of the plugin.
@@ -1031,16 +1031,6 @@ declare class BasePlugin implements IPlugin {
      * @member
      */
     protected static defaultConfig: any;
-    /**
-     * Factory method to create the actual plugin.
-     * @param {string} name - The plugin name
-     * @param {Object} player - The player reference
-     * @param {Object} config - The plugin configuration
-     * @returns {BasePlugin} - New runtime plugin instance
-     * @static
-     * @public
-     */
-    static createPlugin(name: string, player: KalturaPlayer, config?: any): BasePlugin;
     /**
      * Returns under what conditions the plugin is valid.
      * Plugin must implement this method.
@@ -1049,7 +1039,7 @@ declare class BasePlugin implements IPlugin {
      * @public
      * @abstract
      */
-    protected static isValid(): boolean;
+    static isValid(): boolean;
     /**
      * constructor
      * @param {string} name - The plugin name
@@ -1058,7 +1048,7 @@ declare class BasePlugin implements IPlugin {
      * @constructor
      * @private
      */
-    constructor(name: string, player: KalturaPlayer, config: any);
+    constructor(name: string, player: KalturaPlayer, config?: any);
     /**
      * Getter for the configuration of the plugin.
      * @param {string} attr - The key in the plugin configuration (optional).
@@ -1115,7 +1105,7 @@ declare class BasePlugin implements IPlugin {
      * @param {any} payload - The event payload.
      * @returns {void}
      */
-    dispatchEvent(name: string, payload: any): void;
+    dispatchEvent(name: string, payload?: any): void;
 }
 
 /**
@@ -1917,6 +1907,17 @@ export declare type ColorType = {
     warning: string;
     live: string;
     playerBackground: string;
+    paperSurface: string;
+    elevatedSurface: string;
+    protectionSurface: string;
+    tone1: string;
+    tone2: string;
+    tone3: string;
+    tone4: string;
+    tone5: string;
+    tone6: string;
+    tone7: string;
+    tone8: string;
 };
 
 declare namespace Components {
@@ -3486,9 +3487,6 @@ declare class InteractiveArea extends Component<any, any> {
     render(): h.JSX.Element;
 }
 
-declare interface IPlugin {
-}
-
 /**
  * @interface IRemotePlayer
  *
@@ -3901,8 +3899,8 @@ declare class KalturaPlayer extends FakeEventTarget {
     isUntimedImg(): boolean;
     isUntimedDocument(): boolean;
     isImage(): boolean;
-    isAudio(): boolean;
     isDocument(): boolean;
+    isAudio(): boolean;
     seekToLiveEdge(): void;
     getStartTimeOfDvrWindow(): number;
     getTracks(type?: TrackTypes): Array<Track>;
@@ -3993,7 +3991,7 @@ declare class KalturaPlayer extends FakeEventTarget {
     get plugins(): {
         [name: string]: BasePlugin;
     };
-    get provider(): BaseProvider<OVPProviderMediaInfoObject | OTTProviderMediaInfoObject>;
+    get provider(): Provider;
     get ui(): UIWrapper;
     /**
      * The playlist controller.
@@ -4554,6 +4552,13 @@ declare class Logo extends Component<any, any> {
      * @memberof Logo
      */
     private _handleLogoUrl;
+    /**
+     * sets the url with the entry id
+     * @param {string} url - the url configured on the logo
+     * @returns {boolean} - whether the url was set with entry id or not
+     * @memberof Logo
+     */
+    private _setLogoUrlWithEntryId;
     /**
      * should render component
      * @returns {boolean} - whether to render the component
@@ -5509,11 +5514,14 @@ declare class PlaylistNextScreen extends Component<any, any> {
  * @typedef {Object} KPPlaylistOptions@typedef {Object} KPPlaylistOptions
  * @property {boolean} [autoContinue=true] - Determines whether to continue to the next item automatically.
  * @property {boolean} [loop=false] - Determines whether to play the playlist in a loop. When selected, the playlist will play automatically even if autoContinue is set to false.
+ * @property {string} [startAtEntryId] - Determines which entry id to start to the play the playlist from.
  */
 declare interface PlaylistOptions {
     autoContinue: boolean;
     loop: boolean;
     imageDuration: number;
+    documentDuration: number;
+    startAtEntryId?: string;
 }
 
 declare interface PlaylistState {
@@ -7500,14 +7508,14 @@ declare class UIWrapper {
      * @param {KPUIAddComponent} component - The component to add
      * @returns {Function} - Removal function
      */
-    addComponent(component: any): () => void;
+    addComponent(component: KPUIAddComponent_2): () => void;
     /**
      * Remove a component dynamically
      *
      * @param {KPUIRemoveComponent} component - The component to remove
      * @returns {Function} - Undo removal function
      */
-    removeComponent(component: any): () => void;
+    removeComponent(component: KPUIRemoveComponent_2): () => void;
     get store(): any;
     /**
      * Deprecated - left for backward compatibility - use instead registerService in KalturaPlayer