@theoplayer/extended 4.9.1 → 4.11.0

package/THEOplayer.d.ts

@@ -2,7 +2,7 @@
  * THEOplayer
  * https://www.theoplayer.com
  *
- * Version: 2023.1.3 (4.9.1)
+ * Version: 2023.1.5 (4.11.0)
  */
 
 /**
@@ -2977,6 +2977,19 @@ export declare interface DashPlaybackConfiguration {
      *         THEOplayer support or engineering.
      */
     needsTimescaleShifting?: boolean | null;
+    /**
+     * (Experimental) The desired timescale to which the media data should be shifted.
+     *
+     * @remarks
+     * <br/> - Available since v4.11.0.
+     * <br/> - When specified, if the player decides to shift the timescale (see {@link DashPlaybackConfiguration.needsTimescaleShifting}), the timescale will be set to the
+     *         given desired timescale.
+     * <br/> - When not specified, if the player decides to shift timescale, the player will decide the timescale to which it should shift.
+     * <br/> - This is an experimental option. It should only be used after consulting with
+     *         THEOplayer support or engineering.
+     */
+    desiredTimescale?: number;
+
 }
 
 /**
@@ -6500,6 +6513,10 @@ export declare interface PlayerConfiguration {
      * <br/> - Used for DASH and LL-HLS streams.
      */
     abr?: SourceAbrConfiguration;
+    /**
+     * The vr configuration for the player.
+     */
+    vr?: VRPlayerConfiguration;
 }
 
 /**
@@ -7352,6 +7369,7 @@ export declare type RequestMethod = 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POS
  * The request's subtype, represented by a value from the following list:
  * <br/> - `'initialization-segment'`
  * <br/> - Any value of {@link ContentProtectionRequestSubType}
+ * <br/> - Empty string (`''`) when the subtype is unknown
  *
  * @public
  */
@@ -7361,11 +7379,12 @@ export declare type RequestSubType = '' | 'initialization-segment' | ContentProt
  * The request's type, represented by a value from the following list:
  * <br/> - `'manifest'`
  * <br/> - `'segment'`
+ * <br/> - `'preload-hint'`
  * <br/> - `'content-protection'`
  *
  * @public
  */
-export declare type RequestType = '' | 'manifest' | 'segment' | 'content-protection';
+export declare type RequestType = '' | 'manifest' | 'segment' | 'preload-hint' | 'content-protection';
 
 /**
  * The possible types of an HTTP response body.
@@ -11451,6 +11470,15 @@ export declare interface VRConfiguration {
      * @defaultValue `false`
      */
     '360'?: boolean;
+    /**
+     * The panorama mode of the media.
+     *
+     * @remarks
+     * <br/> - If the "360" property is set to true, panoramaMode is ignored and the content will be displayed as 360 degrees panorama.
+     *
+     * @defaultValue `undefined`
+     */
+    panoramaMode?: VRPanoramaMode;
     /**
      * The stereoscopic mode of the media.
      *
@@ -11521,6 +11549,30 @@ export declare interface VREventMap {
     error: ErrorEvent_2;
 }
 
+/**
+ * The panorama mode of the VR content, represented by a value from the following list:
+ * <br/> - `''`: No panorama mode.
+ * <br/> - `'360'`: The video contains content with a full 360 degree field of view.
+ * <br/> - `'180'`: The video contains content with a 180 degree field of view. `'180'` is only available when using the WebXR API.
+ *
+ * @public
+ */
+export declare type VRPanoramaMode = '' | '360' | '180';
+
+/**
+ * Describes the VR configuration
+ *
+ * @public
+ */
+declare interface VRPlayerConfiguration {
+    /**
+     * Whether to use the {@link https://immersiveweb.dev/ | WebXR API}.
+     *
+     * @defaultValue `false`
+     */
+    useWebXR?: boolean;
+}
+
 /**
  * The state of the VR feature, represented by a value from the following list:
  * <br/> - `'unavailable'`