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

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

@@ -1,12 +1,18 @@
 import { BOOL, NSInteger, NSString, int, CMTime, NSData, int64_t, CVPixelBufferRef, CMSampleBufferRef, NSArray, NSURL, long, float } from './types';
 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:](188118#TVLManager(VeLivePlayer)-switchresolution)手动切换档位。
+     *
+     */
     /** {en}
      * @brief The resolution is changed after [switchResolution:](docs-player-sdk-for-ios-api#TVLManager(VeLivePlayer)-switchresolution) is called.
      *
@@ -14,14 +20,23 @@ export declare enum VeLivePlayerResolutionSwitchReason {
     VeLivePlayerResolutionSwitchByManual = 1
 }
 export declare class VeLivePlayerConfiguration {
-    
+    /** {zh}
+     * @brief 是否开启字符串 SEI 消息的解析，默认值为 NO。<br/>
+     *        - YES：开启；
+     *        - NO：关闭。
+     */
     /** {en}
      * @brief Whether to enable the parsing of string SEI messages. The default value is `NO`.<br/>
      *        - YES: Enable;
      *        - NO: Disable.
      */
     enableSei: BOOL;
-    
+    /** {zh}
+     * @brief 是否开启二进制 SEI 消息的解析，默认值为 NO。<br/>
+     *        - YES：开启；
+     *        - NO：关闭。
+     * @notes 二进制 SEI 开启后，字符串 SEI 的回调将不再发送。
+     */
     /** {en}
      * @brief Whether to enable the parsing of binary SEI messages. The default value is `NO`.<br/>
      *        - YES: Enable;
@@ -29,126 +44,184 @@ export declare class VeLivePlayerConfiguration {
      * @notes After binary SEI is enabled, callbacks for string SEI will no longer be sent.
      */
     enableBinarySei: BOOL;
-    
+    /** {zh}
+     * @brief 是否开启硬件解码功能，默认值为 YES。开启硬件解码后，如果出现硬件解码启动失败或硬件解码失败的情况，播放器内部会自动切换为软解。<br>
+     *      - YES：开启；
+     *      - NO：关闭。
+     */
     /** {en}
      * @brief Whether to turn on hardware decoding. The default value is `YES`. 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>
      *       - YES: Enable;
      *       - NO: Disable.
      */
     enableHardwareDecode: BOOL;
-    
+    /** {zh}
+     * @brief 是否开启本地 DNS 预解析，默认值为 NO。开启本地 DNS 预解析可以缩短启播时间。如果本地 DNS 预解析出现异常，可能会影响播放器的正常使用。<br>
+     *      - YES：开启；
+     *      - NO：关闭。
+     */
     /** {en}
      * @brief Whether to enable local DNS prefetch. The default value is `NO`. 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>
      *       - YES: Enable;
      *       - NO: Disable.
      */
     enableLiveDNS: BOOL;
-    
+    /** {zh}
+     * @brief 是否开启播放信息周期性回调。默认值为 NO。周期性回调参数详细说明请参见 [VeLivePlayerStatistics](#VeLivePlayerStatistics) 。当 enableStatisticsCallback 为 YES，且 [statisticsCallbackInterval](#VeLivePlayerConfiguration-statisticscallbackinterval) 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。<br/>
+     *        - YES：开启；
+     *        - NO：关闭。
+     */
     /** {en}
      * @brief Whether to enable periodic callbacks for playback information. The default value is `NO`. Refer to [VeLivePlayerStatistics](#VeLivePlayerStatistics) for more information on callback statistics. If `enableStatisticsCallback` is `YES` and [statisticsCallbackInterval](#VeLivePlayerConfiguration-statisticscallbackinterval) is greater than `0`, the player will periodically report the player status information after the specified time interval.<br/>
      *        - YES: Enable;
      *        - NO: Disable.
      */
     enableStatisticsCallback: BOOL;
-    
+    /** {zh}
+     * @brief 播放信息周期性回调的时间间隔，单位为 s，默认值为 5。当 [enableStatisticsCallback](#VeLivePlayerConfiguration-enablestatisticscallback) 为 YES，且 `statisticsCallbackInterval` 大于 0 时，播放器会在指定的时间间隔内，周期性地回调播放器状态信息。
+     */
     /** {en}
      * @brief The time interval for periodic callbacks that provide playback information, in seconds. The default value is `5`. If enableStatisticsCallback is `YES` and [enableStatisticsCallback](#VeLivePlayerConfiguration-enablestatisticscallback) is greater than `0`, the player will periodically report the player status information after the specified time interval.
      */
     statisticsCallbackInterval: NSInteger;
-    
+    /** {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 to have failed.
      */
     networkTimeoutMs: NSInteger;
-    
+    /** {zh}
+     * @brief 重试时间间隔，单位为 ms，默认值为 5000，仅在无备流时生效。<br>
+     *     - 在无备流的场景下，若遇到网络异常等问题导致播放中断，播放器会立即进行重试，前三次重试为立即执行，第四次及之后的重试将按照设置的重试时间间隔执行；
+     *     - 在有备流的场景下，重试时间间隔将不生效，所有重试均会立即执行。
+     */
     /** {en}
      * @brief Retry interval, in ms. The default value is 5000 and it is only effective when there is no backup stream.
      *        - In scenarios without a backup stream, if playback is interrupted due to issues such as network anomalies, the player will immediately retry. The first three retries are executed immediately, and the fourth and subsequent retries will be executed according to the set retry interval.
      *        - In scenarios with a backup stream, the retry interval will not take effect and all retries will be executed immediately.
      */
     retryIntervalTimeMs: NSInteger;
-    
+    /** {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 a scenario without backup streams, each retry consumes one retry attempt.
      *        - In a scenario with backup streams, each primary-backup stream switch consumes one retry attempt.
      */
     retryMaxCount: NSInteger;
-    
+    /** {zh}
+     * @brief 默认初始化方法。
+     */
     /** {en}
      * @brief Initializes the configurations.
      */
     init(): this;
 }
 export declare class VeLivePlayerStream {
-    
+    /** {zh}
+     * @brief 播放地址。
+     */
     /** {en}
      * @brief The pull stream address.
      */
     url: NSString;
-    
+    /** {zh}
+     * @brief 清晰度档位，详情请参见 [VeLivePlayerResolution](#VeLivePlayerResolution)。
+     */
     /** {en}
      * @brief The resolution. See [VeLivePlayerResolution](#VeLivePlayerResolution) for details.
      */
     resolution: VeLivePlayerResolution;
-    
+    /** {zh}
+     * @brief 播放码率，单位为 bps。
+     */
     /** {en}
      * @brief The playback bitrate, in bps.
      */
     bitrate: int;
-    
+    /** {zh}
+     * @brief 传输协议，详情请参见 [VeLivePlayerProtocol](#VeLivePlayerProtocol)。
+     */
     /** {en}
      * @brief The transmission protocol. See [VeLivePlayerProtocol](#VeLivePlayerProtocol) for details.
      */
     protocol: VeLivePlayerProtocol;
-    
+    /** {zh}
+     * @brief 播放格式，详情请参见 [VeLivePlayerFormat](#VeLivePlayerFormat)。
+     */
     /** {en}
      * @brief The video format. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
      */
     format: VeLivePlayerFormat;
-    
+    /** {zh}
+     * @brief 播放流类型为主路或备路，详情请参见 [VeLivePlayerStreamType](188121#VeLivePlayerStreamType)。
+     */
     /** {en}
      * @brief Whether the stream is a primary or a backup stream. See [VeLivePlayerStreamType](#VeLivePlayerStreamType) for details.
      */
     type: VeLivePlayerStreamType;
-    
+    /** {zh}
+     * @brief 单路直播流配置初始化方法。
+     */
     /** {en}
      * @brief Initializes a pull stream address.
      */
     init(): this;
 }
 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.
      *
