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

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

@@ -1,7 +1,12 @@
 import { int, long, Matrix, ByteBuffer, Runnable, double, String, ArrayList, float, Context, LiveSdkSetting } from './types';
 import { VeLivePusher } from './api';
 export declare class VeLiveVideoEncoderConfiguration {
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频分辨率。
+     * @return 推流视频分辨率 [VeLiveVideoResolution](#VeLivePusherDef-VeLiveVideoResolution)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the video resolution.
@@ -9,7 +14,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     getResolution(): VeLiveVideoResolution;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频分辨率。
+     * @param resolution 推流视频分辨率，默认值为 VeLiveVideoResolution720P，详情请参见 [VeLiveVideoResolution](#VeLivePusherDef-VeLiveVideoResolution)。
+     * @return 推流视频编码参数配置对象，详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the video resolution.
@@ -18,7 +29,12 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     setResolution(resolution: VeLiveVideoResolution): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码格式。
+     * @return 推流视频编码格式，详情请参见 [VeLiveVideoCodec](#VeLiveVideoCodec)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the video codec.
@@ -26,7 +42,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     getCodec(): VeLiveVideoCodec;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码格式。
+     * @param codec 推流视频编码格式，详情请参见 [VeLiveVideoCodec](#VeLiveVideoCodec) 。
+     * @return 推流视频编码参数，详见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the video codec.
@@ -35,7 +57,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     setCodec(codec: VeLiveVideoCodec): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码码率。
+     * @return <br>
+     *      推流视频编码码率。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Get the encoded video bitrate.
@@ -43,7 +71,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     getBitrate(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码码率。
+     * @param bitrate 推流视频编码码率，单位为 kbps，默认值由 `resolution` 参数值决定。
+     * @return 推流视频编码参数配置对象，详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the encoded video bitrate.
@@ -52,7 +86,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     setBitrate(bitrate: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码最小码率。
+     * @return <br>
+     *      推流视频编码最小码率。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the minimum encoded video bitrate.
@@ -60,7 +100,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     getMinBitrate(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码最小码率。
+     * @param minBitrate 推流视频编码最小码率，单位为 kbps，默认值由 `resolution` 参数值决定；如果开启自适应码率，推流 SDK 根据网络情况进行编码码率自适应调整的最小码率
+     * @return 推流视频编码参数配置对象，详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the minimum encoded video bitrate.
@@ -69,7 +115,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     setMinBitrate(minBitrate: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码最大码率。
+     * @return <br>
+     *      推流视频编码最大码率。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the maximum encoded video bitrate.
@@ -77,7 +129,14 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     getMaxBitrate(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码最大码率。
+     * @param maxBitrate 推流视频编码最大码率，单位为 kbps，默认值由 `resolution` 参数值决定；如果开启自适应码率，推流 SDK 根据网络情况进行编码码率自适应调整的最大码率。
+     * @return
+     *         推流视频编码参数配置对象，详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the maximum encoded video bitrate.
@@ -86,7 +145,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     setMaxBitrate(maxBitrate: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码 GOP。
+     * @return <br>
+     *      推流视频编码 GOP。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the encoded video GOP size.
@@ -94,7 +159,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     getGopSize(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码 GOP。
+     * @param gopSize 视频 GOP 大小，单位为 s，默认值为 2
+     * @return 推流视频编码参数配置对象，详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the encoded video GOP size.
@@ -103,7 +174,12 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     setGopSize(gopSize: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码帧率。
+     * @return 推流视频编码帧率。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the encoded frame rate.
@@ -111,7 +187,13 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     getFps(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码帧率。
+     * @param fps 视频编码帧率，单位为 fps，默认值为 15
+     * @return 推流视频编码参数配置对象，详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the encoded frame rate.
@@ -120,7 +202,14 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     setFps(fps: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取是否开启 B 帧。
+     * @return 是否开启B帧。<br/>
+     *         - true：B 帧开启；
+     *         - false：B 帧关闭。
+     *
+     */
     /** {en}
      * @detail api
      * @brief  Gets whether to enable B frames.
@@ -130,7 +219,15 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     isEnableBFrame(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码开启 B 帧。
+     * @param enableBFrame 是否开启 B 帧。默认为 false。 <br>
+     *               - true：开启；
+     *               - false：关闭。
+     * @return 推流视频编码参数配置对象，详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets whether to enable B frames.
@@ -141,7 +238,15 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     setEnableBFrame(enableBFrame: boolean): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取是否开启硬件编码。
+     * @return <br>
+     *      是否开启硬件编码。<br>
+     *         - true：开启；
+     *         - false：关闭。
+     *
+     */
     /** {en}
      * @detail api
      * @brief  Gets whether to enable hardware encoding.
@@ -151,7 +256,15 @@ export declare class VeLiveVideoEncoderConfiguration {
      *
      */
     isEnableAccelerate(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码开启硬件编码。
+     * @param enableAccelerate 是否开启硬件编码。默认值为 true。 <br>
+     *               - true：开启；
+     *               - false：关闭。
+     * @return 推流视频编码参数配置对象，详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Enables hardware encoding.
@@ -165,21 +278,34 @@ export declare class VeLiveVideoEncoderConfiguration {
 }
 export declare class VeLiveVideoFrame {
     constructor(width: int, height: int, pts: long, data: ArrayBuffer);
-    
+    /** {zh}
+     * @detail api
+     * @brief 增加 VeLiveVideoFrame 对象的引用计数。当您需要继续使用 VeLiveVideoFrame 对象时，请调用此方法将引用计数增加 1。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Increases the reference count of the `VeLiveVideoFrame` object. Call this method to increase the reference count by 1 if you need to continue using the `VeLiveVideoFrame` object.
      *
      */
     retain(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 释放对 VeLiveVideoFrame 对象的引用。在您不再需要使用 VeLiveVideoFrame 对象时，应调用此方法将引用计数减少 1。当引用计数减少到零，表示不再有引用指向该对象，可以安全地释放或销毁该对象。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Releases the reference to the `VeLiveVideoFrame` object. Call this method to reduce the reference count by 1 when you no longer need to use the `VeLiveVideoFrame` object. When the reference count is reduced to 0, it means there is no reference to the object, and the object can be safely released or destroyed.
      *
      */
     release(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频数据类型。
+     * @return 视频数据类型，详情请参见 [VeLiveVideoBufferType](#VeLiveVideoBufferType)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the data type of the video.
@@ -187,7 +313,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getBufferType(): VeLiveVideoBufferType;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频数据类型。
+     * @param bufferType 视频数据类型，详情请参见 [VeLiveVideoBufferType](#VeLiveVideoBufferType)。
+     * @return 视频帧对象，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the data type of the video.
@@ -196,7 +328,12 @@ export declare class VeLiveVideoFrame {
      *
      */
     setBufferType(bufferType: VeLiveVideoBufferType): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频像素格式。
+     * @return 视频像素格式，详情请参见 [VeLivePixelFormat](#VeLivePixelFormat)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the pixel format.
@@ -205,7 +342,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getPixelFormat(): VeLivePixelFormat;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频像素格式。
+     * @param pixelFormat 视频像素格式，详情请参见 [VeLivePixelFormat](#VeLivePixelFormat)。
+     * @return 视频帧对象，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the pixel format.
@@ -214,7 +357,12 @@ export declare class VeLiveVideoFrame {
      *
      */
     setPixelFormat(pixelFormat: VeLivePixelFormat): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频帧旋转角度。
+     * @return 视频帧旋转角度，详情请参见 [VeLiveVideoRotation](#VeLiveVideoRotation)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the rotation angle in a clockwise direction.
@@ -222,7 +370,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getRotation(): VeLiveVideoRotation;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频帧旋转角度。
+     * @param rotation 视频帧旋转角度，详情请参见 [VeLiveVideoRotation](#VeLiveVideoRotation)。
+     * @return 视频帧对象，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the rotation angle in a clockwise direction.
@@ -232,7 +386,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     setRotation(rotation: VeLiveVideoRotation): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频帧宽度。
+     * @return <br>
+     *     视频帧宽度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the width of the video frame.
@@ -241,7 +401,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getWidth(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频帧高度。
+     * @return <br>
+     *     视频帧高度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the height of the video frame.
@@ -250,7 +416,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getHeight(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取带旋转角度的视频帧宽度。
+     * @return <br>
+     *     带旋转角度的视频帧宽度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the width of the rotated video frame.
@@ -259,7 +431,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getRotatedWidth(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取带旋转角度的视频帧高度。
+     * @return <br>
+     *     带旋转角度的视频帧高度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the height of the rotated video frame.
@@ -268,7 +446,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getRotatedHeight(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频帧时间戳。
+     * @return <br>
+     *     视频帧时间戳，单位为 μs。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the timestamp of the video frame.
@@ -277,7 +461,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getPts(): long;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频帧纹理 ID。
+     * @return <br>
+     *     视频帧纹理 ID。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the texture ID.
@@ -286,7 +476,12 @@ export declare class VeLiveVideoFrame {
      *
      */
     getTextureId(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频帧纹理矩阵。
+     * @return 视频帧纹理矩阵。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the texture matrix.
@@ -294,7 +489,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getTextureMatrix(): Matrix;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取 ByteBuffer 格式的视频数据。
+     * @return <br>
+     *     ByteBuffer 格式的视频数据。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the video data in the format of ByteBuffer.
@@ -302,7 +503,12 @@ export declare class VeLiveVideoFrame {
      *
      */
     getBuffer(): ByteBuffer;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取 byte[] 格式的视频数据。
+     * @return byte[] 格式的视频数据。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the video data in the format of byte [].
@@ -310,7 +516,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getData(): ArrayBuffer;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频帧内部销毁回调。
+     * @return <br>
+     *     视频帧内部销毁回调。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the internal release callback.
@@ -318,7 +530,13 @@ export declare class VeLiveVideoFrame {
      *
      */
     getReleaseCallback(): Runnable;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频帧内部销毁回调。
+     * @param releaseCallback 视频帧内部销毁回调
+     * @return 视频帧对象，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the internal release callback.
@@ -329,19 +547,28 @@ export declare class VeLiveVideoFrame {
     setReleaseCallback(releaseCallback: Runnable): this;
 }
 export declare enum VeLiveAudioCodec {
-    
+    /** {zh}
+     * @brief FDKAAC 编码。
+     *
+     */
     /** {en}
      * @brief FDKAAC.
      *
      */
     VeLiveAudioCodecFdkAAC = 0,
-    
+    /** {zh}
+     * @brief Mediacodec AAC 编码。
+     *
+     */
     /** {en}
      * @brief Mediacodec AAC.
      *
      */
     VeLiveAudioCodecMediaCodecAAC = 1,
-    
+    /** {zh}
+     * @brief FFMPEG AAC 编码。
+     *
+     */
     /** {en}
      * @brief FFMPEG AAC.
      *
@@ -349,13 +576,19 @@ export declare enum VeLiveAudioCodec {
     VeLiveAudioCodecFFmpegAAC = 2
 }
 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.
      *
@@ -363,97 +596,145 @@ export declare enum VeLiveVideoCodec {
     VeLiveVideoCodecByteVC1 = 1
 }
 export declare class VeLivePusherStatistics {
-    
+    /** {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 视频采集宽度，单位为 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: double;
-    
+    /** {zh}
+     * @brief 视频编码帧率，单位为 fps。
+     *
+     */
     /** {en}
      * @brief The encoded frame rate, in fps.
      *
      */
     encodeFps: double;
-    
+    /** {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: double;
-    
+    /** {zh}
+     * @brief 视频推流帧率，即您通过 [setVideoEncoderConfiguration](147517#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](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的码率，单位为 kbps。
+     *
+     */
     /** {en}
      * @brief The encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
      *
      */
     videoBitrate: int;
-    
+    /** {zh}
+     * @brief 视频推流最小码率，即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最小码率，单位为 kbps。
+     *
+     */
     /** {en}
      * @brief The minimum encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
      *
      */
     minVideoBitrate: int;
-    
+    /** {zh}
+     * @brief 视频推流最大码率，即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最大码率，单位为 kbps。
+     *
+     */
     /** {en}
      * @brief The maximum encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
      *
      */
     maxVideoBitrate: int;
-    
+    /** {zh}
+     * @brief 视频编码码率，单位为 kbps。
+     *
+     */
     /** {en}
      * @brief The encoded video bitrate, in Kbps.
      *
      */
     encodeVideoBitrate: double;
-    
+    /** {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: double;
-    
+    /** {zh}
+     * @brief 音频编码码率，单位为 kbps。
+     *
+     */
     /** {en}
      * @brief The audio encoding bitrate, in Kbps.
      *
      */
     encodeAudioBitrate: double;
-    
+    /** {zh}
+     * @brief 推流地址。
+     *
+     */
     /** {en}
      * @brief The push stream address.
      *
      */
     url: String;
-    
+    /** {zh}
+     * @brief 视频编码格式。
+     *
+     */
     /** {en}
      * @brief The video codec.
      *
@@ -461,19 +742,28 @@ export declare class VeLivePusherStatistics {
     codec: String;
 }
 export declare enum VeLivePusherRenderMode {
-    
+    /** {zh}
+     * @brief 视频帧自适应画布。视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化。
+     *
+     */
     /** {en}
      * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
      *
      */
     VeLivePusherRenderModeFill = 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 Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
      *
@@ -481,13 +771,19 @@ export declare enum VeLivePusherRenderMode {
     VeLivePusherRenderModeHidden = 2
 }
 export declare enum VeLiveVideoEffectLicenseType {
-    
+    /** {zh}
+     * @brief 离线认证视频特效许可证。
+     *
+     */
     /** {en}
      * @brief Authenticate offline.
      *
      */
     VeLiveVideoEffectLicenseTypeOffLine = 0,
-    
+    /** {zh}
+     * @brief 在线认证视频特效许可证。
+     *
+     */
     /** {en}
      * @brief Authenticate online.
      *
@@ -495,13 +791,19 @@ export declare enum VeLiveVideoEffectLicenseType {
     VeLiveVideoEffectLicenseTypeOnLine = 1
 }
 export declare enum VeLiveAudioBufferType {
-    
+    /** {zh}
+     * @brief 未知的音频数据类型。
+     *
+     */
     /** {en}
      * @brief Unknown data type.
      *
      */
     VeLiveAudioBufferTypeUnknown = 0,
-    
+    /** {zh}
+     * @brief ByteBuffer 音频数据类型。
+     *
+     */
     /** {en}
      * @brief ByteBuffer.
      *
@@ -509,13 +811,19 @@ export declare enum VeLiveAudioBufferType {
     VeLiveAudioBufferTypeByteBuffer = 1
 }
 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.
      *
@@ -523,25 +831,37 @@ export declare enum VeLiveAudioChannel {
     VeLiveAudioChannelStereo = 2
 }
 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 in a certain format.
      *
      */
     VeLiveFirstEncodedFrame = 2,
-    
+    /** {zh}
+     * @brief 视频/音频发送首帧，发送首帧是在发送过程中，通过网络传输的第一帧数据。
+     *
+     */
     /** {en}
      * @brief The first audio or video frame transmitted through the network.
      *
@@ -549,48 +869,72 @@ export declare enum VeLiveFirstFrameType {
     VeLiveFirstSendFrame = 3
 }
 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.
      *
      */
-    
+    /** {zh}
+     * @brief 使用屏幕采集。
+     *
+     */
     /** {en}
      * @brief Capture the screen.
      *
      */
     VeLiveVideoCaptureScreen = 2,
-    
+    /** {zh}
+     * @brief 使用外部设备或源进行视频采集。
+     *
+     */
     /** {en}
      * @brief Capture the video with an external device or source.
      *
      */
     VeLiveVideoCaptureExternal = 3,
-    
+    /** {zh}
+     * @brief 使用指定的静态图片作为视频源。
+     *
+     */
     /** {en}
      * @brief Use a static image as the video source.
      *
      */
     VeLiveVideoCaptureCustomImage = 4,
-    
+    /** {zh}
+     * @brief 使用最近采集的一帧图像重复作为视频源。
+     *
+     */
     /** {en}
      * @brief Use the last frame as the video source.
      *
      */
     VeLiveVideoCaptureLastFrame = 5,
-    
+    /** {zh}
+     * @brief 使用黑色帧作为视频源，一般用于调试或特殊需求。
+     *
+     */
     /** {en}
      * @brief Use a black frame as the video source. This is usually used for debugging purposes or in special circumstances.
      *
@@ -598,31 +942,46 @@ export declare enum VeLiveVideoCaptureType {
     VeLiveVideoCaptureDummyFrame = 6
 }
 export declare enum VeLiveVideoProfile {
-    
+    /** {zh}
+     * @brief 未知的视频配置类型。
+     *
+     */
     /** {en}
      * @brief  Unknown codec.
      *
      */
     VeLiveVideoProfileUnknown = 0,
-    
+    /** {zh}
+     * @brief H.264 编码配置，使用 Baseline 级别。
+     *
+     */
     /** {en}
      * @brief  H.264, using Baseline level.
      *
      */
     VeLiveVideoProfileH264Baseline = 1,
-    
+    /** {zh}
+     * @brief H.264 编码配置，使用 Main 级别。
+     *
+     */
     /** {en}
      * @brief  H.264, using Main level.
      *
      */
     VeLiveVideoProfileH264Main = 2,
-    
+    /** {zh}
+     * @brief H.264 编码配置，使用 High 级别。
+     *
+     */
     /** {en}
      * @brief  H.264, using High level.
      *
      */
     VeLiveVideoProfileH264High = 3,
-    
+    /** {zh}
+     * @brief ByteVC1 编码配置，使用 Main 级别。
+     *
+     */
     /** {en}
      * @brief  ByteVC1, using Main level.
      *
@@ -630,25 +989,37 @@ export declare enum VeLiveVideoProfile {
     VeLiveVideoProfileByteVC1Main = 4
 }
 export declare enum VeLiveVideoRotation {
-    
+    /** {zh}
+     * @brief 不旋转。
+     *
+     */
     /** {en}
      * @brief Do not rotate.
      *
      */
     VeLiveVideoRotation0 = 0,
-    
+    /** {zh}
+     * @brief 顺时针旋转 90 度。
+     *
+     */
     /** {en}
      * @brief Rotate by 90 degrees clockwise.
      *
      */
     VeLiveVideoRotation90 = 90,
-    
+    /** {zh}
+     * @brief 顺时针旋转 180 度。
+     *
+     */
     /** {en}
      * @brief Rotate by 180 degrees clockwise.
      *
      */
     VeLiveVideoRotation180 = 180,
-    
+    /** {zh}
+     * @brief 顺时针旋转 270 度。
+     *
+     */
     /** {en}
      * @brief Rotate by 270 degrees clockwise.
      *
@@ -656,13 +1027,19 @@ export declare enum VeLiveVideoRotation {
     VeLiveVideoRotation270 = 270
 }
 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 to be encoded after undergoing various processes, such as filtering and rotation.
      *
@@ -670,19 +1047,28 @@ export declare enum VeLiveVideoFrameSource {
     VeLiveVideoFrameSourcePreEncode = "1 << 1"
 }
 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.
      *
@@ -690,25 +1076,37 @@ export declare enum VeLiveAudioProfile {
     VeLiveAudioAACProfileHEv2 = 2
 }
 export declare enum VeLiveVideoBufferType {
-    
+    /** {zh}
+     * @brief 未知视频数据类型，当未指定输入视频数据的格式时，会默认为此类型。
+     *
+     */
     /** {en}
      * @brief Unknown data type, which is the default type if you do not specify any type.
      *
      */
     VeLiveVideoBufferTypeUnknown = 0,
-    
+    /** {zh}
+     * @brief 视频数据类型为 OpenGL 纹理。
+     *
+     */
     /** {en}
      * @brief OpenGL texture.
      *
      */
     VeLiveVideoBufferTypeTexture = 1,
-    
+    /** {zh}
+     * @brief 视频数据类型为 ByteBuffer 类型。
+     *
+     */
     /** {en}
      * @brief ByteBuffer.
      *
      */
     VeLiveVideoBufferTypeByteBuffer = 2,
-    
+    /** {zh}
+     * @brief 视频数据类型为 ByteArray 类型。
+     *
+     */
     /** {en}
      * @brief ByteArray.
      *
@@ -716,7 +1114,12 @@ export declare enum VeLiveVideoBufferType {
     VeLiveVideoBufferTypeByteArray = 3
 }
 export declare class VeLiveAudioCaptureConfiguration {
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取采集音频采样率。
+     * @return 音频采样率，详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the sample rate.
@@ -724,7 +1127,13 @@ export declare class VeLiveAudioCaptureConfiguration {
      *
      */
     getSampleRate(): VeLiveAudioSampleRate;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置采集音频采样率。
+     * @param sampleRate 音频采样率，默认值为 VeLiveAudioSampleRate44100，详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
+     * @return 推流音频采集参数配置对象，详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the sample rate.
@@ -733,7 +1142,12 @@ export declare class VeLiveAudioCaptureConfiguration {
      *
      */
     setSampleRate(sampleRate: VeLiveAudioSampleRate): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取采集音频声道数。
+     * @return 音频声道数，详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the number of audio channels.
@@ -741,7 +1155,13 @@ export declare class VeLiveAudioCaptureConfiguration {
      *
      */
     getChannel(): VeLiveAudioChannel;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置采集音频声道数。
+     * @param channel 音频声道数，默认值为 VeLiveAudioChannelStereo，详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)
+     * @return 推流音频采集参数配置对象，详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the number of audio channels.
@@ -752,19 +1172,28 @@ export declare class VeLiveAudioCaptureConfiguration {
     setChannel(channel: VeLiveAudioChannel): this;
 }
 export declare class VeLiveStreamMixDescription {
-    
+    /** {zh}
+     * @brief 视频混流布局设置的数组，其中每个元素代表一路视频流的布局。详情请参见 [VeLiveMixVideoLayout](#VeLivePusherDef-VeLiveMixVideoLayout)。
+     *
+     */
     /** {en}
      * @brief An array of video mixing configurations, where each array element represents the mixing configurations of a video stream. See [VeLiveMixVideoLayout](#VeLivePusherDef-VeLiveMixVideoLayout) for details.
      *
      */
     mixVideoStreams: ArrayList<VeLiveMixVideoLayout>;
-    
+    /** {zh}
+     * @brief 音频混流设置的数组，其中每个元素代表一路音频流的。详情请参见 [VeLiveMixAudioLayout](#VeLivePusherDef-VeLiveMixAudioLayout)。
+     *
+     */
     /** {en}
      * @brief An array of audio mixing configurations, where each array element represents the mixing configurations of an audio stream. See [VeLiveMixAudioLayout](#VeLivePusherDef-VeLiveMixAudioLayout) for details.
      *
      */
     mixAudioStreams: ArrayList<VeLiveMixAudioLayout>;
-    
+    /** {zh}
+     * @brief 视频混流画布的背景色设置，采用 #RRGGBB 格式。
+     *
+     */
     /** {en}
      * @brief The background color of the mixed video, in #RRGGBB format.
      *
@@ -772,31 +1201,46 @@ export declare class VeLiveStreamMixDescription {
     backgroundColor: String;
 }
 export declare enum VeLiveAudioSampleRate {
-    
+    /** {zh}
+     * @brief 8k 采样。
+     *
+     */
     /** {en}
      * @brief 8K.
      *
      */
     VeLiveAudioSampleRate8000 = 8000,
-    
+    /** {zh}
+     * @brief 16k 采样。
+     *
+     */
     /** {en}
      * @brief 16K.
      *
      */
     VeLiveAudioSampleRate16000 = 16000,
-    
+    /** {zh}
+     * @brief 32k 采样。
+     *
+     */
     /** {en}
      * @brief 32K.
      *
      */
     VeLiveAudioSampleRate32000 = 32000,
-    
+    /** {zh}
+     * @brief 44.1k 采样。
+     *
+     */
     /** {en}
      * @brief 44.1K.
      *
      */
     VeLiveAudioSampleRate44100 = 44100,
-    
+    /** {zh}
+     * @brief 48k 采样。
+     *
+     */
     /** {en}
      * @brief 48K.
      *
@@ -804,37 +1248,55 @@ export declare enum VeLiveAudioSampleRate {
     VeLiveAudioSampleRate48000 = 48000
 }
 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.
      *
@@ -842,7 +1304,12 @@ export declare enum VeLiveAudioPowerLevel {
     VeLiveAudioPowerLevelNoise = 5
 }
 export declare class VeLiveVideoCaptureConfiguration {
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取采集视频宽度。
+     * @return 采集视频宽度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the width of the captured video.
@@ -850,7 +1317,13 @@ export declare class VeLiveVideoCaptureConfiguration {
      *
      */
     getWidth(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置采集视频宽度。
+     * @param width 采集视频宽度，默认值为 720。
+     * @return 推流视频采集参数配置对象，详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the width of the captured video.
@@ -859,7 +1332,13 @@ export declare class VeLiveVideoCaptureConfiguration {
      *
      */
     setWidth(width: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取采集视频高度。
+     * @return <br>
+     *      采集视频高度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the height of the captured video.
@@ -868,7 +1347,13 @@ export declare class VeLiveVideoCaptureConfiguration {
      *
      */
     getHeight(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置采集视频高度。
+     * @param height 采集视频高度，默认值为 1280。
+     * @return 推流视频采集参数配置对象，详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the height of the captured video.
@@ -877,7 +1362,13 @@ export declare class VeLiveVideoCaptureConfiguration {
      *
      */
     setHeight(height: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取采集视频帧率。
+     * @return <br>
+     *      采集视频帧率。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the captured frame rate.
@@ -885,7 +1376,13 @@ export declare class VeLiveVideoCaptureConfiguration {
      *
      */
     getFps(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置采集视频帧率。
+     * @param fps 采集视频帧率，默认值为 15。
+     * @return 推流视频采集参数配置对象，详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the captured frame rate.
@@ -896,37 +1393,55 @@ export declare class VeLiveVideoCaptureConfiguration {
     setFps(fps: int): this;
 }
 export declare enum VeLivePixelFormat {
-    
+    /** {zh}
+     * @brief 未知格式。
+     *
+     */
     /** {en}
      * @brief Unknown format.
      *
      */
     VeLivePixelFormatUnknown = 0,
-    
+    /** {zh}
+     * @brief I420 格式。
+     *
+     */
     /** {en}
      * @brief I420.
      *
      */
     VeLivePixelFormatI420 = 1,
-    
+    /** {zh}
+     * @brief NV12 格式。
+     *
+     */
     /** {en}
      * @brief NV12.
      *
      */
     VeLivePixelFormatNV12 = 2,
-    
+    /** {zh}
+     * @brief NV21 格式。
+     *
+     */
     /** {en}
      * @brief NV21.
      *
      */
     VeLivePixelFormatNV21 = 3,
-    
+    /** {zh}
+     * @brief 2D 纹理格式。
+     *
+     */
     /** {en}
      * @brief 2D texture.
      *
      */
     VeLivePixelFormat2DTexture = 4,
-    
+    /** {zh}
+     * @brief OES 纹理格式。
+     *
+     */
     /** {en}
      * @brief OES texture.
      *
@@ -934,43 +1449,64 @@ export declare enum VeLivePixelFormat {
     VeLivePixelFormatOesTexture = 5
 }
 export declare enum VeLivePusherStatus {
-    
+    /** {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.
      *
@@ -978,7 +1514,16 @@ export declare enum VeLivePusherStatus {
     VeLivePushStatusDisconnected = 6
 }
 export declare enum VeLiveVideoResolution {
-    
+    /** {zh}
+     * @brief 360P 分辨率。档位详细配置如下所示。
+     *        - 横屏分辨率：640x360
+     *        - 竖屏分辨率：360x640
+     *        - 帧率：15fps
+     *        - 目标码率：500kbps
+     *        - 最小码率：250kbps
+     *        - 最大码率：800kbps
+     *
+     */
     /** {en}
      * @brief 360P.
      *         - Resolution in landscape mode: 640x360
@@ -990,7 +1535,16 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution360P = "VeLiveVideoResolution360P",
-    
+    /** {zh}
+     * @brief 480P 分辨率。档位详细配置如下所示。
+     *        - 横屏分辨率：864x480
+     *        - 竖屏分辨率：480x864
+     *        - 帧率：15fps
+     *        - 目标码率：800kbps
+     *        - 最小码率：320kbps
+     *        - 最大码率：1266kbps
+     *
+     */
     /** {en}
      * @brief 480P.
      *         - Resolution in landscape mode: 864x480
@@ -1002,7 +1556,16 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution480P = "VeLiveVideoResolution480P",
-    
+    /** {zh}
+     * @brief 540P 分辨率。档位详细配置如下所示。
+     *        - 横屏 960x540
+     *        - 竖屏 540x960
+     *        - 帧率：15fps
+     *        - 目标码率：1000kbps
+     *        - 最小码率：500kbps
+     *        - 最大码率：1520kbps
+     *
+     */
     /** {en}
      * @brief 540P.
      *         - Resolution in landscape mode: 960x540
@@ -1014,7 +1577,16 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution540P = "VeLiveVideoResolution540P",
-    
+    /** {zh}
+     * @brief 720P 分辨率。档位详细配置如下所示。
+     *        - 横屏 1280x720
+     *        - 竖屏 720x1280
+     *        - 帧率：15fps
+     *        - 目标码率：1200kbps
+     *        - 最小码率：800kbps
+     *        - 最大码率：1900kbps
+     *
+     */
     /** {en}
      * @brief 720P.
      *         - Resolution in landscape mode: 1280x720
@@ -1026,7 +1598,16 @@ export declare enum VeLiveVideoResolution {
      *
      */
     VeLiveVideoResolution720P = "VeLiveVideoResolution720P",
-    
+    /** {zh}
+     * @brief 1080P 分辨率。档位详细配置如下所示。
+     *        - 横屏 1920x1080
+     *        - 竖屏 1080x1920
+     *        - 帧率：20 fps
+     *        - 目标码率：2500kbps
+     *        - 最小码率：1000kbps
+     *        - 最大码率：3800kbps
+     *
+     */
     /** {en}
      * @brief 1080P.
      *         - Resolution in landscape mode: 1920x1080
@@ -1041,7 +1622,12 @@ export declare enum VeLiveVideoResolution {
 }
 export declare class VeLiveAudioFrame {
     constructor();
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取音频数据类型。
+     * @return 音频数据类型，详情请参见 [VeLiveAudioBufferType](#VeLiveAudioBufferType)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the audio data type.
@@ -1049,7 +1635,12 @@ export declare class VeLiveAudioFrame {
      *
      */
     getBufferType(): VeLiveAudioBufferType;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取音频采样率。
+     * @return 音频采样率，详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the audio sample rate.
@@ -1057,7 +1648,12 @@ export declare class VeLiveAudioFrame {
      *
      */
     getSampleRate(): VeLiveAudioSampleRate;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取音频声道数。
+     * @return 音频声道数，详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the number of audio channels.
@@ -1065,7 +1661,12 @@ export declare class VeLiveAudioFrame {
      *
      */
     getChannels(): VeLiveAudioChannel;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取每个声道的采样点数。
+     * @return 采样点数。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Get the number of sampling points of each channel.
@@ -1073,7 +1674,13 @@ export declare class VeLiveAudioFrame {
      *
      */
     getSamplesPerChannel(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取音频时间戳，单位为 μs。
+     * @return <br>
+     *     音频时间戳，单位为 μs。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the audio timestamp, in μs.
@@ -1082,7 +1689,13 @@ export declare class VeLiveAudioFrame {
      *
      */
     getPts(): long;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取音频数据。音频帧数据为小端字节序存储。
+     * @return <br>
+     *     格式为 ByteBuffer 的音频数据。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the audio data. The audio data is stored in little-endian byte order.
@@ -1093,25 +1706,37 @@ export declare class VeLiveAudioFrame {
     getBuffer(): ByteBuffer;
 }
 export declare enum VeLiveNetworkQuality {
-    
+    /** {zh}
+     * @brief 未查询到网络状态。
+     *
+     */
     /** {en}
      * @brief Network status not found.
      *
      */
     VeLiveNetworkQualityUnknown = 0,
-    
+    /** {zh}
+     * @brief 网络差。
+     *
+     */
     /** {en}
      * @brief Bad network condition.
      *
      */
     VeLiveNetworkQualityBad = 1,
-    
+    /** {zh}
+     * @brief 网络一般。
+     *
+     */
     /** {en}
      * @brief Poor network condition.
      *
      */
     VeLiveNetworkQualityPoor = 2,
-    
+    /** {zh}
+     * @brief 网络状态佳。
+     *
+     */
     /** {en}
      * @brief Good network condition.
      *
@@ -1119,37 +1744,55 @@ export declare enum VeLiveNetworkQuality {
     VeLiveNetworkQualityGood = 3
 }
 export declare enum VeLivePusherLogLevel {
-    
+    /** {zh}
+     * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output VERBOSE, DEBUG, INFO, WARNING and ERROR.
      *
      */
     VeLiveLogLevelVerbose = 0,
-    
+    /** {zh}
+     * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output DEBUG, INFO, WARNING and ERROR.
      *
      */
     VeLiveLogLevelDebug = 1,
-    
+    /** {zh}
+     * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output INFO, WARNING and ERROR.
      *
      */
     VeLiveLogLevelInfo = 2,
-    
+    /** {zh}
+     * @brief 输出 WARNING 和 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output WARNING and ERROR.
      *
      */
     VeLiveLogLevelWarn = 3,
-    
+    /** {zh}
+     * @brief 输出 ERROR 级别的日志。
+     *
+     */
     /** {en}
      * @brief Output ERROR.
      *
      */
     VeLiveLogLevelError = 4,
-    
+    /** {zh}
+     * @brief 关闭日志。
+     *
+     */
     /** {en}
      * @brief Disable logging.
      *
@@ -1157,7 +1800,10 @@ export declare enum VeLivePusherLogLevel {
     VeLiveLogLevelNone = 5
 }
 export declare enum VeLiveAudioBitDepth {
-    
+    /** {zh}
+     * @brief 16bit 位深度。
+     *
+     */
     /** {en}
      * @brief 16bit.
      *
@@ -1165,20 +1811,32 @@ export declare enum VeLiveAudioBitDepth {
     VeLiveAudioBitDepth16 = 16
 }
 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 variable takes effect on both the host and the audience sides.
      *
      */
     volume: float;
-    
+    /** {zh}
+     * @detail api
+     * @brief 更新音频混流设置。
+     * @param other 新的音频混流设置，详情请参见 [VeLiveMixAudioLayout](#VeLivePusherDef-VeLiveMixAudioLayout)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Updates audio mixing configurations.
@@ -1188,7 +1846,13 @@ export declare class VeLiveMixAudioLayout {
     update(other: VeLiveMixAudioLayout): void;
 }
 export declare class VeLivePusherConfiguration {
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流器推流失败后尝试重连的时间间隔。
+     * @param interval 时间间隔，单位为 s，默认值为 5
+     * @order 2
+     *
+     */
     /** {en}
      * @detail api
      * @brief  Sets the time interval between each attempt to reconnect.
@@ -1197,7 +1861,14 @@ export declare class VeLivePusherConfiguration {
      *
      */
     setReconnectIntervalSeconds(interval: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流器推流失败后尝试重连的时间间隔。
+     * @order 3
+     * @return <br>
+     *      时间间隔，单位为 s。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the time interval between each attempt to reconnect.
@@ -1207,7 +1878,13 @@ export declare class VeLivePusherConfiguration {
      *
      */
     getReconnectIntervalSeconds(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流器推流失败后尝试重连的次数。
+     * @param maxCount 重连次数，默认值为 3
+     * @order 4
+     *
+     */
     /** {en}
      * @detail api
      * @brief  Sets the number of attempts to reconnect after the initial attempt fails.
@@ -1216,7 +1893,14 @@ export declare class VeLivePusherConfiguration {
      *
      */
     setReconnectCount(maxCount: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流器推流失败后尝试重连的次数。
+     * @order 5
+     * @return <br>
+     *      重连次数。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the number of attempts to reconnect after the initial attempt fails.
@@ -1226,7 +1910,14 @@ export declare class VeLivePusherConfiguration {
      *
      */
     getReconnectCount(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频采集参数，用于调整和设置视频采集相关的参数。
+     * @order 6
+     * @param config 视频采集参数，详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
+     * @return 推流引擎初始化配置对象，详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the video capture configurations.
@@ -1237,7 +1928,13 @@ export declare class VeLivePusherConfiguration {
      *
      */
     setVideoCaptureConfig(config: VeLiveVideoCaptureConfiguration): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频采集参数，用于调整和设置视频采集相关的参数。
+     * @order 7
+     * @return 视频采集参数配置对象，详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the video capture configurations.
@@ -1246,7 +1943,14 @@ export declare class VeLivePusherConfiguration {
      *
      */
     getVideoCaptureConfig(): VeLiveVideoCaptureConfiguration;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置音频采集参数，用于调整和设置音频采集相关的参数。
+     * @order 7
+     * @param config 音频采集参数，详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
+     * @return 推流引擎初始化配置对象，详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the audio capture configurations.
@@ -1256,7 +1960,13 @@ export declare class VeLivePusherConfiguration {
      *
      */
     setAudioCaptureConfig(config: VeLiveAudioCaptureConfiguration): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取音频采集参数，用于调整和设置音频采集相关的参数。
+     * @order 8
+     * @return 音频采集参数配置对象，详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the audio capture configurations.
@@ -1265,7 +1975,14 @@ export declare class VeLivePusherConfiguration {
      *
      */
     getAudioCaptureConfig(): VeLiveAudioCaptureConfiguration;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置应用上下文。
+     * @order 9
+     * @param context 应用上下文。
+     * @return 推流引擎初始化配置对象，详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the context of the application.
@@ -1275,7 +1992,14 @@ export declare class VeLivePusherConfiguration {
      *
      */
     setContext(context: Context): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取应用上下文。
+     * @order 10
+     * @return <br>
+     *      应用上下文。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the context of the application.
@@ -1285,7 +2009,15 @@ export declare class VeLivePusherConfiguration {
      *
      */
     getContext(): Context;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置扩展参数，默认不需要设置。如果需要使用，您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
+     * @order 11
+     * @param params 扩展参数。
+     * @return
+     *         推流引擎初始化配置对象，详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets advanced parameters. You can leave this parameter empty. If you need to use it, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support.
@@ -1295,7 +2027,14 @@ export declare class VeLivePusherConfiguration {
      *
      */
     setExtraParameters(params: String): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取扩展参数。
+     * @order 12
+     * @return <br>
+     *      扩展参数。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets advanced parameters.
@@ -1305,7 +2044,13 @@ export declare class VeLivePusherConfiguration {
      *
      */
     getExtraParams(): LiveSdkSetting;
-    
+    /** {zh}
+     * @detail api
+     * @brief 构造推流引擎。
+     * @order 1
+     * @return 推流引擎，详情请参见 [VeLivePusher](147517#VeLivePusher)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Creates the live pusher.
@@ -1316,13 +2061,19 @@ export declare class VeLivePusherConfiguration {
     build(): VeLivePusher;
 }
 export declare enum VeLiveOrientation {
-    
+    /** {zh}
+     * @brief 横屏模式。
+     *
+     */
     /** {en}
      * @brief The landscape mode.
      *
      */
     VeLiveOrientationLandscape = 0,
-    
+    /** {zh}
+     * @brief 竖屏模式。
+     *
+     */
     /** {en}
      * @brief The portrait mode.
      *
@@ -1330,19 +2081,28 @@ export declare enum VeLiveOrientation {
     VeLiveOrientationPortrait = 1
 }
 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.
      *
@@ -1350,7 +2110,13 @@ export declare enum VeLiveVideoMirrorType {
     VeLiveVideoMirrorPushStream = 2
 }
 export declare class VeLiveFileRecorderConfiguration {
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取录制视频宽度。
+     * @return <br>
+     *      录制视频宽度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the width of the recorded video.
@@ -1358,7 +2124,13 @@ export declare class VeLiveFileRecorderConfiguration {
      *
      */
     getWidth(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置录制视频宽度。
+     * @param width 录制视频宽度，默认值为 360
+     * @return 推流本地文件录制配置对象，详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the width of the recorded video.
@@ -1367,7 +2139,13 @@ export declare class VeLiveFileRecorderConfiguration {
      *
      */
     setWidth(width: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取录制视频高度。
+     * @return <br>
+     *      录制视频高度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the height of the recorded video.
@@ -1375,7 +2153,13 @@ export declare class VeLiveFileRecorderConfiguration {
      *
      */
     getHeight(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置录制视频高度。
+     * @param height 录制视频宽度，默认值为 640。
+     * @return 推流本地文件录制配置对象，详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。<br/>
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the height of the recorded video.
@@ -1384,7 +2168,13 @@ export declare class VeLiveFileRecorderConfiguration {
      *
      */
     setHeight(height: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取录制视频帧率。
+     * @return <br>
+     *      录制视频帧率。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the frame rate of the recorded video.
@@ -1392,7 +2182,13 @@ export declare class VeLiveFileRecorderConfiguration {
      *
      */
     getFps(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置录制视频帧率。
+     * @param fps 录制视频帧率，默认值为 15。
+     * @return 推流本地文件录制配置对象，详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the frame rate of the recorded video.
@@ -1401,7 +2197,13 @@ export declare class VeLiveFileRecorderConfiguration {
      *
      */
     setFps(fps: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取录制视频码率。
+     * @return <br>
+     *      录制视频码率。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the bitrate of the recorded video.
@@ -1409,7 +2211,14 @@ export declare class VeLiveFileRecorderConfiguration {
      *
      */
     getBitrate(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置录制视频码率。
+     * @param bitrate 录制视频码率，单位为 kbps，默认值为 2000。
+     * @return
+     *         推流本地文件录制配置对象，详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the bitrate of the recorded video.
@@ -1420,55 +2229,84 @@ export declare class VeLiveFileRecorderConfiguration {
     setBitrate(bitrate: int): this;
 }
 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] 之间时，则忽略该配置。
+     *        - 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/>
      *
@@ -1477,7 +2315,12 @@ export declare class VeLiveMixVideoLayout {
      *
      */
     enableAlpha: boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 更新视频混流设置。
+     * @param other 新的视频混流设置，详情请参见 [VeLiveMixVideoLayout](#VeLivePusherDef-VeLiveMixVideoLayout)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Updates video mixing configurations.
@@ -1487,7 +2330,13 @@ export declare class VeLiveMixVideoLayout {
     update(other: VeLiveMixVideoLayout): void;
 }
 export declare class VeLiveVideoEffectLicenseConfiguration {
-    
+    /** {zh}
+     * @detail api
+     * @brief 初始化配置为本地验证模式。
+     * @param path 视频特效许可证的本地缓存路径。可通过 [getPath](#VeLiveVideoEffectLicenseConfiguration-getpath) 获取。
+     * @return 返回 VeLiveVideoEffectLicenseConfiguration 类的实例，该实例使用指定的本地路径进行许可证验证。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Initializes the license configurations in local authentication mode.
@@ -1496,7 +2345,15 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
      *
      */
     static create(path: String): VeLiveVideoEffectLicenseConfiguration;
-    
+    /** {zh}
+     * @detail api
+     * @brief 初始化配置为在线验证模式。
+     * @return <br>返回 VeLiveVideoEffectLicenseConfiguration 类的实例，该实例使用指定的 key、secret 和 url 进行在线许可证验证。
+     * @param key 视频特效许可证的在线认证 key。可通过 [getKey](#VeLiveVideoEffectLicenseConfiguration-getkey) 获取。
+     * @param secret 视频特效许可证的在线认证 secret。可通过 [getSecret](#VeLiveVideoEffectLicenseConfiguration-getsecret) 获取。
+     * @param url 视频特效许可证的在线认证地址，如果传入 `null`，可通过 [getUrl](147521#VeLiveVideoEffectLicenseConfiguration-geturl) 获取在线认证地址。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Initializes the license configurations in local authentication mode.
@@ -1505,7 +2362,12 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
      *
      */
     static create_key$secret$url(key: String, secret: String, url: String): VeLiveVideoEffectLicenseConfiguration;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证类型。
+     * @return 视频特效许可证类型，许可证类型请参见 [VeLiveVideoEffectLicenseType](147521#VeLiveVideoEffectLicenseType)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the special effects license type.
@@ -1513,7 +2375,12 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
      *
      */
     getType(): VeLiveVideoEffectLicenseType;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证的本地路径。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOffLine` 时，返回许可证文件的本地路径。
+     * @return 视频特效许可证的本地路径。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the local path to the video effects license. When [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOffLine`, return the local path of the license file.
@@ -1521,7 +2388,12 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
      *
      */
     getPath(): String;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证的在线认证 key。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，返回在线认证的 key。
+     * @return 视频特效许可证的在线认证 key。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the online authentication key for the video effects licenses, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
@@ -1529,7 +2401,12 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
      *
      */
     getKey(): String;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证的在线认证 secret。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，返回在线认证的 secret。
+     * @return 视频特效许可证的在线认证 secret。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the online authentication secret for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
@@ -1537,7 +2414,12 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
      *
      */
     getSecret(): String;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效许可证的在线认证地址。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时，返回在线认证地址。
+     * @return 视频特效许可证的在线认证地址。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the online authentication address for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
@@ -1547,13 +2429,19 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
     getUrl(): String;
 }
 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 to be encoded after undergoing various processes, such as noise cancellation and echo cancellation.
      *
@@ -1561,7 +2449,13 @@ export declare enum VeLiveAudioFrameSource {
     VeLiveAudioFrameSourcePreEncode = "1 << 1"
 }
 export declare class VeLiveAudioEncoderConfiguration {
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频编码码率。
+     * @return <br>
+     *      推流音频编码码率。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the audio encoding bitrate.
@@ -1569,7 +2463,13 @@ export declare class VeLiveAudioEncoderConfiguration {
      *
      */
     getBitrate(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频编码码率。
+     * @param bitrate 推流音频编码码率，单位为 kbps，默认值为 64。
+     * @return 推流音频编码参数配置对象，详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the audio encoding bitrate.
@@ -1578,7 +2478,12 @@ export declare class VeLiveAudioEncoderConfiguration {
      *
      */
     setBitrate(bitrate: int): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频采样率。
+     * @return 推流音频采样率。详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the encoding sample rate.
@@ -1586,7 +2491,13 @@ export declare class VeLiveAudioEncoderConfiguration {
      *
      */
     getSampleRate(): VeLiveAudioSampleRate;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频采样率。
+     * @param sampleRate 推流音频采样率，默认值为 VeLiveAudioSampleRate44100，详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
+     * @return 推流音频编码参数配置对象，详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the encoding sample rate.
@@ -1595,7 +2506,12 @@ export declare class VeLiveAudioEncoderConfiguration {
      *
      */
     setSampleRate(sampleRate: VeLiveAudioSampleRate): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频声道。
+     * @return 推流音频声道。详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the number of audio channels for streaming.
@@ -1603,7 +2519,13 @@ export declare class VeLiveAudioEncoderConfiguration {
      *
      */
     getChannel(): VeLiveAudioChannel;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频声道。
+     * @param channel 推流音频声道，默认值为 VeLiveAudioChannelStereo，详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
+     * @return 推流音频编码参数配置对象，详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the number of audio channels for streaming.
@@ -1612,7 +2534,12 @@ export declare class VeLiveAudioEncoderConfiguration {
      *
      */
     setChannel(channel: VeLiveAudioChannel): this;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频编码类型。
+     * @return 推流音频编码类型。详情请参见 [VeLiveAudioProfile](#VeLiveAudioProfile)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the audio encoding format.
@@ -1620,7 +2547,13 @@ export declare class VeLiveAudioEncoderConfiguration {
      *
      */
     getProfile(): VeLiveAudioProfile;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频编码类型。
+     * @param profile 推流音频编码类型，默认值为 VeLiveAudioAACProfileLC，详情请参见 [VeLiveAudioProfile](#VeLiveAudioProfile)。
+     * @return 推流音频编码参数配置对象，详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the audio encoding format.
@@ -1631,13 +2564,19 @@ export declare class VeLiveAudioEncoderConfiguration {
     setProfile(profile: VeLiveAudioProfile): this;
 }
 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.
      *
@@ -1645,31 +2584,46 @@ export declare enum VeLiveAudioMixType {
     VeLiveAudioMixPlayAndPush = 1
 }
 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 in screen recording.
      *
      */
     VeLiveAudioCaptureVoiceRecognition = 2,
-    
+    /** {zh}
+     * @brief 使用外部设备或源进行音频采集。
+     *
+     */
     /** {en}
      * @brief Capture the audio with an external device or source.
      *
      */
     VeLiveAudioCaptureExternal = 3,
-    
+    /** {zh}
+     * @brief 使用静音帧作为音频源。
+     *
+     */
     /** {en}
      * @brief Use muted frames as the audio source.
      *