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

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

@@ -1,12 +1,18 @@
 import { int, BOOL, NSDictionary, float, CMTime, GLuint, CVPixelBufferRef, CMSampleBufferRef, NSData, NSArray, NSString } from './types';
 export declare enum VeLiveVideoEffectLicenseType {
-    
+    /** {zh}
+     * @brief 离线认证视频特效许可证。
+     *
+     */
     /** {en}
      * @brief Authenticate offline.
      *
      */
     VeLiveVideoEffectLicenseTypeOffLine = 0,
-    
+    /** {zh}
+     * @brief 在线认证视频特效许可证。
+     *
+     */
     /** {en}
      * @brief Authenticate online.
      *
@@ -14,25 +20,37 @@ export declare enum VeLiveVideoEffectLicenseType {
     VeLiveVideoEffectLicenseTypeOnLine = 1
 }
 export declare enum VeLiveNetworkQuality {
-    
+    /** {zh}
+     * @brief 未查询到网络状态。
+     *
+     */
     /** {en}
      * @brief Network status not found.
      *
      */
     VeLiveNetworkQualityUnknown = -1,
-    
+    /** {zh}
+     * @brief 网络差。
+     *
+     */
     /** {en}
      * @brief Bad network condition.
      *
      */
     VeLiveNetworkQualityBad = 0,
-    
+    /** {zh}
+     * @brief 网络一般。
+     *
+     */
     /** {en}
      * @brief Poor network condition.
      *
      */
     VeLiveNetworkQualityPoor = 1,
-    
+    /** {zh}
+     * @brief 网络状态佳。
+     *
+     */
     /** {en}
      * @brief Good network condition.
      *
@@ -40,13 +58,19 @@ export declare enum VeLiveNetworkQuality {
     VeLiveNetworkQualityGood = 2
 }
 export declare enum VeLiveAudioChannel {
-    
+    /** {zh}
+     * @brief 单声道，适用于语音通信，节省带宽。
+     *
+     */
     /** {en}
      * @brief Mono, which is suitable for voice communication and saves bandwidth.
      *
      */
     VeLiveAudioChannelMono = 1,
-    
+    /** {zh}
+     * @brief 立体声，适用于音乐播放，提供更丰富的音频体验。
+     *
+     */
     /** {en}
      * @brief Stereo, which provides a richer audio experience and is suitable for music playback.
      *
@@ -54,25 +78,37 @@ export declare enum VeLiveAudioChannel {
     VeLiveAudioChannelStereo = 2
 }
 export declare enum VeLiveVideoEncodeFrameType {
-    
+    /** {zh}
+     * @brief IDR 帧类型，关键帧，帧序列中的第一帧或者在视频切换点的帧。
+     *
+     */
     /** {en}
      * @brief IDR frame.
      *
      */
     VeLiveVideoEncodeFrameTypeIDR = 1,
-    
+    /** {zh}
+     * @brief SPS/PPS 帧类型，序列参数集 SPS 和图像参数集 PPS 帧，通常与 IDR 帧一起发送。
+     *
+     */
     /** {en}
      * @brief SPS/PPS frame.
      *
      */
     VeLiveVideoEncodeFrameTypeSPSPPS = 2,
-    
+    /** {zh}
+     * @brief B 帧类型，双向预测内插帧，根据前后帧来预测当前帧的内容。
+     *
+     */
     /** {en}
      * @brief B frame.
      *
      */
     VeLiveVideoEncodeFrameTypeB = 3,
-    
+    /** {zh}
+     * @brief P 帧类型，向前预测帧，只根据前一帧来预测当前帧的内容。
+     *
+     */
     /** {en}
      * @brief P frame.
      *
@@ -80,56 +116,83 @@ export declare enum VeLiveVideoEncodeFrameType {
     VeLiveVideoEncodeFrameTypeP = 4
 }
 export declare class VeLiveVideoEncoderConfiguration {
-    
+    /** {zh}
+     * @brief 推流视频分辨率，默认值为 VeLiveVideoResolution720P，详情请参见 [VeLiveVideoResolution](#VeLiveVideoResolution)。
+     */
     /** {en}
      * @brief The video resolution. See [VeLiveVideoResolution](#VeLiveVideoResolution) for details. The default value is `VeLiveVideoResolution720P`.
      */
     resolution: VeLiveVideoResolution;
-    
+    /** {zh}
+     * @brief 推流视频编码格式，默认值为 VeLiveVideoCodecH264，详情请参见 [VeLiveVideoCodec](#VeLiveVideoCodec)。
+     */
     /** {en}
      * @brief The video codec. The default value is `VeLiveVideoCodecH264`. See [VeLiveVideoCodec](#VeLiveVideoCodec) for details.
      */
     codec: VeLiveVideoCodec;
-    
+    /** {zh}
+     * @brief 视频目标编码码率，单位为 kbps，默认值由 `resolution` 参数值决定。
+     */
     /** {en}
      * @brief The target video encoding bitrate, in Kbps. The default value depends on the value of the `resolution` parameter.
      */
     bitrate: int;
-    
+    /** {zh}
+     * @brief 视频最小编码码率，单位为 kbps，默认值由 `resolution` 参数值决定；如果开启自适应码率，推流 SDK 根据网络情况进行编码码率自适应调整的最小码率。
+     */
     /** {en}
      * @brief The minimum video encoding bitrate, in Kbps, when the adaptive bitrate (ABR) feature is enabled. The default value depends on the value of the `resolution` parameter.
      */
     minBitrate: int;
-    
+    /** {zh}
+     * @brief 视频最大编码码率，单位为 kbps，默认值由 `resolution` 参数值决定；如果开启自适应码率，推流 SDK 根据网络情况进行编码码率自适应调整的最大码率。
+     */
     /** {en}
      * @brief The maximum video encoding bitrate, in Kbps, when the adaptive bitrate (ABR) feature is enabled. The default value depends on the value of the `resolution` parameter.
      */
     maxBitrate: int;
-    
+    /** {zh}
+     * @brief 视频 GOP 大小，单位为 s，默认值为 2。
+     */
     /** {en}
      * @brief The video GOP size, in seconds. The default value is `2`.
      */
     gopSize: int;
-    
+    /** {zh}
+     * @brief 视频编码帧率，单位为 fps，默认值为 15。
+     */
     /** {en}
      * @brief The encoded frame rate, in fps. The default value is `15`.
      */
     fps: int;
-    
+    /** {zh}
+     * @brief 是否启用 B 帧，默认值为 NO，支持的取值包括：<br>
+     *    - YES：开启；
+     *    - NO：关闭。
+     */
     /** {en}
      * @brief Whether to enable B frames. <br>
      *     - YES: Enable.
      *     - NO: (Default) Disable.
      */
     enableBFrame: BOOL;
-    
+    /** {zh}
+     * @brief 是否开启硬件编码。
+     *        - YES：(Default) 开启；
+     *        - NO：不开启。
+     */
     /** {en}
      * @brief Whether to enable hardware encoding.<br>
      *        - YES: (Default) Enable;
      *        - NO: Disable.
      */
     enableAccelerate: BOOL;
-    
+    /** {zh}
+     * @brief 初始化方法，用于创建一个 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration} 对象，并指定视频的分辨率。
+     * @param resolution 视频的分辨率，详情请参见 VeLiveVideoResolution{@link #VeLiveVideoResolution}。
+     * @return <br>
+     *       创建的 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration} 对象。
+     */
     /** {en}
      * @brief Creates a VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration} object and specifies the video resolution.
      * @param resolution The video resolution. See VeLiveVideoResolution {@link #VeLiveVideoResolution} for details.
@@ -139,13 +202,19 @@ export declare class VeLiveVideoEncoderConfiguration {
     initWithResolution(resolution: VeLiveVideoResolution): this;
 }
 export declare enum VeLiveVideoFrameSource {
-    
+    /** {zh}
+     * @brief 采集到的原始视频帧。这是从设备的摄像头或其他视频输入源获取的视频帧。
+     *
+     */
     /** {en}
      * @brief The original video frame captured by the camera or other video sources.
      *
      */
     VeLiveVideoFrameSourceCapture = 1,
-    
+    /** {zh}
+     * @brief 编码前的视频帧。这是通过各种处理（例如滤镜、旋转等）后，准备进行编码的视频帧。
+     *
+     */
     /** {en}
      * @brief The video frame prior to encoding after undergoing various processes, such as filtering and rotation.
      *
@@ -153,19 +222,28 @@ export declare enum VeLiveVideoFrameSource {
     VeLiveVideoFrameSourcePreEncode = 2
 }
 export declare enum VeLiveAudioBufferType {
-    
+    /** {zh}
+     * @brief 未知的音频数据类型。
+     *
+     */
     /** {en}
      * @brief Unknown data type.
      *
      */
     VeLiveAudioBufferTypeUnknown = -1,
-    
+    /** {zh}
+     * @brief 音频数据类型为 CMSampleBufferRef。
+     *
+     */
     /** {en}
      * @brief CMSampleBufferRef.
      *
      */
     VeLiveAudioBufferTypeSampleBuffer = 0,
-    
+    /** {zh}
+     * @brief 音频数据类型为 NSData。
+     *
+     */
     /** {en}
      * @brief NSData.
      *
@@ -173,27 +251,37 @@ export declare enum VeLiveAudioBufferType {
     VeLiveAudioBufferTypeNSData = 1
 }
 export declare class VeLivePusherConfiguration {
-    
+    /** {zh}
+     * @brief 视频采集参数设置，用于调整和设置视频采集相关的参数。详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
+     */
     /** {en}
      * @brief The video capture configurations. See [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration) for details.
      */
     videoCaptureConfig: VeLiveVideoCaptureConfiguration;
-    
+    /** {zh}
+     * @brief 音频采集参数设置，用于调整和设置音频采集相关的参数。详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)。
+     */
     /** {en}
      * @brief The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration) for details.
      */
     audioCaptureConfig: VeLiveAudioCaptureConfiguration;
-    
+    /** {zh}
+     * @brief 推流失败后，尝试重连的时间间隔。单位为 s，默认值为 5。
+     */
     /** {en}
      * @brief The time interval between each attempt to reconnect, in seconds. The default value is `5`.
      */
     reconnectIntervalSeconds: int;
-    
+    /** {zh}
+     * @brief 推流失败后，尝试重连的次数。默认值为 3。
+     */
     /** {en}
      * @brief The number of attempts to reconnect after the initial attempt fails. The default value is `3`.
      */
     reconnectCount: int;
-    
+    /** {zh}
+     * @brief 设置扩展参数，用于实现某些特殊功能或配置，默认不需要设置。
+     */
     /** {en}
      * @brief Advanced parameters. You can leave this parameter empty.
      */
@@ -201,43 +289,64 @@ export declare class VeLivePusherConfiguration {
     init(): this;
 }
 export declare enum VeLiveVideoCaptureType {
-    
+    /** {zh}
+     * @brief 使用前置摄像头进行视频采集。
+     *
+     */
     /** {en}
      * @brief Capture the video with the front-facing camera.
      *
      */
     VeLiveVideoCaptureFrontCamera = 0,
-    
+    /** {zh}
+     * @brief 使用后置摄像头进行视频采集。
+     *
+     */
     /** {en}
      * @brief Capture the video with the rear camera.
      *
      */
     VeLiveVideoCaptureBackCamera = 1,
-    
+    /** {zh}
+     * @brief 使用设备的双摄进行视频采集。
+     *
+     */
     /** {en}
      * @brief Capture the video with dual cameras.
      *
      */
     VeLiveVideoCaptureDualCamera = 2,
-    
+    /** {zh}
+     * @brief 使用外部设备或源进行视频采集。
+     *
+     */
     /** {en}
      * @brief Capture the video with an external device or source.
      *
      */
     VeLiveVideoCaptureExternal = 4,
-    
+    /** {zh}
+     * @brief 使用指定的静态图片作为视频源。
+     *
+     */
     /** {en}
      * @brief Use a static image as the video source.
      *
      */
     VeLiveVideoCaptureCustomImage = 5,
-    
+    /** {zh}
+     * @brief 使用最近采集的一帧图像重复作为视频源。
+     *
+     */
     /** {en}
      * @brief Use the last frame as the video source.
      *
      */
     VeLiveVideoCaptureLastFrame = 6,
-    
+    /** {zh}
+     * @brief 使用黑色帧作为视频源，一般用于调试或特殊需求。
+     *
+     */
     /** {en}
      * @brief Use a black frame as the video source. This is usually used for debugging purposes or in special circumstances.
      *
@@ -245,23 +354,32 @@ export declare enum VeLiveVideoCaptureType {
     VeLiveVideoCaptureDummyFrame = 7
 }
 export declare class VeLiveFileRecorderConfiguration {
-    
+    /** {zh}
+     * @brief 录制的视频宽度，单位为 px，默认值为 360。
+     */
     /** {en}
      * @brief The width of the recorded video, in pixels. The default value is `360`.
      */
     width: int;
-    
+    /** {zh}
+     * @brief 录制的视频高度，单位为 px，默认值为 640。
+     */
     /** {en}
      * @brief The height of the recorded video, in pixels. The default value is `640`.
      */
     height: int;
-    
+    /** {zh}
+     * @deprecated
+     * @brief 录制的视频帧率，默认值为 15，取值范围为 [1,15]。
+     */
     /** {en}
      * @deprecated
      * @brief The frame rate of the recorded video. The default value is `15`. The value range is [1,15].
      */
     fps: int;
-    
+    /** {zh}
+     * @brief 录制的视频编码码率，单位为 kbps，默认值为 2000。
+     */
     /** {en}
      * @brief The encoding bitrate of the recorded video, in Kbps. The default value is `2000`.
      */
@@ -269,31 +387,46 @@ export declare class VeLiveFileRecorderConfiguration {
     init(): this;
 }
 export declare enum VeLiveVideoBufferType {
-    
+    /** {zh}
+     * @brief 未知视频数据类型，当未指定输入视频数据的格式时，会默认为此类型。
+     *
+     */
     /** {en}
      * @brief Unknown data type, which is the default type if you do not specify any type.
      *
      */
     VeLiveVideoBufferTypeUnKnown = -1,
-    
+    /** {zh}
+     * @brief 视频数据类型为 CVPixelBuffer。
+     *
+     */
     /** {en}
      * @brief CVPixelBuffer.
      *
      */
     VeLiveVideoBufferTypePixelBuffer = 0,
-    
+    /** {zh}
+     * @brief 视频数据类型为 CMSampleBufferRef。
+     *
+     */
     /** {en}
      * @brief CMSampleBufferRef.
      *
      */
     VeLiveVideoBufferTypeSampleBuffer = 1,
-    
+    /** {zh}
+     * @brief 视频数据类型为 NSData。
+     *
+     */
     /** {en}
      * @brief NSData.
      *
      */
     VeLiveVideoBufferTypeNSData = 2,
-    
+    /** {zh}
+     * @brief 视频数据类型为 OpenGL 纹理。
+     *
+     */
     /** {en}
      * @brief OpenGL texture.
      *
@@ -301,47 +434,68 @@ export declare enum VeLiveVideoBufferType {
     VeLiveVideoBufferTypeTexture = 3
 }
 export declare class VeLiveMixVideoLayout {
-    
+    /** {zh}
+     * @brief 视频流 ID，唯一标识，用于区分不同的视频流。
+     */
     /** {en}
      * @brief The unique identifier for a video stream.
      */
     streamId: int;
-    
+    /** {zh}
+     * @brief 视频流对应区域左上角的横坐标，该坐标是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。
+     */
     /** {en}
      * @brief The horizontal offset, which represents the ratio of the distance between the left edge of the video and the left edge of the screen to the width of the screen. The value range is [0.0,1.0], where `0.0` indicates the left edge and `1.0` indicates the right edge.
      */
     x: float;
-    
+    /** {zh}
+     * @brief 视频流对应区域左上角的纵坐标，该坐标是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。
+     */
     /** {en}
      * @brief The vertical offset, which represents the ratio of the distance between the top edge of the video and the top edge of the screen to the height of the screen. The value range is [0.0,1.0], where `0.0` indicates the top edge and `1.0` indicates the bottom edge.
      */
     y: float;
-    
+    /** {zh}
+     * @brief 视频流对应区域宽度，该宽度是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。
+     */
     /** {en}
      * @brief The ratio of the video width to the screen width. The value range is [0.0,1.0], where `1.0` indicates that the video occupies the entire screen width.
      */
     width: float;
-    
+    /** {zh}
+     * @brief 视频流对应区域高度，该高度是相对整体画面的归一化比例，取值的范围为 [0.0,1.0]。
+     */
     /** {en}
      * @brief The ratio of the video height to the screen height. The value range is [0.0,1.0], where `1.0` indicates that the video occupies the entire screen height.
      */
     height: float;
-    
+    /** {zh}
+     * @brief 视频流在混流中的透明度，取值范围为 [0.0,1.0]，取值 0.0 表示全透明，取值 1.0 表示不透明。
+     */
     /** {en}
      * @brief The video transparency. The value range is [0.0, 1.0], where `0.0` indicates full transparency and `1.0` indicates full opacity.
      */
     alpha: float;
-    
+    /** {zh}
+     * @brief 视频流在混流中的层级。取值范围为 [0,100]，取值 0 表示最底层，取值越大，层级越高。
+     */
     /** {en}
      * @brief The level of video within the final mixed video. The value range is [0,100], where `0` represents the bottom layer. The higher the value, the higher the level of the video in the final output.
      */
     zOrder: int;
-    
+    /** {zh}
+     * @brief 视频流的渲染模式。详情请参见 [VeLivePusherRenderMode](#VeLivePusherRenderMode)。
+     */
     /** {en}
      * @brief The render mode of the video. See [VeLivePusherRenderMode](#VeLivePusherRenderMode) for details.
      */
     renderMode: VeLivePusherRenderMode;
-    
+    /** {zh}
+     * @brief 是否保留视频流原 Alpha 通道值，默认为保留，当 [alpha](#VeLiveMixVideoLayout-alpha) 取值在 [0.0, 1.0] 之间时，则忽略该配置。<br/>
+     *
+     *        - YES：保留；
+     *        - NO：不保留。
+     */
     /** {en}
      * @brief Whether to retain the original Alpha channel value of the video stream. The default is retain. When the value of [alpha](#VeLiveMixVideoLayout-alpha) is within the range of [0.0, 1.0], this configuration is ignored.<br/>
      *
@@ -352,12 +506,17 @@ export declare class VeLiveMixVideoLayout {
     init(): this;
 }
 export declare class VeLiveMixAudioLayout {
-    
+    /** {zh}
+     * @brief 音频流 ID，唯一标识，用于区分不同的音频流。
+     */
     /** {en}
      * @brief The unique identifier for an audio stream.
      */
     streamId: int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 混流音频的音量，范围为 [0.0,4.0]。当你将 [VeLiveAudioMixType](#VeLiveAudioMixType) 设置为 `VeLiveAudioMixPlayAndPush` 时，该属性同时控制混流音频在拉流端和本地的播放音量。
+     */
     /** {en}
      * @detail api
      * @brief The volume of the mixed audio stream. The value range is [0.0,4.0]. If you set [VeLiveAudioMixType](#VeLiveAudioMixType) to `VeLiveAudioMixPlayAndPush`, this property takes effect on both the host and the audience sides.
@@ -366,19 +525,28 @@ export declare class VeLiveMixAudioLayout {
     init(): this;
 }
 export declare enum VeLiveAudioProfile {
-    
+    /** {zh}
+     * @brief LC-AAC 编码方式。
+     *
+     */
     /** {en}
      * @brief LC-AAC.
      *
      */
     VeLiveAudioAACProfileLC = 0,
-    
+    /** {zh}
+     * @brief HEv1-AAC 编码方式。
+     *
+     */
     /** {en}
      * @brief HEv1-AAC.
      *
      */
     VeLiveAudioAACProfileHEv1 = 1,
-    
+    /** {zh}
+     * @brief HEv2-AAC 编码方式。
+     *
+     */
     /** {en}
      * @brief HEv2-AAC.
      *
@@ -386,57 +554,79 @@ export declare enum VeLiveAudioProfile {
     VeLiveAudioAACProfileHEv2 = 2
 }
 export declare class VeLiveVideoFrame {
-    
+    /** {zh}
+     * @brief 视频数据包装格式。默认值为 VeLiveVideoBufferTypeUnknown，详情请参见 [VeLiveVideoBufferType](#VeLiveVideoBufferType)。
+     */
     /** {en}
      * @brief The video buffer type. The default value is `VeLiveVideoBufferTypeUnknown`. See [VeLiveVideoBufferType](#VeLiveVideoBufferType) for details.
      */
     bufferType: VeLiveVideoBufferType;
-    
+    /** {zh}
+     * @brief 视频帧像素格式。bufferType 为 VeLiveVideoBufferTypeNSData 时，需要指定数据格式。详情请参见 [VeLivePixelFormat](#VeLivePixelFormat)。
+     */
     /** {en}
      * @brief The pixel format. When `bufferType` is `VeLiveVideoBufferTypeNSData`, you must specify `pixelFormat`. See [VeLivePixelFormat](#VeLivePixelFormat) for details.
      */
     pixelFormat: VeLivePixelFormat;
-    
+    /** {zh}
+     * @brief 视频帧顺时针旋转角度。详情请参见 [VeLiveVideoRotation](#VeLiveVideoRotation)。
+     */
     /** {en}
      * @brief The rotation angle in a clockwise direction. See [VeLiveVideoRotation](#VeLiveVideoRotation) for details.
      */
     rotation: VeLiveVideoRotation;
-    
+    /** {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 视频帧时间戳，单位为 μs。
+     */
     /** {en}
      * @brief The timestamp of the video frame, in μs.
      */
     pts: CMTime;
-    
+    /** {zh}
+     * @brief `bufferType` 为 `VeLiveVideoBufferTypeTexture` 时的视频数据。
+     */
     /** {en}
      * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypeTexture`.
      */
     textureId: GLuint;
-    
+    /** {zh}
+     * @brief `bufferType` 为 `VeLiveVideoBufferTypePixelBuffer` 时的视频数据。
+     */
     /** {en}
      * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypePixelBuffer`.
      */
     pixelBuffer: CVPixelBufferRef;
-    
+    /** {zh}
+     * @brief `bufferType` 为 `VeLiveVideoBufferTypeSampleBuffer` 时的视频数据。
+     */
     /** {en}
      * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypeSampleBuffer`.
      */
     sampleBuffer: CMSampleBufferRef;
-    
+    /** {zh}
+     * @brief `bufferType` 为 `VeLiveVideoBufferTypeNSData` 时的视频数据。
+     */
     /** {en}
      * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypeNSData`.
      */
     data: NSData;
-    
+    /** {zh}
+     * @brief 释放回调函数，用于在 SDK 内部处理完 VideoFrame 后通知外部释放相关资源。此回调主要用于 SDK 外部为 VideoFrame 申请内存，以便 SDK 内部使用。但无法预知内部何时使用完毕。
+     */
     /** {en}
      * @brief Triggered when the SDK has completed processing the video frame and no longer needs the memory. You can release the memory for the video frame after receiving this callback.
      */
@@ -444,25 +634,37 @@ export declare class VeLiveVideoFrame {
     init(): this;
 }
 export declare enum VeLiveVideoFluencyLevel {
-    
+    /** {zh}
+     * @brief 流畅，帧率能达到预设的目标帧率。
+     *
+     */
     /** {en}
      * @brief Smooth. The frame rate reaches the expected rate.
      *
      */
     VeLiveVideoFluencyLevelSmooth = 0,
-    
+    /** {zh}
+     * @brief 一般卡顿，帧率比预设的目标帧率低 1fps～3fps。
+     *
+     */
     /** {en}
      * @brief Minor freeze. The frame rate is 1 to 3 fps lower than the expected rate.
      *
      */
     VeLiveVideoFluencyLevelSluggish = 1,
-    
+    /** {zh}
+     * @brief 严重卡顿，帧率比预设的目标帧率低 4fps 以上。
+     *
+     */
     /** {en}
      * @brief Severe freeze. The frame rate is 4 fps lower than the expected rate.
      *
      */
     VeLiveVideoFluencyLevelBlocked = 2,
-    
+    /** {zh}
+     * @brief 完全卡住，帧率低于 2fps。
+     *
+     */
     /** {en}
      * @brief Completely frozen. The frame rate is below 2 fps.
      *
@@ -470,19 +672,28 @@ export declare enum VeLiveVideoFluencyLevel {
     VeLiveVideoFluencyLevelStuck = 3
 }
 export declare enum VeLiveVideoMirrorType {
-    
+    /** {zh}
+     * @brief 对采集画面的镜像控制。开启时，预览和推流画面都会呈现为镜像状态。
+     *
+     */
     /** {en}
      * @brief Mirror the captured video. When turned on, both the preview and the pushed video are mirrored.
      *
      */
     VeLiveVideoMirrorCapture = 0,
-    
+    /** {zh}
+     * @brief 对预览画面的镜像控制。开启时，只有主播预览画面呈现镜像状态。
+     *
+     */
     /** {en}
      * @brief Mirror the preview. When turned on, only the preview is mirrored.
      *
      */
     VeLiveVideoMirrorPreview = 1,
-    
+    /** {zh}
+     * @brief 对编码前画面的镜像控制。开启时，主播推流画面呈现镜像状态。
+     *
+     */
     /** {en}
      * @brief Mirror the video before encoding. When turned on, only the pushed video is mirrored.
      *
@@ -490,12 +701,16 @@ export declare enum VeLiveVideoMirrorType {
     VeLiveVideoMirrorPushStream = 2
 }
 export declare class VeLiveAudioCaptureConfiguration {
-    
+    /** {zh}
+     * @brief 音频采样率，默认值为 `VeLiveAudioSampleRate44100`，详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
+     */
     /** {en}
      * @brief The sample rate. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details. The default value is `VeLiveAudioSampleRate44100`.
      */
     sampleRate: VeLiveAudioSampleRate;
-    
+    /** {zh}
+     * @brief 音频采集声道数，默认值为 `VeLiveAudioChannelStereo`，详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
+     */
     /** {en}
      * @brief The number of audio channels. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details. The default value is `VeLiveAudioChannelStereo`.
      */
@@ -503,7 +718,16 @@ export declare class VeLiveAudioCaptureConfiguration {
     init(): this;
 }
 export declare enum VeLiveVideoResolution {
-    
+    /** {zh}
+     * @brief 360P 分辨率。档位详细配置如下所示。
+     *        - 横屏分辨率：640x360
+     *        - 竖屏分辨率：360x640
+     *        - 帧率：15fps
+     *        - 目标码率：500kbps
+     *        - 最小码率：250kbps
+     *        - 最大码率：800kbps
+     *
+     */
     /** {en}
      * @brief 360P. The predefined configurations are as follows:
      *         - Resolution in landscape mode: 640x360
@@ -515,7 +739,16 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution360P = 0,
-    
+    /** {zh}
+     * @brief 480P 分辨率。档位详细配置如下所示。
+     *        - 横屏分辨率：864x480
+     *        - 竖屏分辨率：480x864
+     *        - 帧率：15fps
+     *        - 目标码率：800kbps
+     *        - 最小码率：320kbps
+     *        - 最大码率：1266kbps
+     *
+     */
     /** {en}
      * @brief 480P. The predefined configurations are as follows:
      *         - Resolution in landscape mode: 864x480
@@ -527,7 +760,16 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution480P = 1,
-    
+    /** {zh}
+     * @brief 540P 分辨率。档位详细配置如下所示。
+     *        - 横屏 960x540
+     *        - 竖屏 540x960
+     *        - 帧率：15fps
+     *        - 目标码率：1000kbps
+     *        - 最小码率：500kbps
+     *        - 最大码率：1520kbps
+     *
+     */
     /** {en}
      * @brief 540P. The predefined configurations are as follows:
      *         - Resolution in landscape mode: 960x540
@@ -539,7 +781,16 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution540P = 2,
-    
+    /** {zh}
+     * @brief 720P 分辨率。档位详细配置如下所示。
+     *        - 横屏 1280x720
+     *        - 竖屏 720x1280
+     *        - 帧率：15fps
+     *        - 目标码率：1200kbps
+     *        - 最小码率：800kbps
+     *        - 最大码率：1900kbps
+     *
+     */
     /** {en}
      * @brief 720P. The predefined configurations are as follows:
      *         - Resolution in landscape mode: 1280x720
@@ -551,7 +802,16 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution720P = 3,
-    
+    /** {zh}
+     * @brief 1080P 分辨率。档位详细配置如下所示。
+     *        - 横屏 1920x1080
+     *        - 竖屏 1080x1920
+     *        - 帧率：20 fps
+     *        - 目标码率：2500kbps
+     *        - 最小码率：1000kbps
+     *        - 最大码率：3800kbps
+     *
+     */
     /** {en}
      * @brief 1080P. The predefined configurations are as follows:
      *         - Resolution in landscape mode: 1920x1080
@@ -563,7 +823,14 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution1080P = 4,
-    
+    /** {zh}
+     * @brief 屏幕推流分辨率。档位详细配置如下所示。
+     *        - 帧率：15fps
+     *        - 目标码率：2500kbps
+     *        - 最小码率：1000kbps
+     *        - 最大码率：3800kbps
+     *
+     */
     /** {en}
      * @brief The resolution of the streamed screen. The predefined configurations are as follows:
      *         - Frame rate: 15 fps
@@ -575,25 +842,37 @@ export declare enum VeLiveVideoResolution {
     VeLiveVideoResolutionScreen = 10
 }
 export declare enum VeLiveVideoRotation {
-    
+    /** {zh}
+     * @brief 不旋转。
+     *
+     */
     /** {en}
      * @brief Do not rotate.
      *
      */
     VeLiveVideoRotation0 = 0,
-    
+    /** {zh}
+     * @brief 顺时针旋转 90 度。
+     *
+     */
     /** {en}
      * @brief Rotate by 90 degrees clockwise.
      *
      */
     VeLiveVideoRotation90 = 1,
-    
+    /** {zh}
+     * @brief 顺时针旋转 180 度。
+     *
+     */
     /** {en}
      * @brief Rotate by 180 degrees clockwise.
      *
      */
     VeLiveVideoRotation180 = 2,
-    
+    /** {zh}
+     * @brief 顺时针旋转 270 度。
+     *
+     */
     /** {en}
      * @brief Rotate by 270 degrees clockwise.
      *
@@ -601,17 +880,23 @@ export declare enum VeLiveVideoRotation {
     VeLiveVideoRotation270 = 3
 }
 export declare class VeLiveStreamMixDescription {
-    
+    /** {zh}
+     * @brief 视频混流布局设置的数组，其中每个元素代表一路视频流的布局。详情请参见 [VeLiveMixVideoLayout](#VeLiveMixVideoLayout)。
+     */
     /** {en}
      * @brief An array of video mixing configurations, where each array element represents the mixing configurations of a video stream. See [VeLiveMixVideoLayout](#VeLiveMixVideoLayout) for details.
      */
     mixVideoStreams: NSArray<VeLiveMixVideoLayout>;
-    
+    /** {zh}
+     * @brief 音频混流设置的数组，其中每个元素代表一路音频流的。详情请参见 [VeLiveMixAudioLayout](#VeLiveMixAudioLayout)。
+     */
     /** {en}
      * @brief An array of audio mixing configurations, where each array element represents the mixing configurations of an audio stream. See [VeLiveMixAudioLayout](#VeLiveMixAudioLayout) for details.
      */
     mixAudioStreams: NSArray<VeLiveMixAudioLayout>;
-    
+    /** {zh}
+     * @brief 视频混流画布的背景色设置，采用 #RRGGBB 格式。
+     */
     /** {en}
      * @brief The background color of the mixed video, in  #RRGGBB format.
      */
@@ -619,25 +904,37 @@ export declare class VeLiveStreamMixDescription {
     init(): this;
 }
 export declare enum VeLiveAudioCaptureType {
-    
+    /** {zh}
+     * @brief 使用默认麦克风设备进行音频采集。
+     *
+     */
     /** {en}
      * @brief Capture the audio with the default microphone.
      *
      */
     VeLiveAudioCaptureMicrophone = 0,
-    
+    /** {zh}
+     * @brief 使用语音通话模式进行音频采集，此模式下会启动硬件的 3A 功能，即自动增益控制、自动频率控制和自动噪声抑制。
+     *
+     */
     /** {en}
      * @brief Capture the audio in voice call mode, which will activate the 3A features of the hardware, including automatic gain control, automatic frequency control, and automatic noise suppression.
      *
      */
     VeLiveAudioCaptureVoiceCommunication = 1,
-    
+    /** {zh}
+     * @brief 使用外部设备或源进行音频采集。
+     *
+     */
     /** {en}
      * @brief Capture the audio with an external device or source.
      *
      */
     VeLiveAudioCaptureExternal = 2,
-    
+    /** {zh}
+     * @brief 使用静音帧作为音频源。
+     *
+     */
     /** {en}
      * @brief Use muted frames as the audio source.
      *
@@ -645,13 +942,19 @@ export declare enum VeLiveAudioCaptureType {
     VeLiveAudioCaptureMuteFrame = 3
 }
 export declare enum VeLiveVideoCodec {
-    
+    /** {zh}
+     * @brief 使用 H.264 视频编码。
+     *
+     */
     /** {en}
      * @brief H.264.
      *
      */
     VeLiveVideoCodecH264 = 0,
-    
+    /** {zh}
+     * @brief 使用火山引擎自研 ByteVC1 视频编码。
+     *
+     */
     /** {en}
      * @brief ByteVC1, an encoding format developed by BytePlus.
      *
@@ -659,22 +962,30 @@ export declare enum VeLiveVideoCodec {
     VeLiveVideoCodecByteVC1 = 1
 }
 export declare class VeLiveVideoEncodeFrame {
-    
+    /** {zh}
+     * @brief 编码帧展示时间戳，单位为 μs。
+     */
     /** {en}
      * @brief The display timestamp, in μs. The display timestamp indicates when the frame should be rendered.
      */
     pts: CMTime;
-    
+    /** {zh}
+     * @brief 编码帧 dts 时间，即解码时间戳，单位为 μs。
+     */
     /** {en}
      * @brief The dts time, or the decoding timestamp, in μs. The decoding timestamp indicates when the frame should be decoded.
      */
     dts: CMTime;
-    
+    /** {zh}
+     * @brief 编码帧的类型，详细请参见 [VeLiveVideoEncodeFrameType:](#VeLiveVideoEncodeFrameType)。
+     */
     /** {en}
      * @brief The type of the encoded frame. See [VeLiveVideoEncodeFrameType:](#VeLiveVideoEncodeFrameType) for details.
      */
     videoEcodeFrameType: VeLiveVideoEncodeFrameType;
-    
+    /** {zh}
+     * @brief 编码帧的数据，使用 NSData 表示。
+     */
     /** {en}
      * @brief The encoded data of the video frame. The encoded data is represented by an object of type NSData.
      */
@@ -682,22 +993,30 @@ export declare class VeLiveVideoEncodeFrame {
     init(): this;
 }
 export declare class VeLiveAudioEncoderConfiguration {
-    
+    /** {zh}
+     * @brief 音频编码码率，单位为 kbps，默认值为 64。
+     */
     /** {en}
      * @brief The audio encoding bitrate, in Kbps. The default value is `64`.
      */
     bitrate: int;
-    
+    /** {zh}
+     * @brief 音频编码采样率，默认值为 VeLiveAudioSampleRate44100，详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
+     */
     /** {en}
      * @brief The encoding sample rate. The default value is `VeLiveAudioSampleRate44100`. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
      */
     sampleRate: VeLiveAudioSampleRate;
-    
+    /** {zh}
+     * @brief 音频声道数，默认值为 VeLiveAudioChannelStereo，详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
+     */
     /** {en}
      * @brief The number of audio channels. The default value is `VeLiveAudioChannelStereo`. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
      */
     channel: VeLiveAudioChannel;
-    
+    /** {zh}
+     * @brief AAC 编码类型，默认值为 VeLiveAudioAACProfileLC。详情请参见 [VeLiveAudioProfile](#VeLiveAudioProfile)。
+     */
     /** {en}
      * @brief The AAC encoding format. The default value is `VeLiveAudioAACProfileLC`. See [VeLiveAudioProfile](#VeLiveAudioProfile) for details.
      */
@@ -705,37 +1024,55 @@ export declare class VeLiveAudioEncoderConfiguration {
     init(): this;
 }
 export declare enum VeLivePusherLogLevel {
-    
+    /** {zh}
+     * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output VERBOSE, DEBUG, INFO, WARNING and ERROR.
      *
      */
     VeLivePusherLogLevelVerbose = 0,
-    
+    /** {zh}
+     * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output DEBUG, INFO, WARNING and ERROR.
      *
      */
     VeLivePusherLogLevelDebug = 1,
-    
+    /** {zh}
+     * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output INFO, WARNING and ERROR.
      *
      */
     VeLivePusherLogLevelInfo = 2,
-    
+    /** {zh}
+     * @brief 输出 WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output WARNING and ERROR.
      *
      */
     VeLivePusherLogLevelWarn = 3,
-    
+    /** {zh}
+     * @brief 输出 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output ERROR.
      *
      */
     VeLivePusherLogLevelError = 4,
-    
+    /** {zh}
+     * @brief 关闭日志。
+     *
+     */
     /** {en}
      * @brief Disable logging.
      *
@@ -743,13 +1080,19 @@ export declare enum VeLivePusherLogLevel {
     VeLivePusherLogLevelNone = 5
 }
 export declare enum VeLiveAudioMixType {
-    
+    /** {zh}
+     * @brief 拉流端可以听到混音效果，本地无法听到。
+     *
+     */
     /** {en}
      * @brief The audience can hear the mixed audio, but the host cannot.
      *
      */
     VeLiveAudioMixPush = 0,
-    
+    /** {zh}
+     * @brief 拉流端和本地都可以听到混音效果。
+     *
+     */
     /** {en}
      * @brief Both the host and audience can hear the mixed audio.
      *
@@ -757,19 +1100,28 @@ export declare enum VeLiveAudioMixType {
     VeLiveAudioMixPlayAndPush = 1
 }
 export declare enum VeLivePusherRenderMode {
-    
+    /** {zh}
+     * @brief 视窗填满优先。视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。
+     *
+     */
     /** {en}
      * @brief Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
      *
      */
     VeLivePusherRenderModeHidden = 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 background color.
      *
      */
     VeLivePusherRenderModeFit = 1,
-    
+    /** {zh}
+     * @brief 视频帧自适应画布。视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化。
+     *
+     */
     /** {en}
      * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
      *
@@ -777,32 +1129,47 @@ export declare enum VeLivePusherRenderMode {
     VeLivePusherRenderModeFill = 2
 }
 export declare class VeLiveVideoEffectLicenseConfiguration {
-    
+    /** {zh}
+     * @brief 获取视频特效许可证类型。许可证类型请参见 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType)。
+     */
     /** {en}
      * @brief The special effects license type. See [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) for details.
      */
     type: VeLiveVideoEffectLicenseType;
-    
+    /** {zh}
+     * @brief 获取视频特效许可证的本地路径。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOffLine` 时，该属性返回许可证文件的本地路径。
+     */
     /** {en}
      * @brief The local path to the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOffLine`.
      */
     path: NSString;
-    
+    /** {zh}
+     * @brief 获取视频特效许可证的在线认证 key。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，该属性返回在线认证的 key。
+     */
     /** {en}
      * @brief The online authentication key for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
      */
     key: NSString;
-    
+    /** {zh}
+     * @brief 获取视频特效许可证的在线认证 secret。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，该属性返回在线认证的 secret。
+     */
     /** {en}
      * @brief The online authentication secret for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
      */
     secret: NSString;
-    
+    /** {zh}
+     * @brief 获取视频特效许可证的在线认证地址。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，该属性返回在线认证地址。
+     */
     /** {en}
      * @brief The online authentication address for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
      */
     url: NSString;
-    
+    /** {zh}
+     * @detail api
+     * @brief 初始化配置为本地验证模式。
+     * @param path 视频特效许可证的本地缓存路径。可通过 [path](#VeLiveVideoEffectLicenseConfiguration-path) 获取
+     * @return 返回 [VeLiveVideoEffectLicenseConfiguration](#VeLiveVideoEffectLicenseConfiguration) 类的实例，该实例使用指定的本地路径进行许可证验证。
+     */
     /** {en}
      * @detail api
      * @brief Initializes the license configurations in local authentication mode.
@@ -810,7 +1177,14 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
      * @return A [VeLiveVideoEffectLicenseConfiguration](#VeLiveVideoEffectLicenseConfiguration) object that uses the specified local path for license authentication.
      */
     initWithPath(path: NSString): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 初始化配置为在线验证模式。
+     * @param key 视频特效许可证的在线认证 key，可通过 [key](#VeLiveVideoEffectLicenseConfiguration-key) 获取。
+     * @param secret 视频特效许可证的在线认证 secret，可通过 [secret](#VeLiveVideoEffectLicenseConfiguration-secret) 获取。
+     * @param url 视频特效许可证的在线认证地址，如果传入 nil，会使用默认 url，可通过 [url](#VeLiveVideoEffectLicenseConfiguration-url) 获取在线认证地址。
+     * @return 返回 [VeLiveVideoEffectLicenseConfiguration](#VeLiveVideoEffectLicenseConfiguration) 类的实例，该实例使用指定的 key、secret 和 url 进行在线许可证验证。
+     */
     /** {en}
      * @detail api
      * @brief Initializes the license configurations in online authentication mode.
@@ -822,13 +1196,19 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
     initWithKey(key: NSString, secret: NSString, url: NSString): this;
 }
 export declare enum VeLiveAudioFrameSource {
-    
+    /** {zh}
+     * @brief 采集到的原始音频帧。这是从设备的麦克风或其他音频输入源获取的音频帧。
+     *
+     */
     /** {en}
      * @brief The original audio frame captured by the microphone or other audio sources.
      *
      */
     VeLiveAudioFrameSourceCapture = 1,
-    
+    /** {zh}
+     * @brief 编码前的音频帧。这是通过各种处理（例如噪音消除、回声消除等）后，准备进行编码的音频帧。
+     *
+     */
     /** {en}
      * @brief The audio frame prior to encoding after undergoing various processes, such as noise cancellation and echo cancellation.
      *
@@ -836,43 +1216,64 @@ export declare enum VeLiveAudioFrameSource {
     VeLiveAudioFrameSourcePreEncode = 2
 }
 export declare enum VeLivePushStatus {
-    
+    /** {zh}
+     * @brief 初始状态。
+     *
+     */
     /** {en}
      * @brief The initial state.
      *
      */
     VeLivePushStatusNone = 0,
-    
+    /** {zh}
+     * @brief 正在连接服务器。
+     *
+     */
     /** {en}
      * @brief Connecting to the server.
      *
      */
     VeLivePushStatusConnecting = 1,
-    
+    /** {zh}
+     * @brief 连接服务器成功。
+     *
+     */
     /** {en}
      * @brief The connection with the server is established.
      *
      */
     VeLivePushStatusConnectSuccess = 2,
-    
+    /** {zh}
+     * @brief 重连服务器中。
+     *
+     */
     /** {en}
      * @brief Reconnecting to the server.
      *
      */
     VeLivePushStatusReconnecting = 3,
-    
+    /** {zh}
+     * @brief 推流连接被终止。
+     *
+     */
     /** {en}
      * @brief Stops connecting to the server.
      *
      */
     VeLivePushStatusConnectStop = 4,
-    
+    /** {zh}
+     * @brief 推流连接失败。
+     *
+     */
     /** {en}
      * @brief Fails to connect to the server.
      *
      */
     VeLivePushStatusConnectError = 5,
-    
+    /** {zh}
+     * @brief 与服务器断开连接。
+     *
+     */
     /** {en}
      * @brief The connection with the server is lost.
      *
@@ -880,31 +1281,46 @@ export declare enum VeLivePushStatus {
     VeLivePushStatusDisconnected = 6
 }
 export declare enum VeLiveFirstFrameType {
-    
+    /** {zh}
+     * @brief 视频/音频采集首帧，采集首帧是从音频设备或视频设备（如麦克风、摄像头）获取的第一帧数据。
+     *
+     */
     /** {en}
      * @brief The first audio or video frame captured by the microphone or the camera.
      *
      */
     VeLiveFirstCaptureFrame = 0,
-    
+    /** {zh}
+     * @brief 视频渲染首帧，渲染首帧是在渲染过程中在屏幕上显示的第一帧视频数据。
+     *
+     */
     /** {en}
      * @brief The first video frame rendered, which is the first frame displayed on the screen.
      *
      */
     VeLiveFirstRenderFrame = 1,
-    
+    /** {zh}
+     * @brief 视频/音频编码完成首帧，编码完成首帧是编码为某种特定格式的第一帧数据。
+     *
+     */
     /** {en}
      * @brief The first audio or video frame encoded.
      *
      */
     VeLiveFirstEncodedFrame = 2,
-    
+    /** {zh}
+     * @brief 视频/音频发送首帧，发送首帧是在发送过程中，通过网络传输的第一帧数据。
+     *
+     */
     /** {en}
      * @brief The first audio or video frame transmitted through the network.
      *
      */
     VeLiveFirstSendFrame = 3,
-    
+    /** {zh}
+     * @brief 录屏采集开始后，获得的第一个 app 音频帧。
+     *
+     */
     /** {en}
      * @brief The first audio frame captured from the app after screen streaming starts.
      *
@@ -912,7 +1328,10 @@ export declare enum VeLiveFirstFrameType {
     VeLiveFirstAppAudioCaptureFrame = 4
 }
 export declare enum VeLiveAudioSampleRate {
-    
+    /** {zh}
+     * @brief 44.1k 采样，适用于大多数音频处理场景，是音乐 CD 的标准采样率。
+     *
+     */
     /** {en}
      * @brief 44.1K. This sample rate is suitable for most audio processing scenarios, and is the standard sampling rate for music CDs.
      *
@@ -920,82 +1339,114 @@ export declare enum VeLiveAudioSampleRate {
     VeLiveAudioSampleRate44100 = 44100
 }
 export declare class VeLivePusherStatistics {
-    
+    /** {zh}
+     * @brief 视频采集宽度，单位为 px。
+     */
     /** {en}
      * @brief The width of the captured video, in pixels.
      */
     captureWidth: int;
-    
+    /** {zh}
+     * @brief 视频采集高度，单位为 px。
+     */
     /** {en}
      * @brief The height of the captured video, in pixels.
      */
     captureHeight: int;
-    
+    /** {zh}
+     * @brief 视频采集帧率，单位为 fps。
+     */
     /** {en}
      * @brief The captured frame rate, in fps.
      */
     captureFps: int;
-    
+    /** {zh}
+     * @brief 视频编码宽度，单位为 px。
+     */
     /** {en}
      * @brief The width of the encoded video, in pixels.
      */
     encodeWidth: int;
-    
+    /** {zh}
+     * @brief 视频编码高度，单位为 px。
+     */
     /** {en}
      * @brief The height of the encoded video, in pixels.
      */
     encodeHeight: int;
-    
+    /** {zh}
+     * @brief 视频编码帧率，单位为 fps。
+     */
     /** {en}
      * @brief The encoded frame rate, in fps.
      */
     encodeFps: int;
-    
+    /** {zh}
+     * @brief 视频编码码率，单位为 kbps。
+     */
     /** {en}
      * @brief The encoded video bitrate, in Kbps.
      */
     encodeVideoBitrate: int;
-    
+    /** {zh}
+     * @brief 音频编码码率，单位为 kbps。
+     */
     /** {en}
      * @brief The encoded audio bitrate, in Kbps.
      */
     encodeAudioBitrate: int;
-    
+    /** {zh}
+     * @brief 视频发送帧率，可用展示实时帧率，单位为 fps。
+     */
     /** {en}
      * @brief The transmission frame rate, in fps. You can use this parameter to showcase the real-time frame rate on the user interface.
      */
     transportFps: int;
-    
+    /** {zh}
+     * @brief 视频发送码率，可用于展示实时码率，单位为 kbps。
+     */
     /** {en}
      * @brief The transmission bitrate, in Kbps. You can use this parameter to showcase the real-time bitrate on the user interface.
      */
     transportVideoBitrate: int;
-    
+    /** {zh}
+     * @brief 视频推流帧率，即您通过 setVideoEncoderConfiguration:{@link #VeLivePusher#setVideoEncoderConfiguration} 方法设置的帧率，单位为 fps。
+     */
     /** {en}
      * @brief The encoded frame rate you specify in the setVideoEncoderConfiguration:{@link #VeLivePusher#setVideoEncoderConfiguration} method, in fps.
      */
     fps: int;
-    
+    /** {zh}
+     * @brief 视频推流码率，即您通过 [setVideoEncoderConfiguration](155318#VeLivePusher-setvideoencoderconfiguration) 方法设置的码率，单位为 kbps。
+     */
     /** {en}
      * @brief The encoded bitrate you specify in the [setVideoEncoderConfiguration](docs-broadcast-sdk-for-ios-api#VeLivePusher-setvideoencoderconfiguration) method, in Kbps.
      */
     videoBitrate: int;
-    
+    /** {zh}
+     * @brief 视频推流最小码率，即您通过 [etVideoEncoderConfiguration:](155318#VeLivePusher-setvideoencoderconfiguration) 方法设置的最小码率，单位为 kbps。
+     */
     /** {en}
      * @brief The minimum encoded bitrate you specify in the [etVideoEncoderConfiguration:](docs-broadcast-sdk-for-ios-api#VeLivePusher-setvideoencoderconfiguration) method, in Kbps.
      */
     minVideoBitrate: int;
-    
+    /** {zh}
+     * @brief 视频推流最大码率，即您通过 setVideoEncoderConfiguration:{@link #VeLivePusher#setVideoEncoderConfiguration} 方法设置的最大码率，单位为 kbps。
+     */
     /** {en}
      * @brief The maximum encoded bitrate you specify in the setVideoEncoderConfiguration:{@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
      */
     maxVideoBitrate: int;
-    
+    /** {zh}
+     * @brief 推流地址。
+     */
     /** {en}
      * @brief The push stream address.
      */
     url: NSString;
-    
+    /** {zh}
+     * @brief 视频编码格式。
+     */
     /** {en}
      * @brief The video codec.
      */
@@ -1003,37 +1454,55 @@ export declare class VeLivePusherStatistics {
     init(): this;
 }
 export declare enum VeLivePixelFormat {
-    
+    /** {zh}
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @brief Unknown format.
      *
      */
     VeLivePixelFormatUnknown = -1,
-    
+    /** {zh}
+     * @brief I420 格式。
+     *
+     */
     /** {en}
      * @brief I420.
      *
      */
     VeLivePixelFormatI420 = 0,
-    
+    /** {zh}
+     * @brief NV12 格式。
+     *
+     */
     /** {en}
      * @brief NV12.
      *
      */
     VeLivePixelFormatNV12 = 1,
-    
+    /** {zh}
+     * @brief NV21 格式。
+     *
+     */
     /** {en}
      * @brief NV21 format.
      *
      */
     VeLivePixelFormatNV21 = 2,
-    
+    /** {zh}
+     * @brief RAGBA 格式。
+     *
+     */
     /** {en}
      * @brief RAGBA.
      *
      */
     VeLivePixelFormatBGRA32 = 3,
-    
+    /** {zh}
+     * @brief OpenGL 2D 纹理。
+     *
+     */
     /** {en}
      * @brief OpenGL 2D texture.
      *
@@ -1041,22 +1510,35 @@ export declare enum VeLivePixelFormat {
     VeLivePixelFormat2DTexture = 4
 }
 export declare class VeLiveVideoCaptureConfiguration {
-    
+    /** {zh}
+     * @brief 视频采集宽度，单位为 px，默认值为 720。
+     */
     /** {en}
      * @brief The width of the captured video, in pixels. The default value is `720`.
      */
     width: int;
-    
+    /** {zh}
+     * @brief 视频采集高度，单位为 px，默认值为 1280。
+     */
     /** {en}
      * @brief The height of the captured video, in pixels. The default value is `1280`.
      */
     height: int;
-    
+    /** {zh}
+     * @brief 视频采集帧率，单位为 fps，默认值为 15。
+     */
     /** {en}
      * @brief The captured frame rate, in fps. The default value is `15`.
      */
     fps: int;
-    
+    /** {zh}
+     * @brief 视频采集帧类型，默认为 kCVPixelFormatType_420YpCbCr8BiPlanarFullRange。
+     * @note 支持以下视频帧类型：
+     *       - kCVPixelFormatType_32BGRA
+     *       - kCVPixelFormatType_420YpCbCr8BiPlanarFullRange
+     *       - kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange
+     *       - kCVPixelFormatType_420YpCbCr10BiPlanarVideoRange
+     */
     /** {en}
      * @brief The pixel format. The default format is kCVPixelFormatType_420YpCbCr8BiPlanarFullRange.
      * @note The following formats are supported:
@@ -1069,32 +1551,44 @@ export declare class VeLiveVideoCaptureConfiguration {
     init(): this;
 }
 export declare class VeLiveAudioFrame {
-    
+    /** {zh}
+     * @brief 音频数据类型，默认值为 `VeLiveAudioBufferTypeUnknown`，详情请参见 [VeLiveAudioBufferType](#VeLiveAudioBufferType)。
+     */
     /** {en}
      * @brief The audio data type. The default value is `VeLiveAudioBufferTypeUnknown`. See [VeLiveAudioBufferType](#VeLiveAudioBufferType) for details.
      */
     bufferType: VeLiveAudioBufferType;
-    
+    /** {zh}
+     * @brief 音频采样率。详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
+     */
     /** {en}
      * @brief The audio sample rate. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
      */
     sampleRate: VeLiveAudioSampleRate;
-    
+    /** {zh}
+     * @brief 音频声道数。详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
+     */
     /** {en}
      * @brief The number of audio channels. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
      */
     channels: VeLiveAudioChannel;
-    
+    /** {zh}
+     * @brief 当 bufferType 取值为 `VeLiveAudioBufferNSData` 时的音频帧时间戳，单位为 μs。
+     */
     /** {en}
      * @brief The audio frame timestamp, in μs, when `bufferType` is `VeLiveAudioBufferNSData`.
      */
     pts: CMTime;
-    
+    /** {zh}
+     * @brief 当 bufferType 取值为 `VeLiveAudioBufferTypeSampleBuffer` 时的音频数据。
+     */
     /** {en}
      * @brief The audio data, when `bufferType` is `VeLiveAudioBufferTypeSampleBuffer`.
      */
     sampleBuffer: CMSampleBufferRef;
-    
+    /** {zh}
+     * @brief 当 bufferType 取值为 `VeLiveAudioBufferTypeNSData` 时的音频数据。音频帧数据为 float32 格式小端字节序存储。
+     */
     /** {en}
      * @brief The audio data, when `bufferType` is `VeLiveAudioBufferTypeNSData`. The audio data is of type float32 and is stored in little-endian byte order.
      */
@@ -1102,37 +1596,55 @@ export declare class VeLiveAudioFrame {
     init(): this;
 }
 export declare enum VeLiveAudioPowerLevel {
-    
+    /** {zh}
+     * @brief 无声，音量 ≤ 1dB。
+     *
+     */
     /** {en}
      * @brief Muted. The volume is 1 dB or less.
      *
      */
     VeLiveAudioPowerLevelSilent = 0,
-    
+    /** {zh}
+     * @brief 安静，音量 15dB 以下。
+     *
+     */
     /** {en}
      * @brief Quiet. The volume is below 15 dB.
      *
      */
     VeLiveAudioPowerLevelQuiet = 1,
-    
+    /** {zh}
+     * @brief 轻声，接近耳语音量，音量为 16dB～30dB 之间。
+     *
+     */
     /** {en}
      * @brief Soft, close to whisper. The volume is between 16 dB and 30 dB.
      *
      */
     VeLiveAudioPowerLevelLight = 2,
-    
+    /** {zh}
+     * @brief 正常，音量适宜，类似正常对话的音量，音量为 30dB～60dB 之间。
+     *
+     */
     /** {en}
      * @brief Normal, similar to the volume in a daily conversation. The volume is between 30 dB and 60 dB.
      *
      */
     VeLiveAudioPowerLevelNormal = 3,
-    
+    /** {zh}
+     * @brief 较大，音量较高，类似咖啡馆、餐厅的环境噪音，音量为 61dB～85dB 之间。
+     *
+     */
     /** {en}
      * @brief Loud, similar to the volume of the noise at cafes. The volume is between 61 dB and 85 dB.
      *
      */
     VeLiveAudioPowerLevelLoud = 4,
-    
+    /** {zh}
+     * @brief 吵闹，音量极高，类似于繁忙的街道或者是音乐会现场，音量超过 85dB。
+     *
+     */
     /** {en}
      * @brief Noisy, similar to the volume of the noise on a busy street or at a concert. The volume is higher than 85 dB.
      *