@volcengine/react-native-live-push 1.1.3-rc.0 → 1.2.0-rc.0

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

@@ -1,29 +1,31 @@
 import { NSString, BOOL, int, float, CGPoint, NSDictionary, id, long, NSArray, UIImage } from './types';
-import { VeLiveFileRecorderConfiguration, VeLiveAudioMixType, VeLiveVideoFrame, VeLiveAudioFrame, VeLiveStreamMixDescription, VeLivePusherLogLevel, VeLivePusherConfiguration, VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, UIInterfaceOrientation, VeLiveVideoEncodeFrame, VeLiveVideoEffectLicenseConfiguration } from './keytype';
+import { VeLiveFileRecorderConfiguration, VeLivePusherLogLevel, VeLivePusherConfiguration, VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, UIInterfaceOrientation, VeLiveVideoFrame, VeLiveVideoEncodeFrame, VeLiveAudioFrame, VeLiveVideoEffectLicenseConfiguration } from './keytype';
 import { VeLiveMediaPlayerListener, VeLiveMediaPlayerFrameListener, VeLivePusherObserver, VeLivePusherStatisticsObserver, VeLiveVideoFrameListener, VeLiveAudioFrameListener, VeLiveScreenCaptureStatusObserver, VeLiveFileRecordingListener, VeLiveVideoFrameFilter, VeLiveAudioFrameFilter, VeLiveSnapshotListener } from './callback';
 import { UIView } from './external';
 export declare class VeLiveFileRecorderManager {
     /** {zh}
      * @detail api
      * @brief 开始直播录制。
-     * @notes <br>
-     *        - 请在调用 [startPush:](155318#VeLivePusher-startpush) 推流成功之后，调用该方法，直播过程中的音视频数据将保存到本地；
-     *        - 本方法为异步操作；
-     *        - 开始录制后，会触发 [onFileRecordingStarted](155319#VeLiveFileRecordingListener-onfilerecordingstarted) 回调消息；
-     *        - 录制出现错误，会触发 [onFileRecordingError:message:](155319#VeLiveFileRecordingListener-onfilerecordingerror-message) 回调消息。
+     * @notes - 请在调用 [startPush:](#VeLivePusher-startpush) 推流成功之后，调用该方法，直播过程中的音视频数据将保存到本地；
+     *          - 本方法为异步操作；
+     *          - 开始录制后，会触发 [onFileRecordingStarted](155319#VeLiveFileRecordingListener-onfilerecordingstarted) 回调消息；
+     *          - 录制出现错误，会触发 [onFileRecordingError:message:](155319#VeLiveFileRecordingListener-onfilerecordingerror-message) 回调消息。
      * @param path 录制文件保存路径，不能为空。
      * @param config 直播录制配置。详情请参见 [VeLiveFileRecorderConfiguration](155321#VeLiveFileRecorderConfiguration)。
+     * @order 43
      */
+    
     startRecord(path: NSString, config: VeLiveFileRecorderConfiguration): void;
     /** {zh}
      * @detail api
      * @brief 停止本地直播录制。
-     * @notes <br>
-     *        - 请在调用 [startRecord:config:](#VeLiveFileRecorderManager-startrecord-config) 成功开始录制之后，调用该方法；
+     * @notes - 请在调用 [startRecord:config:](#VeLiveFileRecorderManager-startrecord-config) 成功开始录制之后，调用该方法；
      *        - 本方法为异步操作；
-     *        - 停止录制，会触发 [onFileRecordingStoped](155319#VeLiveFileRecordingListener-onfilerecordingstopped) 回调消息；
+     *        - 停止录制，会触发 [onFileRecordingStopped](155319#VeLiveFileRecordingListener-onfilerecordingstopped) 回调消息；
      *        - 录制出现错误，会触发 [onFileRecordingError:message:](155319#VeLiveFileRecordingListener-onfilerecordingerror-message) 回调消息。
+     * @order 45
      */
+    
     stopRecord(): void;
     init(): this;
 }
