@volcengine/veplayer 2.3.0 → 2.4.0-rc.1

package/veplayer.d.ts

@@ -1497,6 +1497,34 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
      * @hidden
      */
     preparePlugins?: PreparePlugins;
+    /** {zh}
+     * @brief 是否关闭 PC 端单击播放区域切换播放/暂停的能力，开启时，点击播放器区域可实现播放或暂停。
+     *        - `true`: 关闭；
+     *        - `false`: 开启。
+     * @default false
+     */
+    /** {en}
+     * @brief Whether to disable the click-to-play feature.
+     *        - `true`: Disable.
+     *        - `false`: Enable. Play/pause the video on mounse click for the PCs.
+     * @default false
+     */
+    closeVideoClick?: boolean;
+    /** {zh}
+     * @brief PC 端时表示是否关闭双击播放器进入全屏的能力；移动端时表示是否关闭双击切换播放/暂停的能力。
+     *        - `true`: 关闭；
+     *        - `false`: 开启。
+     * @default false
+     */
+    /** {en}
+     * @brief Whether to disable the double-click/tap action.
+     *        - `true`: Disable.
+     *        - `false`: Enable.
+     *        	- For the PCs, double click on the video to enter or exit the full screen mode.
+     *        	- For the mobiles, play/pause the video with double tap.
+     * @default false
+     */
+    closeVideoDblclick?: boolean;
 }
 /** {zh}
  * @list option
@@ -2032,7 +2060,7 @@ declare class VePlayerBase {
      * @param callback 表示事件的回调函数。
      */
     /** {en}
-     * @brief Listens for a specified event. The event handler is executed only once.
+     * @brief Add a one-time listener function for the specified event.
      * @param event The event name.
      * @param callback The callback function for the event.
      */
