@byteplus/veplayer 2.3.0 → 2.3.1-rc.0

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.
      */
@@ -3812,6 +3840,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
@@ -5219,6 +5275,7 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      */
     icons?: any;
     /** {zh}
+     * @hidden
      * @brief 商业 DRM 播放配置。
      * @default -
      */
@@ -5228,6 +5285,15 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      */
     drm?: Drm;
 }
+/** {zh}
+ * @hidden
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
 interface Drm {
     /** {zh}
      * @brief FairPlay DRM 配置
@@ -5237,8 +5303,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 +5328,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 +5369,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]。
@@ -8035,6 +8124,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 +8688,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.
          */
@@ -9641,6 +9758,7 @@ declare namespace live {
          */
         icons?: any;
         /** {zh}
+         * @hidden
          * @brief 商业 DRM 播放配置。
          * @default -
          */
@@ -9650,6 +9768,15 @@ declare namespace live {
          */
         drm?: Drm;
     }
+    /** {zh}
+     * @hidden
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
     interface Drm {
         /** {zh}
          * @brief FairPlay DRM 配置
@@ -9659,8 +9786,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 +9811,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 +9852,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]。

package/veplayer.live.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.
      */
@@ -3812,6 +3840,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
@@ -5219,6 +5275,7 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      */
     icons?: any;
     /** {zh}
+     * @hidden
      * @brief 商业 DRM 播放配置。
      * @default -
      */
@@ -5228,6 +5285,15 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      */
     drm?: Drm;
 }
+/** {zh}
+ * @hidden
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
 interface Drm {
     /** {zh}
      * @brief FairPlay DRM 配置
@@ -5237,8 +5303,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 +5328,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 +5369,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]。
@@ -8035,6 +8124,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 +8688,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.
          */
@@ -9641,6 +9758,7 @@ declare namespace live {
          */
         icons?: any;
         /** {zh}
+         * @hidden
          * @brief 商业 DRM 播放配置。
          * @default -
          */
@@ -9650,6 +9768,15 @@ declare namespace live {
          */
         drm?: Drm;
     }
+    /** {zh}
+     * @hidden
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
     interface Drm {
         /** {zh}
          * @brief FairPlay DRM 配置
@@ -9659,8 +9786,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 +9811,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 +9852,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]。

package/veplayer.vod.d.ts

@@ -1366,6 +1366,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
@@ -1864,7 +1892,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.
      */
@@ -3639,6 +3667,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