@@ -31,175 +33,186 @@ export declare class VeLiveCameraDevice {
     /** {zh}
      * @detail api
      * @brief 是否支持闪光灯。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 49
      * @return <br>
      *     - YES：支持；
      *     - NO：不支持。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
-     * @order 49
      */
+    
     isTorchSupported(): BOOL;
     /** {zh}
      * @detail api
      * @brief 开启/关闭闪光灯。
-     * @return <br>
-     *     - =0：开启/关闭成功；
-     *     - ≠0：开启/关闭失败。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
      * @order 51
      * @param enable 是否开启闪光灯。默认为 NO。 <br>
      *        - YES：开启；
      *        - NO：关闭。
+     * @return - =0：开启/关闭成功；
+     *         - ≠0：开启/关闭失败。
      */
+    
     enableTorch(enable: BOOL): int;
     /** {zh}
      * @detail api
      * @brief 设置摄像头的缩放倍数。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 52
+     * @param ratio 缩放倍数。默认为原尺寸，缩放倍数的取值范围为 [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)]。
      * @return <br>
      *     - =0：缩放成功；
      *     - ≠0：缩放失败。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
-     * @order 52
-     * @param ratio 缩放倍数。默认为原尺寸，缩放倍数的取值范围为 [[getMinZoomRatio,getMaxZoomRatio](155318#VeLiveCameraDevice-getmaxzoomratio)]。
      */
+    
     setZoomRatio(ratio: float): int;
     /** {zh}
      * @detail api
      * @brief 获取摄像头当前的缩放倍数。
-     * @return <br>
-     *     - ≤0：表示不支持缩放；
-     *     - \\>0：支持缩放，数值表示当前缩放倍数。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
      * @order 53
+     * @return - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示当前缩放倍数。
      */
+    
     getCurrentZoomRatio(): float;
     /** {zh}
      * @detail api
      * @brief 获取摄像头的最大缩放倍数。
-     * @return <br>
-     *     - ≤0：表示不支持缩放；
-     *     - \\>0：支持缩放，数值表示最大缩放倍数。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
      * @order 54
+     * @return <br>
+     *         - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示最大缩放倍数。
      */
+    
     getMaxZoomRatio(): float;
     /** {zh}
      * @detail api
      * @brief 获取摄像头的最小缩放倍数。
-     * @return <br>
-     *     - ≤0：表示不支持缩放；
-     *     - \\>0：支持缩放，数值表示最小缩放倍数。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
      * @order 55
+     * @return <br>
+     *         - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示最小缩放倍数。
      */
+    
     getMinZoomRatio(): float;
     /** {zh}
      * @detail api
      * @brief 是否支持自动对焦。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 56
      * @return <br>
      *     - YES：支持；
      *     - NO：不支持。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
-     * @order 56
      */
+    
     isAutoFocusEnabled(): BOOL;
     /** {zh}
      * @detail api
      * @brief 开启/关闭自动对焦功能。
-     * @return <br>
-     *     - =0：开启/关闭成功；
-     *     - ≠0：开启/关闭失败。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
      * @order 57
      * @param enable 是否开启自动对焦，默认为 YES。
      *     - YES：开启；
      *     - NO：关闭。
+     * @return <br>
+     *     - =0：开启/关闭成功；
+     *     - ≠0：开启/关闭失败。
      */
+    
     enableAutoFocus(enable: BOOL): int;
     /** {zh}
      * @detail api
      * @brief 设置摄像头的对焦位置。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 58
+     * @param position 以左上角为原点，对焦点距当前视图的坐标值。
      * @return <br>
      *     - =0：设置成功；
      *     - ≠0：设置失败。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
-     * @order 58
-     * @param position 以左上角为原点，对焦点距当前视图的坐标值。
      */
+    
     setFocusPosition(position: CGPoint): int;
     /** {zh}
      * @detail api
      * @brief 检查当前使用的摄像头是否支持手动设置曝光点。
+     * @notes 必须已调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。
+     * @order 59
      * @return  <br>
      *     - YES: 支持。 <br>
      *     - NO: 不支持。
-     * @notes 必须已调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture}  使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。
-     * @order 59
      */
+    
     isExposurePositionSupported(): BOOL;
     /** {zh}
      * @detail api
      * @brief 设置当前使用的摄像头的曝光点。
      * @param position 曝光点坐标。以本地预览画布的左上为坐标原点，`position`的`x`字段为曝光点水平方向归一化坐标，`y`字段为曝光点垂直方向归一化坐标，取值范围为 [0, 1]。
+     * @notes - 必须已调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集，并且使用 SDK 内部渲染时，才能设置曝光点。
+     *        - 曝光点设置为画布中央（即`x`和`y`均取 0.5）时，恢复系统默认值。
+     *        - 调用 [stopVideoCapture:](155318#VeLivePusher-stopvideocapture) 关闭内部采集后，设置的曝光点失效。
+     * @order 60
      * @return  <br>
      *     - =0: 成功。
      *     - ≠0: 失败。
-     * @notes <br>
-     *     - 必须已调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 使用 SDK 内部采集模块进行视频采集，并且使用 SDK 内部渲染时，才能设置曝光点。  <br>
-     *     - 曝光点设置为画布中央（即`x`和`y`均取 0.5）时，恢复系统默认值。  <br>
-     *     - 调用 stopVideoCapture:{@link #VeLivePusher#stopVideoCapture}  关闭内部采集后，设置的曝光点失效。
-     * @order 60
      */
+    
     setExposurePosition(position: CGPoint): int;
     /** {zh}
      * @detail api
      * @brief 设置当前使用的摄像头的曝光补偿。
-     * @return  <br>
-     *     - =0：设置成功；
-     *     - ≠0：设置失败。
-     * @notes <br>
-     *     - 必须已调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture}  使用 SDK 内部采集模块进行视频采集时，才能设置曝光补偿。
-     *     - 调用 stopVideoCapture:{@link #VeLivePusher#stopVideoCapture} 关闭内部采集后，设置的曝光补偿失效。
+     * @notes - 必须已调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时，才能设置曝光补偿。
+     *        - 调用 [stopVideoCapture:](#VeLivePusher-stopvideocapture) 关闭内部采集后，设置的曝光补偿失效。
      * @order 61
-     * @param value 曝光补偿值，取值范围 [[getMinExposureCompensation](155318#VeLiveCameraDevice-getminexposurecompensation), [getMaxExposureCompensation](155318#VeLiveCameraDevice-getmaxexposurecompensation)]，0 为系统默认值表示没有曝光补偿。
+     * @param value 曝光补偿值，取值范围 [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation), [getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)]，0 为系统默认值表示没有曝光补偿。
+     * @return - =0：设置成功；
+     *         - ≠0：设置失败。
      */
+    
     setExposureCompensation(value: float): int;
     /** {zh}
      * @detail api
      * @brief 获取摄像头的最小曝光补偿。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 62
      * @return <br>
      *     - ≤0：表示不支持曝光补偿；
      *     - >0：支持曝光补偿，数值表示最小曝光补偿。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
-     * @order 62
      */
+    
     getMinExposureCompensation(): float;
     /** {zh}
      * @detail api
      * @brief 获取摄像头的最大曝光补偿。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 63
      * @return <br>
      *     - ≤0：表示不支持曝光补偿；
      *     - >0：支持曝光补偿，数值表示最大曝光补偿。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
-     * @order 63
      */
+    
     getMaxExposureCompensation(): float;
     /** {zh}
      * @detail api
      * @brief 设置相机参数。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
      * @order 64
      * @param parameter 相机参数字典，包含要设置的参数名称（键）和对应的值
      */
+    
     setParameter(parameter: NSDictionary): void;
     /** {zh}
      * @detail api
      * @brief 获取相机参数。
-     * @return <br>
-     *      相机参数的值，具体类型需要根据参数名称确定。
-     * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后，调用本方法。
+     * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
      * @order 65
      * @param key 需要获取的相机参数的名称。
+     * @return <br>
+     *      相机参数的值，具体类型需要根据参数名称确定。
      */
+    
     getParameter(key: NSString): id;
     init(): this;
 }
