@volcengine/veplayer 2.8.1 → 2.8.2

package/umd/veplayer.live.d.ts

@@ -516,6 +516,16 @@ declare enum Level {
      */
     Warn = "Warn"
 }
+/** {zh}
+ * @detail error
+ * @id errorcode
+ * @hidden
+ */
+/** {en}
+ * @detail error
+ * @id errorcode
+ * @hidden
+ */
 declare enum ErrorCode {
     /** {zh}
      * @brief 视频解析错误
@@ -1729,15 +1739,15 @@ interface Poster {
      */
     isEndedShow?: boolean;
     /** {zh}
-     * @brief 是否播放后再隐藏封面图。
-     *   - `true`：播放后隐藏，未启播时一直显示封面图。
-     *   - `false`：在 `play` 事件触发后隐藏封面图。
+     * @brief 是否在播放后隐藏封面图。
+     *   - `true`：在播放器开始播放（即画面可见）后隐藏封面图，播放前始终显示，避免黑屏；
+     *   - `false`：在触发 `play` 事件时立即隐藏封面图，可能在画面显示前出现黑屏。
      * @default false
      */
     /** {en}
-     * @brief Whether to hide the cover image after `canplay` event.
-     * - `true`：hide the cover image after `canplay` event.
-     * - `false`：hide the cover image after `play` event.
+     * @brief Whether to hide the poster image after playback starts.
+     * - `true`：The poster image remains visible until video playback actually starts (i.e., video frames are rendered), preventing a black screen before playback.
+     * - `false`：The poster image is hidden immediately when the `play` event is triggered, which may cause a brief black screen before video appears.
      * @default false
      */
     hideCanplay?: boolean;
@@ -1751,18 +1761,18 @@ interface Poster {
      */
     notHidden?: boolean;
     /** {zh}
-     * @brief 封面图填充方式。取值如下：
-     * - `fixWidth`：宽度方向填充，不会被拉伸压缩。
-     * - `fixHeight`：高度方向填充，不会被拉伸压缩。
-     * - `cover`：完全覆盖容器，多余部分会被裁剪。
-     * - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+     * @brief 封面图的填充方式，取值如下所示。
+     * - `fixWidth`：按宽度适配容器，高度等比缩放，图像不拉伸压缩；
+     * - `fixHeight`：按高度适配容器，宽度等比缩放，图像不拉伸压缩；
+     * - `cover`：等比缩放并裁剪，使封面图完整覆盖容器，不留黑边；
+     * - `contain`：等比缩放并拉伸，使封面图完整覆盖容器，不留黑边，可能失真。
      */
     /** {en}
-     * @brief Cover image fill mode.
-     * - `fixWidth`：Fill the width of the container and crop the height if necessary.
-     * - `fixHeight`：Fill the height of the container and crop the width if necessary.
-     * - `cover`：Fill the entire container while keeping the original aspect ratio.
-     * - `contain`：Stretch the video to fill the container.
+     * @brief Fill mode of the poster image. The available options are as follows:
+     * - `fixWidth`：Scales the image to fit the container's width while maintaining aspect ratio. Height is scaled proportionally, which may leave vertical blank space.
+     * - `fixHeight`：Scales the image to fit the container's height while maintaining aspect ratio. Width is scaled proportionally, which may leave horizontal blank space.
+     * - `cover`：Scales the image proportionally and crops overflow to fully cover the container without black borders.
+     * - `contain`：Scales the image to fully fit the container. May stretch non-proportionally to avoid black borders, potentially causing distortion.
      */
     fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
 }
@@ -3027,6 +3037,16 @@ declare namespace strategy {
          */
         Warn = "Warn"
     }
+    /** {zh}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
+    /** {en}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
     enum ErrorCode {
         /** {zh}
          * @brief 视频解析错误
@@ -4244,15 +4264,15 @@ declare namespace strategy {
          */
         isEndedShow?: boolean;
         /** {zh}
-         * @brief 是否播放后再隐藏封面图。
-         *   - `true`：播放后隐藏，未启播时一直显示封面图。
-         *   - `false`：在 `play` 事件触发后隐藏封面图。
+         * @brief 是否在播放后隐藏封面图。
+         *   - `true`：在播放器开始播放（即画面可见）后隐藏封面图，播放前始终显示，避免黑屏；
+         *   - `false`：在触发 `play` 事件时立即隐藏封面图，可能在画面显示前出现黑屏。
          * @default false
          */
         /** {en}
-         * @brief Whether to hide the cover image after `canplay` event.
-         * - `true`：hide the cover image after `canplay` event.
-         * - `false`：hide the cover image after `play` event.
+         * @brief Whether to hide the poster image after playback starts.
+         * - `true`：The poster image remains visible until video playback actually starts (i.e., video frames are rendered), preventing a black screen before playback.
+         * - `false`：The poster image is hidden immediately when the `play` event is triggered, which may cause a brief black screen before video appears.
          * @default false
          */
         hideCanplay?: boolean;
@@ -4266,18 +4286,18 @@ declare namespace strategy {
          */
         notHidden?: boolean;
         /** {zh}
-         * @brief 封面图填充方式。取值如下：
-         * - `fixWidth`：宽度方向填充，不会被拉伸压缩。
-         * - `fixHeight`：高度方向填充，不会被拉伸压缩。
-         * - `cover`：完全覆盖容器，多余部分会被裁剪。
-         * - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+         * @brief 封面图的填充方式，取值如下所示。
+         * - `fixWidth`：按宽度适配容器，高度等比缩放，图像不拉伸压缩；
+         * - `fixHeight`：按高度适配容器，宽度等比缩放，图像不拉伸压缩；
+         * - `cover`：等比缩放并裁剪，使封面图完整覆盖容器，不留黑边；
+         * - `contain`：等比缩放并拉伸，使封面图完整覆盖容器，不留黑边，可能失真。
          */
         /** {en}
-         * @brief Cover image fill mode.
-         * - `fixWidth`：Fill the width of the container and crop the height if necessary.
-         * - `fixHeight`：Fill the height of the container and crop the width if necessary.
-         * - `cover`：Fill the entire container while keeping the original aspect ratio.
-         * - `contain`：Stretch the video to fill the container.
+         * @brief Fill mode of the poster image. The available options are as follows:
+         * - `fixWidth`：Scales the image to fit the container's width while maintaining aspect ratio. Height is scaled proportionally, which may leave vertical blank space.
+         * - `fixHeight`：Scales the image to fit the container's height while maintaining aspect ratio. Width is scaled proportionally, which may leave horizontal blank space.
+         * - `cover`：Scales the image proportionally and crops overflow to fully cover the container without black borders.
+         * - `contain`：Scales the image to fully fit the container. May stretch non-proportionally to avoid black borders, potentially causing distortion.
          */
         fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
     }
@@ -4818,6 +4838,16 @@ declare namespace error {
          */
         Warn = "Warn"
     }
+    /** {zh}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
+    /** {en}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
     enum ErrorCode {
         /** {zh}
          * @brief 视频解析错误
@@ -5655,7 +5685,6 @@ interface LoggerConfig {
 }
 /** {zh}
  * 高级能力（策略）名称
- * @detail Options
  * @brief 策略名称
  */
 declare enum StrategyNames {
@@ -5682,7 +5711,6 @@ declare enum StrategyNames {
 }
 /** {zh}
  * 播放器预初始化配置
- * @detail Options
  */
 type StrategyInitOptions<T = Record<string, Partial<VeStrategyConfig> | boolean>> = {
     /**
@@ -5782,6 +5810,7 @@ interface ErrorFallbackStrategy {
      */
     /** {en}
      * @brief Type of fallback. Specifies whether fallback is automatic or manually controlled.
+     * @hidden
      */
     type?: FallbackKind;
     /** {zh}
@@ -5882,15 +5911,56 @@ declare class ProtocolManager {
     private _init;
     private _initSingleProtocol;
 }
+/** {zh}
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
 interface PrepareOptions {
+    /** {zh}
+     * @brief 应用 ID，登录[视频直播控制台 > SDK 管理](https://console.volcengine.com/live/main/sdk)查询。
+     */
+    /** {en}
+     * @brief The SDK application ID. You can access it by logging in to the BytePlus MediaLive console and navigating to [SDK Management](https://console.byteplus.com/live/main/sdk).
+     */
     appId: string;
+    /** {zh}
+     * @brief 用于识别单一用户的 ID，如不设置，会随机生成一个用户 ID 存在浏览器缓存中。
+     * @listtip
+     * 建议您使用与业务相关的用户 ID，以便在发生播放错误时快速定位排查问题。
+     */
+    /** {en}
+     * @brief The ID used to identify a single user. If not set, a random user ID will be generated and stored in the browser cache.
+     * @listtip
+     * We recommend using a business-related user ID to quickly locate and troubleshoot problems in the event of playback errors.
+     */
     userId?: string;
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @hidden
+     */
     deviceId?: string;
-    strategies: RtmAdaptiveBufferStrategy;
+    /** {zh}
+     * @brief 播放策略配置。
+     */
+    /** {en}
+     * @brief Playback Strategy Configuration.
+     */
+    strategies: {
+        /** {zh}
+         * @brief 是否开启 RTM buffer 自适应策略。
+         */
+        /** {en}
+         * @brief Enable RTM buffer adaptive strategy.
+         */
+        rtmAdaptiveBuffer?: boolean;
+    };
 }
-type RtmAdaptiveBufferStrategy = {
-    rtmAdaptiveBuffer?: boolean;
-};
 /** {zh}
  * @list option
  * @kind property
@@ -6019,6 +6089,7 @@ interface Fallback {
      */
     /** {en}
      * @brief Whether to enable protocol fallback.
+     * @hidden
      */
     enableFallback?: boolean;
     /** {zh}
@@ -6056,6 +6127,9 @@ interface FallbackStrategy {
     /** {zh}
      * @brief 拉流报错时降级策略
      */
+    /** {en}
+     * @brief The protocol downgrade strategy when a pull stream encounters an error.
+     */
     [FallbackKind.Error]?: ErrorFallbackStrategy;
     /**
      * @hidden
@@ -6186,13 +6260,25 @@ interface HlsAbr {
  */
 interface Drm {
     /** {zh}
-     * @brief FairPlay DRM 配置。
+     * @brief 配置 FairPlay DRM 参数，用于在 Apple 系统中播放加密内容。
      */
     /** {en}
-     * @brief FairPlay DRM configurations.
+     * @brief FairPlay DRM configuration, used for encrypted content playback on Apple devices.
      */
     fairplay?: FairplayDrm;
+    /** {zh}
+     * @brief Widevine DRM 配置。
+     */
+    /** {en}
+     * @brief Widevine DRM configurations.
+     */
     widevine?: WidevineDrm;
+    /** {zh}
+     * @brief 配置 PlayReady DRM 参数，用于支持在 Windows/Edge 等环境中播放加密内容。
+     */
+    /** {en}
+     * @brief PlayReady DRM configuration, used for encrypted content playback on Windows/Edge.
+     */
     playready?: PlayreadyDrm;
 }
 /** {zh}
@@ -6229,10 +6315,10 @@ interface FairplayDrm {
  */
 interface WidevineDrm {
     /** {zh}
-     * @hidden
+     * @brief 获取内容密钥许可证的请求地址。
      */
     /** {en}
-     * @hidden
+     * @brief URL used to acquire the DRM license.
      */
     // [x: string]: string | undefined;
     /** {zh}
@@ -6253,7 +6339,7 @@ interface WidevineDrm {
  */
 interface PlayreadyDrm {
     /**
-     * @hidden
+     * @brief 获取内容密钥许可证的请求地址。
      */
     // [x: string]: string | undefined;
     /** {zh}
@@ -6416,11 +6502,13 @@ interface Rtm {
      *  - 未指定 `fallbackUrl`：当前环境不支持播放 RTM 或 RTM 拉流建联失败时，根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
      * @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下，不会自动降级到 FLV 或者 HLS 地址。
      *          - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 协议拉流](https://www.volcengine.com/docs/6469/1548474)。
+     * @hidden
      */
     /** {en}
      * @brief The FLV or HLS addresses the player uses when failing to pull an RTM stream. This parameter takes effect when `enableFallback` is set to `true`.
      *  - If `fallbackUrl` is specified, in the event of a failed RTM pull-stream connection, the player will switch to the specified fallback address.
      *  - If `fallbackUrl` is not specified, in the event of a failed RTM pull-stream connection, the player will switch to the corresponding FLV or HLS address.
+     * @hidden
      */
     fallbackUrl?: string;
     /** {zh}
@@ -6515,17 +6603,20 @@ interface Rtm {
      */
     delayHint?: number;
     /** {zh}
-     * @brief RTM 建联后将在达到该阈值后检测数据接收是否异常，如果异常则播放器报错，单位毫秒。
+     * @brief RTM 拉流建联成功后延迟指定时间开始检测数据接收情况，单位为毫秒。取值范围为 [5000,10000]。若在此时间内未成功接收到数据，则触发播放错误
      * @default 5000
      */
     /** {en}
-     * @brief After RTM connection is established, the system will detect abnormal data reception once the threshold (in milliseconds) is reached. If anomalies occur, the player triggers an error.
+     * @brief After the RTM streaming connection is successfully established, the player delays for a specified period (in milliseconds) before checking if data is successfully received. If no data is received within this period, a playback error will be triggered.
      * @default 5000
      */
     checkStatsErrorDelay?: number;
     /** {zh}
      * @brief 是否打开 RTM SEI
      */
+    /** {en}
+     * @brief enable RTM SEI data.
+     */
     enableSei?: boolean;
 }
 /** {zh}
@@ -7932,6 +8023,16 @@ declare namespace live {
          */
         Warn = "Warn"
     }
+    /** {zh}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
+    /** {en}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
     enum ErrorCode {
         /** {zh}
          * @brief 视频解析错误
@@ -9149,15 +9250,15 @@ declare namespace live {
          */
         isEndedShow?: boolean;
         /** {zh}
-         * @brief 是否播放后再隐藏封面图。
-         *   - `true`：播放后隐藏，未启播时一直显示封面图。
-         *   - `false`：在 `play` 事件触发后隐藏封面图。
+         * @brief 是否在播放后隐藏封面图。
+         *   - `true`：在播放器开始播放（即画面可见）后隐藏封面图，播放前始终显示，避免黑屏；
+         *   - `false`：在触发 `play` 事件时立即隐藏封面图，可能在画面显示前出现黑屏。
          * @default false
          */
         /** {en}
-         * @brief Whether to hide the cover image after `canplay` event.
-         * - `true`：hide the cover image after `canplay` event.
-         * - `false`：hide the cover image after `play` event.
+         * @brief Whether to hide the poster image after playback starts.
+         * - `true`：The poster image remains visible until video playback actually starts (i.e., video frames are rendered), preventing a black screen before playback.
+         * - `false`：The poster image is hidden immediately when the `play` event is triggered, which may cause a brief black screen before video appears.
          * @default false
          */
         hideCanplay?: boolean;
@@ -9171,18 +9272,18 @@ declare namespace live {
          */
         notHidden?: boolean;
         /** {zh}
-         * @brief 封面图填充方式。取值如下：
-         * - `fixWidth`：宽度方向填充，不会被拉伸压缩。
-         * - `fixHeight`：高度方向填充，不会被拉伸压缩。
-         * - `cover`：完全覆盖容器，多余部分会被裁剪。
-         * - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+         * @brief 封面图的填充方式，取值如下所示。
+         * - `fixWidth`：按宽度适配容器，高度等比缩放，图像不拉伸压缩；
+         * - `fixHeight`：按高度适配容器，宽度等比缩放，图像不拉伸压缩；
+         * - `cover`：等比缩放并裁剪，使封面图完整覆盖容器，不留黑边；
+         * - `contain`：等比缩放并拉伸，使封面图完整覆盖容器，不留黑边，可能失真。
          */
         /** {en}
-         * @brief Cover image fill mode.
-         * - `fixWidth`：Fill the width of the container and crop the height if necessary.
-         * - `fixHeight`：Fill the height of the container and crop the width if necessary.
-         * - `cover`：Fill the entire container while keeping the original aspect ratio.
-         * - `contain`：Stretch the video to fill the container.
+         * @brief Fill mode of the poster image. The available options are as follows:
+         * - `fixWidth`：Scales the image to fit the container's width while maintaining aspect ratio. Height is scaled proportionally, which may leave vertical blank space.
+         * - `fixHeight`：Scales the image to fit the container's height while maintaining aspect ratio. Width is scaled proportionally, which may leave horizontal blank space.
+         * - `cover`：Scales the image proportionally and crops overflow to fully cover the container without black borders.
+         * - `contain`：Scales the image to fully fit the container. May stretch non-proportionally to avoid black borders, potentially causing distortion.
          */
         fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
     }
@@ -10462,7 +10563,6 @@ declare namespace live {
     }
     /** {zh}
      * 高级能力（策略）名称
-     * @detail Options
      * @brief 策略名称
      */
     enum StrategyNames {
@@ -10489,7 +10589,6 @@ declare namespace live {
     }
     /** {zh}
      * 播放器预初始化配置
-     * @detail Options
      */
     type StrategyInitOptions<T = Record<string, Partial<VeStrategyConfig> | boolean>> = {
         /**
@@ -10615,6 +10714,7 @@ declare namespace live {
          */
         /** {en}
          * @brief Type of fallback. Specifies whether fallback is automatic or manually controlled.
+         * @hidden
          */
         type?: FallbackKind;
         /** {zh}
@@ -10715,15 +10815,56 @@ declare namespace live {
         private _init;
         private _initSingleProtocol;
     }
+    /** {zh}
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
     interface PrepareOptions {
+        /** {zh}
+         * @brief 应用 ID，登录[视频直播控制台 > SDK 管理](https://console.volcengine.com/live/main/sdk)查询。
+         */
+        /** {en}
+         * @brief The SDK application ID. You can access it by logging in to the BytePlus MediaLive console and navigating to [SDK Management](https://console.byteplus.com/live/main/sdk).
+         */
         appId: string;
+        /** {zh}
+         * @brief 用于识别单一用户的 ID，如不设置，会随机生成一个用户 ID 存在浏览器缓存中。
+         * @listtip
+         * 建议您使用与业务相关的用户 ID，以便在发生播放错误时快速定位排查问题。
+         */
+        /** {en}
+         * @brief The ID used to identify a single user. If not set, a random user ID will be generated and stored in the browser cache.
+         * @listtip
+         * We recommend using a business-related user ID to quickly locate and troubleshoot problems in the event of playback errors.
+         */
         userId?: string;
+        /** {zh}
+         * @hidden
+         */
+        /** {en}
+         * @hidden
+         */
         deviceId?: string;
-        strategies: RtmAdaptiveBufferStrategy;
+        /** {zh}
+         * @brief 播放策略配置。
+         */
+        /** {en}
+         * @brief Playback Strategy Configuration.
+         */
+        strategies: {
+            /** {zh}
+             * @brief 是否开启 RTM buffer 自适应策略。
+             */
+            /** {en}
+             * @brief Enable RTM buffer adaptive strategy.
+             */
+            rtmAdaptiveBuffer?: boolean;
+        };
     }
-    type RtmAdaptiveBufferStrategy = {
-        rtmAdaptiveBuffer?: boolean;
-    };
     /** {zh}
      * @list option
      * @kind property
@@ -10852,6 +10993,7 @@ declare namespace live {
          */
         /** {en}
          * @brief Whether to enable protocol fallback.
+         * @hidden
          */
         enableFallback?: boolean;
         /** {zh}
@@ -10889,6 +11031,9 @@ declare namespace live {
         /** {zh}
          * @brief 拉流报错时降级策略
          */
+        /** {en}
+         * @brief The protocol downgrade strategy when a pull stream encounters an error.
+         */
         [FallbackKind.Error]?: ErrorFallbackStrategy;
         /**
          * @hidden
@@ -11019,13 +11164,25 @@ declare namespace live {
      */
     interface Drm {
         /** {zh}
-         * @brief FairPlay DRM 配置。
+         * @brief 配置 FairPlay DRM 参数，用于在 Apple 系统中播放加密内容。
          */
         /** {en}
-         * @brief FairPlay DRM configurations.
+         * @brief FairPlay DRM configuration, used for encrypted content playback on Apple devices.
          */
         fairplay?: FairplayDrm;
+        /** {zh}
+         * @brief Widevine DRM 配置。
+         */
+        /** {en}
+         * @brief Widevine DRM configurations.
+         */
         widevine?: WidevineDrm;
+        /** {zh}
+         * @brief 配置 PlayReady DRM 参数，用于支持在 Windows/Edge 等环境中播放加密内容。
+         */
+        /** {en}
+         * @brief PlayReady DRM configuration, used for encrypted content playback on Windows/Edge.
+         */
         playready?: PlayreadyDrm;
     }
     /** {zh}
@@ -11062,10 +11219,10 @@ declare namespace live {
      */
     interface WidevineDrm {
         /** {zh}
-         * @hidden
+         * @brief 获取内容密钥许可证的请求地址。
          */
         /** {en}
-         * @hidden
+         * @brief URL used to acquire the DRM license.
          */
         // [x: string]: string | undefined;
         /** {zh}
@@ -11086,7 +11243,7 @@ declare namespace live {
      */
     interface PlayreadyDrm {
         /**
-         * @hidden
+         * @brief 获取内容密钥许可证的请求地址。
          */
         // [x: string]: string | undefined;
         /** {zh}
@@ -11249,11 +11406,13 @@ declare namespace live {
          *  - 未指定 `fallbackUrl`：当前环境不支持播放 RTM 或 RTM 拉流建联失败时，根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
          * @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下，不会自动降级到 FLV 或者 HLS 地址。
          *          - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 协议拉流](https://www.volcengine.com/docs/6469/1548474)。
+         * @hidden
          */
         /** {en}
          * @brief The FLV or HLS addresses the player uses when failing to pull an RTM stream. This parameter takes effect when `enableFallback` is set to `true`.
          *  - If `fallbackUrl` is specified, in the event of a failed RTM pull-stream connection, the player will switch to the specified fallback address.
          *  - If `fallbackUrl` is not specified, in the event of a failed RTM pull-stream connection, the player will switch to the corresponding FLV or HLS address.
+         * @hidden
          */
         fallbackUrl?: string;
         /** {zh}
@@ -11348,17 +11507,20 @@ declare namespace live {
          */
         delayHint?: number;
         /** {zh}
-         * @brief RTM 建联后将在达到该阈值后检测数据接收是否异常，如果异常则播放器报错，单位毫秒。
+         * @brief RTM 拉流建联成功后延迟指定时间开始检测数据接收情况，单位为毫秒。取值范围为 [5000,10000]。若在此时间内未成功接收到数据，则触发播放错误
          * @default 5000
          */
         /** {en}
-         * @brief After RTM connection is established, the system will detect abnormal data reception once the threshold (in milliseconds) is reached. If anomalies occur, the player triggers an error.
+         * @brief After the RTM streaming connection is successfully established, the player delays for a specified period (in milliseconds) before checking if data is successfully received. If no data is received within this period, a playback error will be triggered.
          * @default 5000
          */
         checkStatsErrorDelay?: number;
         /** {zh}
          * @brief 是否打开 RTM SEI
          */
+        /** {en}
+         * @brief enable RTM SEI data.
+         */
         enableSei?: boolean;
     }
     /** {zh}
@@ -12215,6 +12377,54 @@ declare namespace live {
      * @returns The player instance.
      */
     function createLivePlayer(options?: LiveVePlayerOptions): Promise<VePlayerLive>;
+    /** {zh}
+     * @detail api
+     * @brief 初始化播放器策略。
+     * @example
+     * ```js
+     * live.prepare({
+     *  appId: '***',
+     *  userId: '***',
+     *  strategies: {
+     *   rtmAdaptiveBuffer: true,
+     *  },
+     * }).then(function () {
+     *  VePlayer.createLivePlayer({
+     *   height: '300px',
+     *   url: 'https://pulldomain.com/appname/streamname.sdp',
+     *   logger: {
+     *     userId: '***',
+     *     appId: '***',
+     *   },
+     *  });
+     * });
+     * ```
+     * @param options 配置策略参数。
+     */
+    /** {en}
+     * @detail api
+     * @brief Initialize player strategy.
+     * @example
+     * ```js
+     * live.prepare({
+     *  appId: '***',
+     *  userId: '***',
+     *  strategies: {
+     *   rtmAdaptiveBuffer: true,
+     *  },
+     * }).then(function () {
+     *  VePlayer.createLivePlayer({
+     *   height: '300px',
+     *   url: 'https://pulldomain.com/appname/streamname.sdp',
+     *   logger: {
+     *     userId: '***',
+     *     appId: '***',
+     *   },
+     *  });
+     * });
+     * ```
+     * @param options Configure strategy parameters.
+     */
     function prepare(options: PrepareOptions): Promise<VeStrategyManager | undefined>;
     /** {zh}
      * @detail events
@@ -12560,6 +12770,12 @@ declare namespace live {
          * @brief Event of failing to switch Adaptive Bitrate (ABR) live stream.
          */
         ABR_SWITCH_FAILED = "abrSwitchFailed",
+        /** {en}
+         * @hidden
+         */
+        /** {zh}
+         * @hidden
+         */
         RTM_NETWORK = "rtmNetwork"
     }
     /** {zh}
@@ -13170,6 +13386,12 @@ declare namespace live {
              */
             url: string;
         }) => void;
+        /** {en}
+         * @hidden
+         */
+        /** {zh}
+         * @hidden
+         */
         [LiveEvents.RTM_NETWORK]: (data: any) => void;
     }
     const Events: {