@annoto/widget-api 3.65.0-alpha.0 → 3.66.0-alpha.0

package/dist/build_esm/player-adapter/index.d.ts

@@ -24,11 +24,11 @@ export interface ICaptureUIEventCallbackParams {
     eventCanceledCb?: () => void;
 }
 /**
- * @description Annoto Player Adaptor API
+ * Annoto Player Adaptor API
  */
 export interface IPlayerAdaptorApi {
     /**
-     * @description This method is called by Annoto as the first method.
+     * This method is called by Annoto as the first method.
      * Use it to configure the player interface object.
      * If the method returns false, Annoto will retry a number of times with fixed
      * period of time between the retries.
@@ -42,42 +42,42 @@ export interface IPlayerAdaptorApi {
      */
     init(element: Element, params?: any): boolean | Promise<boolean>;
     /**
-     * @description (OPTIONAL) called by Annoto to release resources when the widget is closing.
+     * (OPTIONAL) called by Annoto to release resources when the widget is closing.
      * NOTICE: Although optional this method is highly recommended if you use Annoto API
      * to dynamically load and close the widget.
      * The adaptor implementation should discard the events that were regsitered using the onReady, onPlay, etc. when remove() is called.
      */
     remove?(): void | Promise<void>;
     /**
-     * @description Start playing the media
+     * Start playing the media
      */
     play(): void | Promise<void>;
     /**
-     * @description Pause the media
+     * Pause the media
      */
     pause(): void | Promise<void>;
     /**
-     * @description set default text track (captions/subtitles) if available.
+     * set default text track (captions/subtitles) if available.
      */
     setDefaultTextTrack?(textTrack?: ITextTrack): void | Promise<void>;
     /**
-     * @description Set the media current time of track (skip/seek to time of the track)
+     * Set the media current time of track (skip/seek to time of the track)
      * @param time - in seconds
      */
     setCurrentTime(time: number): void | Promise<void>;
     /**
-     * @description (OPTIONAL) Return if the media is a live stream or a VOD.
+     * (OPTIONAL) Return if the media is a live stream or a VOD.
      * NOTE: if the method is not implemented VOD is assumed.
      * @returns {boolean | Promise<boolean>}
      */
     isLive?(): boolean | Promise<boolean>;
     /**
-     * @description Get time of current playback position.
+     * Get time of current playback position.
      * @returns {Number | Promise<number>} - in seconds. Preferred Floating point precision.
      */
     currentTime(): number | Promise<number>;
     /**
-     * @description Get the total media track duration in seconds
+     * Get the total media track duration in seconds
      * 0 or NaN or 'undefined' values may be returned until media is ready.
      * Note: For live video for best experience return the latest known duration of the stream.
      * (for DVR enabled live stream, it can defer from currentTime)
@@ -85,38 +85,38 @@ export interface IPlayerAdaptorApi {
      */
     duration(): number | Promise<number>;
     /**
-     * @description Get player playback state (playing or paused)
+     * Get player playback state (playing or paused)
      * @returns {boolean | Promise<boolean>} - true if pause, false if playing
      */
     paused(): boolean | Promise<boolean>;
     /**
-     * @description Get currently played media source. The returned value, identifies
+     * Get currently played media source. The returned value, identifies
      * the current video and must be unique. It can be a full URL or an unique identifier.
      * Notice: this value can be overriden by hooks.mediaDetails widget configuration.
      * @returns {string | Promise<string>}
      */
     mediaSrc(): string | Promise<string>;
     /**
-     * @description (OPTIONAL) Get Details for the media.
+     * (OPTIONAL) Get Details for the media.
      * Notice: this value can be overriden by hooks.mediaDetails widget configuration.
      * @return {IMediaDetails | Promise<IMediaDetails>}
      */
     mediaMetadata?(): IMediaDetails | Promise<IMediaDetails>;
     /**
-     * @description (OPTIONAL) Get player autoplay configuration option
+     * (OPTIONAL) Get player autoplay configuration option
      * (if player configured to play on page load)
      * @returns {boolean | Promise<boolean>}
      */
     autoplay?(): boolean | Promise<boolean>;
     /**
-     * @description (OPTIONAL) Get player full screen state.
+     * (OPTIONAL) Get player full screen state.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect full screen.
      * @returns {boolean}
      */
     fullScreen?(): boolean;
     /**
-     * @description (OPTIONAL) By default Annoto will try applying a fix
+     * (OPTIONAL) By default Annoto will try applying a fix
      * To enable Annoto to work when player enters Full screen. The fix is
      * moving annoto-app container as a child of the player element or embeddableElement()
      * annoto-app will be moved only if the player element allows it (is NOT an IFRAME).
@@ -127,7 +127,7 @@ export interface IPlayerAdaptorApi {
      */
     fixFullScreen?(): boolean;
     /**
-     * @description (OPTIONAL) Get player controls Element for embedding
+     * (OPTIONAL) Get player controls Element for embedding
      * annoto timeline for overlay and full screen mode.
      * NOTE: Although this method is optional it's highly recomended and will make the integration
      * much simpler, imrove performance and provide better User experience.
@@ -136,28 +136,28 @@ export interface IPlayerAdaptorApi {
      */
     controlsElement?(): Element;
     /**
-     * @description (OPTIONAL) Get player Element for embedding annoto application for full screen state.
+     * (OPTIONAL) Get player Element for embedding annoto application for full screen state.
      * If not provided the main player Element would be used (the element provided at init()).
      * NOTE: if not supported the function must be undefined.
      * @returns {Element}
      */
     embeddableElement?(): Element;
     /**
-     * @description (OPTIONAL) Get player width in pixels.
+     * (OPTIONAL) Get player width in pixels.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect width of the player.
      * @returns {number | string} if string, may contain 'px'
      */
     width?(): number | string;
     /**
-     * @description (OPTIONAL) Get player height in pixels.
+     * (OPTIONAL) Get player height in pixels.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
      * @returns {number | string} if string, may contain 'px'
      */
     height?(): number | string;
     /**
-     * @description Feature support flag. If set to true, indicates that
+     * Feature support flag. If set to true, indicates that
      * the player has support for side panel layout, including for full screen.
      * Player that supports side panel layout, must reserve space for the widget, if requested by the widget.
      * The widget applies number of classes and css variables to the player element:
@@ -167,70 +167,70 @@ export interface IPlayerAdaptorApi {
      */
     readonly sidePanelSupported?: boolean;
     /**
-     * @description cb should be called when the player is setup and the media metadata is loaded.
+     * cb should be called when the player is setup and the media metadata is loaded.
      * Note: This method MUST be called as the first event.
      * If your player does not support this event, simulate it by calling the cb manually.
      * @param cb
      */
     onReady(cb: PlayerEventCallback): void;
     /**
-     * @description cb should be called when the media is played.
+     * cb should be called when the media is played.
      * @param cb
      */
     onPlay(cb: PlayerEventCallback): void;
     /**
-     * @description cb should be called when the media is paused.
+     * cb should be called when the media is paused.
      * @param cb
      */
     onPause(cb: PlayerEventCallback): void;
     /**
-     * @description cb should be called when the media is seeked
+     * cb should be called when the media is seeked
      * (playback position changes after seeking).
      * @param cb
      */
     onSeek(cb: PlayerEventCallback): void;
     /**
-     * @description cb should be called when the media playback current time is updated.
+     * cb should be called when the media playback current time is updated.
      * Or when the media duration is changed.
      * can be frequent. 200 msec is a good choice for period.
      * @param cb
      */
     onTimeUpdate(cb: PlayerEventCallback): void;
     /**
-     * @description cb should be called when the media source changes.
+     * cb should be called when the media source changes.
      * @param cb
      */
     onMediaChange(cb: PlayerEventCallback): void;
     /**
-     * @description (OPTIONAL) cb should be called when media is ended
+     * (OPTIONAL) cb should be called when media is ended
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect media end.
      * @param cb
      */
     onEnded?(cb: PlayerEventCallback): void;
     /**
-     * @description (OPTIONAL) cb should be called when full screen state of the player changes.
+     * (OPTIONAL) cb should be called when full screen state of the player changes.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect full screen changes.
      * @param cb the callback may pass non mandatory new full screen state as boolean.
      */
     onFullScreen?(cb: (isFullScreen?: boolean) => void): void;
     /**
-     * @description (OPTIONAL) cb should be called when player size changes.
+     * (OPTIONAL) cb should be called when player size changes.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect size change.
      * @param cb
      */
     onSizeChange?(cb: PlayerEventCallback): void;
     /**
-     * @description (OPTIONAL) cb should be called when
+     * (OPTIONAL) cb should be called when
      * the media element/player is taken off of a page.
      * Useful for dynamic websites.
      * @param cb
      */
     onRemove?(cb: PlayerEventCallback): void;
     /**
-     * @description (OPTIONAL) cb should be called when click event captured on player progress bar
+     * (OPTIONAL) cb should be called when click event captured on player progress bar
      * or keydown event captured on player.
      * Implementation of this callback may improve interactions and fast forwarding limit functionality
      * NOTE: if not supported the function must be undefined.
@@ -238,13 +238,13 @@ export interface IPlayerAdaptorApi {
      */
     onCaptureUIEvent?(cb: CaptureUIEventCallback): void;
     /**
-     * @description (OPTIONAL) Get player controls description parameters.
+     * (OPTIONAL) Get player controls description parameters.
      * The parameters describe behavior of the player controls.
      * @returns controls descriptor object
      */
     controlsDescriptor?(): IControlsDescriptor;
     /**
-     * @description (OPTIONAL) If defined will be called at view refreshes of the widget.
+     * (OPTIONAL) If defined will be called at view refreshes of the widget.
      * Allows the player to perform optional adjustments to the controls descriptor.
      * NOTE: may be called frequently, so no heavy operations should be performed.
      * @param isPhone
@@ -252,14 +252,14 @@ export interface IPlayerAdaptorApi {
      */
     updateControlsDescriptor?(isPhone: boolean, isFullScreen: boolean): void;
     /**
-     * @description (OPTIONAL) Get player controls hidden state.
+     * (OPTIONAL) Get player controls hidden state.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect controls state.
      * @returns
      */
     controlsHidden?(): boolean;
     /**
-     * @description (OPTIONAL) Get player controls height in pixels.
+     * (OPTIONAL) Get player controls height in pixels.
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
@@ -267,7 +267,7 @@ export interface IPlayerAdaptorApi {
      */
     controlsHeight?(): number | string;
     /**
-     * @description (OPTIONAL) Get player controls track (progress bar) left margin in pixels.
+     * (OPTIONAL) Get player controls track (progress bar) left margin in pixels.
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
@@ -275,7 +275,7 @@ export interface IPlayerAdaptorApi {
      */
     trackMarginLeft?(): number | string;
     /**
-     * @description (OPTIONAL) Get player player controls track (progress bar) right margin in pixels.
+     * (OPTIONAL) Get player player controls track (progress bar) right margin in pixels.
      * If supported it will be used instead of controlsDescriptor values.
      * NOTE: if not supported the function must be undefined.
      * Annoto will use other methods to detect height of the player.
@@ -283,7 +283,7 @@ export interface IPlayerAdaptorApi {
      */
     trackMarginRight?(): number | string;
     /**
-     * @description (OPTIONAL) cb should be called when player controls are shown.
+     * (OPTIONAL) cb should be called when player controls are shown.
      * If implemented the onControlsHide() method must be implemented as well.
      * If implemented those events will be used instead of mouse tracking
      * and controlsDescriptor.mouse parameters.
@@ -293,7 +293,7 @@ export interface IPlayerAdaptorApi {
      */
     onControlsShow?(cb: PlayerEventCallback): void;
     /**
-     * @description (OPTIONAL) cb should be called when player controls are hidden.
+     * (OPTIONAL) cb should be called when player controls are hidden.
      * If implemented the onControlsShow() method must be implemented as well.
      * If implemented those events will be used instead of mouse tracking
      * and controlsDescriptor.mouse parameters.
@@ -303,7 +303,7 @@ export interface IPlayerAdaptorApi {
      */
     onControlsHide?(cb: PlayerEventCallback): void;
     /**
-     * @description (OPTIONAL) Get the ration of width / height of the video frame itself.
+     * (OPTIONAL) Get the ration of width / height of the video frame itself.
      * Note: the ratio shold be of the video frame, not of the player element (it can be differnt).
      * Note: In most cases this method is not required. It is required only if the controls size
      * depends on the video frame size and not on the player element size, for example this is the
@@ -311,7 +311,7 @@ export interface IPlayerAdaptorApi {
      */
     videoRatio?(): number | null;
     /**
-     * @description (DEPRECATED) cb should be called when mouse enters player controls.
+     * (DEPRECATED) cb should be called when mouse enters player controls.
      * If implemented the onControlsLeave() method must be implemented as well.
      * NOTE: In most cases this event is not required.
      * NOTE: if not supported the function must be undefined.
@@ -323,7 +323,7 @@ export interface IPlayerAdaptorApi {
      */
     onControlsEnter?(cb: PlayerEventCallback): void;
     /**
-     * @description (DEPRECATED) cb should be called when mouse leaves player controls.
+     * (DEPRECATED) cb should be called when mouse leaves player controls.
      * If implemented the onControlsEnter() method must be implemented as well.
      * NOTE: In most cases this event is not required.
      * NOTE: if not supported the function must be undefined.

package/dist/build_esm/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../lib/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,OAAO,EAAE,MAAM,IAAI,CAAC;CACvB;AAED,eAAO,MAAM,eAAe,yFAezB;IACC,mBAAmB,EAAE,WAAW,EAAE,CAAC;IACnC,iBAAiB,EAAE,WAAW,EAAE,CAAC;IACjC,WAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,EAAE,EAAE,sBAAsB,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,KAAG,WA2CH,CAAC"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../lib/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,OAAO,EAAE,MAAM,IAAI,CAAC;CACvB;AAED,eAAO,MAAM,eAAe,GAAI,sFAe7B;IACC,mBAAmB,EAAE,WAAW,EAAE,CAAC;IACnC,iBAAiB,EAAE,WAAW,EAAE,CAAC;IACjC,WAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,EAAE,EAAE,sBAAsB,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,KAAG,WA2CH,CAAC"}