@@ -207,36 +220,39 @@ export declare class VeLiveMediaPlayer {
     /** {zh}
      * @detail api
      * @brief 设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
+     * @order 1
+     * @param url 文件路径。
      * @return <br>
      *        - 0：成功；
      *        - ≠0：失败。
-     * @order 87
-     * @param url 文件路径。
      */
+    
     prepare(url: NSString): int;
     /** {zh}
      * @detail api
      * @brief 销毁播放器实例。
-     * @order 88
+     * @order 3
      */
+    
     destroy(): void;
     /** {zh}
      * @detail api
      * @brief 设置播放状态的监听。
-     * @notes <br>
-     *      重复调用本方法，仅最后一次调用生效。
-     * @order 89
+     * @notes 重复调用本方法，仅最后一次调用生效。
+     * @order 4
      * @param listener 播放状态监听。详情请参见 [VeLiveMediaPlayerListener](155319#VeLiveMediaPlayerListener)。
      */
+    
     setListener(listener: id<VeLiveMediaPlayerListener>): void;
     /** {zh}
      * @detail api
      * @brief 设置音视频帧回调的监听。
      * @notes <br>
      *      重复调用本方法，仅最后一次调用生效。
-     * @order 90
+     * @order 5
      * @param listener 音视频帧回调监听。详情请参见 [VeLiveMediaPlayerFrameListener](155319#VeLiveMediaPlayerFrameListener)。
      */
+    
     setFrameListener(listener: id<VeLiveMediaPlayerFrameListener>): void;
     /** {zh}
      * @detail api
@@ -244,16 +260,18 @@ export declare class VeLiveMediaPlayer {
      * @param enable 开启/关闭，默认为 NO。 <br>
      *        - YES：开启；
      *        - NO：关闭。
-     * @order 91
+     * @order 6
      */
+    
     enableMixer(enable: BOOL): void;
     /** {zh}
      * @detail api
      * @brief 开启/关闭自动音量均衡。
-     * @order 92
+     * @order 7
      * @param sourceLufs 源响度。
      * @param targetLufs 目标响度。
      */
+    
     enableAutoEq(sourceLufs: float, targetLufs: float): void;
     /** {zh}
      * @detail api
@@ -261,6 +279,7 @@ export declare class VeLiveMediaPlayer {
      * @param view 渲染视图。
      * @order 93
      */
+    
     setRenderView(view: UIView): void;
     /** {zh}
      * @detail api
@@ -268,84 +287,93 @@ export declare class VeLiveMediaPlayer {
      * @param enable 是否循环播放。默认为 NO。<br>
      *               - YES：循环播放；
      *               - NO：不循环播放。
-     * @order 95
+     * @order 8
      */
+    
     enableBGMLoop(enable: BOOL): void;
     /** {zh}
      * @detail api
      * @brief 开始播放。
+     * @notes
+     *        - 需要在调用 [prepare:](#VeLiveMediaPlayer-prepare) 设置文件路径后，调用本方法；
+     *        - 此方法为异步操作。当 SDK 收到开始播放 [onStart](155319#VeLiveMediaPlayerListener-onstart) 的回调后，开始播放。
+     * @order 9
      * @return <br>
      *        - 0：成功；
      *        - ≠0：失败。
-     * @notes <br>
-     *        - 需要在调用 prepare:{@link #VeLiveMediaPlayer#prepare} 设置文件路径后，调用本方法；
-     *        - 此方法为异步操作。当 SDK 收到开始播放 onStart{@link #VeLiveMediaPlayerListener#onStart} 的回调后，开始播放。
-     * @order 94
      */
+    
     start(): Promise<int>;
     /** {zh}
      * @detail api
      * @brief 停止播放。
+     * @notes
+     *        需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。
+     * @order 10
      * @return <br>
      *        - 0：成功；
      *        - ≠0：失败。
-     * @notes <br>
-     *     需要在调用 start{@link #start} 开始播放后，调用本方法。
-     * @order 97
      */
+    
     stop(): Promise<int>;
     /** {zh}
      * @detail api
      * @brief 暂停播放。
-     * @notes <br>
-     *     需要在调用 start{@link #start} 开始播放后，调用本方法。
-     * @order 98
+     * @notes
+     *        需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。
+     * @order 11
      */
+    
     pause(): Promise<void>;
     /** {zh}
      * @detail api
      * @brief 恢复播放。
-     * @notes <br>
-     *     需要在调用 pause{@link #pause} 暂停播放后，调用本方法。
-     * @order 99
+     * @notes
+     *        需要在调用 [pause](#VeLiveMediaPlayer-pause) 暂停播放后，调用本方法。
+     * @order 12
      */
+    
     resume(): Promise<void>;
     /** {zh}
      * @detail api
      * @brief 设置播放进度。
+     * @order 13
+     * @param pos 播放时间，单位为 ms。
      * @return <br>
      *        - 0：成功；
      *        - ≠0：失败。
-     * @order 100
-     * @param pos 播放时间，单位为 ms。
      */
+    
     seek(pos: long): int;
     /** {zh}
      * @detail api
      * @brief 获取文件的总时长，单位为 ms。
+     * @notes
+     *        需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。
+     * @order 2
      * @return <br>
      *     - >0：成功，音频文件时长；
      *     - ≤0：失败。
-     * @notes <br>
-     *     需要在调用 start{@link #start} 开始播放后，调用本方法。
-     * @order 101
      */
+    
     getDuration(): long;
     /** {zh}
      * @detail api
      * @brief 设置播放音频的音量。
-     * @order 102
+     * @order 14
      * @param volume 播放音频音量，取值范围为 [0.0,4.0]。
      */
+    
     setBGMVolume(volume: float): void;
     /** {zh}
      * @detail api
      * @brief 设置音频采集音量。
-     * @notes <br>
-     *     需要在调用 start{@link #start} 开始播放背景音乐后，调用本方法。
-     * @order 103
+     * @notes
+     *        需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放背景音乐后，调用本方法。
+     * @order 15
      * @param volume 音频采集音量，取值范围为 [0.0,4.0]。
      */
+    
     setVoiceVolume(volume: float): void;
     init(): this;
 }
@@ -356,14 +384,16 @@ export declare class VeLiveAudioDevice {
      * @order 60
      * @param level 音量响度等级，取值范围为 [0.0,4.0]。
      */
+    
     setVoiceLoudness(level: float): void;
     /** {zh}
      * @detail api
      * @brief 获取当前音量响度。
+     * @order 61
      * @return <br>
      *      当前音量响度等级。
-     * @order 61
      */
+    
     getVoiceLoudness(): float;
     /** {zh}
      * @detail api
@@ -373,6 +403,7 @@ export declare class VeLiveAudioDevice {
      *     - NO：不支持。
      * @order 62
      */
+    
     isSupportHardwareEcho(): BOOL;
     /** {zh}
      * @detail api
@@ -380,138 +411,85 @@ export declare class VeLiveAudioDevice {
      * @param enable 耳返功能开关。默认值为 NO。<br>
      *      - YES：开启；
      *      - NO：关闭。
-     * @notes <br>
-     *      需要在调用 startAudioCapture:{@link #VeLivePusher#startAudioCapture} 启动音频采集后，调用本方法。
+     * @notes
+     *        需要在调用 [startAudioCapture:](#VeLivePusher-startaudiocapture) 启动音频采集后，调用本方法。
      * @order 64
      */
+    
     enableEcho(enable: BOOL): void;
     /** {zh}
      * @detail api
      * @brief 获取当前耳返开启状态。
+     * @notes
+     *        需要在调用 [startAudioCapture:](#VeLivePusher-startaudiocapture) 启动音频采集后，调用本方法。
+     * @order 65
      * @return <br>
      *     - YES：开启；
      *     - NO：关闭。
-     * @notes <br>
-     *      需要在调用 startAudioCapture:{@link #VeLivePusher#startAudioCapture} 启动音频采集后，调用本方法。
-     * @order 65
      */
+    
     isEnableEcho(): BOOL;
     init(): this;
 }
