@castlabs/prestoplay 6.28.0 → 6.30.0

package/typings.d.ts

@@ -875,6 +875,11 @@ export namespace clpp {
      * Enables preloading of video assets.
      */
     enablePreloading: boolean;
+    /**
+     * Set to true when using custom playback on SmartTV and iOS to enforce
+     * VAST playback (required to play plain VAST without VMAP).
+     */
+    isVast?: boolean;
     /**
      * Timeout (in milliseconds) when loading a video ad media file.
      * Use -1 for the default of 8 seconds.
@@ -1347,7 +1352,7 @@ export namespace clpp {
     /**
      * A unique identifier of this configuration object.
      * This attribute is optional, except for configuration objects passed to
-     * {@link clpp.plist.ScPlaylist} for which the ID is mandatory, since we
+     * {@link clpp.playlist.ScPlaylist} for which the ID is mandatory, since we
      * need a clear way to distinguish different items of the playlist.
      */
     id?: string;
@@ -1646,6 +1651,11 @@ export namespace clpp {
      * Optional. The URL of the poster.
      */
     image?: string;
+    /**
+     * Optional. If false, the item cannot be skipped via playlist controls. This
+     * property is respected only in {@link clpp.cast.playlist.CastPlaylist}.
+     */
+    skippable?: boolean;
     /**
      * Optional. The title.
      */
@@ -3301,7 +3311,7 @@ export namespace clpp {
      */
     DRM_LICENSE_REQUESTED = "drmlicenserequested",
     /**
-     * Triggered when an attempt to autoplay the media was block by the platform.
+     * Triggered when an attempt to autoplay the media was blocked by the platform.
      */
     AUTOPLAY_NOT_ALLOWED = "autoplaynotallowed",
     /**
@@ -3429,6 +3439,11 @@ export namespace clpp {
      * Triggered when status of cast receiver changed.
      */
     CAST_STATUS_CHANGED = "caststatuschanged",
+    /**
+     * Triggered when the cast receiver app goes into the background, or from
+     * background back to foreground.
+     */
+    CAST_VISIBILITY_CHANGED = "castvisibilitychanged",
     /**
      * Triggered when status of AirPlay availability changed.
      */
@@ -4323,7 +4338,7 @@ export namespace clpp {
      */
     start(): void;
     /**
-     * Stop iterating the playlist.
+     * Stop iterating the playlist. Does not stop the playback.
      */
     stop(): void;
   }
@@ -4528,6 +4543,9 @@ export namespace clpp {
   }
   
   namespace Error {
+    /**
+     * Error category.
+     */
     export enum Category {
       /**
        * Errors from the network stack.
@@ -4571,6 +4589,9 @@ export namespace clpp {
       ADS = 10,
     }
     
+    /**
+     * Error code.
+     */
     export enum Code {
       /**
        * A network request was made using an unsupported URI scheme.
@@ -5031,8 +5052,7 @@ export namespace clpp {
        */
       CANNOT_ADD_EXTERNAL_TEXT_TO_LIVE_STREAM = 4040,
       /**
-       * We do not support playing Fairplay-encrypted transport streams
-       * (MPEG-TS) with MSE.
+       * Due to limitations of the MSE API Fairplay-protected MPEG-TS is not supported.
        */
       HLS_MSE_ENCRYPTED_TS_NOT_SUPPORTED = 4041,
       /**
@@ -5453,6 +5473,9 @@ export namespace clpp {
       SESSIONS_INVALID_CONFIGURATION = 15000,
     }
     
+    /**
+     * Error severity.
+     */
     export enum Severity {
       /**
        * An error occurred that the player will try to recover from. If retrying
@@ -5850,8 +5873,9 @@ export namespace clpp {
        * @param opt_playerConfig optional
        *   configuration to cast. If omitted, player will try to cast current
        *   content.
+       * @param opt_queueOptions optional queue items and starting index to load.
        */
-      cast(opt_playerConfig?: clpp.PlayerConfiguration): Promise<void>;
+      cast(opt_playerConfig?: clpp.PlayerConfiguration, opt_queueOptions?: Record<string, any>): Promise<void>;
       /**
        * Change receiver id. It will close current session, if any.
        *
@@ -6122,6 +6146,89 @@ export namespace clpp {
       updateContentMetadata(metadata: clpp.cast.utils.ReceiverMetadataObject|null): void;
     }
     
+    namespace playlist {
+      /**
+       * Creates a playlist controller bound to the provided player.
+       */
+      export class CastPlaylist {
+        /**
+         * Creates a playlist controller bound to the provided player.
+         *
+         * @param player sender player instance
+         * @param castAppId Chromecast receiver application ID
+         * @param playlistItems items to enqueue
+         */
+        constructor(player: clpp.Player, castAppId: string, playlistItems: Array<clpp.PlaylistItem>);
+        /**
+         * Appends a new item locally and mirrors it to the cast queue when casting.
+         */
+        append(item: clpp.PlaylistItem): Promise<void>;
+        /**
+         * Returns whether casting is currently active.
+         */
+        canCast(): boolean;
+        /**
+         * Stops playlist, destroys the current underlying castProxy
+         * and releases player.
+         */
+        destroy(): void;
+        /**
+         * Returns the index of the currently active playlist item.
+         */
+        getCurrentIndex(): number;
+        /**
+         * Returns the current local playlist queue.
+         */
+        getPlaylistItems(): Array<clpp.PlaylistItem>;
+        /**
+         * Returns whether casting is currently active.
+         */
+        isCasting(): boolean;
+        /**
+         * Moves to the next playlist item using cast queue when casting.
+         */
+        next(): Promise<void>;
+        /**
+         * Registers a handler for cast availability or connection status changes.
+         *
+         * @param handler callback invoked with event payload
+         */
+        onCastStatusChanged(handler: Function): clpp.EventCallback;
+        /**
+         * Registers a handler invoked when the active playlist index changes.
+         *
+         * @param handler callback invoked with event payload
+         */
+        onPlaylistItemChange(handler: Function): clpp.EventCallback;
+        /**
+         * Registers a handler invoked when the playlist content is modified.
+         *
+         * @param handler callback invoked with event payload
+         */
+        onPlaylistModified(handler: Function): clpp.EventCallback;
+        /**
+         * Pauses playback on the underlying player.
+         */
+        pause(): void;
+        /**
+         * Plays the underlying player.
+         */
+        play(): void;
+        /**
+         * Moves to the previous playlist item using cast queue when casting.
+         */
+        previous(): Promise<void>;
+        /**
+         * Starts playlist playback from the current index.
+         */
+        start(): void;
+        /**
+         * Starts casting with the current queue or disconnects if already casting.
+         */
+        toggleCast(): Promise<void>;
+      }
+    }
+    
     namespace utils {
       /**
        * Callback function used to modify load request data before play.
@@ -6974,7 +7081,7 @@ export namespace clpp {
     export type LogInterceptor = Function;
     
     /**
-     * All available log levels
+     * Log level.
      */
     export enum Level {
       /**
@@ -7965,82 +8072,7 @@ export namespace clpp {
     }
   }
   
-  namespace plist {
-    /**
-     * A playlist item.
-     * It consists of an asset/config, a player instances selected
-     * to play this asset and the underlying video element to which the player is
-     * attached.
-     */
-    export type Item = {
-      /**
-       * Source configuration.
-       */
-      config: clpp.PlayerConfiguration;
-      /**
-       * The index of the item in the playlist.
-       */
-      index: number;
-      /**
-       * A player instance.
-       */
-      player: clpp.Player|null;
-      /**
-       * A promise that resolves when the item is preloaded.
-       */
-      preloadPromise: Promise<void>;
-      /**
-       * The role of the item.
-       */
-      role: string;
-      /**
-       * The state of the item (e.g. 'preloading', 'preloaded', 'preload-failed').
-       */
-      state: string;
-      /**
-       * The video element attached to the player.
-       */
-      videoEl: HTMLVideoElement|null;
-    }
-    
-    /**
-     * Playlist options.
-     */
-    export type Options = {
-      /**
-       * ID of the HTML element to be used as a container
-       * for video elements created by this playlist.
-       */
-      anchorId: string;
-      /**
-       * If true, when one item finishes playback the next item is played
-       * automatically and so on until the end of the playlist.
-       */
-      autoplayNext?: boolean;
-      /**
-       * Default configuration for player instances.
-       */
-      config: clpp.PlayerConfiguration;
-      /**
-       * If true, preloaded items will have also their media segments preloaded
-       * thus reducing the time to start playback to minimum. This option is
-       * intended to be used with VOD streams.
-       */
-      preloadMedia?: boolean;
-      /**
-       * A custom callback to toggle the visibility of a video element. By default
-       * this is done via z-index.
-       */
-      toggleVisible?: Function;
-      /**
-       * Transition method, can be "pause" or "keep-playing". In cause of "pause"
-       * the current video will be paused when calling
-       * {@link clpp.plist.McPlaylist.playNext} or
-       * {@link clpp.plist.McPlaylist.playPrev}.
-       */
-      transition?: string;
-    }
-    
+  namespace playlist {
     /**
      * Multi-controller playlist intended for fast live TV channel zapping.
      * It is based on an architecture which leverages multiple video elements
@@ -8116,12 +8148,13 @@ export namespace clpp {
       hasPrev(): boolean;
       /**
        * Play the first item.
-       * Make sure to set items via {@link clpp.plist.McPlaylist.setItems} and
-       * select the index to start from via {@link clpp.plist.McPlaylist.setIndex}
+       * Make sure to set items via {@link clpp.playlist.McPlaylist.setItems} and
+       * select the index to start from via
+       * {@link clpp.playlist.McPlaylist.setIndex}
        * before calling this method.
        * To switch to the next or previous item use methods
-       * {@link clpp.plist.McPlaylist.playNext} and
-       * {@link clpp.plist.McPlaylist.playPrev}.
+       * {@link clpp.playlist.McPlaylist.playNext} and
+       * {@link clpp.playlist.McPlaylist.playPrev}.
        */
       playFirst(): Promise<void>;
       /**
@@ -8180,7 +8213,7 @@ export namespace clpp {
       /**
        * Append an item to the end of the playlist.
        * This method cannot be called before
-       * {@link clpp.plist.ScPlaylist#open|open()}.
+       * {@link clpp.playlist.ScPlaylist#open|open()}.
        *
        * @param config an item which must contain
        *   at least an `id` and a `source`.
@@ -8306,6 +8339,83 @@ export namespace clpp {
     }
   }
   
+  namespace plist {
+    /**
+     * A playlist item.
+     * It consists of an asset/config, a player instances selected
+     * to play this asset and the underlying video element to which the player is
+     * attached.
+     */
+    export type Item = {
+      /**
+       * Source configuration.
+       */
+      config: clpp.PlayerConfiguration;
+      /**
+       * The index of the item in the playlist.
+       */
+      index: number;
+      /**
+       * A player instance.
+       */
+      player: clpp.Player|null;
+      /**
+       * A promise that resolves when the item is preloaded.
+       */
+      preloadPromise: Promise<void>;
+      /**
+       * The role of the item.
+       */
+      role: string;
+      /**
+       * The state of the item (e.g. 'preloading', 'preloaded', 'preload-failed').
+       */
+      state: string;
+      /**
+       * The video element attached to the player.
+       */
+      videoEl: HTMLVideoElement|null;
+    }
+    
+    /**
+     * Playlist options.
+     */
+    export type Options = {
+      /**
+       * ID of the HTML element to be used as a container
+       * for video elements created by this playlist.
+       */
+      anchorId: string;
+      /**
+       * If true, when one item finishes playback the next item is played
+       * automatically and so on until the end of the playlist.
+       */
+      autoplayNext?: boolean;
+      /**
+       * Default configuration for player instances.
+       */
+      config: clpp.PlayerConfiguration;
+      /**
+       * If true, preloaded items will have also their media segments preloaded
+       * thus reducing the time to start playback to minimum. This option is
+       * intended to be used with VOD streams.
+       */
+      preloadMedia?: boolean;
+      /**
+       * A custom callback to toggle the visibility of a video element. By default
+       * this is done via z-index.
+       */
+      toggleVisible?: Function;
+      /**
+       * Transition method, can be "pause" or "keep-playing". In cause of "pause"
+       * the current video will be paused when calling
+       * {@link clpp.playlist.McPlaylist.playNext} or
+       * {@link clpp.playlist.McPlaylist.playPrev}.
+       */
+      transition?: string;
+    }
+  }
+  
   namespace smooth {
     export class SmoothComponent {