@@ -2307,7 +2335,8 @@ declare enum DynamicModule {
     PluginShaka = "plugin:shaka",
     PluginRtm = "plugin:rtm",
     PluginXgvideo = "plugin:xgvideo",
-    PluginDrm = "plugin:drm"
+    PluginDrm = "plugin:drm",
+    PluginAbr = "plugin:abr"
 }
 type ModulesMap = {
     [DynamicModule.BizVod]: Exports;
@@ -2319,6 +2348,7 @@ type ModulesMap = {
     [DynamicModule.PluginRtm]: Exports;
     [DynamicModule.PluginXgvideo]: Exports;
     [DynamicModule.PluginDrm]: Exports;
+    [DynamicModule.PluginAbr]: Exports;
 };
 declare const registerPlugin: (name: string, exports: {
     [x: string]: any;
@@ -3812,6 +3842,34 @@ declare namespace strategy {
          * @hidden
          */
         preparePlugins?: PreparePlugins;
+        /** {zh}
+         * @brief 是否关闭 PC 端单击播放区域切换播放/暂停的能力，开启时，点击播放器区域可实现播放或暂停。
+         *        - `true`: 关闭；
+         *        - `false`: 开启。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to disable the click-to-play feature.
+         *        - `true`: Disable.
+         *        - `false`: Enable. Play/pause the video on mounse click for the PCs.
+         * @default false
+         */
+        closeVideoClick?: boolean;
+        /** {zh}
+         * @brief PC 端时表示是否关闭双击播放器进入全屏的能力；移动端时表示是否关闭双击切换播放/暂停的能力。
+         *        - `true`: 关闭；
+         *        - `false`: 开启。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to disable the double-click/tap action.
+         *        - `true`: Disable.
+         *        - `false`: Enable.
+         *        	- For the PCs, double click on the video to enter or exit the full screen mode.
+         *        	- For the mobiles, play/pause the video with double tap.
+         * @default false
+         */
+        closeVideoDblclick?: boolean;
     }
     /** {zh}
      * @list option
@@ -4015,6 +4073,7 @@ declare namespace strategy {
         readonly "plugin:rtm": "veplayer.plugin.rtm.[env].[ext]";
         readonly "plugin:xgvideo": "veplayer.plugin.xgvideo.[env].[ext]";
         readonly "plugin:drm": "veplayer.plugin.drm.[env].[ext]";
+        readonly "plugin:abr": "veplayer.plugin.abr.[env].[ext]";
     };
     const enum State {
         Fetching = 0,
@@ -4044,7 +4103,8 @@ declare namespace strategy {
         PluginShaka = "plugin:shaka",
         PluginRtm = "plugin:rtm",
         PluginXgvideo = "plugin:xgvideo",
-        PluginDrm = "plugin:drm"
+        PluginDrm = "plugin:drm",
+        PluginAbr = "plugin:abr"
     }
     type ModulesMap = {
         [DynamicModule.BizVod]: Exports;
@@ -4056,6 +4116,7 @@ declare namespace strategy {
         [DynamicModule.PluginRtm]: Exports;
         [DynamicModule.PluginXgvideo]: Exports;
         [DynamicModule.PluginDrm]: Exports;
+        [DynamicModule.PluginAbr]: Exports;
     };
     class Loader {
         readonly modules: Record<string, Module>;
@@ -4832,6 +4893,9 @@ declare namespace event {
         AUTOPLAY_SUCCESS: string;
         ERROR_REFRESH_CLICK: string;
         SOURCE_CHANGE: string;
+        SWITCH_DEFINITION_START: string;
+        SWITCH_DEFINITION_SUCCESS: string;
+        DOWN_DEFINITION: string;
     };
     const Events: {
         SEI: string;
@@ -4857,6 +4921,9 @@ declare namespace event {
         AUTOPLAY_SUCCESS: string;
         ERROR_REFRESH_CLICK: string;
         SOURCE_CHANGE: string;
+        SWITCH_DEFINITION_START: string;
+        SWITCH_DEFINITION_SUCCESS: string;
+        DOWN_DEFINITION: string;
         REPLAY: string;
         ERROR: string;
         PLAY: string;
@@ -4888,6 +4955,9 @@ declare namespace event {
         COMPLETE: string;
         DESTROY: string;
         URL_CHANGE: string;
+        LEAVE_PLAYER: string;
+        ENTER_PLAYER: string;
+        LOADING: string;
         SEI_PARSED: string;
         RETRY: string;
         ROTATE: string;
@@ -5219,6 +5289,7 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      */
     icons?: any;
     /** {zh}
+     * @hidden
      * @brief 商业 DRM 播放配置。
      * @default -
      */
@@ -5228,6 +5299,30 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      */
     drm?: Drm;
 }
+interface Abr {
+    enable?: boolean;
+    downTip?: boolean;
+    debug?: boolean;
+    bitrate: number;
+    urls: {
+        [bitrate: number]: string;
+    };
+}
+interface HlsAbr {
+    enable?: boolean;
+    downTip?: boolean;
+    debug?: boolean;
+    bitrate: number;
+}
+/** {zh}
+ * @hidden
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
 interface Drm {
     /** {zh}
      * @brief FairPlay DRM 配置
@@ -5237,8 +5332,18 @@ interface Drm {
      */
     fairplay?: FairplayDrm;
 }
+/** {zh}
+ * @hidden
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
 interface FairplayDrm extends FairplayDrmConfig {
     /** {zh}
+     * @hidden
      * @brief 获取 DRM 配置的方法，用于更新 DRM 配置。
      * @param config
      * @returns 证书的请求地址和内容密钥许可证的请求地址。
@@ -5252,6 +5357,15 @@ interface FairplayDrm extends FairplayDrmConfig {
         url: string;
     }) => Promise<FairplayDrmConfig>;
 }
+/** {zh}
+ * @hidden
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
 interface FairplayDrmConfig {
     /** {zh}
      * @brief 获取证书的请求地址
@@ -5284,6 +5398,10 @@ interface TimeShiftConfig {
      * @brief 直播开始时间，Unix 时间戳，单位为 s，需要传入浏览器本地时间。
      * @default Date.now() / 1000
      */
+    /** {en}
+     * @brief The time the live stream session started. Unix timestamp in seconds. The time must be specified according to the time zone of the browser.
+     * @default Date.now() / 1000
+     */
     liveStartTime?: number;
     /** {zh}
      * @brief 最大时移时间，单位为 s，取值范围为 [6,604800]。
@@ -5440,6 +5558,8 @@ interface Flv {
      * @hidden
      */
     abrPts?: string | number;
+    abr?: Abr;
+    mseLowLatency?: boolean;
 }
 /** {zh}
  * @list option
@@ -5490,6 +5610,8 @@ interface Hls {
      * @default false
      */
     enableMSE?: boolean;
+    abr?: HlsAbr;
+    mseLowLatency?: boolean;
 }
 /** {zh}
  * @detail api
@@ -5541,11 +5663,50 @@ declare class VePlayerLive extends VePlayerBase {
      *
      */
     closeInfoPanel(): void;