-export declare class VeLiveMixerManager {
-    /** {zh}
-     * @detail api
-     * @brief 添加一路需要混流的视频流到混流器中。
-     * @return <br>
-     *     视频流 ID。
-     * @order 65
-     */
-    addVideoStream(): int;
-    /** {zh}
-     * @detail api
-     * @brief 从混流器中移除一路非主路的视频流。
-     * @order 66
-     * @param streamId 需要移除的非主路视频流 ID。
-     */
-    removeVideoStream(streamId: int): void;
-    /** {zh}
-     * @detail api
-     * @brief 添加一路音频流到混流器中，并指定混流类型。
-     * @param type 混流类型，详情请参见 VeLiveAudioMixType{@link #VeLiveAudioMixType}
-     * @return <br>
-     *     音频流 ID。
-     * @order 68
-     */
-    addAudioStream(type: VeLiveAudioMixType): int;
-    /** {zh}
-     * @detail api
-     * @brief 从混流器中移除一路非主路的音频流。
-     * @order 69
-     * @param streamId 需要移除的非主路音频流 ID。
-     */
-    removeAudioStream(streamId: int): void;
-    /** {zh}
-     * @detail api
-     * @brief 设置指定混流音频的音量。当你将 VeLiveAudioMixType{@link #VeLiveAudioMixType} 设置为 `VeLiveAudioMixPlayAndPush` 时，该方法同时控制该路音频在拉流端和本地的播放音量。
-     * @order 70
-     * @param streamId 非主路音频流 ID。
-     * @param volume 音量大小，范围为 [0.0,4.0]。
-     */
-    setAudioStream(streamId: int, volume: float): void;
-    /** {zh}
-     * @detail api
-     * @brief 获取主路视频流 ID。
-     * @order 71
-     */
-    getOriginVideoStream(): int;
-    /** {zh}
-     * @detail api
-     * @brief 获取主路音频流 ID。
-     * @order 72
-     */
-    getOriginAudioStream(): int;
-    /** {zh}
-     * @detail api
-     * @brief 获取屏幕推流App音频流 ID。
-     */
-    getAppAudioStream(): int;
-    /** {zh}
-     * @detail api
-     * @order 73
-     * @brief 发送指定混流 ID 的自定义视频帧数据。
-     * @param frame 自定义的视频帧，详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
-     * @param streamId 需要混流的视频流 ID。
-     */
-    sendCustomVideoFrame(frame: VeLiveVideoFrame, streamId: int): void;
-    /** {zh}
-     * @detail api
-     * @order 74
-     * @brief 发送指定混流 ID 的自定义音频帧数据。
-     * @param frame 自定义的音频帧，详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
-     * @param streamId 混流的音频流 ID。
-     */
-    sendCustomAudioFrame(frame: VeLiveAudioFrame, streamId: int): void;
-    /** {zh}
-     * @detail api
-     * @brief 更新音视频混流的布局。
-     * @order 75
-     * @param mixDescription 新的音视频混流布局，详情请参见 [VeLiveStreamMixDescription](155321#VeLiveStreamMixDescription)。
-     */
-    updateStreamMixDescription(mixDescription: VeLiveStreamMixDescription): void;
-    init(): this;
-}
 export declare class VeLivePusher {
     /** {zh}
      * @detail api
      * @brief 设置输出到控制台的日志等级。
-     * @order 48
+     * @order 50
      * @param level 输出的日志级别，默认值为 `VeLivePusherLogLevelNone`，表示关闭日志。级别详情请参见 [VeLivePusherLogLevel](155321#VeLivePusherLogLevel)。
      */
+    
     static setLogLevel(level: VeLivePusherLogLevel): void;
     /** {zh}
      * @detail api
      * @param applicationGroupIdentifier iOS app group 标识符。
      * @brief 开启屏幕采集。
+     * @order 20
      */
+    
     startScreenCapture(applicationGroupIdentifier: NSString): void;
     /** {zh}
      * @detail api
-     * @brief 关闭屏幕采集。
+     * @brief 停止屏幕采集。
+     * @notes  <br>
+     *      该方法用于结束当前屏幕采集流程，并释放相关资源。调用本方法后，`pauseScreenCapture` 和 `resumeScreenCapture` 将不再生效。
+     * @order 21
      */
+    
     stopScreenCapture(): void;
+    /** {zh}
+     * @detail api
+     * @brief 暂停屏幕采集。
+     * @notes  <br>
+     *      调用该方法后，屏幕采集将暂停输出数据，但不会销毁内部资源。您可通过 `resumeScreenCapture` 来恢复采集。如果当前采集已经停止或尚未开始，调用本方法不会产生任何效果。
+     * @order 22
+     */
+    
+    pauseScreenCapture(): void;
+    /** {zh}
+     * @detail api
+     * @brief 恢复屏幕采集。
+     * @notes  <br>
+     *      在调用 `pauseScreenCapture` 暂停后，通过本方法可以恢复屏幕采集输出。如果屏幕采集已经停止或尚未开始，调用本方法不会产生任何效果。
+     * @order 23
+     */
+    
+    resumeScreenCapture(): void;
     init(): this;
     /** {zh}
      * @detail api
      * @brief 初始化推流器。
      * @order 0
-     * @param config 推流配置类。详细信息请参见 [VeLivePusherConfiguration](155321#VeLivePusherConfiguration)。
+     * @param config 推流配置类。详细信息请参见 [VeLivePusherConfiguration](155321#VeLivePusherConfiguration)。
      */
+    
     initWithConfig(config: VeLivePusherConfiguration): this;
     /** {zh}
      * @detail api
-     * @brief 停止采集和推流，并销毁推流器。通常在调用 stopPush{@link #VeLivePusher#stopPush} 结束推流后调用此方法进行清理。
+     * @brief 停止采集和推流，并销毁推流器。通常在调用 [stopPush](#VeLivePusher-stoppush) 结束推流后调用此方法进行清理。
      * @order 2
      */
+    
     destroy(): void;
     /** {zh}
      * @detail api
@@ -519,9 +497,10 @@ export declare class VeLivePusher {
      * @notes <br>
      *     - 需要在创建推流引擎后，调用本方法；
      *     - 重复调用本方法，仅最后一次调用生效。
-     * @order 2
+     * @order 4
      * @param observer 推流器回调对象，详细信息请参见 [VeLivePusherObserver](155319#VeLivePusherObserver)。
      */
+    
     setObserver(observer: id<VeLivePusherObserver>): void;
     /** {zh}
      * @detail api
@@ -529,200 +508,222 @@ export declare class VeLivePusher {
      * @notes <br>
      *     - 需要在创建推流引擎后，调用本方法；
      *     - 重复调用本方法，仅最后一次调用生效。
-     * @order 3
+     * @order 6
      * @param observer 推流器周期性回调对象，详细信息请参见 [VeLivePusherStatisticsObserver](155319#VeLivePusherStatisticsObserver)。
      * @param interval 周期性回调的时间间隔，单位为 s，默认值为 5。
      */
+    
     setStatisticsObserver(observer: id<VeLivePusherStatisticsObserver>, interval: int): void;
     /** {zh}
      * @detail api
      * @brief 添加视频帧的监听回调，用于获取推流器输出的视频帧。
+     * @order 51
+     * @param listener 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](155319#VeLiveVideoFrameListener)。
      * @return <br>
      *      - 0：成功；
      *      - ≠0：失败。
-     * @order 4
-     * @param listener 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](155319#VeLiveVideoFrameListener)。
      */
+    
     addVideoFrameListener(listener: id<VeLiveVideoFrameListener>): int;
     /** {zh}
      * @detail api
      * @brief 移除已添加的视频帧监听回调。
-     * @return <br>
-     *      - 0：成功；
-     *      - <0：失败。
      * @notes <br>
      *    如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。
-     * @order 5
+     * @order 52
      * @param listener 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](155319#VeLiveVideoFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
      */
+    
     removeVideoFrameListener(listener: id<VeLiveVideoFrameListener>): int;
     /** {zh}
      * @detail api
      * @brief 添加音频帧的监听回调，用于获取推流器输出的音频帧。
+     * @order 53
+     * @param listener 音频帧监听回调，详细信息请参见 [VeLiveAudioFrameListener](155319#VeLiveAudioFrameListener)。
      * @return <br>
      *      - 0：成功；
      *      - <0：失败。
-     * @order 6
-     * @param listener 音频帧监听回调，详细信息请参见 [VeLiveAudioFrameListener](155319#VeLiveAudioFrameListener)。
      */
+    
     addAudioFrameListener(listener: id<VeLiveAudioFrameListener>): int;
     /** {zh}
      * @detail api
      * @brief 移除已添加的音频帧监听回调。
-     * @return <br>
-     *      - 0：成功；
-     *      - <0：失败。
      * @notes <br>
      *    如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。
-     * @order 7
+     * @order 54
      * @param listener 音频帧的监听回调，详细信息请参见 [VeLiveAudioFrameListener](155319#VeLiveAudioFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
      */
+    
     removeAudioFrameListener(listener: id<VeLiveAudioFrameListener>): int;
     /** {zh}
      * @detail api
      * @brief 添加屏幕采集的监听。
-     * @return <br>
-     *      - 0：成功；
-     *      - <0：失败。
      * @notes <br>
      *    如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。
      * @param listener 屏幕采集事件监听回调，详细信息请参见 VeLiveScreenCaptureStatusObserver{@link #VeLiveScreenCaptureStatusObserver}
      * @param observer 录屏推流事件监听器。详情见 [VeLiveScreenCaptureStatusObserver](155319#VeLiveScreenCaptureStatusObserver)。
+     * @order 5
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
      */
+    
     setScreenCaptureObserver(observer: id<VeLiveScreenCaptureStatusObserver>): int;
     /** {zh}
      * @detail api
      * @brief 设置本地预览视图。如您对采集到的画面进行了美颜等处理，View 中显示的是美颜后的画面。
-     * @order 8
+     * @order 7
      * @param view 本地预览视图。
      */
+    
     setRenderView(view: UIView): Promise<void>;
     /** {zh}
      * @detail api
-     * @order 94
+     * @order 10
      * @brief 设置本地预览填充模式。
      * @param fillMode 本地预览填充模式，默认值为 VeLivePusherRenderModeFill，即视频帧自适应画布的填充模式，详细信息请参见 [VeLivePusherRenderMode](155321#VeLivePusherRenderMode)。
      */
+    
     setRenderFillMode(fillMode: VeLivePusherRenderMode): void;
     /** {zh}
      * @detail api
-     * @brief 开启/关闭镜像。
-     * @notes <br>
-     *     该方法可用于配置预览和推流画面是否镜像。
-     * @order 9
+     * @brief 开启/关闭镜像。该方法可用于配置预览和推流画面是否镜像。
+     * @order 8
      * @param type 镜像类型，详细信息请参见 [VeLiveVideoMirrorType](155321#VeLiveVideoMirrorType)。
      * @param enable 是否开启镜像。<br>
      *               - YES：开启；
      *               - NO：关闭。
      */
+    
     setVideoMirror(type: VeLiveVideoMirrorType, enable: BOOL): void;
     /** {zh}
      * @detail api
      * @brief 开始推流。
-     * @order 10
+     * @order 24
      * @param url 推流地址，用于将直播流推送到目标服务器。
      */
+    
     startPush(url: NSString): void;
     /** {zh}
      * @detail api
      * @brief 开始推流，支持备用推流地址。
      * @notes <br>
      *    当数组中第一个推流地址不可用时，会自动切换到后面的备用推流地址继续推流。
-     * @order 11
+     * @order 25
      * @param urls 推流地址列表，包含一个或多个推流地址。
      */
+    
     startPushWithUrls(urls: NSArray<NSString>): void;
     /** {zh}
      * @detail api
      * @brief 停止推流。
-     * @notes <br>
-     *    停止推流后，可以通过调用 startPush:{@link #VeLivePusher#startPush} 或 startPushWithUrls:{@link #VeLivePusher#startPushWithUrls} 方法重新开始推流。
-     * @order 15
+     * @notes
+     *        停止推流后，可以通过调用 [startPush:](#VeLivePusher-startpush) 或 [startPushWithUrls:](#VeLivePusher-startpushwithurls) 方法重新开始推流。
+     * @order 26
      */
+    
     stopPush(): void;
     /** {zh}
      * @detail api
      * @brief 当前是否正在推流中，可用来查询推流器的当前状态。
+     * @order 27
      * @return <br>
      *      是否正在推流。<br>
      *         - YES：正在推流中；
      *         - NO：已经停止推流。
-     * @order 13
      */
+    
     isPushing(): BOOL;
     /** {zh}
      * @detail api
      * @brief 开始视频采集。
-     * @notes <br>
-     *    调用该接口后，可以通过调用接口 stopVideoCapture{@link #VeLivePusher#stopVideoCapture} 停止视频采集。
-     * @order 17
+     * @notes
+     *        调用该接口后，可以通过调用接口 [stopVideoCapture](#VeLivePusher-stopvideocapture) 停止视频采集。
+     * @order 11
      * @param type 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType)。
      */
+    
     startVideoCapture(type: VeLiveVideoCaptureType): void;
     /** {zh}
      * @detail api
      * @brief 停止视频采集。
-     * @notes <br>调用该接口后，可以通过调用接口 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 开始视频采集。
-     * @order 18
+     * @notes
+     *         调用该接口后，可以通过调用接口 [startVideoCapture:](#VeLivePusher-startvideocapture) 开始视频采集。
+     * @order 12
      */
+    
     stopVideoCapture(): void;
     /** {zh}
      * @detail api
      * @brief 切换视频采集类型。
-     * @notes <br>该接口必须在调用接口 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 后调用才能生效。
-     * @order 19
+     * @notes
+     *        该接口必须在调用接口 [startVideoCapture:](#VeLivePusher-startvideocapture) 后调用才能生效。
+     * @order 13
      * @param type 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType)。
      */
+    
     switchVideoCapture(type: VeLiveVideoCaptureType): void;
     /** {zh}
      * @detail api
      * @brief 开始音频采集。
-     * @notes <br>
-     *    调用该接口后，可以通过调用接口 stopAudioCapture{@link #VeLivePusher#stopAudioCapture} 停止音频采集。
-     * @order 20
+     * @notes
+     *        调用该接口后，可以通过调用接口 [[stopAudioCapture](#VeLivePusher-stopaudiocapture) 停止音频采集。
+     * @order 15
      * @param type 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](155321#VeLiveAudioCaptureType)。
      */
+    
     startAudioCapture(type: VeLiveAudioCaptureType): void;
     /** {zh}
      * @detail api
      * @brief 停止音频采集。
-     * @notes <br>
-     *    调用该接口后，可以通过调用接口 startAudioCapture:{@link #VeLivePusher#startAudioCapture} 开始音频采集。
-     * @order 21
+     * @notes
+     *        调用该接口后，可以通过调用接口 [startAudioCapture:](#VeLivePusher-startaudiocapture) 开始音频采集。
+     * @order 16
      */
+    
     stopAudioCapture(): void;
     /** {zh}
      * @detail api
      * @brief 切换音频采集类型。
-     * @notes <br>
-     *    该接口必须在调用接口 startAudioCapture:{@link #VeLivePusher#startAudioCapture} 后调用才能生效。
-     * @order 22
+     * @notes
+     *        该接口必须在调用接口 [startAudioCapture:](#VeLivePusher-startaudiocapture) 后调用才能生效。
+     * @order 17
      * @param type 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](155321#VeLiveAudioCaptureType)。
      */
+    
     switchAudioCapture(type: VeLiveAudioCaptureType): void;
     /** {zh}
      * @detail api
      * @brief 获取当前视频采集类型。
+     * @order 14
      * @return <br>
      *      视频采集类型，详细信息请参见 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType}。
-     * @order 20
      */
+    
     getCurrentVideoCaptureType(): VeLiveVideoCaptureType;
     /** {zh}
      * @detail api
      * @brief 获取当前音频采集类型。
+     * @order 18
      * @return <br>
      *      音频采集类型，详细信息请参见 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType}。
-     * @order 21
      */
+    
     getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
     /** {zh}
      * @detail api
-     * @brief 自定义静态图，适用于静态图推流采集类型。
-     * @notes <br>使用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage，您可调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 方法，将 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。
-     * @order 25
+     * @brief 自定义静态图，适用于静态图推流采集类型。使用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage，您可调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 方法，将 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。
+     * @order 19
      * @param image 静态图片，用于在静态图推流采集类型下设置静态图。
      */
+    
     updateCustomImage(image: UIImage): Promise<void>;
     /** {zh}
      * @detail api
@@ -730,51 +731,58 @@ export declare class VeLivePusher {
      * @param mute 是否设置为静音。默认为 NO。<br>
      *             - YES：静音推流；
      *             - NO：正常推流。
-     * @order 23
+     * @order 22
      */
+    
     setMute(mute: BOOL): void;
     /** {zh}
      * @detail api
      * @brief 当前是否是静音状态。
+     * @order 23
      * @return <br>
      *     - YES：当前是静音状态；
      *     - NO：当前非静音状态。
-     * @order 24
      */
+    
     isMute(): BOOL;
     /** {zh}
      * @detail api
      * @brief 设置推流视频编码参数。
      * @notes <br>
      *    该接口可在推流开始前或开始后调用。
-     * @order 25
+     * @order 29
      * @param config 推流视频参数，支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](155321#VeLiveVideoEncoderConfiguration)。
      */
+    
     setVideoEncoderConfiguration(config: VeLiveVideoEncoderConfiguration): void;
     /** {zh}
      * @detail api
      * @brief 设置推流音频编码参数。
-     * @notes <br>
-     *    该接口需要在 startPush:{@link #VeLivePusher#startPush} 或 startPushWithUrls:{@link #VeLivePusher#startPushWithUrls} 方法之前调用。
-     * @order 29
+     * @notes
+     *        该接口需要在 [startPush:](#VeLivePusher-startpush) 或 [startPushWithUrls:](#VeLivePusher-startpushwithurls) 方法之前调用。
+     * @order 28
      * @param config 推流音频编码参数，详情请参见 [VeLiveAudioEncoderConfiguration](155321#VeLiveAudioEncoderConfiguration)。
      */
+    
     setAudioEncoderConfiguration(config: VeLiveAudioEncoderConfiguration): void;
     /** {zh}
      * @detail api
      * @brief 开始本地文件录制。
-     * @order 27
+     * @order 44
      * @param path 录制文件保存路径，不能为空。
      * @param config 文件录制设置，详情请参见 [VeLiveFileRecorderConfiguration](155321#VeLiveFileRecorderConfiguration)。
      * @param listener 本地文件录制的监听，详情请参见 [VeLiveFileRecordingListener](155319#VeLiveFileRecordingListener)。
      */
+    
     startFileRecording(path: NSString, config: VeLiveFileRecorderConfiguration, listener: id<VeLiveFileRecordingListener>): void;
     /** {zh}
      * @detail api
      * @brief 停止本地文件录制。
-     * @notes <br>该接口需要在 [startFileRecording](#VeLivePusher-startfilerecording-config-listener) 方法之后调用。
-     * @order 28
+     * @notes
+     *        该接口需要在 [startFileRecording](#VeLivePusher-startfilerecording-config-listener) 方法之后调用。
+     * @order 46
      */
+    
     stopFileRecording(): void;
     /** {zh}
      * @detail api
@@ -782,30 +790,25 @@ export declare class VeLivePusher {
      *        - 控制闪光灯开关
      *        - 设置摄像头缩放比例
      *        - 设置自动对焦
-     * @return <br>
-     *      相机设备管理对象 VeLiveCameraDevice{@link #VeLiveCameraDevice}。
-     * @notes <br>该接口需要在 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureBackCamera。
+     * @notes
+     *        该接口需要在 [startVideoCapture:](#VeLivePusher-startvideocapture) 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureBackCamera。
      * @order 32
+     * @return
+     *          相机设备管理对象 [VeLiveCameraDevice](#VeLiveCameraDevice)。
      */
+    
     getCameraDevice(): VeLiveCameraDevice;
     /** {zh}
      * @detail api
      * @brief 获取音频模块管理对象。
-     * @return <br>
-     *      音频模块管理对象 VeLiveAudioDevice{@link #VeLiveAudioDevice}。
-     * @notes <br>
-     *    该接口需要在 startAudioCapture:{@link #VeLivePusher#startAudioCapture} 方法中设置 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType} 为 VeLiveAudioCaptureMicrophone。
+     * @notes
+     *        该接口需要在 [startAudioCapture:](#VeLivePusher-startaudiocapture) 方法中设置 [VeLiveAudioCaptureType](155321#VeLiveAudioCaptureType) 为 VeLiveAudioCaptureMicrophone。
      * @order 33
+     * @return
+     *         音频模块管理对象 [VeLiveAudioDevice](#VeLiveAudioDevice)。
      */
+    
     getAudioDevice(): VeLiveAudioDevice;
-    /** {zh}
-     * @detail api
-     * @brief 获取混流管理对象。
-     * @return <br>
-     *      混流管理对象 VeLiveMixerManager{@link #VeLiveMixerManager}。
-     * @order 31
-     */
-    getMixerManager(): VeLiveMixerManager;
     /** {zh}
      * @detail api
      * @brief 获取视频特效管理对象 `VeLiveVideoEffectManager`。通过视频特效管理，您可以使用以下功能。
@@ -814,70 +817,75 @@ export declare class VeLivePusher {
      *        - 设置素材
      *        - 设置贴纸
      *        - 设置滤镜
-     * @return <br>
-     *      视频特效管理对象 VeLiveVideoEffectManager{@link #VeLiveVideoEffectManager}。
-     * @notes <br>
-     *    该接口需要集成美颜特效 CV SDK 后才能使用。
-     * @order 32
+     * @notes
+     *        该接口需要集成智能美化特效 SDK 后才能使用。
+     * @order 31
+     * @return
+     *         视频特效管理对象 [VeLiveVideoEffectManager](#VeLiveVideoEffectManager)。
      */
+    
     getVideoEffectManager(): VeLiveVideoEffectManager;
     /** {zh}
      * @detail api
      * @brief 创建播放器。
-     * @return <br>
-     *      播放器管理对象 VeLiveMediaPlayer{@link #VeLiveMediaPlayer}。
-     * @order 33
+     * @order 3
+     * @return
+     *         播放器管理对象 [VeLiveMediaPlayer](#VeLiveMediaPlayer)。
      */
+    
     createPlayer(): VeLiveMediaPlayer;
     /** {zh}
      * @detail api
      * @brief 自定义视频处理。
      * @param filter 视频帧滤镜对象 VeLiveVideoFrameFilter{@link #VeLiveVideoFrameFilter}。
-     * @order 34
+     * @order 36
      */
+    
     setVideoFrameFilter(filter: id<VeLiveVideoFrameFilter>): void;
     /** {zh}
      * @detail api
      * @brief 自定义音频处理。
      * @param filter 音频帧滤镜对象 VeLiveAudioFrameFilter{@link #VeLiveAudioFrameFilter}。
-     * @order 35
+     * @order 40
      */
+    
     setAudioFrameFilter(filter: id<VeLiveAudioFrameFilter>): void;
     /** {zh}
      * @detail api
      * @brief 设置推流视频帧朝向。默认为竖屏推流。
      * @param orientation 视频帧朝向。
+     * @order 9
      */
+    
     setOrientation(orientation: UIInterfaceOrientation): void;
     /** {zh}
      * @detail api
      * @brief 设置推流水印。
-     * @return <br>
-     *     - 0：水印设置成功；
-     *     - <0：水印设置失败。
-     * @order 37
+     * @order 35
      * @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：水印设置失败。
      */
+    
     setWatermark(image: UIImage, x: float, y: float, scale: float): Promise<int>;
     /** {zh}
      * @detail api
      * @brief 视频截图。
-     * @order 38
+     * @order 34
      * @param listener 截图监听对象，详情请参见 [VeLiveSnapshotListener](155319#VeLiveSnapshotListener)。
      */
+    
     snapshot(listener: id<VeLiveSnapshotListener>): void;
     /** {zh}
      * @detail api
      * @brief 通过视频帧发送 SEI 消息。
-     * @return <br>
-     *     - 0：成功；
-     *     - <0：失败。
-     * @notes <br>
-     *    该接口需要在调用 startPush:{@link #VeLivePusher#startPush} 或 startPushWithUrls:{@link #VeLivePusher#startPushWithUrls} 方法之后调用。
-     * @order 42
+     * @notes
+     *        该接口需要在调用 [startPush:](#VeLivePusher-startpush) 或 [startPushWithUrls:](#VeLivePusher-startpushwithurls) 方法之后调用。
+     * @order 41
      * @param key SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Key。
      * @param value SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Value。
      * @param repeat 消息发送重复的次数。例如，`repeat` 取值为 20，`isKeyFrame` 取值为 YES，则会在调用该方法后连续 20 个关键帧中添加 SEI 消息。
@@ -887,210 +895,231 @@ export declare class VeLivePusher {
      * @param allowsCovered 是否允许覆盖。<br>
      *        - YES：允许；
      *        - NO：不允许。
+     * @return <br>
+     *     - 0：成功；
+     *     - <0：失败。
      */
+    
     sendSeiMessage(key: NSString, value: id, repeat: int, isKeyFrame: BOOL, allowsCovered: BOOL): int;
     /** {zh}
      * @detail api
      * @brief 推送外部视频帧数据。
+     * @notes
+     *        该接口需要在 [startVideoCapture:](#VeLivePusher-startvideocapture) 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureExternal。
+     * @order 37
+     * @param frame 视频帧的数据信息，详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
      * @return <br>
      *     - 0：成功；
      *     - <0：失败。
-     * @notes <br>该接口需要在 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureExternal。
-     * @order 43
-     * @param frame 视频帧的数据信息，详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
      */
+    
     pushExternalVideoFrame(frame: VeLiveVideoFrame): int;
     /** {zh}
      * @detail api
      * @brief 推送外部视频编码数据。
+     * @notes
+     *        该接口需要在 [startVideoCapture:](#VeLivePusher-startvideocapture) 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureExternal。
+     * @order 38
+     * @param encodeFrame 视频编码帧的数据信息，详情请参见 [VeLiveVideoEncodeFrame](155321#VeLiveVideoEncodeFrame)。
      * @return <br>
      *     - 0：成功；
      *     - <0：失败。
-     * @notes <br>该接口需要在 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureExternal。
-     * @order 44
-     * @param encodeFrame 视频编码帧的数据信息，详情请参见 [VeLiveVideoEncodeFrame](155321#VeLiveVideoEncodeFrame)。
      */
+    
     pushExternalVideoEncodeFrame(encodeFrame: VeLiveVideoEncodeFrame): int;
     /** {zh}
      * @detail api
      * @brief 推送外部音频帧数据。
+     * @notes
+     *        该接口需要在 [startAudioCapture:](#VeLivePusher-startaudiocapture) 方法中设置 [VeLiveAudioCaptureType](155321#VeLiveAudioCaptureType) 为 VeLiveAudioCaptureExternal。
+     * @order 39
+     * @param frame 外部音频数据。详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
      * @return <br>
      *      - 0：成功；
      *      - <0：失败。
-     * @notes <br>
-     *    该接口需要在 startAudioCapture:{@link #VeLivePusher#startAudioCapture}  方法中设置 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType} 为 VeLiveAudioCaptureExternal。
-     * @order 45
-     * @param frame 外部音频数据。详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
      */
+    
     pushExternalAudioFrame(frame: VeLiveAudioFrame): int;
     /** {zh}
      * @detail api
-     * @brief 高级配置。
+     * @brief 高级配置。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)，了解配置方法。
+     * @order 42
+     * @param key 推流高级配置为 JSON 格式的字符串，此参数为 JSON 结构中的 Key。
+     * @param value 推流高级配置为 JSON 格式的字符串，此参数为 JSON 结构中的 Value。建议传入 NSDictionary 或者 NSString 对象。
      * @return <br>
      *     - 0：成功；
      *     - -1：失败，参数错误。
-     * @order 43
-     * @param key 推流高级配置为 JSON 格式的字符串，此参数为 JSON 结构中的 Key。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)，了解配置方法。
-     * @param value 推流高级配置为 JSON 格式的字符串，此参数为 JSON 结构中的 Value。建议传入 NSDictionary 或者 NSString 对象。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)，了解配置方法。
      */
+    
     setProperty(key: NSString, value: id): int;
     /** {zh}
      * @detail api
      * @brief 强制请求 IDR 帧，发起请求以编码一个新的 IDR 帧。
-     * @notes <br>
-     *    该接口需要在调用 startPush:{@link #VeLivePusher#startPush} 或 startPushWithUrls:{@link #VeLivePusher#startPushWithUrls} 方法之后调用。
-     * @order 47
+     * @notes
+     *        该接口需要在调用 [startPush:](#VeLivePusher-startpush) 或 [startPushWithUrls:](#VeLivePusher-startpushwithurls) 方法之后调用。
+     * @order 49
      */
+    
     requestIDRFrame(): void;
 }
 export declare class VeLiveVideoEffectManager {
     /** {zh}
      * @detail api
      * @brief 视频特效许可证配置，用于初始化视频特效管理对象。
+     * @order 2
+     * @param config 特效初始化配置，详情请参见 [VeLiveVideoEffectLicenseConfiguration](155321#VeLiveVideoEffectLicenseConfiguration)。
      * @return <br>
      *     - 0：调用成功；
      *     - -1：调用失败。
-     * @order 76
-     * @param config 特效初始化配置，详情请参见 [VeLiveVideoEffectLicenseConfiguration](155321#VeLiveVideoEffectLicenseConfiguration)。
      */
+    
     setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): int;
     /** {zh}
      * @detail api
-     * @brief 更新在线 License。本方法仅对在线 License 有效。
-     * @notes <br>
-     *     - 需要通过调用 setupWithConfig:{@link #VeLiveVideoEffectManager#setupWithConfig} 设置视频特效许可证后调用；
-     *     - 如果您使用在线 License 认证方式，在许可证过期后，可调用该方法更新 License；
-     *     - 本方法为异步操作。
-     * @order 76
+     * @brief 在许可证过期后，可调用该方法更新 License，本方法仅对在线 License 有效。
+     * @notes
+     *        - 需要通过调用 [setupWithConfig:](155318#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用；
+     *        - 本方法为异步操作。
+     * @order 3
      * @param completion 结果回调信息。
      */