@@ -156,39 +229,55 @@ export declare enum VeLivePlayerLogLevel {
     VeLivePlayerLogLevelNone = 5
 }
 export declare class VeLivePlayerAudioFrame {
-    
+    /** {zh}
+     * @brief 音频帧数据封装格式，详情请参见 [VeLivePlayerAudioBufferType](#VeLivePlayerAudioBufferType)。
+     */
     /** {en}
      * @brief The encapsulation format of the audio data. See [VeLivePlayerAudioBufferType](#VeLivePlayerAudioBufferType) for details.
      */
     bufferType: VeLivePlayerAudioBufferType;
-    
+    /** {zh}
+     * @brief 音频采样率，单位为 Hz。
+     */
     /** {en}
      * @brief The audio sample rate, in Hz.
      */
     sampleRate: int;
-    
+    /** {zh}
+     * @brief 声道数。<br>
+     *     - 1：单声道；
+     *     - 2：双声道。
+     */
     /** {en}
      * @brief The number of audio channels. <br>
      *      - 1: Mono;
      *      - 2: Stereo.
      */
     channels: int;
-    
+    /** {zh}
+     * @brief 音频位深度。
+     */
     /** {en}
      * @brief The audio bit depth.
      */
     bitDepth: int;
-    
+    /** {zh}
+     * @brief 音频渲染时间戳，单位为 ms。
+     */
     /** {en}
      * @brief The timestamp indicating the time when the audio is rendered, in milliseconds.
      */
     pts: CMTime;
-    
+    /** {zh}
+     * @brief PCM 音频数据。
+     */
     /** {en}
      * @brief The PCM audio data.
      */
     data: NSData;
-    
+    /** {zh}
+     * @brief 音频采样点个数。
+     */
     /** {en}
      * @brief The number of audio samples.
      */
@@ -196,42 +285,58 @@ export declare class VeLivePlayerAudioFrame {
     init(): this;
 }
 export declare class VeLivePlayerVideoFrame {
-    
+    /** {zh}
+     * @brief 视频帧数据封装格式，详情请参见 [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType)。
+     */
     /** {en}
      * @brief The encapsulation format. See [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) for details.
      */
     bufferType: VeLivePlayerVideoBufferType;
-    
+    /** {zh}
+     * @brief 视频帧像素格式，详情请参见 [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat)。
+     */
     /** {en}
      * @brief The pixel format. See [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) for details.
      */
     pixelFormat: VeLivePlayerPixelFormat;
-    
+    /** {zh}
+     * @brief 视频宽度，单位为 px。
+     */
     /** {en}
      * @brief The video width, in pixels.
      */
     width: NSInteger;
-    
+    /** {zh}
+     * @brief 视频高度，单位为 px。
+     */
     /** {en}
      * @brief The video height, in pixels.
      */
     height: NSInteger;
-    
+    /** {zh}
+     * @brief 视频帧的渲染时间戳，单位为 ms。
+     */
     /** {en}
      * @brief The timestamp indicating the time when the video frame is rendered, in milliseconds.
      */
     pts: int64_t;
-    
+    /** {zh}
+     * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypePixelBuffer` 时的视频数据。
+     */
     /** {en}
      * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypePixelBuffer`.
      */
     pixelBuffer: CVPixelBufferRef;
-    
+    /** {zh}
+     * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypeSampleBuffer` 时的视频数据。
+     */
     /** {en}
      * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeSampleBuffer`.
      */
     sampleBuffer: CMSampleBufferRef;
-    
+    /** {zh}
+     * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypeNSData` 时的视频数据。
+     */
     /** {en}
      * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeNSData`.
      */
@@ -239,37 +344,55 @@ export declare class VeLivePlayerVideoFrame {
     init(): this;
 }
 export declare enum VeLivePlayerSupportResolutionSwitchError {
-    
+    /** {zh}
+     * @brief 没有找到对应分辨率档位。
+     *
+     */
     /** {en}
      * @brief The corresponding resolution gear is not found.
      *
      */
     VeLivePlayerErrorResNotFound = -1,
-    
+    /** {zh}
+     * @brief 和当前分辨率档位相同。
+     *
+     */
     /** {en}
      * @brief The same as the current resolution level.
      *
      */
     VeLivePlayerErrorSameRes = -2,
-    
+    /** {zh}
+     * @brief 播放器状态为非 prepare 状态。
+     *
+     */
     /** {en}
      * @brief The player status is not in the prepare state.
      *
      */
     VeLivePlayerErrorStatusInvalid = -3,
-    
+    /** {zh}
+     * @brief 分辨率档位错误。
+     *
+     */
     /** {en}
      * @brief Resolution level error.
      *
      */
     VeLivePlayerErrorInvalidRes = -4,
-    
+    /** {zh}
+     * @brief 配置不支持。
+     *
+     */
     /** {en}
      * @brief Configuration not supported.
      *
      */
     VeLivePlayerErrorConfigNotSupport = -5,
-    
+    /** {zh}
+     * @brief 格式不支持。
+     *
+     */
     /** {en}
      * @brief Format not supported.
      *
@@ -277,41 +400,59 @@ export declare enum VeLivePlayerSupportResolutionSwitchError {
     VeLivePlayerErrorFormatNotSupport = -6
 }
 export declare class VeLivePlayerStreamData {
-    
+    /** {zh}
+     * @brief 是否打开 ABR 平滑切档功能，默认为 NO。<br>
+     *     - YES：开启；
+     *     - NO：关闭。
+     */
     /** {en}
      * @brief Whether to enable adaptive bitrate (ABR). The default value is `NO`. <br>
      *      - YES: Enable;
      *      - NO: Disable.
      */
     enableABR: BOOL;
-    
+    /** {zh}
+     * @brief 是否打开主备切换，默认为 NO。<br>
+     *     - YES：开启；
+     *     - NO：关闭。
+     */
     /** {en}
      * @brief Whether to enable switching between the primary and the backup stream. The default value is `NO`. <br>
      *      - YES: Enable;
      *      - NO: Disable.
      */
     enableMainBackupSwitch: BOOL;
-    
+    /** {zh}
+     * @brief 播放器的默认清晰度档位，默认使用原始流清晰度，详情请参见 [VeLivePlayerResolution](#VeLivePlayerResolution)。
+     */
     /** {en}
      * @brief The default resolution. The default value is `VeLivePlayerResolutionOrigin`, which indicates the original resolution. See [VeLivePlayerResolution](#VeLivePlayerResolution) for details.
      */
     defaultResolution: VeLivePlayerResolution;
-    
+    /** {zh}
+     * @brief 播放器的默认播放格式，默认值为 FLV，详情请参见 [VeLivePlayerFormat](#VeLivePlayerFormat)。
+     */
     /** {en}
      * @brief The default video format. The default value is `VeLivePlayerFormatFLV`. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
      */
     defaultFormat: VeLivePlayerFormat;
-    
+    /** {zh}
+     * @brief 播放器的默认播放传输层协议，默认值为 TCP，详情请参见 [VeLivePlayerProtocol](#VeLivePlayerProtocol)。
+     */
     /** {en}
      * @brief The default transmission protocol. The default value is `VeLivePlayerProtocolTCP`. See [VeLivePlayerProtocol](#VeLivePlayerProtocol) for details.
      */
     defaultProtocol: VeLivePlayerProtocol;
-    
+    /** {zh}
+     * @brief 主路流地址列表，详情请参见 [VeLivePlayerStream](#VeLivePlayerStream)。
+     */
     /** {en}
      * @brief A list of main stream addresses. See [VeLivePlayerStream](#VeLivePlayerStream) for details.
      */
     mainStream: NSArray<VeLivePlayerStream>;
-    
+    /** {zh}
+     * @brief 备路流地址列表，详情请参见 [VeLivePlayerStream](#VeLivePlayerStream)。
+     */
     /** {en}
      * @brief A list of backup stream addresses. See [VeLivePlayerStream](#VeLivePlayerStream) for details.
      */
@@ -319,19 +460,28 @@ export declare class VeLivePlayerStreamData {
     init(): this;
 }
 export declare enum VeLivePlayerAudioBufferType {
-    
+    /** {zh}
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @brief Unknown format.
      *
      */
     VeLivePlayerAudioBufferUnknown = 0,
-    
+    /** {zh}
+     * @brief CVSampleBufferRef 格式，音频数据以样本缓冲区 sample buffer 的形式进行处理和渲染。
+     *
+     */
     /** {en}
      * @brief CVSampleBufferRef. The audio data is processed and rendered as sample buffers.
      *
      */
     VeLivePlayerAudioBufferTypeSampleBuffer = 1,
-    
+    /** {zh}
+     * @brief NSData 格式，音频数据以 NSData 对象的形式进行处理和渲染。
+     *
+     */
     /** {en}
      * @brief NSData. The audio data is processed and rendered as NSData objects.
      *
@@ -339,25 +489,37 @@ export declare enum VeLivePlayerAudioBufferType {
     VeLivePlayerAudioBufferTypeNSData = 2
 }
 export declare enum VeLivePlayerVideoBufferType {
-    
+    /** {zh}
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @brief Unknown format.
      *
      */
     VeLivePlayerVideoBufferTypeUnknown = 0,
-    
+    /** {zh}
+     * @brief CVPixelBufferRef 格式。
+     *
+     */
     /** {en}
      * @brief CVPixelBufferRef.
      *
      */
     VeLivePlayerVideoBufferTypePixelBuffer = 1,
-    
+    /** {zh}
+     * @brief CVSampleBufferRef 格式。
+     *
+     */
     /** {en}
      * @brief CVSampleBufferRef.
      *
      */
     VeLivePlayerVideoBufferTypeSampleBuffer = 2,
-    
+    /** {zh}
+     * @brief NSData 格式。
+     *
+     */
     /** {en}
      * @brief NSData.
      *
@@ -365,25 +527,37 @@ export declare enum VeLivePlayerVideoBufferType {
     VeLivePlayerVideoBufferTypeNSData = 3
 }
 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 HTTP 协议。
+     *
+     */
     /** {en}
      * @brief HTTP。
      *
@@ -391,19 +565,28 @@ export declare enum VeLivePlayerProtocol {
     VeLivePlayerProtocolHTTP2 = 3
 }
 export declare enum VeLivePlayerFillMode {
-    
+    /** {zh}
+     * @brief 视频填满画布。视频帧等比缩放，直至填满画布，超出屏幕的部分将被裁剪，画面可能不完整。
+     *
+     */
     /** {en}
      * @brief Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
      *
      */
     VeLivePlayerFillModeAspectFill = 0,
-    
+    /** {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 = 1,
-    
+    /** {zh}
+     * @brief 视频帧自适应画布。视频帧非等比缩放，直至填满画布。在此过程中，视频帧的长宽比例可能会发生变化。
+     *
+     */
     /** {en}
      * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
      *
@@ -411,25 +594,37 @@ export declare enum VeLivePlayerFillMode {
     VeLivePlayerFillModeFullFill = 2
 }
 export declare enum VeLivePlayerRotation {
-    
+    /** {zh}
+     * @brief 关闭旋转。
+     *
+     */
     /** {en}
      * @brief No rotation.
      *
      */
     VeLivePlayerRotation0 = 0,
-    
+    /** {zh}
+     * @brief 顺时针旋转 90 度。
+     *
+     */
     /** {en}
      * @brief Rotate 90 degrees clockwise.
      *
      */
     VeLivePlayerRotation90 = 90,
-    
+    /** {zh}
+     * @brief 顺时针旋转 180 度。
+     *
+     */
     /** {en}
      * @brief Rotate 180 degrees clockwise.
      *
      */
     VeLivePlayerRotation180 = 180,
-    
+    /** {zh}
+     * @brief 顺时针旋转 270 度。
+     *
+     */
     /** {en}
      * @brief Rotate 270 degrees clockwise.
      *
@@ -437,19 +632,28 @@ export declare enum VeLivePlayerRotation {
     VeLivePlayerRotation270 = 270
 }
 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.
      *
@@ -457,25 +661,37 @@ export declare enum VeLivePlayerMirror {
     VeLivePlayerMirrorVertical = 2
 }
 export declare enum VeLivePlayerPixelFormat {
-    
+    /** {zh}
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @brief Unknown format.
      *
      */
     VeLivePlayerPixelFormatUnknown = 0,
-    
+    /** {zh}
+     * @brief NV12 格式。
+     *
+     */
     /** {en}
      * @brief NV12.
      *
      */
     VeLivePlayerPixelFormatNV12 = 1,
-    
+    /** {zh}
+     * @brief YUVI420 格式。
+     *
+     */
     /** {en}
      * @brief YUVI420.
      *
      */
     VeLivePlayerPixelFormatI420 = 2,
-    
+    /** {zh}
+     * @brief BGRA 格式。
+     *
+     */
     /** {en}
      * @brief BGRA.
      *
@@ -483,31 +699,46 @@ export declare enum VeLivePlayerPixelFormat {
     VeLivePlayerPixelFormatBGRA32 = 3
 }
 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.
      *
@@ -515,74 +746,104 @@ export declare enum VeLivePlayerStatus {
     VeLivePlayerStatusError = 4
 }
 export declare class VeLivePlayerStatistics {
-    
+    /** {zh}
+     * @brief 当前直播的播放地址。
+     */
     /** {en}
      * @brief The current pull stream address.
      */
     url: NSURL;
-    
+    /** {zh}
+     * @brief 是否使用硬件解码。<br>
+     *     - YES：硬解；
+     *     - NO：非硬解。
+     */
     /** {en}
      * @brief Whether hardware decoding is used. <br>
      *      - YES: Hardware decoding is used;
      *      - NO: Hardware decoding is not used.
      */
     isHardWareDecode: BOOL;
-    
+    /** {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.
      */
     delayMs: int;
-    
+    /** {zh}
+     * @brief 从当前视频开始播放起，累计的卡顿时长，单位为 ms。
+     */
     /** {en}
      * @brief The cumulative duration of stutters that occurred since the beginning of playback, in milliseconds.
      */
     stallTimeMs: int;
-    
+    /** {zh}
+     * @brief 带宽预测 ，单位为 kbps。
+     */
     /** {en}
      * @brief The estimated bandwidth, in kbps.
      */
     bandwidthEstimation: long;
-    
+    /** {zh}
+     * @brief 视频的编码类型。
+     */
     /** {en}
      * @brief The encoding format of the video.
      */
     videoCodec: NSString;
-    
+    /** {zh}
+     * @brief 当前播放视频的宽度，单位为 px。
+     */
     /** {en}
      * @brief The width of the video, in pixels.
      */
     width: int;
-    
+    /** {zh}
+     * @brief 当前播放视频的高度，单位为 px。
+     */
     /** {en}
      * @brief The height of the video, in pixels.
      */
     height: int;
-    
+    /** {zh}
+     * @brief 当前播放视频的帧率，单位为 fps。
+     */
     /** {en}
      * @brief The frame rate of the video, in fps.
      */
     fps: float;
-    
+    /** {zh}
+     * @brief 实时下载的码率，单位为 kbps。
+     */
     /** {en}
      * @brief The downlink bitrate, in Kbps.
      */
     bitrate: long;
-    
+    /** {zh}
+     * @brief 视频播放的缓冲区 buffer 大小，单位为 ms。
+     */
     /** {en}
      * @brief The video buffer, in milliseconds.
      */
     videoBufferMs: long;
-    
+    /** {zh}
+     * @brief 音频播放的缓冲区 buffer 大小，单位为 ms。
+     */
     /** {en}
      * @brief The audio buffer, in milliseconds.
      */
     audioBufferMs: long;
-    
+    /** {zh}
+     * @brief 当前播放的视频格式。
+     */
     /** {en}
      * @brief The video format.
      */
     format: VeLivePlayerFormat;
-    
+    /** {zh}
+     * @brief 当前播放的传输协议。
+     */
     /** {en}
      * @brief The transmission protocol of the live stream.
      */
@@ -590,13 +851,19 @@ export declare class VeLivePlayerStatistics {
     init(): this;
 }
 export declare enum VeLivePlayerType {
-    
+    /** {zh}
+     * @brief 自研播放器。
+     *
+     */
     /** {en}
      * @brief Custom player.
      *
      */
     VeLivePlayerTypeOwn = 0,
-    
+    /** {zh}
+     * @brief 系统播放器。
+     *
+     */
     /** {en}
      * @brief System player.
      *
@@ -604,13 +871,19 @@ export declare enum VeLivePlayerType {
     VeLivePlayerTypeSystem = 1
 }
 export declare enum VeLivePlayerStreamType {
-    
+    /** {zh}
+     * @brief 主路流。
+     *
+     */
     /** {en}
      * @brief The primary stream.
      *
      */
     VeLivePlayerStreamTypeMain = 0,
-    
+    /** {zh}
+     * @brief 备路流。
+     *
+     */
     /** {en}
      * @brief The backup stream.
      *
@@ -618,19 +891,28 @@ export declare enum VeLivePlayerStreamType {
     VeLivePlayerStreamTypeBackup = 1
 }
 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).
      *
@@ -638,55 +920,84 @@ export declare enum VeLivePlayerFormat {
     VeLivePlayerFormatRTM = 2
 }
 export declare enum VeLivePlayerResolution {
-    
+    /** {zh}
+     * @brief 原始流。
+     *
+     */
     /** {en}
      * @brief Original.
      *
      */
     VeLivePlayerResolutionOrigin = 0,
-    
+    /** {zh}
+     * @brief UHD 超高清。
+     *
+     */
     /** {en}
      * @brief Ultra high definition (UHD).
      *
      */
     VeLivePlayerResolutionUHD = 1,
-    
+    /** {zh}
+     * @brief FHD 全高清
+     *
+     */
     /** {en}
      * @brief Full High definition (FHD).
      *
      */
     VeLivePlayerResolutionFHD = 2,
-    
+    /** {zh}
+     * @brief HD 高清。
+     *
+     */
     /** {en}
      * @brief High definition (HD).
      *
      */
     VeLivePlayerResolutionHD = 3,
-    
+    /** {zh}
+     * @brief SD 标清。
+     *
+     */
     /** {en}
      * @brief Standard definition (SD).
      *
      */
     VeLivePlayerResolutionSD = 4,
-    
+    /** {zh}
+     * @brief LD 低清。
+     *
+     */
     /** {en}
      * @brief Low definition (LD).
      *
      */
     VeLivePlayerResolutionLD = 5,
-    
+    /** {zh}
+     * @brief MD 审核档位
+     * @hidden (iOS)
+     *
+     */
     /** {en}
      * @hidden (iOS)
      *
      */
     VeLivePlayerResolutionMD = 6,
-    
+    /** {zh}
+     * @brief 仅音频
+     * @hidden (iOS)
+     *
+     */
     /** {en}
      * @hidden (iOS)
      *
      */
     VeLivePlayerResolutionAO = 7,
-    
+    /** {zh}
+     * @brief 自动档位。
+     *
+     */
     /** {en}
      * @brief Auto.
      *