@castlabs/prestoplay 6.33.0 → 6.34.0

package/typings.d.ts

@@ -306,12 +306,23 @@ export namespace clpp {
      * a list of hosts separated by "," (i.e "192.168.1.1,192.168.10.1")
      */
     nanoCDNHost: string;
+    /**
+     * Broadpeak streaming session options.
+     */
+    sessionOptions: clpp.BroadpeakSessionOptions;
     /**
      * The Unique User Identifier.
      */
     uuid: string;
   }
   
+  /**
+   * Broadpeak streaming session options passed to SmartLib.
+   * Use StreamingSessionOptions constants as keys.
+   * See {@link https://delivery-platform.broadpeak.tv/smartlib/public/advanced-features/session-options|Broadpeak session options docs}.
+   */
+  export type BroadpeakSessionOptions = Record<string, any>;
+  
   /**
    * Chromecast configuration.
    */
@@ -321,7 +332,7 @@ export namespace clpp {
      */
     useSenderAbrConfig?: boolean;
     /**
-     * Enable to pass on current sender {@link clpp.StreamingConfiguration} to reciver.
+     * Enable to pass on current sender {@link clpp.StreamingConfiguration} to receiver.
      */
     useSenderStreamingConfig?: boolean;
   }
@@ -642,58 +653,6 @@ export namespace clpp {
     persistentState: boolean;
   }
   
-  /**
-   * Contains information about an EMSG MP4 box.
-   */
-  export type EmsgInfo = {
-    /**
-     * The time that the event ends (in presentation time).
-     */
-    endTime: number;
-    /**
-     * The duration of the event (in units of timescale).
-     */
-    eventDuration: number;
-    /**
-     * A field identifying this instance of the message.
-     */
-    id: number;
-    /**
-     * Body of the message.
-     */
-    messageData: Uint8Array;
-    /**
-     * The absolute event presentation time (in units of timescale).
-     * Available for EMSG v1.
-     */
-    presentationTime?: number;
-    /**
-     * The offset that the event starts, relative to the start of the segment
-     * this is contained in (in units of timescale). Available for EMSG v0.
-     */
-    presentationTimeDelta?: number;
-    /**
-     * Identifies the message scheme.
-     */
-    schemeIdUri: string;
-    /**
-     * The time that the event starts (in presentation time).
-     */
-    startTime: number;
-    /**
-     * Provides the timescale, in ticks per second.
-     */
-    timescale: number;
-    /**
-     * Specifies the value for the event.
-     */
-    value: string;
-    /**
-     * Version of the EMSG box (0 or 1).
-     */
-    version: number;
-  }
-  
   /**
    * The type for event listener callback functions.
    */