+    
     updateLicense(completion: (result: number, message: string) => void): void;
     /** {zh}
      * @detail api
      * @brief 设置特效算法模型包的路径。
-     * @return <br>
-     *     - 0：调用成功；
-     *     - -1：调用失败。
      * @notes <br>
      *     需要通过调用 setupWithConfig:{@link #VeLiveVideoEffectManager#setupWithConfig} 设置视频特效许可证后调用。
-     * @order 77
+     * @order 4
      * @param path 特效算法模型包的路径。
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
      */
+    
     setAlgoModelPath(path: NSString): int;
     /** {zh}
      * @detail api
      * @brief 创建/销毁特效引擎。
-     * @return <br>
-     *     - 0：调用成功；
-     *     - -1：调用失败。
-     * @notes <br>
-     *        - 该方法需要在调用 setupWithConfig:{@link #VeLiveVideoEffectManager#setupWithConfig} 和 setAlgoModelPath:{@link #VeLiveVideoEffectManager#setAlgoModelPath} 后调用；
-     *        - 该方法不直接开启/关闭视频特效，您需要在调用该方法后，调用 setComposeNodes:{@link #VeLiveVideoEffectManager#setComposeNodes} 开启视频特效；
+     * @notes
+     *        - 该方法需要在调用 [setupWithConfig:](#VeLiveVideoEffectManager-setupwithconfig) 和 [setAlgoModelPath:](#VeLiveVideoEffectManager-setalgomodelpath) 后调用；
+     *        - 该方法不直接开启/关闭视频特效，您需要在调用该方法后，调用 [setComposeNodes:](#VeLiveVideoEffectManager-setcomposenodes) 开启视频特效；
      *        - 通用场景下，特效引擎会随 EffectManager 销毁而销毁。如果您对性能有较高要求，也可以在不使用特效相关功能时，调用该方法销毁特效引擎；
      *        - 如果重复创建/销毁特效引擎，会产生时间消耗。
-     * @order 78
+     * @order 5
      * @param enable 是否创建特效引擎。默认为 NO。 <br>
      *               - YES：创建；
      *               - NO：销毁。
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
      */
