@byteplus/react-native-live-pull 1.5.1-rc.2 → 1.5.1-rc.3

package/lib/typescript/codegen/pack/keytype.d.ts

@@ -1,36 +1,60 @@
 import * as $p_a from '../android/index';
 import * as $p_i from '../ios/index';
-
+/** {zh}
+ * @detail keytype
+ * @brief 视频顺时针旋转角度。
+ *
+ */
 export declare enum VeLivePlayerRotation {
-    
+    /** {zh}
+     * @brief 关闭旋转。
+     *
+     */
     /** {en}
      * @brief No rotation.
      *
      */
     VeLivePlayerRotation0 = 0,
-    
+    /** {zh}
+     * @brief 顺时针旋转 90 度。
+     *
+     */
     /** {en}
      * @brief Rotate 90 degrees clockwise.
      *
      */
     VeLivePlayerRotation90 = 1,
-    
+    /** {zh}
+     * @brief 顺时针旋转 180 度。
+     *
+     */
     /** {en}
      * @brief Rotate 180 degrees clockwise.
      *
      */
     VeLivePlayerRotation180 = 2,
-    
+    /** {zh}
+     * @brief 顺时针旋转 270 度。
+     *
+     */
     /** {en}
      * @brief Rotate 270 degrees clockwise.
      *
      */
     VeLivePlayerRotation270 = 3
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 播放地址相关配置。
+ */
 export declare class VeLivePlayerStreamData {
     protected _instance: any;
-    
+    /** {zh}
+     * @brief 是否打开 ABR 平滑切档功能，默认为 false。<br>
+     *     - true：开启；
+     *     - false：关闭。
+     *
+     */
     /** {en}
      * @brief Whether to enable adaptive bitrate (ABR). The default value is `false`. <br>
      *      - true: Enable;
@@ -39,7 +63,12 @@ export declare class VeLivePlayerStreamData {
      */
     get enableABR(): boolean;
     set enableABR(value: boolean);
-    
+    /** {zh}
+     * @brief 是否打开主备切换，默认为 false。<br>
+     *     - true：开启；
+     *     - false：关闭。
+     *
+     */
     /** {en}
      * @brief Whether to enable switching between primary and backup streams. The default value is `false`. <br>
      *      - true: Enable;
@@ -48,21 +77,30 @@ export declare class VeLivePlayerStreamData {
      */
     get enableMainBackupSwitch(): boolean;
     set enableMainBackupSwitch(value: boolean);
-    
+    /** {zh}
+     * @brief 播放器的默认清晰度档位，默认使用原始流清晰度。详情请参见 [VeLivePlayerResolution](#VeLivePlayerResolution)。
+     *
+     */
     /** {en}
      * @brief The default resolution. The default value is `VeLivePlayerResolutionOrigin`, which indicates the original resolution. See [VeLivePlayerResolution](#VeLivePlayerResolution) for details.
      *
      */
     get defaultResolution(): VeLivePlayerResolution;
     set defaultResolution(value: VeLivePlayerResolution);
-    
+    /** {zh}
+     * @brief 播放器的默认播放格式，默认值为 FLV。详情请参见 [VeLivePlayerFormat](#VeLivePlayerFormat)。
+     *
+     */
     /** {en}
      * @brief The default video format. The default value is `VeLivePlayerFormatFLV`. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
      *
      */
     get defaultFormat(): VeLivePlayerFormat;
     set defaultFormat(value: VeLivePlayerFormat);
-    
+    /** {zh}
+     * @brief 播放器的默认播放传输层协议，默认值为 TCP。详情请参见 [VeLivePlayerProtocol](#VeLivePlayerProtocol)。
+     *
+     */
     /** {en}
      * @brief The default transmission protocol. The default value is `VeLivePlayerProtocolTCP`. See [VeLivePlayerProtocol](#VeLivePlayerProtocol) for details.
      *
@@ -72,79 +110,129 @@ export declare class VeLivePlayerStreamData {
     protected __init(...args: any[]): void;
     protected __new_instance(...args: any[]): any;
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 直播播放器状态。
+ *
+ */
 export declare enum VeLivePlayerStatus {
-    
+    /** {zh}
+     * @brief 播放器准备完成，等待渲染。
+     *
+     */
     /** {en}
      * @brief The player finishes preparing and is waiting to render the video.
      *
      */
     VeLivePlayerStatusPrepared = 0,
-    
+    /** {zh}
+     * @brief 正在播放，即首帧渲染完成且播放器未发生错误。
+     *
+     */
     /** {en}
      * @brief Playback is currently in progress, meaning that the first frame has been rendered and no errors have occurred to the player.
      *
      */
     VeLivePlayerStatusPlaying = 1,
-    
+    /** {zh}
+     * @brief 暂停播放状态。
+     *
+     */
     /** {en}
      * @brief The playback is paused.
      *
      */
     VeLivePlayerStatusPaused = 2,
-    
+    /** {zh}
+     * @brief 停止播放状态。
+     *
+     */
     /** {en}
      * @brief The playback is stopped.
      *
      */
     VeLivePlayerStatusStopped = 3,
-    
+    /** {zh}
+     * @brief 播放器发生错误。
+     *
+     */
     /** {en}
      * @brief An error has occurred to the player.
      *
      */
     VeLivePlayerStatusError = 4
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 直播播放器清晰度档位变化原因。
+ *
+ */
 export declare enum VeLivePlayerResolutionSwitchReason {
-    
+    /** {zh}
+     * @brief ABR 自动切档。
+     *
+     */
     /** {en}
      * @brief The resolution is switched automatically through the adaptive bitrate (ABR) feature.
      *
      */
     VeLivePlayerResolutionSwitchByAuto = 0,
-    
+    /** {zh}
+     * @brief 调用 [switchResolution](188111#VeLivePlayer-switchresolution) 手动切换档位导致的分辨率变化。
+     *
+     */
     /** {en}
      * @brief The resolution is changed after switchResolution{@link #VeLivePlayer#switchResolution} is called.
      *
      */
     VeLivePlayerResolutionSwitchByManual = 1
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 直播播放器画面的填充模式。
+ *
+ */
 export declare enum VeLivePlayerFillMode {
-    
+    /** {zh}
+     * @brief 显示完整的视频帧。视频帧等比缩放，直至视频帧恰好在画布上全部显示。如果视频帧长宽比例与画布不同，视窗上未被视频帧填满区域将填充为黑色。
+     *
+     */
     /** {en}
      * @brief Display the full video. The video is uniformly scaled until one dimension of the video hits the boundary of the screen. Any remaining space on the screen will be filled with black.
      *
      */
     VeLivePlayerFillModeAspectFit = 0,
-    
+    /** {zh}
+     * @brief 视频帧自适应画布。视频帧非等比缩放，直至填满画布。在此过程中，视频帧的长宽比例可能会发生变化。
+     *
+     */
     /** {en}
      * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
      *
      */
     VeLivePlayerFillModeFullFill = 1,
-    
+    /** {zh}
+     * @brief 视频填满画布。视频帧等比缩放，直至填满画布，超出屏幕的部分将被裁剪，画面可能不完整。
+     *
+     */
     /** {en}
      * @brief Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
      *
      */
     VeLivePlayerFillModeAspectFill = 2
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 播放周期性统计信息。
+ */
 export declare class VeLivePlayerStatistics {
     protected _instance: any;
-    
+    /** {zh}
+     * @brief 是否使用硬件解码。<br>
+     *     - true：硬解；
+     *     - false：非硬解。
+     *
+     */
     /** {en}
      * @brief Whether hardware decoding is used. <br>
      *      - true: Hardware decoding is used;
@@ -152,117 +240,181 @@ export declare class VeLivePlayerStatistics {
      *
      */
     get isHardwareDecode(): boolean;
-    
+    /** {zh}
+     * @brief 当前直播的播放地址。
+     *
+     */
     /** {en}
      * @brief The current pull stream address.
      *
      */
     get url(): string;
-    
+    /** {zh}
+     * @brief 视频的编码类型。
+     *
+     */
     /** {en}
      * @brief The encoding format of the video.
      *
      */
     get videoCodec(): string;
-    
+    /** {zh}
+     * @brief 从当前视频开始播放起，累计的卡顿时长，单位为 ms。
+     *
+     */
     /** {en}
      * @brief The cumulative duration of stutters that occurred since the beginning of playback, in milliseconds.
      *
      */
     get stallTimeMs(): number;
-    
+    /** {zh}
+     * @brief 带宽预测 ，单位为 kbps
+     *
+     */
     /** {en}
      * @brief Bandwidth estimation, unit is kbps.
      *
      */
     get bandwidthEstimation(): number;
-    
+    /** {zh}
+     * @brief 当前播放延时，单位为 ms。仅在使用了火山引擎视频直播推流 SDK 时，支持统计播放延时。
+     *
+     */
     /** {en}
      * @brief The current playback latency, in milliseconds. The latency data is available only if you use the BytePlus MediaLive Broadcast SDK to push the live stream.
      *
      */
     get delayMs(): number;
-    
+    /** {zh}
+     * @brief 当前播放视频的宽度，单位为 px。
+     *
+     */
     /** {en}
      * @brief The width of the video, in pixels.
      *
      */
     get width(): number;
-    
+    /** {zh}
+     * @brief 当前播放视频的高度，单位为 px。
+     *
+     */
     /** {en}
      * @brief The height of the video, in pixels.
      *
      */
     get height(): number;
-    
+    /** {zh}
+     * @brief 当前播放视频的帧率，单位为 fps。
+     *
+     */
     /** {en}
      * @brief The frame rate of the video, in fps.
      *
      */
     get fps(): number;
-    
+    /** {zh}
+     * @brief 实时下载的码率，单位为 kbps。
+     *
+     */
     /** {en}
      * @brief The downlink bitrate, in Kbps.
      *
      */
     get bitrate(): number;
-    
+    /** {zh}
+     * @brief 视频播放的缓冲区 buffer 大小，单位为 ms。
+     *
+     */
     /** {en}
      * @brief The video buffer, in milliseconds.
      *
      */
     get videoBufferMs(): number;
-    
+    /** {zh}
+     * @brief 音频播放的缓冲区 buffer 大小，单位为 ms。
+     *
+     */
     /** {en}
      * @brief The audio buffer, in milliseconds.
      *
      */
     get audioBufferMs(): number;
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 视频数据封装格式。
+ *
+ */
 export declare enum VeLivePlayerVideoBufferType {
-    
+    /** {zh}
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @brief Unknown format.
      *
      */
     VeLivePlayerVideoBufferTypeUnknown = 0,
-    
+    /** {zh}
+     * @platform android
+     * @brief ByteBuffer 格式。
+     *
+     */
     /** {en}
      * @platform android
      * @brief ByteBuffer.
      *
      */
     VeLivePlayerVideoBufferTypeByteBuffer = 1,
-    
+    /** {zh}
+     * @platform android
+     * @brief ByteArray 格式。
+     *
+     */
     /** {en}
      * @platform android
      * @brief ByteArray.
      *
      */
     VeLivePlayerVideoBufferTypeByteArray = 2,
-    
+    /** {zh}
+     * @platform android
+     * @brief 纹理格式。
+     *
+     */
     /** {en}
      * @platform android
      * @brief Texture.
      *
      */
     VeLivePlayerVideoBufferTypeTexture = 3,
-    
+    /** {zh}
+     * @platform ios
+     * @brief CVPixelBufferRef 格式。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief CVPixelBufferRef.
      *
      */
     VeLivePlayerVideoBufferTypePixelBuffer = 4,
-    
+    /** {zh}
+     * @platform ios
+     * @brief CVSampleBufferRef 格式。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief CVSampleBufferRef.
      *
      */
     VeLivePlayerVideoBufferTypeSampleBuffer = 5,
-    
+    /** {zh}
+     * @platform ios
+     * @brief NSData 格式。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief NSData.
@@ -270,43 +422,70 @@ export declare enum VeLivePlayerVideoBufferType {
      */
     VeLivePlayerVideoBufferTypeNSData = 6
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 视频帧像素格式。
+ *
+ */
 export declare enum VeLivePlayerPixelFormat {
-    
+    /** {zh}
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @brief Unknown format.
      *
      */
     VeLivePlayerPixelFormatUnknown = 0,
-    
+    /** {zh}
+     * @platform android
+     * @brief RGBA8888 格式。
+     *
+     */
     /** {en}
      * @platform android
      * @brief RGBA8888.
      *
      */
     VeLivePlayerPixelFormatRGBA32 = 1,
-    
+    /** {zh}
+     * @platform android
+     * @brief 纹理格式。
+     *
+     */
     /** {en}
      * @platform android
      * @brief Texture.
      *
      */
     VeLivePlayerPixelFormatTexture = 2,
-    
+    /** {zh}
+     * @platform ios
+     * @brief NV12 格式。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief NV12.
      *
      */
     VeLivePlayerPixelFormatNV12 = 3,
-    
+    /** {zh}
+     * @platform ios
+     * @brief YUVI420 格式。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief YUVI420.
      *
      */
     VeLivePlayerPixelFormatI420 = 4,
-    
+    /** {zh}
+     * @platform ios
+     * @brief BGRA 格式。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief BGRA.
@@ -314,37 +493,61 @@ export declare enum VeLivePlayerPixelFormat {
      */
     VeLivePlayerPixelFormatBGRA32 = 5
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 音频数据封装格式。
+ *
+ */
 export declare enum VeLivePlayerAudioBufferType {
-    
+    /** {zh}
+     * @platform android
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @platform android
      * @brief Unknown format.
      *
      */
     VeLivePlayerAudioBufferTypeUnknown = 0,
-    
+    /** {zh}
+     * @platform android
+     * @brief ByteArray 格式。
+     *
+     */
     /** {en}
      * @platform android
      * @brief ByteArray.
      *
      */
     VeLivePlayerAudioBufferTypeByteArray = 1,
-    
+    /** {zh}
+     * @platform ios
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief Unknown format.
      *
      */
     VeLivePlayerAudioBufferUnknown = 2,
-    
+    /** {zh}
+     * @platform ios
+     * @brief CVSampleBufferRef 格式，音频数据以样本缓冲区 sample buffer 的形式进行处理和渲染。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief CVSampleBufferRef. The audio data is processed and rendered as sample buffers.
      *
      */
     VeLivePlayerAudioBufferTypeSampleBuffer = 3,
-    
+    /** {zh}
+     * @platform ios
+     * @brief NSData 格式，音频数据以 NSData 对象的形式进行处理和渲染。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief NSData. The audio data is processed and rendered as NSData objects.
@@ -352,53 +555,84 @@ export declare enum VeLivePlayerAudioBufferType {
      */
     VeLivePlayerAudioBufferTypeNSData = 4
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 直播播放器的清晰度档位。
+ *
+ */
 export declare enum VeLivePlayerResolution {
-    
+    /** {zh}
+     * @brief 原始流。
+     *
+     */
     /** {en}
      * @brief Original.
      *
      */
     VeLivePlayerResolutionOrigin = 0,
-    
+    /** {zh}
+     * @brief UHD 超高清。
+     *
+     */
     /** {en}
      * @brief Ultra high definition (UHD).
      *
      */
     VeLivePlayerResolutionUHD = 1,
-    
+    /** {zh}
+     * @brief HD 高清。
+     *
+     */
     /** {en}
      * @brief High definition (HD).
      *
      */
     VeLivePlayerResolutionHD = 2,
-    
+    /** {zh}
+     * @brief SD 标清。
+     *
+     */
     /** {en}
      * @brief Standard definition (SD).
      *
      */
     VeLivePlayerResolutionSD = 3,
-    
+    /** {zh}
+     * @brief LD 低清。
+     *
+     */
     /** {en}
      * @brief Low definition (LD).
      *
      */
     VeLivePlayerResolutionLD = 4,
-    
+    /** {zh}
+     * @brief AO 纯音频流。
+     * @hidden (Android)
+     *
+     */
     /** {en}
      * @brief AO pure audio stream.
      * @hidden (Android)
      *
      */
     VeLivePlayerResolutionAO = 5,
-    
+    /** {zh}
+     * @platform ios
+     * @brief FHD 全高清
+     *
+     */
     /** {en}
      * @platform ios
      * @brief Full High definition (FHD).
      *
      */
     VeLivePlayerResolutionFHD = 6,
-    
+    /** {zh}
+     * @platform ios
+     * @brief 自动档位。
+     *
+     */
     /** {en}
      * @platform ios
      * @brief Auto.
@@ -406,10 +640,18 @@ export declare enum VeLivePlayerResolution {
      */
     VeLivePlayerResolutionAUTO = 8
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 播放器初始化相关配置。
+ */
 export declare class VeLivePlayerConfiguration {
     protected _instance: any;
-    
+    /** {zh}
+     * @brief 是否开启字符串 SEI 消息的解析，默认值为 false。<br/>
+     *        - true：开启；
+     *        - false：关闭。
+     *
+     */
     /** {en}
      * @brief Whether to enable the parsing of string SEI messages. The default value is `false`.<br/>
      *        - true: Enable;
@@ -418,7 +660,13 @@ export declare class VeLivePlayerConfiguration {
      */
     get enableSei(): boolean;
     set enableSei(value: boolean);
-    
+    /** {zh}
+     * @brief 是否开启二进制 SEI 消息的解析，默认值为 false。<br/>
+     *        - true：开启；
+     *        - false：关闭。
+     * @notes 二进制 SEI 开启后，字符串 SEI 的回调将不再发送。
+     *
+     */
     /** {en}
      * @brief Whether to enable the parsing of binary SEI messages. The default value is `false`. <br>
      *       - true: Enable;
@@ -428,7 +676,12 @@ export declare class VeLivePlayerConfiguration {
      */
     get enableBinarySei(): boolean;
     set enableBinarySei(value: boolean);
-    
+    /** {zh}
+     * @brief 是否开启硬件解码功能，默认值为 true。开启硬件解码后，如果出现硬件解码启动失败或硬件解码失败的情况，播放器内部会自动切换为软解。<br>
+     *      - true：开启；
+     *      - false：关闭。
+     *
+     */
     /** {en}
      * @brief Whether to turn on hardware decoding. The default value is `true`. When hardware decoding is enabled, if the player fails to start hardware decoding or if hardware decoding fails, the player automatically switches to software decoding. <br>
      *       - true: Enable;
@@ -437,14 +690,22 @@ export declare class VeLivePlayerConfiguration {
      */
     get enableHardwareDecode(): boolean;
     set enableHardwareDecode(value: boolean);
-    
+    /** {zh}
+     * @brief 网络超时时间，单位为 ms，默认值为 5000。播放器发起网络请求，如果超过了该时间仍未收到服务器响应，则认为网络请求失败。
+     *
+     */
     /** {en}
      * @brief Network timeout duration, in milliseconds. The default value is `5000`. Once the player sends a network request, if the player does not receive a response from the server after the timeout duration, the network request is considered failed.
      *
      */
     get networkTimeoutMs(): number;
     set networkTimeoutMs(value: number);
-    
+    /** {zh}
+     * @brief 重试时间间隔，单位为 ms，默认值为 5000，仅在无备流时生效。<br>
+     *     - 在无备流的场景下，若遇到网络异常等问题导致播放中断，播放器会立即进行重试，前三次重试为立即执行，第四次及之后的重试将按照设置的重试时间间隔执行；
+     *     - 在有备流的场景下，重试时间间隔将不生效，所有重试均会立即执行。
+     *
+     */
     /** {en}
      * @brief The retry time interval, in milliseconds. The default value is `5000`. This variable takes effect only when there is no backup stream.<br>
      *     - In the absence of a backup stream, if playback is interrupted due to network issues or other anomalies, the player will immediately initiate a retry. The player will make the first three retries immediately without any waiting time. However, for subsequent retries starting from the fourth attempt, the player will wait for the specified time interval between each attempt.
@@ -453,7 +714,12 @@ export declare class VeLivePlayerConfiguration {
      */
     get retryIntervalTimeMs(): number;
     set retryIntervalTimeMs(value: number);
-    
+    /** {zh}
+     * @brief 在网络连接错误的情况下，播放器最大重试次数，默认值为 5。如果取值为 0，表示关闭播放器内部重试。<br>
+     *     - 在无备流的场景下，每次重试，会消耗一次重试次数；
+     *     - 在有备流的场景下，每次主备流切换，会消耗一次重试次数。
+     *
+     */
     /** {en}
      * @brief In the case of a network connection error, the maximum number of automatic retries of the player. The default value is `5`. If the value is `0`, the player will not automatically retry.<br>
      *     - In the absence of a backup stream, each retry will count as one retry attempt.
@@ -462,7 +728,12 @@ export declare class VeLivePlayerConfiguration {
      */
     get retryMaxCount(): number;
     set retryMaxCount(value: number);
-    
+    /** {zh}
+     * @brief 是否开启本地 DNS 预解析，默认值为 false。开启本地 DNS 预解析可以缩短启播时间。如果本地 DNS 预解析出现异常，可能会影响播放器的正常使用。<br>
+     *      - true：开启；
+     *      - false：关闭。
+     *
+     */
     /** {en}
      * @brief Whether to enable local DNS prefetch. The default value is `false`. Enabling local DNS prefetch can reduce the time required to start playback. If an abnormality occurs with local DNS prefetch, the player may not function properly. <br>
      *       - true: Enable;
@@ -471,7 +742,12 @@ export declare class VeLivePlayerConfiguration {
      */
     get enableLiveDNS(): boolean;
     set enableLiveDNS(value: boolean);
-    
+    /** {zh}
+     * @brief 是否开启播放信息周期性回调。默认值为 false。周期性回调参数详细说明请参见 [VeLivePlayerStatistics](188115#VeLivePlayerStatistics) 。当 `enableStatisticsCallback` 为 `true`，且 [statisticsCallbackInterval](188115#VeLivePlayerConfiguration-statisticscallbackinterval) 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。<br>
+     *        - true：开启；
+     *        - false：关闭。
+     *
+     */
     /** {en}
      * @brief Whether to enable periodic callbacks for playback information. The default value is `false`. Refer to [VeLivePlayerStatistics](#VeLivePlayerStatistics) for more information on callback statistics. If `enableStatisticsCallback` is `true` and [statisticsCallbackInterval](#VeLivePlayerConfiguration-statisticscallbackinterval) is greater than `0`, the player will periodically report the player status information after the specified time interval.<br/>
      *        - true: Enable;
@@ -480,7 +756,10 @@ export declare class VeLivePlayerConfiguration {
      */
     get enableStatisticsCallback(): boolean;
     set enableStatisticsCallback(value: boolean);
-    
+    /** {zh}
+     * @brief 播放信息周期性回调的时间间隔，单位为 s，默认值为 5。当 [enableStatisticsCallback](188115#VeLivePlayerConfiguration-enablestatisticscallback) 为 `true`，且 `statisticsCallbackInterval` 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。
+     *
+     */
     /** {en}
      * @brief The time interval for periodic callbacks that provide playback information, in seconds. The default value is `5`. If [enableStatisticsCallback](#VeLivePlayerConfiguration-enablestatisticscallback) is `true` and `statisticsCallbackInterval` is greater than `0`, the player will periodically report the player status information after the specified time interval.
      *
@@ -490,27 +769,44 @@ export declare class VeLivePlayerConfiguration {
     protected __init(...args: any[]): void;
     protected __new_instance(...args: any[]): any;
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 直播播放格式。
+ *
+ */
 export declare enum VeLivePlayerFormat {
-    
+    /** {zh}
+     * @brief FLV 格式。
+     *
+     */
     /** {en}
      * @brief FLV.
      *
      */
     VeLivePlayerFormatFLV = 0,
-    
+    /** {zh}
+     * @brief HLS 格式。
+     *
+     */
     /** {en}
      * @brief HLS.
      *
      */
     VeLivePlayerFormatHLS = 1,
-    
+    /** {zh}
+     * @brief RTM 格式。
+     *
+     */
     /** {en}
      * @brief Real Time Media (RTM).
      *
      */
     VeLivePlayerFormatRTM = 2,
-    
+    /** {zh}
+     * @platform android
+     * @brief CMAF 格式
+     *
+     */
     /** {en}
      * @platform android
      * @brief CMAF format
@@ -518,88 +814,137 @@ export declare enum VeLivePlayerFormat {
      */
     VeLivePlayerFormatCMAF = 3
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 直播播放传输协议。
+ *
+ */
 export declare enum VeLivePlayerProtocol {
-    
+    /** {zh}
+     * @brief TCP 协议。
+     *
+     */
     /** {en}
      * @brief TCP.
      *
      */
     VeLivePlayerProtocolTCP = 0,
-    
+    /** {zh}
+     * @brief QUIC 协议。
+     *
+     */
     /** {en}
      * @brief QUIC.
      *
      */
     VeLivePlayerProtocolQUIC = 1,
-    
+    /** {zh}
+     * @brief TLS 协议。
+     *
+     */
     /** {en}
      * @brief TLS.
      *
      */
     VeLivePlayerProtocolTLS = 2,
-    
+    /** {zh}
+     * @brief HTTP2.0 协议。
+     *
+     */
     /** {en}
      * @brief HTTP2.0 protocol
      *
      */
     VeLivePlayerProtocolHTTP2 = 3
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 视频镜像。
+ *
+ */
 export declare enum VeLivePlayerMirror {
-    
+    /** {zh}
+     * @brief 关闭镜像。
+     *
+     */
     /** {en}
      * @brief No mirroring.
      *
      */
     VeLivePlayerMirrorNone = 0,
-    
+    /** {zh}
+     * @brief 水平镜像。
+     *
+     */
     /** {en}
      * @brief Horizontal mirroring.
      *
      */
     VeLivePlayerMirrorHorizontal = 1,
-    
+    /** {zh}
+     * @brief 垂直镜像。
+     *
+     */
     /** {en}
      * @brief Vertical mirroring.
      *
      */
     VeLivePlayerMirrorVertical = 2
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 流地址信息。
+ *
+ */
 export declare class VeLivePlayerStream {
     constructor();
     constructor();
     protected _instance: any;
-    
+    /** {zh}
+     * @brief 播放地址。
+     *
+     */
     /** {en}
      * @brief The pull stream address.
      *
      */
     get url(): string;
     set url(value: string);
-    
+    /** {zh}
+     * @brief 清晰度档位。详情请参见 [VeLivePlayerResolution](#VeLivePlayerResolution)。
+     *
+     */
     /** {en}
      * @brief The playback resolution. For details, see [VeLivePlayerResolution](#VeLivePlayerResolution).
      *
      */
     get resolution(): VeLivePlayerResolution;
     set resolution(value: VeLivePlayerResolution);
-    
+    /** {zh}
+     * @brief 播放码率，单位为 kbps。
+     *
+     */
     /** {en}
      * @brief The playback bitrate, in Kbps.
      *
      */
     get bitrate(): number;
     set bitrate(value: number);
-    
+    /** {zh}
+     * @brief 播放格式。详情请参见 [VeLivePlayerFormat](#VeLivePlayerFormat)。
+     *
+     */
     /** {en}
      * @brief The format of the live stream. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
      *
      */
     get format(): VeLivePlayerFormat;
     set format(value: VeLivePlayerFormat);
-    
+    /** {zh}
+     * @platform android
+     * @brief 播放流类型为主路或备路。详情请参见 [VeLivePlayerStreamType](#VeLivePlayerStreamType)。
+     *
+     */
     /** {en}
      * @platform android
      * @brief Whether the stream is a main or backup stream. See [VeLivePlayerStreamType](#VeLivePlayerStreamType) for details.
@@ -607,14 +952,20 @@ export declare class VeLivePlayerStream {
      */
     get streamType(): $p_a.VeLivePlayerStreamType;
     set streamType(value: $p_a.VeLivePlayerStreamType);
-    
+    /** {zh}
+     * @platform ios
+     * @brief 传输协议，详情请参见 [VeLivePlayerProtocol](#VeLivePlayerProtocol)。
+     */
     /** {en}
      * @platform ios
      * @brief The transmission protocol. See [VeLivePlayerProtocol](#VeLivePlayerProtocol) for details.
      */
     get protocol(): $p_i.VeLivePlayerProtocol;
     set protocol(value: $p_i.VeLivePlayerProtocol);
-    
+    /** {zh}
+     * @platform ios
+     * @brief 播放流类型为主路或备路，详情请参见 [VeLivePlayerStreamType](188121#VeLivePlayerStreamType)。
+     */
     /** {en}
      * @platform ios
      * @brief Whether the stream is a primary or a backup stream. See [VeLivePlayerStreamType](#VeLivePlayerStreamType) for details.
@@ -624,45 +975,67 @@ export declare class VeLivePlayerStream {
     protected __init(...args: any[]): void;
     protected __new_instance(...args: any[]): any;
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 视频帧数据。
+ */
 export declare class VeLivePlayerVideoFrame {
     protected _instance: any;
-    
+    /** {zh}
+     * @brief 视频帧数据封装格式。详情请参见 [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType)。
+     *
+     */
     /** {en}
      * @brief The encapsulation format. See [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) for details.
      *
      */
     get bufferType(): VeLivePlayerVideoBufferType;
     set bufferType(value: VeLivePlayerVideoBufferType);
-    
+    /** {zh}
+     * @brief 视频帧像素格式。详情请参见 [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat)。
+     *
+     */
     /** {en}
      * @brief The pixel format. See [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) for details.
      *
      */
     get pixelFormat(): VeLivePlayerPixelFormat;
     set pixelFormat(value: VeLivePlayerPixelFormat);
-    
+    /** {zh}
+     * @brief 视频宽度，单位为 px。
+     *
+     */
     /** {en}
      * @brief The video width, in pixels.
      *
      */
     get width(): number;
     set width(value: number);
-    
+    /** {zh}
+     * @brief 视频高度，单位为 px。
+     *
+     */
     /** {en}
      * @brief The video height, in pixels.
      *
      */
     get height(): number;
     set height(value: number);
-    
+    /** {zh}
+     * @brief 视频帧的渲染时间戳。单位为 ms。
+     *
+     */
     /** {en}
      * @brief The timestamp indicating the time when the video frame is rendered, in milliseconds.
      *
      */
     get pts(): number;
     set pts(value: number);
-    
+    /** {zh}
+     * @platform android
+     * @brief OpenGL 渲染的视频纹理数据。如果将 [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) 设置为`VeLivePlayerPixelFormatTexture`，并将 [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) 设置为`VeLivePlayerVideoBufferTypeTexture`，SDK 会返回此视频数据类型。有关详细信息，请参阅[VeLivePlayerVideoTexture](#VeLivePlayerVideoTexture)。
+     *
+     */
     /** {en}
      * @platform android
      * @brief The texture data for OpenGL rendering. The SDK returns this video data type if you set [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) to `VeLivePlayerPixelFormatTexture` and set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeTexture`. See [VeLivePlayerVideoTexture](#VeLivePlayerVideoTexture) for details.
@@ -670,7 +1043,11 @@ export declare class VeLivePlayerVideoFrame {
      */
     get texture(): $p_a.VeLivePlayerVideoTexture;
     set texture(value: $p_a.VeLivePlayerVideoTexture);
-    
+    /** {zh}
+     * @platform android
+     * @brief ByteBuffer 格式的视频数据。如果将 [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat)设置为`VeLivePlayerPixelFormatRGBA32`，并将 [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) 设置为`VeLivePlayerVideoBufferTypeByteBuffer`，则 SDK 会返回此视频数据类型。
+     *
+     */
     /** {en}
      * @platform android
      * @brief The video data in ByteBuffer format. The SDK returns this video data type if you set [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) to `VeLivePlayerPixelFormatRGBA32` and set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeByteBuffer`.
@@ -678,21 +1055,30 @@ export declare class VeLivePlayerVideoFrame {
      */
     get buffer(): $p_a.ByteBuffer;
     set buffer(value: $p_a.ByteBuffer);
-    
+    /** {zh}
+     * @brief ByteArray 格式的视频数据。如果将 [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) 设置为“VeLivePlayerPixelFormatRGBA32”，并将 [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) 设置为“VeLivePlayerVideoBufferTypeByteArray”，则 SDK 会返回这种视频数据类型。
+     *
+     */
     /** {en}
      * @brief The video data in ByteArray format. The SDK returns this video data type if you set [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) to `VeLivePlayerPixelFormatRGBA32` and set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeByteArray`.
      *
      */
     get data(): ArrayBuffer;
     set data(value: ArrayBuffer);
-    
+    /** {zh}
+     * @platform ios
+     * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypePixelBuffer` 时的视频数据。
+     */
     /** {en}
      * @platform ios
      * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypePixelBuffer`.
      */
     get pixelBuffer(): $p_i.CVPixelBufferRef;
     set pixelBuffer(value: $p_i.CVPixelBufferRef);
-    
+    /** {zh}
+     * @platform ios
+     * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypeSampleBuffer` 时的视频数据。
+     */
     /** {en}
      * @platform ios
      * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeSampleBuffer`.
@@ -702,78 +1088,124 @@ export declare class VeLivePlayerVideoFrame {
     protected __init(...args: any[]): void;
     protected __new_instance(...args: any[]): any;
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 直播播放流类型。
+ *
+ */
 export declare enum VeLivePlayerStreamType {
-    
+    /** {zh}
+     * @brief 主路流。
+     *
+     */
     /** {en}
      * @brief The primary stream.
      *
      */
     VeLivePlayerStreamTypeMain = 0,
-    
+    /** {zh}
+     * @brief 备路流。
+     *
+     */
     /** {en}
      * @brief The backup stream.
      *
      */
     VeLivePlayerStreamTypeBackup = 1
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 直播播放器日志打印级别。
+ *
+ */
 export declare enum VeLivePlayerLogLevel {
-    
+    /** {zh}
+     * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output logs at the VERBOSE, DEBUG, INFO, WARNING, and ERROR levels.
      *
      */
     VeLivePlayerLogLevelVerbose = 0,
-    
+    /** {zh}
+     * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output logs at the DEBUG, INFO, WARNING, and ERROR levels.
      *
      */
     VeLivePlayerLogLevelDebug = 1,
-    
+    /** {zh}
+     * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output logs at the INFO, WARNING, and ERROR levels.
      *
      */
     VeLivePlayerLogLevelInfo = 2,
-    
+    /** {zh}
+     * @brief 输出 WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output logs at the WARNING and ERROR levels.
      *
      */
     VeLivePlayerLogLevelWarn = 3,
-    
+    /** {zh}
+     * @brief 输出 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output logs at the ERROR level.
      *
      */
     VeLivePlayerLogLevelError = 4,
-    
+    /** {zh}
+     * @brief 关闭日志打印。
+     *
+     */
     /** {en}
      * @brief Disable log printing.
      *
      */
     VeLivePlayerLogLevelNone = 5
 }
-
+/** {zh}
+ * @detail keytype
+ * @brief 音频帧数据。
+ */
 export declare class VeLivePlayerAudioFrame {
     protected _instance: any;
-    
+    /** {zh}
+     * @brief 音频帧数据封装格式，详情请参见 [VeLivePlayerAudioBufferType](#VeLivePlayerAudioBufferType)。
+     *
+     */
     /** {en}
      * @brief The encapsulation format of the audio data. See [VeLivePlayerAudioBufferType](#VeLivePlayerAudioBufferType) for details.
      *
      */
     get bufferType(): VeLivePlayerAudioBufferType;
     set bufferType(value: VeLivePlayerAudioBufferType);
-    
+    /** {zh}
+     * @brief 音频采样率，单位为 Hz。
+     *
+     */
     /** {en}
      * @brief The audio sample rate, in Hz.
      *
      */
     get sampleRate(): number;
     set sampleRate(value: number);
-    
+    /** {zh}
+     * @brief 声道数。<br>
+     *     - 1：单声道；
+     *     - 2：双声道。
+     *
+     */
     /** {en}
      * @brief The number of audio channels. <br>
      *      - 1: Mono;
@@ -782,21 +1214,31 @@ export declare class VeLivePlayerAudioFrame {
      */
     get channels(): number;
     set channels(value: number);
-    
+    /** {zh}
+     * @brief 音频位深度。
+     *
+     */
     /** {en}
      * @brief The audio bit depth.
      *
      */
     get bitDepth(): number;
     set bitDepth(value: number);
-    
+    /** {zh}
+     * @brief 音频渲染时间戳。单位为 ms。
+     *
+     */
     /** {en}
      * @brief The timestamp indicating the time when the audio is rendered, in milliseconds.
      *
      */
     get pts(): number;
     set pts(value: number);
-    
+    /** {zh}
+     * @platform android
+     * @brief PCM 音频数据。byte[]类型
+     *
+     */
     /** {en}
      * @platform android
      * @brief The PCM audio data. byte[] type.
@@ -804,7 +1246,11 @@ export declare class VeLivePlayerAudioFrame {
      */
     get bufferArray(): ArrayBuffer;
     set bufferArray(value: ArrayBuffer);
-    
+    /** {zh}
+     * @platform android
+     * @brief PCM 音频数据。ByteBuffer[]类型
+     *
+     */
     /** {en}
      * @platform android
      * @brief The PCM audio data. ByteBuffer[] type.
@@ -812,14 +1258,20 @@ export declare class VeLivePlayerAudioFrame {
      */
     get buffer(): $p_a.ByteBuffer[];
     set buffer(value: $p_a.ByteBuffer[]);
-    
+    /** {zh}
+     * @brief 音频采样点个数。
+     *
+     */
     /** {en}
      * @brief The number of audio samples.
      *
      */
     get samples(): number;
     set samples(value: number);
-    
+    /** {zh}
+     * @platform ios
+     * @brief PCM 音频数据。
+     */
     /** {en}
      * @platform ios
      * @brief The PCM audio data.