+    openAbr(): void;
+    closeAbr(): void;
     /** {zh}
      * @brief 调用此方法更新 DRM 鉴权配置。
      * @hidden
      */
     updateDrmConfig(config: FairplayDrmConfig): void;
+    switch(target: string | {
+        /** {zh}
+         * @brief 清晰度的唯一标识。
+         * @default 无
+         */
+        /** {en}
+         * @brief The resolution ID.
+         */
+        definition?: string;
+        /** {zh}
+         * @brief 线路的唯一标识。
+         * @default 无
+         */
+        /** {en}
+         * @brief The playback source ID.
+         */
+        source?: string;
+    }, options?: {
+        /** {zh}
+         * @brief 清晰度 definition 配置无效时，是否降级到播放列表第一个清晰度地址。
+         * @default false
+         *
+         */
+        /** {en}
+         * @brief Whether to downgrade to the first resolution in the playlist when the player cannot play with the specified resolution.
+         * @default false
+         *
+         */
+        fallbackToFirstDefinition?: boolean;
+        abr: {
+            bitrate: number; // 默认起播的码率，必传
+            method?: number; // 选择abr算法编号
+            urls: {
+                [bitrate: number]: string;
+            }; // 可用的码率和对应的拉流地址
+        };
+    }): Promise<any>;
 }
 /** {zh}
  * @detail api
@@ -7224,6 +7385,9 @@ declare namespace live {
         AUTOPLAY_SUCCESS: string;
         ERROR_REFRESH_CLICK: string;
         SOURCE_CHANGE: string;
+        SWITCH_DEFINITION_START: string;
+        SWITCH_DEFINITION_SUCCESS: string;
+        DOWN_DEFINITION: string;
         REPLAY: string;
         ERROR: string;
         PLAY: string;
@@ -7255,6 +7419,9 @@ declare namespace live {
         COMPLETE: string;
         DESTROY: string;
         URL_CHANGE: string;
+        LEAVE_PLAYER: string;
+        ENTER_PLAYER: string;
+        LOADING: string;
         SEI_PARSED: string;
         RETRY: string;
         ROTATE: string;
@@ -8035,6 +8202,34 @@ declare namespace live {
          * @hidden
          */
         preparePlugins?: PreparePlugins;
+        /** {zh}
+         * @brief 是否关闭 PC 端单击播放区域切换播放/暂停的能力，开启时，点击播放器区域可实现播放或暂停。
+         *        - `true`: 关闭；
+         *        - `false`: 开启。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to disable the click-to-play feature.
+         *        - `true`: Disable.
+         *        - `false`: Enable. Play/pause the video on mounse click for the PCs.
+         * @default false
+         */
+        closeVideoClick?: boolean;
+        /** {zh}
+         * @brief PC 端时表示是否关闭双击播放器进入全屏的能力；移动端时表示是否关闭双击切换播放/暂停的能力。
+         *        - `true`: 关闭；
+         *        - `false`: 开启。
+         * @default false
+         */
+        /** {en}
+         * @brief Whether to disable the double-click/tap action.
+         *        - `true`: Disable.
+         *        - `false`: Enable.
+         *        	- For the PCs, double click on the video to enter or exit the full screen mode.
+         *        	- For the mobiles, play/pause the video with double tap.
+         * @default false
+         */
+        closeVideoDblclick?: boolean;
     }
     /** {zh}
      * @list option
@@ -8571,7 +8766,7 @@ declare namespace live {
          * @param callback 表示事件的回调函数。
          */
         /** {en}
-         * @brief Listens for a specified event. The event handler is executed only once.
+         * @brief Add a one-time listener function for the specified event.
          * @param event The event name.
          * @param callback The callback function for the event.
          */