+    
     setEnable(enable: BOOL): int;
     /** {zh}
      * @detail api
      * @brief 设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能，包括美颜、美形、美体、美妆等。
+     * @notes
+     *        - 需要在调用 [setEnable:](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法；
+     *        - 重复调用本方法，仅最后一次调用生效；
+     *        - 如果需要在当前的视频特效组合中叠加特效，可调用 [appendComposeNodes:](#VeLiveVideoEffectManager-appendcomposenodes) 方法。
+     * @order 6
+     * @param nodes 视频特效素材包路径数组。
      * @return <br>
      *     - 0：调用成功；
      *     - -1：调用失败。
-     * @notes <br>
-     *        - 需要在调用 setEnable:{@link #VeLiveVideoEffectManager#setEnable} 创建特效引擎后，调用本方法；
-     *        - 重复调用本方法，仅最后一次调用生效；
-     *        - 如果需要在当前的视频特效组合中叠加特效，可调用 appendComposeNodes:{@link #VeLiveVideoEffectManager#appendComposeNodes} 方法。
-     * @order 79
-     * @param nodes 视频特效素材包路径数组。
      */
+    
     setComposeNodes(nodes: NSArray<NSString>): int;
     /** {zh}
      * @detail api
-     * @brief 在已有的视频特效组合上，叠加视频特效素材包。
+     * @brief 调用本方法，会在 [setComposeNodes:](#VeLiveVideoEffectManager-setcomposenodes) 设置的视频特效组合的基础上叠加特效。
+     * @notes 需要在调用 [setEnable:](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法。
+     * @order 7
+     * @param nodes 视频特效素材包路径数组。
      * @return <br>
      *     - 0：调用成功；
      *     - -1：调用失败。
-     * @notes <br>
-     *        - 需要在调用 setEnable:{@link #VeLiveVideoEffectManager#setEnable} 创建特效引擎后，调用本方法。
-     *        - 调用本方法，会在 setComposeNodes:{@link #VeLiveVideoEffectManager#setComposeNodes} 设置的视频特效组合的基础上叠加特效。
-     * @order 80
-     * @param nodes 视频特效素材包路径数组。
      */