@@ -800,11 +759,11 @@ export namespace clpp {
      */
     id: string;
     /**
-     * Maximum duration of the slot allowed.
+     * Maximum duration of the slot allowed in seconds.
      */
     maxDuration?: number;
     /**
-     * Minimum duration of the slot allowed.
+     * Minimum duration of the slot allowed in seconds.
      */
     minDuration?: number;
     /**
@@ -860,12 +819,12 @@ export namespace clpp {
      * There are platforms where the video size is fixed (for example Smart TVs)
      * and the resize observer might be disabled to not cause unnecessary load.
      */
-    enableResizeObserver: boolean;
+    enableResizeObserver?: boolean;
     /**
      * Stretch a subtitle image (like SMPTE-TT or IMSC1) to fit the surrounding
      * container.
      */
-    stretchSmpteImage: boolean;
+    stretchSmpteImage?: boolean;
   }
   
   /**
@@ -1319,7 +1278,7 @@ export namespace clpp {
      */
     abr?: Partial<clpp.AbrConfiguration>;
     /**
-     * Adobe analytics plugin configuration.
+     * Deprecated. Adobe analytics plugin configuration.
      */
     adobe?: Partial<clpp.AdobeConfiguration>;
     /**
@@ -1327,7 +1286,10 @@ export namespace clpp {
      */
     ads?: Partial<clpp.AdsConfiguration>;
     /**
-     * Configures the autoplay behavior.
+     * If true, video automatically starts playback after {@link clpp.Player#open()|player.open()}.
+     * Before configuring this please make sure you are familiar with browser
+     * autoplay policies limiting autoplay on page load
+     * {@link https://developer.mozilla.org/en-US/docs/Web/Media/Guides/Autoplay}.
      */
     autoplay?: boolean;
     /**
@@ -1352,9 +1314,7 @@ export namespace clpp {
      */
     drm?: Partial<clpp.DrmConfiguration>|null;
     /**
-     * The DRM configuration resolver. Only works on MSE, not compatible
-     * with {@link clpp.onboard.OnboardComponent}, {@link clpp.drm.HeaderDrmComponent}
-     * nor {@link clpp.verimatrix.VcasComponent}.
+     * The DRM configuration resolver. Only works on MSE.
      */
     drmResolver?: Partial<clpp.DrmConfigurationResolver>;
     /**
@@ -1589,7 +1549,7 @@ export namespace clpp {
      */
     viewerId?: string;
     /**
-     * Vimond plugin configuration.
+     * Deprecated. Vimond plugin configuration.
      */
     vimond?: Partial<clpp.VimondConfiguration>;
     /**
@@ -1664,13 +1624,13 @@ export namespace clpp {
     cropTimeline?: boolean;
     /**
      * This option applies to the single-controller playlist. It is the time
-     * at which the playlist should stop. The time is relative to the
+     * in seconds at which the playlist should stop. The time is relative to the
      * start of the first playlist item and may span several items.
      */
     endTime?: number;
     /**
      * This option applies to the single-controller playlist. IT is the time
-     * within the first playlist item at which the playlist should start
+     * in seconds within the first playlist item at which the playlist should start
      * playback. The time is relative to the start of the first playlist item.
      */
     startTime?: number;