@@ -8829,6 +9024,7 @@ declare namespace live {
         readonly "plugin:rtm": "veplayer.plugin.rtm.[env].[ext]";
         readonly "plugin:xgvideo": "veplayer.plugin.xgvideo.[env].[ext]";
         readonly "plugin:drm": "veplayer.plugin.drm.[env].[ext]";
+        readonly "plugin:abr": "veplayer.plugin.abr.[env].[ext]";
     };
     const enum State {
         Fetching = 0,
@@ -8858,7 +9054,8 @@ declare namespace live {
         PluginShaka = "plugin:shaka",
         PluginRtm = "plugin:rtm",
         PluginXgvideo = "plugin:xgvideo",
-        PluginDrm = "plugin:drm"
+        PluginDrm = "plugin:drm",
+        PluginAbr = "plugin:abr"
     }
     type ModulesMap = {
         [DynamicModule.BizVod]: Exports;
@@ -8870,6 +9067,7 @@ declare namespace live {
         [DynamicModule.PluginRtm]: Exports;
         [DynamicModule.PluginXgvideo]: Exports;
         [DynamicModule.PluginDrm]: Exports;
+        [DynamicModule.PluginAbr]: Exports;
     };
     class Loader {
         readonly modules: Record<string, Module>;
@@ -9641,6 +9839,7 @@ declare namespace live {
          */
         icons?: any;
         /** {zh}
+         * @hidden
          * @brief 商业 DRM 播放配置。
          * @default -
          */
@@ -9650,6 +9849,30 @@ declare namespace live {
          */
         drm?: Drm;
     }
+    interface Abr {
+        enable?: boolean;
+        downTip?: boolean;
+        debug?: boolean;
+        bitrate: number;
+        urls: {
+            [bitrate: number]: string;
+        };
+    }
+    interface HlsAbr {
+        enable?: boolean;
+        downTip?: boolean;
+        debug?: boolean;
+        bitrate: number;
+    }
+    /** {zh}
+     * @hidden
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
     interface Drm {
         /** {zh}
          * @brief FairPlay DRM 配置
@@ -9659,8 +9882,18 @@ declare namespace live {
          */
         fairplay?: FairplayDrm;
     }
+    /** {zh}
+     * @hidden
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
     interface FairplayDrm extends FairplayDrmConfig {
         /** {zh}
+         * @hidden
          * @brief 获取 DRM 配置的方法，用于更新 DRM 配置。
          * @param config
          * @returns 证书的请求地址和内容密钥许可证的请求地址。
@@ -9674,6 +9907,15 @@ declare namespace live {
             url: string;
         }) => Promise<FairplayDrmConfig>;
     }
+    /** {zh}
+     * @hidden
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
     interface FairplayDrmConfig {
         /** {zh}
          * @brief 获取证书的请求地址
@@ -9706,6 +9948,10 @@ declare namespace live {
          * @brief 直播开始时间，Unix 时间戳，单位为 s，需要传入浏览器本地时间。
          * @default Date.now() / 1000
          */
+        /** {en}
+         * @brief The time the live stream session started. Unix timestamp in seconds. The time must be specified according to the time zone of the browser.
+         * @default Date.now() / 1000
+         */
         liveStartTime?: number;
         /** {zh}
          * @brief 最大时移时间，单位为 s，取值范围为 [6,604800]。
@@ -9862,6 +10108,8 @@ declare namespace live {
          * @hidden
          */
         abrPts?: string | number;
+        abr?: Abr;
+        mseLowLatency?: boolean;
     }
     /** {zh}
      * @list option
@@ -9912,6 +10160,8 @@ declare namespace live {
          * @default false
          */
         enableMSE?: boolean;
+        abr?: HlsAbr;
+        mseLowLatency?: boolean;
     }
     /** {zh}
      * @detail api
@@ -9963,11 +10213,50 @@ declare namespace live {
          *
          */
         closeInfoPanel(): void;
+        openAbr(): void;
+        closeAbr(): void;
         /** {zh}
          * @brief 调用此方法更新 DRM 鉴权配置。
          * @hidden
          */
         updateDrmConfig(config: FairplayDrmConfig): void;
+        switch(target: string | {
+            /** {zh}
+             * @brief 清晰度的唯一标识。
+             * @default 无
+             */
+            /** {en}
+             * @brief The resolution ID.
+             */
+            definition?: string;
+            /** {zh}
+             * @brief 线路的唯一标识。
+             * @default 无
+             */
+            /** {en}
+             * @brief The playback source ID.
+             */
+            source?: string;
+        }, options?: {
+            /** {zh}
+             * @brief 清晰度 definition 配置无效时，是否降级到播放列表第一个清晰度地址。
+             * @default false
+             *
+             */
+            /** {en}
+             * @brief Whether to downgrade to the first resolution in the playlist when the player cannot play with the specified resolution.
+             * @default false
+             *
+             */
+            fallbackToFirstDefinition?: boolean;
+            abr: {
+                bitrate: number; // 默认起播的码率，必传
+                method?: number; // 选择abr算法编号
+                urls: {
+                    [bitrate: number]: string;
+                }; // 可用的码率和对应的拉流地址
+            };
+        }): Promise<any>;
     }
     /** {zh}
      * @detail api