+    
     appendComposeNodes(nodes: NSArray<NSString>): int;
     /** {zh}
      * @detail api
-     * @brief 移除指定的视频特效资源。
+     * @brief 调用本方法，可移除调用 [setComposeNodes:](#VeLiveVideoEffectManager-setcomposenodes) 和 [ppendComposeNodes:](#VeLiveVideoEffectManager-appendcomposenodes) 设置的视频特效资源。
+     * @notes 需要在调用 [setEnable:](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法。
+     * @order 8
+     * @param nodes 视频特效素材包路径数组。
      * @return <br>
      *     - 0：调用成功；
      *     - -1：调用失败。
-     * @notes <br>
-     *        - 需要在调用 setEnable:{@link #VeLiveVideoEffectManager#setEnable} 创建特效引擎后，调用本方法。
-     *        - 调用本方法，可移除调用 setComposeNodes:{@link #VeLiveVideoEffectManager#setComposeNodes} 和 appendComposeNodes:{@link #VeLiveVideoEffectManager#appendComposeNodes} 设置的视频特效资源。
-     * @order 81
-     * @param nodes 视频特效素材包路径数组。
      */
+    
     removeComposeNodes(nodes: NSArray<NSString>): int;
     /** {zh}
      * @detail api
      * @brief 设置视频特效强度。
-     * @return <br>
-     *     - 0：调用成功；
-     *     - -1：调用失败。
-     * @notes <br>
-     *        - 需要在调用 setComposeNodes:{@link #VeLiveVideoEffectManager#setComposeNodes} 设置视频特效组合或调用 appendComposeNodes:{@link #VeLiveVideoEffectManager#appendComposeNodes} 叠加视频特效素材包后，调用本方法；
+     * @notes
+     *        - 需要在调用 [setComposeNodes:](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合或调用 [appendComposeNodes:](#VeLiveVideoEffectManager-appendcomposenodes) 叠加视频特效素材包后，调用本方法；
      *        - 该方法仅适用于同时含有上述三个参数的特效资源，对于没有强度参数的特效（如贴纸），该方法无效。
-     * @order 82
+     * @order 9
      * @param node 视频特效素材包路径。
      * @param key 需要设置的素材 key 名称
      * @param intensity 需要设置的强度值。取值范围为 [0.0,1.0]。
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
      */
