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

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

@@ -2,7 +2,15 @@ import { int, float, String, EGLContext, View, Bitmap, long } from './types';
 import { VeLiveVideoEffectLicenseConfiguration, VeLivePusherLogLevel, VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveVideoFrame, VeLiveAudioFrame, VeLiveOrientation } from './keytype';
 import { VeLiveVideoEffectCallback, VeLiveVideoEffectHandleCallback, VeLivePusherObserver, VeLivePusherStatisticsObserver, VeLiveFileRecordingListener, VeLiveVideoFrameFilter, VeLiveAudioFrameFilter, VeLiveVideoFrameListener, VeLiveAudioFrameListener, VeLiveSnapshotListener, VeLiveMediaPlayerListener, VeLiveMediaPlayerFrameListener } from './callback';
 export declare class VeLiveCameraDevice {
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取相机支持帧率范围。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 3
+     * @return <br>
+     *      相机支持帧率范围。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the frame rate range supported by the camera.
@@ -13,7 +21,19 @@ export declare class VeLiveCameraDevice {
      *
      */
     getRealFpsRange(): Array<int>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭闪光灯。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 8
+     * @param enable 是否开启闪光灯。默认为 false。 <br>
+     *        - true：开启；
+     *        - false：关闭。
+     * @return <br>
+     *     - 0：开启/关闭成功；
+     *     - ≠0：开启/关闭失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Enables or disables the flashlight.
@@ -28,7 +48,17 @@ export declare class VeLiveCameraDevice {
      *
      */
     enableTorch(enable: boolean): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置摄像头的缩放倍数。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 5
+     * @param ratio 缩放倍数。默认为原尺寸。缩放倍数的取值范围为 [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)]。
+     * @return <br>
+     *     - 0：缩放成功；
+     *     - ≠0：缩放失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the zoom factor of the camera.
@@ -41,7 +71,16 @@ export declare class VeLiveCameraDevice {
      *
      */
     setZoomRatio(ratio: float): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头当前的缩放倍数。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 4
+     * @return <br>
+     *         - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示当前缩放倍数。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the current zoom factor of the camera.
@@ -53,7 +92,16 @@ export declare class VeLiveCameraDevice {
      *
      */
     getCurrentZoomRatio(): float;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头的最大缩放倍数。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 6
+     * @return <br>
+     *         - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示最大缩放倍数。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the maximum zoom factor of the camera.
@@ -65,7 +113,16 @@ export declare class VeLiveCameraDevice {
      *
      */
     getMaxZoomRatio(): float;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头的最小缩放倍数。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 7
+     * @return <br>
+     *         - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示最小缩放倍数。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the minimum zoom factor of the camera.
@@ -77,7 +134,16 @@ export declare class VeLiveCameraDevice {
      *
      */
     getMinZoomRatio(): float;
-    
+    /** {zh}
+     * @detail api
+     * @brief 是否支持自动对焦。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 9
+     * @return <br>
+     *     - true：支持；
+     *     - false：不支持。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Checks whether autofocus is supported.
@@ -89,7 +155,19 @@ export declare class VeLiveCameraDevice {
      *
      */
     isAutoFocusEnabled(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭自动对焦功能。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 10
+     * @param enable 是否开启自动对焦，默认为 true。
+     *     - true：开启；
+     *     - false：关闭。
+     * @return <br>
+     *     - 0：开启/关闭成功；
+     *     - ≠0：开启/关闭失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Enables or disables autofocus.
@@ -104,7 +182,20 @@ export declare class VeLiveCameraDevice {
      *
      */
     enableAutoFocus(enable: boolean): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置摄像头的对焦位置。
+     * @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 11
+     * @param viewW 当前视图宽度。
+     * @param viewH 当前视图高度。
+     * @param x 以左上角为原点，对焦点距当前视图的横向坐标值。
+     * @param y 以左上角为原点，对焦点距当前视图的纵向坐标值。
+     * @return <br>
+     *     - 0：设置成功；
+     *     - ≠0：设置失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the focus position of the camera.
@@ -120,7 +211,15 @@ export declare class VeLiveCameraDevice {
      *
      */
     setFocusPosition(viewW: int, viewH: int, x: int, y: int): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 检查当前使用的摄像头是否支持手动设置曝光点。
+     * @notes 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。
+     * @order 12
+     * @return - YES：支持；
+     *         - NO：不支持。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Checks if manual exposure setting is available for the currently used camera.
@@ -131,7 +230,20 @@ export declare class VeLiveCameraDevice {
      *
      */
     isExposurePositionSupported(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置当前使用的摄像头的曝光点。
+     * @notes - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集，并且使用 SDK 内部渲染时，才能设置曝光点；
+     *        - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后，设置的曝光点失效。
+     * @order 13
+     * @param viewW 当前视图宽度。
+     * @param viewH 当前视图高度。
+     * @param x 以左上角为原点，对焦点距当前视图的横向坐标值。
+     * @param y 以左上角为原点，对焦点距当前视图的纵向坐标值。
+     * @return - =0：成功；
+     *         - ≠0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the manual exposure position for the currently used camera.
@@ -147,7 +259,15 @@ export declare class VeLiveCameraDevice {
      *
      */
     setExposurePosition(viewW: int, viewH: int, x: int, y: int): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头的最小曝光补偿值。
+     * @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 14
+     * @return - ≤0：表示不支持曝光补偿；
+     *         - >0：支持曝光补偿，数值表示最小曝光补偿。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the minimum exposure compensation of the camera.
@@ -158,7 +278,15 @@ export declare class VeLiveCameraDevice {
      *
      */
     getMinExposureCompensation(): float;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头的最大曝光补偿值。
+     * @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 15
+     * @return - ≤0：表示不支持曝光补偿；
+     *         - >0：支持曝光补偿，数值表示最大曝光补偿。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the maximum exposure compensation of the camera.
@@ -169,7 +297,17 @@ export declare class VeLiveCameraDevice {
      *
      */
     getMaxExposureCompensation(): float;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置当前使用的摄像头的曝光补偿。
+     * @notes - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时，才能设置曝光补偿。
+     *        - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后，设置的曝光补偿失效。
+     * @order 16
+     * @param value 曝光补偿值，取值范围 [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation),[getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)]，0 为系统默认值，表示没有曝光补偿。
+     * @return - =0：设置成功；
+     *         - ≠0：设置失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the exposure compensation for the currently used camera.
@@ -185,7 +323,16 @@ export declare class VeLiveCameraDevice {
     setExposureCompensation(value: float): int;
 }
 export declare class VeLiveVideoEffectManager {
-    
+    /** {zh}
+     * @detail api
+     * @brief 视频特效许可证配置，用于初始化视频特效管理对象。
+     * @order 89
+     * @param config 特效初始化配置，详情请参见 [VeLiveVideoEffectLicenseConfiguration](147521#VeLivePusherDef-VeLiveVideoEffectLicenseConfiguration)。
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Initializes the special effects manager.
@@ -197,7 +344,15 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 如果您使用在线 License 认证方式，在许可证过期后，可调用该方法更新 License；
+     * @notes - 需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用；
+     *        - 本方法为异步操作。
+     * @order 90
+     * @param callback 结果回调信息
+     *
+     */
     /** {en}
      * @detail api
      * @brief Updates the special effects license. This method is effective only if you authenticate the license online.
@@ -209,7 +364,22 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     updateLicense(callback: VeLiveVideoEffectCallback): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 创建/销毁特效引擎。
+     * @notes - 该方法需要在调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 和 [setAlgorithmModelPath](#VeLiveVideoEffectManager-setalgorithmmodelpath) 后调用；
+     *        - 该方法不直接开启/关闭视频特效，您需要在调用该方法后，调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 开启视频特效；
+     *        - 通用场景下，特效引擎会随 EffectManager 销毁而销毁。如果您对性能有较高要求，也可以在不使用特效相关功能时，调用该方法销毁特效引擎；
+     *        - 如果重复创建/销毁特效引擎，会产生时间消耗。
+     * @order 92
+     * @param enable 是否创建特效引擎。默认为 false。 <br>
+     *               - true：创建；
+     *               - false：销毁。
+     * @param callback 视频特效回调 [VeLiveVideoEffectCallback](147519#VeLivePusherDef-VeLiveVideoEffectCallback)。
+     * @return - 0：成功；
+     *         - -1：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Creates or destroys the special effects engine.
@@ -229,7 +399,17 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     setEnable(enable: boolean, callback: VeLiveVideoEffectCallback): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置特效算法模型包的路径。
+     * @notes <br>需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用。
+     * @order 91
+     * @param path 特效算法模型包的路径
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the path to the algorithm model package of the special effects.
@@ -243,7 +423,20 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     setAlgorithmModelPath(path: String): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能，包括美颜、美形、美体、美妆等。
+     * @notes <br>
+     *        - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法；
+     *        - 重复调用本方法，仅最后一次调用生效；
+     *        - 如果需要在当前的视频特效组合中叠加特效，可调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 方法。
+     * @order 93
+     * @param nodes 视频特效素材包路径数组
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the special effects you want to apply to the video. You can choose effects from ComposeMakeup.bundle.
@@ -259,7 +452,17 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     setComposeNodes(nodes: Array<String>): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 在已有的视频特效组合上，叠加视频特效素材包，您可以调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合。
+     * @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法。
+     * @order 94
+     * @param nodes 视频特效素材包路径数组
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Adds one or more effects to the existing effects settings that you have configured by calling setComposeNodes {@link #VeLiveVideoEffectManager#setComposeNodes}.
@@ -272,7 +475,17 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     appendComposeNodes(nodes: Array<String>): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 调用本方法，可移除调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 和 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 设置的视频特效资源。
+     * @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法。
+     * @order 94
+     * @param nodes 视频特效素材包路径数组
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Removes one or more special effects resource set by the [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) or [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) methods.
@@ -285,7 +498,21 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     removeComposeNodes(nodes: Array<String>): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置视频特效强度。
+     * @notes <br>
+     *        - 需要在调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合或调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 叠加视频特效素材包后，调用本方法；
+     *        - 该方法仅适用于同时含有上述三个参数的特效资源，对于没有强度参数的特效（如贴纸），该方法无效。
+     * @order 95
+     * @param node 视频特效素材包路径
+     * @param key 需要设置的素材 key 名称
+     * @param intensity 需要设置的强度值。取值范围为 [0.0,1.0]
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the intensity of a special effect.
@@ -302,7 +529,17 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     updateComposerNodeIntensity(node: String, key: String, intensity: float): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置颜色滤镜。
+     * @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法。
+     * @order 96
+     * @param path 滤镜资源包绝对路径
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the color filter.
@@ -316,7 +553,16 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     setFilter(path: String): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置已启用的颜色滤镜强度。
+     * @notes <br>请在调用 [setFilter](#VeLiveVideoEffectManager-setfilter) 设置颜色滤镜后调用。
+     * @order 97
+     * @param intensity 滤镜强度，取值范围为 [0.0,1.0]。
+     * @return - 0：调用成功；
+     *         - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the intensity of the color filter.
@@ -329,7 +575,17 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     updateFilterIntensity(intensity: float): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置贴纸特效。
+     * @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法。
+     * @order 98
+     * @param path 贴纸素材包的绝对路径
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the sticker.
@@ -343,7 +599,16 @@ export declare class VeLiveVideoEffectManager {
      *
      */
     setSticker(path: String): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 智能美化特效的高级功能。
+     * @notes 请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法，不要在主线程中频繁执行同步操作。
+     * @order 99
+     * @param callback 将 handle 作为参数的回调函数。
+     * @param isGLThread 是否在 GL 线程回调 callback。
+     * @param isAsync 是否同步执行 callback。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Advanced functions of BytePlus Effects.
@@ -358,7 +623,14 @@ export declare class VeLiveVideoEffectManager {
     setAdvancedFeature(callback: VeLiveVideoEffectHandleCallback, isGLThread: boolean, isAsync: boolean): int;
 }
 export declare class VeLivePusher {
-    
+    /** {zh}
+     * @detail api
+     * @hidden
+     * @brief 获取当前 SDK 版本号。
+     * @return <br>
+     *    当前 SDK 版本号。
+     *
+     */
     /** {en}
      * @detail api
      * @hidden
@@ -368,7 +640,13 @@ export declare class VeLivePusher {
      *
      */
     static getVersion(): String;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置输出到控制台的日志等级。
+     * @order 49
+     * @param logLevel 输出的日志级别。级别详情请参见 [VeLivePusherLogLevel](147521#VeLivePusherLogLevel)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the level of the output log.
@@ -377,7 +655,13 @@ export declare class VeLivePusher {
      *
      */
     static setLogLevel(logLevel: VeLivePusherLogLevel): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置 OpenGL 的上下文。
+     * @order 50
+     * @param context OpenGL 上下文。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the context of OpenGL.
@@ -386,7 +670,12 @@ export declare class VeLivePusher {
      *
      */
     static setEGLContext(context: EGLContext): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止采集和推流，并销毁推流器。通常在调用 [stopPush](#VeLivePusher-stoppush) 结束推流后调用此方法进行清理。
+     * @order 4
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops capturing and pushing streams and destroys the pusher. Call this method after [stopPush](#VeLivePusher-stoppush) is called.
@@ -394,7 +683,16 @@ export declare class VeLivePusher {
      *
      */
     release(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流器回调，通过设置回调，监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。
+     * @notes <br>
+     *     - 需要在创建推流引擎后，调用本方法；
+     *     - 重复调用本方法，仅最后一次调用生效。
+     * @order 2
+     * @param observer 推流器回调对象，详细信息请参见 [VeLivePusherObserver](147519#VeLivePusherObserver)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets an observer to listen for live pusher events, including errors, statuses, network quality, device information, and first frame rendering.
@@ -406,7 +704,17 @@ export declare class VeLivePusher {
      *
      */
     setObserver(observer: VeLivePusherObserver): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流器周期性回调，用于定期获取推流状态信息。
+     * @notes <br>
+     *     - 需要在创建推流引擎后，调用本方法；
+     *     - 重复调用本方法，仅最后一次调用生效。
+     * @order 3
+     * @param observer 推流器周期性回调对象，详细信息请参见 [VeLivePusherStatisticsObserver](147519#VeLivePusherDef-VeLivePusherStatisticsObserver)。
+     * @param interval 周期性回调的时间间隔，单位为 s，默认值为 5。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets an observer to periodically report push-stream statistics.
@@ -419,7 +727,13 @@ export declare class VeLivePusher {
      *
      */
     setStatisticsObserver(observer: VeLivePusherStatisticsObserver, interval: int): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置本地摄像头预览视图。摄像头采集到的画面，经过美颜、脸形调整、滤镜等多种效果叠加之后，最终会显示到传入的 View 上。
+     * @param view 摄像头预览视图
+     * @order 5
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the preview for the local camera. If beauty AR is applied to the captured video or if it undergoes any other processing, the preview will display the processed video.
@@ -428,7 +742,13 @@ export declare class VeLivePusher {
      *
      */
     setRenderView(view: View): Promise<void>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置本地预览画面的填充模式。
+     * @param mode 填充模式。
+     * @order 6
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets fill mode for the local camera preview.
@@ -437,7 +757,18 @@ export declare class VeLivePusher {
      *
      */
     setRenderFillMode(mode: VeLivePusherRenderMode): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭镜像。
+     * @notes <br>
+     *     用于配置视频镜像效果，影响采集、预览和推流画面。
+     * @order 7
+     * @param type 镜像类型，详细信息请参见 [VeLiveVideoMirrorType](147521#VeLiveVideoMirrorType)。
+     * @param mirror 是否开启镜像。<br>
+     *               - true：开启；
+     *               - false：关闭。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Enables or disables mirroring for the local preview and the streamed video.
@@ -449,7 +780,14 @@ export declare class VeLivePusher {
      *
      */
     setVideoMirror(type: VeLiveVideoMirrorType, mirror: boolean): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开始视频采集。
+     * @notes <br>调用该接口后，可以通过调用接口 [stopVideoCapture](#VeLivePusher-stopvideocapture) 停止视频采集。
+     * @order 8
+     * @param type 视频采集类型，详细信息请参见 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType}
+     *
+     */
     /** {en}
      * @detail api
      * @brief Starts video capture.
@@ -459,7 +797,13 @@ export declare class VeLivePusher {
      *
      */
     startVideoCapture(type: VeLiveVideoCaptureType): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止视频采集。
+     * @notes <br>调用该接口后，可以通过调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 开始视频采集。
+     * @order 10
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops video capture.
@@ -468,7 +812,14 @@ export declare class VeLivePusher {
      *
      */
     stopVideoCapture(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开始音频采集。
+     * @notes <br>调用该接口后，可以通过调用接口 [stopAudioCapture](#VeLivePusher-stopaudiocapture) 停止音频采集。
+     * @order 9
+     * @param type 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Starts audio capture.
@@ -478,7 +829,13 @@ export declare class VeLivePusher {
      *
      */
     startAudioCapture(type: VeLiveAudioCaptureType): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止音频采集。
+     * @notes <br>调用该接口后，可以通过调用接口 [startAudioCapture](#VeLivePusher-startaudiocapture) 开始音频采集。
+     * @order 11
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops audio capture.
@@ -487,7 +844,14 @@ export declare class VeLivePusher {
      *
      */
     stopAudioCapture(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 切换视频采集类型。
+     * @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
+     * @order 12
+     * @param type 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Switches the video capture type.
@@ -497,7 +861,14 @@ export declare class VeLivePusher {
      *
      */
     switchVideoCapture(type: VeLiveVideoCaptureType): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 切换音频采集类型。
+     * @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
+     * @order 13
+     * @param type 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Switches audio capture type.
@@ -507,7 +878,13 @@ export declare class VeLivePusher {
      *
      */
     switchAudioCapture(type: VeLiveAudioCaptureType): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取当前视频采集类型。
+     * @order 14
+     * @return 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the current video capture type.
@@ -516,7 +893,13 @@ export declare class VeLivePusher {
      *
      */
     getCurrentVideoCaptureType(): VeLiveVideoCaptureType;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取当前音频采集类型。
+     * @order 15
+     * @return <br>音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the current audio capture type.
@@ -525,7 +908,13 @@ export declare class VeLivePusher {
      *
      */
     getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
-    
+    /** {zh}
+     * @detail api
+     * @brief 自定义静态图，适用于静态图推流采集类型。使用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage，您可调用 [startVideoCapture](#VeLivePusher-startvideocapture) 方法，将 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。
+     * @order 16
+     * @param image 静态图片，用于在静态图推流采集类型下设置静态图。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets a static image to push. When using this method, you must call startVideoCapture {@link #VeLivePusher#startVideoCapture} and set VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} to `VeLiveVideoCaptureCustomImage`.
@@ -534,7 +923,18 @@ export declare class VeLivePusher {
      *
      */
     updateCustomImage(image: Bitmap): Promise<void>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取相机设备管理对象 `VeLiveCameraDevice`。通过设备管理，您可以使用以下功能。
+     *        - 控制闪光灯开关
+     *        - 设置摄像头缩放比例
+     *        - 设置自动对焦
+     * @notes <br>
+     *    该接口需要在 startVideoCapture{@link #startVideoCapture}  方法中设置 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureBackCamera。
+     * @order 17
+     * @return 相机设备管理对象 [VeLiveCameraDevice](#VeLiveCameraDevice)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the camera manager. With the camera manager, you can do the following:
@@ -547,7 +947,14 @@ export declare class VeLivePusher {
      *
      */
     getCameraDevice(): VeLiveCameraDevice;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码参数。
+     * @notes 该接口可在推流开始前或开始后调用。
+     * @order 18
+     * @param config 推流视频参数，支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets video encoding parameters for the pushed stream.
@@ -557,7 +964,13 @@ export declare class VeLivePusher {
      *
      */
     setVideoEncoderConfiguration(config: VeLiveVideoEncoderConfiguration): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码参数。
+     * @order 19
+     * @return 推流视频参数，支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets video encoding parameters for the pushed stream.
@@ -566,7 +979,14 @@ export declare class VeLivePusher {
      *
      */
     getVideoEncoderConfiguration(): VeLiveVideoEncoderConfiguration;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频编码参数。
+     * @notes <br>该接口需要在 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之前调用。
+     * @order 20
+     * @param config 推流音频编码参数，详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets audio encoding parameters for the pushed stream.
@@ -576,7 +996,13 @@ export declare class VeLivePusher {
      *
      */
     setAudioEncoderConfiguration(config: VeLiveAudioEncoderConfiguration): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频编码参数。
+     * @order 21
+     * @return 推流音频编码参数，详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets audio encoding parameters for the pushed stream.
@@ -585,7 +1011,13 @@ export declare class VeLivePusher {
      *
      */
     getAudioEncoderConfiguration(): VeLiveAudioEncoderConfiguration;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开始推流。
+     * @order 22
+     * @param url 推流地址，用于将直播流推送到目标服务器。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Starts streaming.
@@ -594,7 +1026,15 @@ export declare class VeLivePusher {
      *
      */
     startPush(url: String): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开始推流，支持备用推流地址。
+     * @notes <br>
+     *    当主推流地址不可用时，会自动切换到备用推流地址继续推流。
+     * @order 23
+     * @param urls 推流地址列表，包含一个或多个推流地址。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Starts streaming with one or more push stream addresses.
@@ -605,7 +1045,13 @@ export declare class VeLivePusher {
      *
      */
     startPushWithUrls(urls: Array<String>): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止推流。
+     * @notes <br>停止推流后，可以通过调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法重新开始推流。
+     * @order 24
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops streaming.
@@ -615,7 +1061,16 @@ export declare class VeLivePusher {
      *
      */
     stopPush(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 当前是否正在推流中，可用来查询推流器的当前状态。
+     * @order 25
+     * @return <br>
+     *      是否正在推流。<br>
+     *         - true：正在推流中；
+     *         - false：已经停止推流。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Checks whether the streaming is currently ongoing. You can use this method to query the status of the live pusher.
@@ -627,7 +1082,19 @@ export declare class VeLivePusher {
      *
      */
     isPushing(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流水印。
+     * @order 26
+     * @param image 水印图片。取值为 null 时，表示禁用水印。
+     * @param x 水印的水平偏移量，即水印图片相对视频流左上角的横向偏移与视频流宽度的比值，取值范围为 [0.0,1.0]。
+     * @param y 水印的垂直偏移量，即水印图片相对视频流左上角的纵向偏移与视频流高度的比值，取值范围为 [0.0,1.0]。
+     * @param scale 水印图片的缩放比例，取值范围为 [0.0,1.0]。
+     * @return <br>
+     *     - 0：水印设置成功；
+     *     - <0：水印设置失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets a watermark for the pushed stream.
@@ -642,7 +1109,15 @@ export declare class VeLivePusher {
      *
      */
     setWatermark(image: Bitmap, x: float, y: float, scale: float): Promise<int>;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开始本地文件录制。
+     * @order 27
+     * @param path 录制文件保存路径，不能为空。
+     * @param config 文件录制设置，详情请参见 [VeLiveFileRecorderConfiguration](147521#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
+     * @param listener 本地文件录制的监听，详情请参见 [VeLiveFileRecordingListener](147519#VeLivePusherDef-VeLiveFileRecordingListener)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Starts local recording.
@@ -653,7 +1128,13 @@ export declare class VeLivePusher {
      *
      */
     startFileRecording(path: String, config: VeLiveFileRecorderConfiguration, listener: VeLiveFileRecordingListener): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止本地文件录制。
+     * @notes <br>该接口需要在 [startFileRecording](#VeLivePusher-startfilerecording) 方法之后调用。
+     * @order 28
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops local recording.
@@ -662,7 +1143,17 @@ export declare class VeLivePusher {
      *
      */
     stopFileRecording(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 高级配置。
+     * @order 29
+     * @param key 推流高级配置为 JSON 格式的字符串，此参数为 JSON 结构中的 Key。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)，了解配置方法。
+     * @param value 推流高级配置为 JSON 格式的字符串，此参数为 JSON 结构中的 Value。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)，了解配置方法。
+     * @return <br>
+     *     - 0：成功；
+     *     - -1：失败，参数错误。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Set advanced configurations. You can contact BytePlus technical support for more information about how to use this method.
@@ -675,7 +1166,17 @@ export declare class VeLivePusher {
      *
      */
     setProperty(key: String, value: Object): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 推送外部视频帧数据。
+     * @notes <br>
+     *    调用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureExternal，您可调用 startVideoCapture{@link #startVideoCapture} 方法，将 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} 设置为 VeLiveVideoCaptureExternal。
+     * @order 30
+     * @param frame 视频帧的数据信息，详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
+     * @return - 0：成功；
+     *         - <0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Pushes an external video frame.
@@ -687,7 +1188,17 @@ export declare class VeLivePusher {
      *
      */
     pushExternalVideoFrame(frame: VeLiveVideoFrame): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 推送外部音频帧数据。
+     * @notes 该接口需要在 startAudioCapture 方法中设置 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType) 为 VeLiveAudioCaptureExternal。
+     * @order 31
+     * @param frame 外部音频数据。详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Pushes an external audio frame.
@@ -699,7 +1210,13 @@ export declare class VeLivePusher {
      *
      */
     pushExternalAudioFrame(frame: VeLiveAudioFrame): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频帧朝向。默认为竖屏推流。
+     * @order 32
+     * @param orientation 视频帧朝向，详情请参见 [VeLiveOrientation](147521#VeLiveOrientation)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the orientation of the pushed video frame. The default orientation is portrait.
@@ -708,7 +1225,25 @@ export declare class VeLivePusher {
      *
      */
     setOrientation(orientation: VeLiveOrientation): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 通过视频帧发送 SEI 消息。
+     * @notes <br>该接口需要在调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之后调用。
+     * @order 33
+     * @param key SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Key。
+     * @param value SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Value。
+     * @param repeat 消息发送重复的次数。例如，`repeat` 取值为 20，`isKeyFrame` 取值为 YES，则会在视频帧开始的连续 20 个关键帧中添加 SEI 消息。
+     * @param isKeyFrame 是否仅在关键帧中包含 SEI 消息。<br>
+     *        - true：仅在关键帧中包含；
+     *        - false：所有帧中均包含。
+     * @param allowsCovered 是否允许覆盖。<br>
+     *        - true：允许；
+     *        - false：不允许。
+     * @return <br>
+     *     - 0：成功；
+     *     - <0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sends an SEI message through the video frame. The SEI messages are strings in JSON format.
@@ -729,7 +1264,15 @@ export declare class VeLivePusher {
      *
      */
     sendSeiMessage(key: String, value: Object, repeat: int, isKeyFrame: boolean, allowsCovered: boolean): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置静音。
+     * @param mute 是否设置为静音。默认为正常推流。<br>
+     *             - true：静音推流；
+     *             - false：正常推流。
+     * @order 34
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets whether to mute the stream.
@@ -740,7 +1283,15 @@ export declare class VeLivePusher {
      *
      */
     setMute(mute: boolean): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 当前是否是静音状态。
+     * @order 35
+     * @return <br>
+     *     - true：当前是静音状态；
+     *     - false：当前非静音状态。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Checks whether the stream is muted.
@@ -751,7 +1302,19 @@ export declare class VeLivePusher {
      *
      */
     isMute(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效管理对象 `VeLiveVideoEffectManager`。通过视频特效管理，您可以使用以下功能。
+     *        - 设置美颜
+     *        - 设置特效
+     *        - 设置素材
+     *        - 设置贴图
+     *        - 设置滤镜
+     * @notes 该接口需要集成智能美化特效 SDK 后才能使用。
+     * @order 36
+     * @return 视频特效管理对象 [VeLiveVideoEffectManager](#VeLiveVideoEffectManager)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the special effects manager. With the special effects manager, you can do the following:
@@ -766,7 +1329,13 @@ export declare class VeLivePusher {
      *
      */
     getVideoEffectManager(): VeLiveVideoEffectManager;
-    
+    /** {zh}
+     * @detail api
+     * @brief 自定义视频处理。
+     * @order 37
+     * @param filter 视频数据处理回调，详情请参见 [VeLiveVideoFrameFilter](147519#VeLivePusherDef-VeLiveVideoFrameFilter)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets custom video processing.
@@ -775,7 +1344,15 @@ export declare class VeLivePusher {
      *
      */
     setVideoFrameFilter(filter: VeLiveVideoFrameFilter): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取音频模块管理对象。
+     * @notes <br>
+     *    该接口需要在 startAudioCapture{@link #startAudioCapture}  方法中设置 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType} 为 VeLiveAudioCaptureMicrophone。
+     * @order 38
+     * @return 音频模块管理对象 [VeLiveAudioDevice](#VeLiveAudioDevice)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the audio device manager.
@@ -785,7 +1362,13 @@ export declare class VeLivePusher {
      *
      */
     getAudioDevice(): VeLiveAudioDevice;
-    
+    /** {zh}
+     * @detail api
+     * @brief 自定义音频处理。
+     * @order 39
+     * @param filter 音频帧滤镜对象 VeLiveAudioFrameFilter 。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets custom audio processing.
@@ -794,7 +1377,13 @@ export declare class VeLivePusher {
      *
      */
     setAudioFrameFilter(filter: VeLiveAudioFrameFilter): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 创建播放器。
+     * @order 1
+     * @return 播放器管理对象 [VeLiveMediaPlayer](#VeLiveMediaPlayer)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Creates the media player.
@@ -803,7 +1392,12 @@ export declare class VeLivePusher {
      *
      */
     createPlayer(): VeLiveMediaPlayer;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开始系统音频采集。
+     * @order 41
+     *
+     */
     /** {en}
      * @detail api
      * @brief Starts system audio capture.
@@ -811,7 +1405,12 @@ export declare class VeLivePusher {
      *
      */
     startMixSystemAudio(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止系统音频采集。
+     * @order 42
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops system audio capture.
@@ -819,7 +1418,12 @@ export declare class VeLivePusher {
      *
      */
     stopMixSystemAudio(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取当前是否处于屏幕采集状态。
+     * @order 43
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets whether the SDK is capturing the screen at this moment.
@@ -827,7 +1431,16 @@ export declare class VeLivePusher {
      *
      */
     isScreenRecording(): boolean;
-    
+    /** {zh}
+     * @detail api
+     * @brief 添加视频帧的监听回调，用于获取推流器输出的视频帧。
+     * @order 44
+     * @param listener 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Adds a video frame listener.
@@ -839,7 +1452,18 @@ export declare class VeLivePusher {
      *
      */
     addVideoFrameListener(listener: VeLiveVideoFrameListener): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 移除已添加的视频帧监听回调。
+     * @notes <br>
+     *    如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。
+     * @order 45
+     * @param listener 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Removes the video frame listener.
@@ -853,7 +1477,16 @@ export declare class VeLivePusher {
      *
      */
     removeVideoFrameListener(listener: VeLiveVideoFrameListener): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 添加音频帧的监听回调，用于获取推流器输出的音频帧。
+     * @order 46
+     * @param listener 音频帧监听回调，详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Adds an audio frame listener.
@@ -865,7 +1498,18 @@ export declare class VeLivePusher {
      *
      */
     addAudioFrameListener(listener: VeLiveAudioFrameListener): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 移除已添加的音频帧监听回调。
+     * @notes <br>
+     *    如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。
+     * @order 47
+     * @param listener 音频帧的监听回调，详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Removes the audio frame listener.
@@ -879,7 +1523,13 @@ export declare class VeLivePusher {
      *
      */
     removeAudioFrameListener(listener: VeLiveAudioFrameListener): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 视频截图。
+     * @order 48
+     * @param listener 截图监听对象，详情请参见 [VeLiveSnapshotListener](147519#VeLivePusherDef-VeLiveSnapshotListener)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Takes a screenshot.
@@ -890,7 +1540,12 @@ export declare class VeLivePusher {
     snapshot(listener: VeLiveSnapshotListener): void;
 }
 export declare class VeLiveMediaPlayer {
-    
+    /** {zh}
+     * @detail api
+     * @brief 销毁播放器实例。
+     * @order 1
+     *
+     */
     /** {en}
      * @detail api
      * @brief Destroys the media player instance.
@@ -898,7 +1553,15 @@ export declare class VeLiveMediaPlayer {
      *
      */
     release(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置播放状态的监听。
+     * @notes <br>
+     *      重复调用本方法，仅最后一次调用生效。
+     * @order 4
+     * @param listener 播放状态监听。详情请参见 [VeLiveMediaPlayerListener](147519#VeLivePusherDef-VeLiveMediaPlayerListener)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the observer for playback statuses.
@@ -909,7 +1572,16 @@ export declare class VeLiveMediaPlayer {
      *
      */
     setListener(listener: VeLiveMediaPlayerListener): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
+     * @order 2
+     * @param url 文件路径。
+     * @return <br>
+     *        - 0：成功；
+     *        - ≠0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the file path. Supported file formats include MP3, AAC, M4A, WAV.
@@ -921,7 +1593,14 @@ export declare class VeLiveMediaPlayer {
      *
      */
     prepare(url: String): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开始播放。
+     * @notes <br>
+     *     需要在调用 start{@link #start} 开始播放后，调用本方法。
+     * @order 12
+     *
+     */
     /** {en}
      * @detail api
      * @brief  Start playback.
@@ -931,7 +1610,17 @@ export declare class VeLiveMediaPlayer {
      *
      */
     start(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 停止播放。
+     * @notes <br>
+     *     需要在调用 start{@link #start} 开始播放后，调用本方法。
+     * @order 13
+     * @return <br>
+     *        - 0：成功；
+     *        - ≠0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Stops playback.
@@ -944,7 +1633,13 @@ export declare class VeLiveMediaPlayer {
      *
      */
     stop(): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 暂停播放。
+     * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start)[start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。
+     * @order 14
+     *
+     */
     /** {en}
      * @detail api
      * @brief Pauses playback.
@@ -954,7 +1649,13 @@ export declare class VeLiveMediaPlayer {
      *
      */
     pause(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 恢复播放。
+     * @notes <br>需要在调用 [pause](#VeLiveMediaPlayer-pause) 暂停播放后，调用本方法。
+     * @order 15
+     *
+     */
     /** {en}
      * @detail api
      * @brief Resumes playback.
@@ -963,7 +1664,16 @@ export declare class VeLiveMediaPlayer {
      *
      */
     resume(): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取文件的总时长，单位为 ms。
+     * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。
+     * @order 3
+     * @return <br>
+     *     - >0：成功，音频文件时长；
+     *     - ≤0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the duration of the media file.
@@ -975,7 +1685,16 @@ export declare class VeLiveMediaPlayer {
      *
      */
     getDuration(): long;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置播放进度。
+     * @order 5
+     * @param posMs 播放时间，单位为 ms。
+     * @return <br>
+     *        - 0：成功；
+     *        - ≠0：失败。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the playback progress.
@@ -987,7 +1706,15 @@ export declare class VeLiveMediaPlayer {
      *
      */
     seek(posMs: long): int;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭音频是否混音到直播流。
+     * @param enable 开启/关闭，默认为 false。 <br>
+     *        - ture：开启；
+     *        - false：关闭。
+     * @order 6
+     *
+     */
     /** {en}
      * @detail api
      * @brief Enables or disables mixing the audio to the live stream.
@@ -998,7 +1725,14 @@ export declare class VeLiveMediaPlayer {
      *
      */
     enableMixer(enable: boolean): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭自动音量均衡。
+     * @order 7
+     * @param sourceLufs 源响度。
+     * @param targetLufs 目标响度。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Enables or disables automatic volume equalization.
@@ -1008,7 +1742,15 @@ export declare class VeLiveMediaPlayer {
      *
      */
     enableAutoEq(sourceLufs: float, targetLufs: float): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置音视频帧回调的监听。
+     * @notes <br>
+     *      重复调用本方法，仅最后一次调用生效。
+     * @order 8
+     * @param listener 音视频帧回调监听。详情请参见 [VeLiveMediaPlayerFrameListener](147519#VeLivePusherDef-VeLiveMediaPlayerFrameListener)。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the observer for audio and video frames.
@@ -1019,7 +1761,13 @@ export declare class VeLiveMediaPlayer {
      *
      */
     setFrameListener(listener: VeLiveMediaPlayerFrameListener): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置播放音频的音量。
+     * @order 9
+     * @param volume 播放音频音量，取值范围为 [0.0,4.0]。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the playback volume.
@@ -1028,7 +1776,14 @@ export declare class VeLiveMediaPlayer {
      *
      */
     setBGMVolume(volume: float): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置音频采集音量。
+     * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放背景音乐后，调用本方法。
+     * @order 10
+     * @param volume 音频采集音量，取值范围为 [0.0,4.0]。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the audio capture volume.
@@ -1038,7 +1793,15 @@ export declare class VeLiveMediaPlayer {
      *
      */
     setVoiceVolume(volume: float): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置是否循环播放。
+     * @param loop 是否循环播放。默认为 false。<br>
+     *               - true：循环播放；
+     *               - false：不循环播放。
+     * @order 11
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets whether to loop the video.
@@ -1051,7 +1814,13 @@ export declare class VeLiveMediaPlayer {
     enableBGMLoop(loop: boolean): void;
 }
 export declare class VeLiveAudioDevice {
-    
+    /** {zh}
+     * @detail api
+     * @brief 设置音量响度。
+     * @order 74
+     * @param level 音量响度等级，取值范围为 [0.0,4.0]。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Sets the volume.
@@ -1060,7 +1829,14 @@ export declare class VeLiveAudioDevice {
      *
      */
     setVoiceLoudness(level: float): void;
-    
+    /** {zh}
+     * @detail api
+     * @brief 获取当前音量响度。
+     * @order 75
+     * @return <br>
+     *      当前音量响度等级。
+     *
+     */
     /** {en}
      * @detail api
      * @brief Gets the current volume.