@@ -2002,18 +1962,17 @@ export namespace clpp {
      */
     adParameters?: string;
     /**
-     * The duration of the SIMID creative
+     * The duration of the SIMID creative in seconds
      */
     duration: number;
     /**
-     * Pre-load the creative. The value here is the
-     * delta from the startTime. For example, preload=5 would mean that the
-     * player will load the creative at startTime-5.
+     * The offset in seconds before the startTime at
+     * which to preload the creative
      */
-    preload: number;
+    preload?: number;
     /**
      * The start time in seconds relative to the main
-     * content timeline.
+     * content timeline
      */
     startTime: number;
     /**
@@ -2267,6 +2226,13 @@ export namespace clpp {
      * When set to |true|, live edge chasing algorithm will be enabled.
      */
     enableLiveEdgeChasing: boolean;
+    /**
+     * Defaults to true.
+     * 
+     * When enabled, the player monitors segment downloads and aborts
+     * any request that has been running longer than rebufferingGoal.
+     */
+    enableStalledSegmentAbort?: boolean;
     /**
      * If this is true, native TS support will be used where possible. Otherwise
      * we will transmux TS content even if not strictly necessary
@@ -3266,17 +3232,11 @@ export namespace clpp {
      */
     LOADEDMETADATA = "loadedmetadata",
     /**
-     * Triggered when player ends buffering.
-     * The detail will contains the
-     * {@link clpp.events.BufferingDetails|BufferingDetails} that exposes the
-     * reason for the buffering start.
+     * Triggered when player finishes buffering.
      */
     BUFFERING_ENDED = "bufferingended",
     /**
      * Triggered when player starts buffering.
-     * The detail will contains the
-     * {@link clpp.events.BufferingDetails|BufferingDetails} that exposes the
-     * reason for the buffering start.
      */
     BUFFERING_STARTED = "bufferingstarted",
     /**
@@ -3343,11 +3303,6 @@ export namespace clpp {
      * Triggered when an audio segment is appended or removed
      */
     AUDIO_BUFFER_CHANGED = "audiobufferchanged",
-    /**
-     * Triggered when a video or audio segment was downloaded successfully
-     * and considered by the players bandwidth estimation.
-     */
-    DOWNLOAD_TRACE = "downloadtrace",
     /**
      * Triggered when the players DRM session is created.
      */
@@ -3603,15 +3558,6 @@ export namespace clpp {
      * Triggered by the Yospace plugin when the Yospace session has been shut down.
      */
     YOSPACE_SESSION_ENDED = "yospace-session-ended",
-    /**
-     * Triggered when location selection and priorities are updated
-     * for a BaseUriCollection
-     */
-    CONTENT_STEERING_CHANGE = "content-steering-change",
-    /**
-     * Triggered when a service location is banned/unbanned
-     */
-    CONTENT_STEERING_LOCATION_BAN_UPDATE = "content-steering-location-ban-update",
   }
   
   /**
@@ -3704,7 +3650,7 @@ export namespace clpp {
      * The default behavior includes gaps, meaning if the playhead is in a
      * gap, it is considered buffered.
      *
-     * @param time The time
+     * @param time time in seconds
      * @param opt_includeGaps If false, gaps will not be
      *   included, meaning if the time is in a gap it will be considered
      *   un-buffered. The default is to consider gaps as buffered.
@@ -3735,8 +3681,9 @@ export namespace clpp {
      *   'message' property, which will be used as the error message
      * @param opt_error Optional cause. This will be available as the cause
      *   for this error.
+     * @param opt_svtaCode Optional SVTA code.
      */
-    constructor(severity: clpp.Error.Severity, category: clpp.Error.Category, code: clpp.Error.Code, opt_data?: Record<string, any>|string, opt_error?: any);
+    constructor(severity: clpp.Error.Severity, category: clpp.Error.Category, code: clpp.Error.Code, opt_data?: Record<string, any>|string, opt_error?: any, opt_svtaCode?: number);
     /**
      * The error category.
      */
@@ -3761,6 +3708,10 @@ export namespace clpp {
      * The error severity.
      */
     severity: clpp.Error.Severity;
+    /**
+     * The SVTA error code.
+     */
+    svtaCode: number;
   }
   
   /**
@@ -3809,7 +3760,7 @@ export namespace clpp {
     destroy(): Promise<void>;
     /**
      * Returns the ads manager or null if not available.
-     * The ads manager is available when {@link clpp.Player.open} is resolved.
+     * The ads manager is available when {@link clpp.Player#open} is resolved.
      */
     getAdsManager(): clpp.ads.IAdsManager|null;
     /**
@@ -4964,7 +4915,7 @@ export namespace clpp {
       /**
        * The WebM header parser was unable to locate the Duration element.
        * The init segment data may be corrupt or may have been incorrectly encoded.
-       * Shaka requires a duration in WebM DASH content.
+       * Duration information in WebM DASH content is required.
        */
       WEBM_DURATION_ELEMENT_MISSING = 3011,
       /**
@@ -5769,12 +5720,6 @@ export namespace clpp {
     }
   }
   
-  namespace adobe {
-    export class AdobeAnalyticsPlugin {
-      static Id: string;
-    }
-  }
-  
   namespace ads {
     export interface IAd {
       /**
@@ -6211,10 +6156,6 @@ export namespace clpp {
       setPlayerConfigInterceptor(interceptor: clpp.cast.utils.PlayerConfigInterceptor|null): void;
     }
     
-    export class CastUtils {
-      
-    }
-    
     export class Queue {
       
     }
@@ -6898,10 +6839,6 @@ export namespace clpp {
     }
     
     namespace eme {
-      export class EmeFactory {
-        
-      }
-      
       namespace EmeFactory {
         /**
          * Versions of Encrypted Media Extensions (EME) API.
@@ -6959,13 +6896,12 @@ export namespace clpp {
      * Container object that contains meta-data for a buffering event.
      * The object is send with
      * {@link clpp.events.BUFFERING_STARTED|BUFFERING_STARTED} and
-     * {@link clpp.events.BUFFERING_ENDED|BUFFERING_ENDED} events. Please
-     * note that the bufferedTimeMs will be -1 for a CLPP_BUFFERING_STARTED event.
+     * {@link clpp.events.BUFFERING_ENDED|BUFFERING_ENDED} events.
      */
     export type BufferingDetails = {
       /**
-       * The time the player spend in buffering state or -1 for
-       * BUFFERING_STARTED events
+       * The time in milliseconds the player spent in buffering state or -1
+       * in case of BUFFERING_STARTED events
        */
       bufferedTimeMS: number;
       /**
@@ -7002,13 +6938,13 @@ export namespace clpp {
        */
       maxSuggestedBitrateKbps?: number;
       /**
-       * The time elapsed between the receipt of the request
+       * The time in milliseconds elapsed between the receipt of the request
        * and when the first byte of the body becomes available to send to the client.
        * Header-Key: rd
        */
       responseDelay?: number;
       /**
-       * Estimated round trip time between client and server.
+       * Estimated round trip time in milliseconds between client and server.
        * This estimate may be derived from the transport handshake.
        * Header-Key: rtt
        */
@@ -7279,6 +7215,9 @@ export namespace clpp {
        * to the presentation). |endTime| will be greater to equal to |startTime|.
        * |remove| should only return |false| if the displayer has been destroyed. If
        * the displayer has not been destroyed |remove| should return |true|.
+       *
+       * @param startTime start time in seconds
+       * @param endTime end time in seconds
        */
       remove(startTime: number, endTime: number): boolean;
       /**
@@ -7631,45 +7570,6 @@ export namespace clpp {
       timeout: number;
     }
     
-    /**
-     * Container object that contains information about a single download trace.
-     * The object is send with
-     * {@link clpp.events.DOWNLOAD_TRACE|DOWNLOAD_TRACE} events.
-     */
-    export type DownloadTrace = {
-      /**
-       * The current bandwidth estimation after the sample was pushed.
-       */
-      bandwidthEstimate: number;
-      /**
-       * The calculated speed of the download in bps
-       */
-      bitrate: number;
-      /**
-       * The type of the downloaded segment. One of 'audio', 'video', or 'text' if
-       * known.
-       */
-      contentType: string;
-      /**
-       * True if the downloaded segment was an init segment.
-       */
-      initSegment: boolean;
-      /**
-       * The number of bytes downloaded
-       */
-      size: number;
-      /**
-       * The download time in milliseconds
-       */
-      time: number;
-      /**
-       * Either 'full' or 'partial'. Full trace events are posted after the entire
-       * segment was downloaded while partial traces are posted during an ongoing
-       * download.
-       */
-      type: string;
-    }
-    
     export type Mp4Fragment = {
       /**
        * The number of mdat boxes in this fragment or
@@ -7755,7 +7655,7 @@ export namespace clpp {
        */
       disableMergedFragments: boolean|null;
       /**
-       * The media end time or null
+       * The media end time in seconds or null
        */
       endTime: number|null;
       /**
@@ -7829,7 +7729,7 @@ export namespace clpp {
        */
       sessionId: string|null;
       /**
-       * The media start time or null
+       * The media start time in seconds or null
        */
       startTime: number|null;
       /**
@@ -9572,20 +9472,6 @@ export namespace clpp {
     }
   }
   
-  namespace vimond {
-    export class VimondPlugin {
-      static Id: string;
-      /**
-       * Update the auth token.
-       * The auth token may expire during playback.
-       * Pass a fresh auth token regularly to prevent failure.
-       *
-       * @param authToken Authentication token
-       */
-      updateAuthToken(authToken: string): void;
-    }
-  }
-  
   namespace vr {
     export class VrPlugin {
       static Id: string;