+    
     updateComposerNodeIntensity(node: NSString, key: NSString, intensity: float): int;
     /** {zh}
      * @detail api
      * @brief 设置颜色滤镜。
+     * @notes
+     *        请在调用 [setEnable:](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法。
+     * @order 11
+     * @param path 滤镜资源包绝对路径。
      * @return <br>
      *     - 0：调用成功；
      *     - -1：调用失败。
-     * @notes <br>请在调用 setEnable:{@link #VeLiveVideoEffectManager#setEnable} 开启视频特效后，调用该方法。
-     * @order 83
-     * @param path 滤镜资源包绝对路径。
      */
+    
     setFilter(path: NSString): int;
     /** {zh}
      * @detail api
      * @brief 设置已启用的颜色滤镜强度。
+     * @notes
+     *        请在调用 [setFilter:](#VeLiveVideoEffectManager-setfilter) 设置颜色滤镜后调用。
+     * @order 12
+     * @param intensity 滤镜强度，取值范围为 [0.0,1.0]。
      * @return <br>
      *     - 0：调用成功；
      *     - -1：调用失败。
-     * @notes <br>
-     *     请在调用 setFilter:{@link #VeLiveVideoEffectManager#setFilter} 设置颜色滤镜后调用。
-     * @order 84
-     * @param intensity 滤镜强度，取值范围为 [0.0,1.0]。
      */
+    
     updateFilterIntensity(intensity: float): int;
     /** {zh}
      * @detail api
      * @brief 设置贴纸特效。
+     * @notes
+     *        请在调用 [setEnable:](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法。
+     * @order 10
+     * @param path 贴纸素材包的绝对路径。
      * @return <br>
      *     - 0：调用成功；
      *     - -1：调用失败。
-     * @notes <br>请在调用 setEnable:{@link #VeLiveVideoEffectManager#setEnable} 开启视频特效后，调用该方法。
-     * @order 85
-     * @param path 贴纸素材包的绝对路径。
      */
+    
     setSticker(path: NSString): int;
     /** {zh}
      * @detail api
      * @brief 智能美化特效（简称 CV）高级接口。
-     * @notes <br>请在调用 [setEnable:](155318#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法，不要在主线程中频繁执行同步操作。
+     * @notes
+     *        请在调用 [setEnable:](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法，不要在主线程中频繁执行同步操作。
      * @param callback 回调 CV 的 handle。
      * @param isGLThread 是否在 GL 线程回调 callback。
      * @param isAsync 是否同步执行 callback。
      */
+    
     setAdvancedFeature(callback: (handle: void) => void, isGLThread: BOOL, isAsync: BOOL): void;
     init(): this;
 }