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

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

@@ -0,0 +1,1068 @@
+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>
+     *      相机支持帧率范围。
+     *
+     */
+    
+    getRealFpsRange(): Array<int>;
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭闪光灯。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 8
+     * @param enable 是否开启闪光灯。默认为 false。 <br>
+     *        - true：开启；
+     *        - false：关闭。
+     * @return <br>
+     *     - 0：开启/关闭成功；
+     *     - ≠0：开启/关闭失败。
+     *
+     */
+    
+    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：缩放失败。
+     *
+     */
+    
+    setZoomRatio(ratio: float): int;
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头当前的缩放倍数。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 4
+     * @return <br>
+     *         - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示当前缩放倍数。
+     *
+     */
+    
+    getCurrentZoomRatio(): float;
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头的最大缩放倍数。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 6
+     * @return <br>
+     *         - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示最大缩放倍数。
+     *
+     */
+    
+    getMaxZoomRatio(): float;
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头的最小缩放倍数。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 7
+     * @return <br>
+     *         - ≤0：表示不支持缩放；
+     *         - >0：支持缩放，数值表示最小缩放倍数。
+     *
+     */
+    
+    getMinZoomRatio(): float;
+    /** {zh}
+     * @detail api
+     * @brief 是否支持自动对焦。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 9
+     * @return <br>
+     *     - true：支持；
+     *     - false：不支持。
+     *
+     */
+    
+    isAutoFocusEnabled(): boolean;
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭自动对焦功能。
+     * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 10
+     * @param enable 是否开启自动对焦，默认为 true。
+     *     - true：开启；
+     *     - false：关闭。
+     * @return <br>
+     *     - 0：开启/关闭成功；
+     *     - ≠0：开启/关闭失败。
+     *
+     */
+    
+    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：设置失败。
+     *
+     */
+    
+    setFocusPosition(viewW: int, viewH: int, x: int, y: int): int;
+    /** {zh}
+     * @detail api
+     * @brief 检查当前使用的摄像头是否支持手动设置曝光点。
+     * @notes 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。
+     * @order 12
+     * @return - YES：支持；
+     *         - NO：不支持。
+     *
+     */
+    
+    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：失败。
+     *
+     */
+    
+    setExposurePosition(viewW: int, viewH: int, x: int, y: int): int;
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头的最小曝光补偿值。
+     * @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 14
+     * @return - ≤0：表示不支持曝光补偿；
+     *         - >0：支持曝光补偿，数值表示最小曝光补偿。
+     *
+     */
+    
+    getMinExposureCompensation(): float;
+    /** {zh}
+     * @detail api
+     * @brief 获取摄像头的最大曝光补偿值。
+     * @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。
+     * @order 15
+     * @return - ≤0：表示不支持曝光补偿；
+     *         - >0：支持曝光补偿，数值表示最大曝光补偿。
+     *
+     */
+    
+    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：设置失败。
+     *
+     */
+    
+    setExposureCompensation(value: float): int;
+}
+export declare class VeLiveVideoEffectManager {
+    /** {zh}
+     * @detail api
+     * @brief 视频特效许可证配置，用于初始化视频特效管理对象。
+     * @order 89
+     * @param config 特效初始化配置，详情请参见 [VeLiveVideoEffectLicenseConfiguration](147521#VeLivePusherDef-VeLiveVideoEffectLicenseConfiguration)。
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
+    
+    setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): int;
+    /** {zh}
+     * @detail api
+     * @brief 如果您使用在线 License 认证方式，在许可证过期后，可调用该方法更新 License；
+     * @notes - 需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用；
+     *        - 本方法为异步操作。
+     * @order 90
+     * @param callback 结果回调信息
+     *
+     */
+    
+    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：失败。
+     *
+     */
+    
+    setEnable(enable: boolean, callback: VeLiveVideoEffectCallback): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置特效算法模型包的路径。
+     * @notes <br>需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用。
+     * @order 91
+     * @param path 特效算法模型包的路径
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
+    
+    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：调用失败。
+     *
+     */
+    
+    setComposeNodes(nodes: Array<String>): int;
+    /** {zh}
+     * @detail api
+     * @brief 在已有的视频特效组合上，叠加视频特效素材包，您可以调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合。
+     * @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法。
+     * @order 94
+     * @param nodes 视频特效素材包路径数组
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
+    
+    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：调用失败。
+     *
+     */
+    
+    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：调用失败。
+     *
+     */
+    
+    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：调用失败。
+     *
+     */
+    
+    setFilter(path: String): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置已启用的颜色滤镜强度。
+     * @notes <br>请在调用 [setFilter](#VeLiveVideoEffectManager-setfilter) 设置颜色滤镜后调用。
+     * @order 97
+     * @param intensity 滤镜强度，取值范围为 [0.0,1.0]。
+     * @return - 0：调用成功；
+     *         - -1：调用失败。
+     *
+     */
+    
+    updateFilterIntensity(intensity: float): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置贴纸特效。
+     * @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法。
+     * @order 98
+     * @param path 贴纸素材包的绝对路径
+     * @return <br>
+     *     - 0：调用成功；
+     *     - -1：调用失败。
+     *
+     */
+    
+    setSticker(path: String): int;
+    /** {zh}
+     * @detail api
+     * @brief 智能美化特效的高级功能。
+     * @notes 请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法，不要在主线程中频繁执行同步操作。
+     * @order 99
+     * @param callback 将 handle 作为参数的回调函数。
+     * @param isGLThread 是否在 GL 线程回调 callback。
+     * @param isAsync 是否同步执行 callback。
+     *
+     */
+    
+    setAdvancedFeature(callback: VeLiveVideoEffectHandleCallback, isGLThread: boolean, isAsync: boolean): int;
+}
+export declare class VeLivePusher {
+    /** {zh}
+     * @detail api
+     * @hidden
+     * @brief 获取当前 SDK 版本号。
+     * @return <br>
+     *    当前 SDK 版本号。
+     *
+     */
+    
+    static getVersion(): String;
+    /** {zh}
+     * @detail api
+     * @brief 设置输出到控制台的日志等级。
+     * @order 49
+     * @param logLevel 输出的日志级别。级别详情请参见 [VeLivePusherLogLevel](147521#VeLivePusherLogLevel)。
+     *
+     */
+    
+    static setLogLevel(logLevel: VeLivePusherLogLevel): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置 OpenGL 的上下文。
+     * @order 50
+     * @param context OpenGL 上下文。
+     *
+     */
+    
+    static setEGLContext(context: EGLContext): void;
+    /** {zh}
+     * @detail api
+     * @brief 停止采集和推流，并销毁推流器。通常在调用 [stopPush](#VeLivePusher-stoppush) 结束推流后调用此方法进行清理。
+     * @order 4
+     *
+     */
+    
+    release(): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流器回调，通过设置回调，监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。
+     * @notes <br>
+     *     - 需要在创建推流引擎后，调用本方法；
+     *     - 重复调用本方法，仅最后一次调用生效。
+     * @order 2
+     * @param observer 推流器回调对象，详细信息请参见 [VeLivePusherObserver](147519#VeLivePusherObserver)。
+     *
+     */
+    
+    setObserver(observer: VeLivePusherObserver): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流器周期性回调，用于定期获取推流状态信息。
+     * @notes <br>
+     *     - 需要在创建推流引擎后，调用本方法；
+     *     - 重复调用本方法，仅最后一次调用生效。
+     * @order 3
+     * @param observer 推流器周期性回调对象，详细信息请参见 [VeLivePusherStatisticsObserver](147519#VeLivePusherDef-VeLivePusherStatisticsObserver)。
+     * @param interval 周期性回调的时间间隔，单位为 s，默认值为 5。
+     *
+     */
+    
+    setStatisticsObserver(observer: VeLivePusherStatisticsObserver, interval: int): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置本地摄像头预览视图。摄像头采集到的画面，经过美颜、脸形调整、滤镜等多种效果叠加之后，最终会显示到传入的 View 上。
+     * @param view 摄像头预览视图
+     * @order 5
+     *
+     */
+    
+    setRenderView(view: View): Promise<void>;
+    /** {zh}
+     * @detail api
+     * @brief 设置本地预览画面的填充模式。
+     * @param mode 填充模式。
+     * @order 6
+     *
+     */
+    
+    setRenderFillMode(mode: VeLivePusherRenderMode): void;
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭镜像。
+     * @notes <br>
+     *     用于配置视频镜像效果，影响采集、预览和推流画面。
+     * @order 7
+     * @param type 镜像类型，详细信息请参见 [VeLiveVideoMirrorType](147521#VeLiveVideoMirrorType)。
+     * @param mirror 是否开启镜像。<br>
+     *               - true：开启；
+     *               - false：关闭。
+     *
+     */
+    
+    setVideoMirror(type: VeLiveVideoMirrorType, mirror: boolean): void;
+    /** {zh}
+     * @detail api
+     * @brief 开始视频采集。
+     * @notes <br>调用该接口后，可以通过调用接口 [stopVideoCapture](#VeLivePusher-stopvideocapture) 停止视频采集。
+     * @order 8
+     * @param type 视频采集类型，详细信息请参见 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType}
+     *
+     */
+    
+    startVideoCapture(type: VeLiveVideoCaptureType): void;
+    /** {zh}
+     * @detail api
+     * @brief 停止视频采集。
+     * @notes <br>调用该接口后，可以通过调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 开始视频采集。
+     * @order 10
+     *
+     */
+    
+    stopVideoCapture(): void;
+    /** {zh}
+     * @detail api
+     * @brief 开始音频采集。
+     * @notes <br>调用该接口后，可以通过调用接口 [stopAudioCapture](#VeLivePusher-stopaudiocapture) 停止音频采集。
+     * @order 9
+     * @param type 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
+     *
+     */
+    
+    startAudioCapture(type: VeLiveAudioCaptureType): void;
+    /** {zh}
+     * @detail api
+     * @brief 停止音频采集。
+     * @notes <br>调用该接口后，可以通过调用接口 [startAudioCapture](#VeLivePusher-startaudiocapture) 开始音频采集。
+     * @order 11
+     *
+     */
+    
+    stopAudioCapture(): void;
+    /** {zh}
+     * @detail api
+     * @brief 切换视频采集类型。
+     * @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
+     * @order 12
+     * @param type 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
+     *
+     */
+    
+    switchVideoCapture(type: VeLiveVideoCaptureType): void;
+    /** {zh}
+     * @detail api
+     * @brief 切换音频采集类型。
+     * @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
+     * @order 13
+     * @param type 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
+     *
+     */
+    
+    switchAudioCapture(type: VeLiveAudioCaptureType): void;
+    /** {zh}
+     * @detail api
+     * @brief 获取当前视频采集类型。
+     * @order 14
+     * @return 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
+     *
+     */
+    
+    getCurrentVideoCaptureType(): VeLiveVideoCaptureType;
+    /** {zh}
+     * @detail api
+     * @brief 获取当前音频采集类型。
+     * @order 15
+     * @return <br>音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
+     *
+     */
+    
+    getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
+    /** {zh}
+     * @detail api
+     * @brief 自定义静态图，适用于静态图推流采集类型。使用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage，您可调用 [startVideoCapture](#VeLivePusher-startvideocapture) 方法，将 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。
+     * @order 16
+     * @param image 静态图片，用于在静态图推流采集类型下设置静态图。
+     *
+     */
+    
+    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)。
+     *
+     */
+    
+    getCameraDevice(): VeLiveCameraDevice;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频编码参数。
+     * @notes 该接口可在推流开始前或开始后调用。
+     * @order 18
+     * @param config 推流视频参数，支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
+    
+    setVideoEncoderConfiguration(config: VeLiveVideoEncoderConfiguration): void;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流视频编码参数。
+     * @order 19
+     * @return 推流视频参数，支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
+     *
+     */
+    
+    getVideoEncoderConfiguration(): VeLiveVideoEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流音频编码参数。
+     * @notes <br>该接口需要在 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之前调用。
+     * @order 20
+     * @param config 推流音频编码参数，详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
+     *
+     */
+    
+    setAudioEncoderConfiguration(config: VeLiveAudioEncoderConfiguration): void;
+    /** {zh}
+     * @detail api
+     * @brief 获取推流音频编码参数。
+     * @order 21
+     * @return 推流音频编码参数，详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
+     *
+     */
+    
+    getAudioEncoderConfiguration(): VeLiveAudioEncoderConfiguration;
+    /** {zh}
+     * @detail api
+     * @brief 开始推流。
+     * @order 22
+     * @param url 推流地址，用于将直播流推送到目标服务器。
+     *
+     */
+    
+    startPush(url: String): void;
+    /** {zh}
+     * @detail api
+     * @brief 开始推流，支持备用推流地址。
+     * @notes <br>
+     *    当主推流地址不可用时，会自动切换到备用推流地址继续推流。
+     * @order 23
+     * @param urls 推流地址列表，包含一个或多个推流地址。
+     *
+     */
+    
+    startPushWithUrls(urls: Array<String>): void;
+    /** {zh}
+     * @detail api
+     * @brief 停止推流。
+     * @notes <br>停止推流后，可以通过调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法重新开始推流。
+     * @order 24
+     *
+     */
+    
+    stopPush(): void;
+    /** {zh}
+     * @detail api
+     * @brief 当前是否正在推流中，可用来查询推流器的当前状态。
+     * @order 25
+     * @return <br>
+     *      是否正在推流。<br>
+     *         - true：正在推流中；
+     *         - false：已经停止推流。
+     *
+     */
+    
+    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：水印设置失败。
+     *
+     */
+    
+    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)。
+     *
+     */
+    
+    startFileRecording(path: String, config: VeLiveFileRecorderConfiguration, listener: VeLiveFileRecordingListener): void;
+    /** {zh}
+     * @detail api
+     * @brief 停止本地文件录制。
+     * @notes <br>该接口需要在 [startFileRecording](#VeLivePusher-startfilerecording) 方法之后调用。
+     * @order 28
+     *
+     */
+    
+    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：失败，参数错误。
+     *
+     */
+    
+    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：失败。
+     *
+     */
+    
+    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：失败。
+     *
+     */
+    
+    pushExternalAudioFrame(frame: VeLiveAudioFrame): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置推流视频帧朝向。默认为竖屏推流。
+     * @order 32
+     * @param orientation 视频帧朝向，详情请参见 [VeLiveOrientation](147521#VeLiveOrientation)。
+     *
+     */
+    
+    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：失败。
+     *
+     */
+    
+    sendSeiMessage(key: String, value: Object, repeat: int, isKeyFrame: boolean, allowsCovered: boolean): int;
+    /** {zh}
+     * @detail api
+     * @brief 设置静音。
+     * @param mute 是否设置为静音。默认为正常推流。<br>
+     *             - true：静音推流；
+     *             - false：正常推流。
+     * @order 34
+     *
+     */
+    
+    setMute(mute: boolean): void;
+    /** {zh}
+     * @detail api
+     * @brief 当前是否是静音状态。
+     * @order 35
+     * @return <br>
+     *     - true：当前是静音状态；
+     *     - false：当前非静音状态。
+     *
+     */
+    
+    isMute(): boolean;
+    /** {zh}
+     * @detail api
+     * @brief 获取视频特效管理对象 `VeLiveVideoEffectManager`。通过视频特效管理，您可以使用以下功能。
+     *        - 设置美颜
+     *        - 设置特效
+     *        - 设置素材
+     *        - 设置贴图
+     *        - 设置滤镜
+     * @notes 该接口需要集成智能美化特效 SDK 后才能使用。
+     * @order 36
+     * @return 视频特效管理对象 [VeLiveVideoEffectManager](#VeLiveVideoEffectManager)。
+     *
+     */
+    
+    getVideoEffectManager(): VeLiveVideoEffectManager;
+    /** {zh}
+     * @detail api
+     * @brief 自定义视频处理。
+     * @order 37
+     * @param filter 视频数据处理回调，详情请参见 [VeLiveVideoFrameFilter](147519#VeLivePusherDef-VeLiveVideoFrameFilter)。
+     *
+     */
+    
+    setVideoFrameFilter(filter: VeLiveVideoFrameFilter): void;
+    /** {zh}
+     * @detail api
+     * @brief 获取音频模块管理对象。
+     * @notes <br>
+     *    该接口需要在 startAudioCapture{@link #startAudioCapture}  方法中设置 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType} 为 VeLiveAudioCaptureMicrophone。
+     * @order 38
+     * @return 音频模块管理对象 [VeLiveAudioDevice](#VeLiveAudioDevice)。
+     *
+     */
+    
+    getAudioDevice(): VeLiveAudioDevice;
+    /** {zh}
+     * @detail api
+     * @brief 自定义音频处理。
+     * @order 39
+     * @param filter 音频帧滤镜对象 VeLiveAudioFrameFilter 。
+     *
+     */
+    
+    setAudioFrameFilter(filter: VeLiveAudioFrameFilter): void;
+    /** {zh}
+     * @detail api
+     * @brief 创建播放器。
+     * @order 1
+     * @return 播放器管理对象 [VeLiveMediaPlayer](#VeLiveMediaPlayer)。
+     *
+     */
+    
+    createPlayer(): VeLiveMediaPlayer;
+    /** {zh}
+     * @detail api
+     * @brief 开始系统音频采集。
+     * @order 41
+     *
+     */
+    
+    startMixSystemAudio(): void;
+    /** {zh}
+     * @detail api
+     * @brief 停止系统音频采集。
+     * @order 42
+     *
+     */
+    
+    stopMixSystemAudio(): void;
+    /** {zh}
+     * @detail api
+     * @brief 获取当前是否处于屏幕采集状态。
+     * @order 43
+     *
+     */
+    
+    isScreenRecording(): boolean;
+    /** {zh}
+     * @detail api
+     * @brief 添加视频帧的监听回调，用于获取推流器输出的视频帧。
+     * @order 44
+     * @param listener 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
+    
+    addVideoFrameListener(listener: VeLiveVideoFrameListener): int;
+    /** {zh}
+     * @detail api
+     * @brief 移除已添加的视频帧监听回调。
+     * @notes <br>
+     *    如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。
+     * @order 45
+     * @param listener 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
+    
+    removeVideoFrameListener(listener: VeLiveVideoFrameListener): int;
+    /** {zh}
+     * @detail api
+     * @brief 添加音频帧的监听回调，用于获取推流器输出的音频帧。
+     * @order 46
+     * @param listener 音频帧监听回调，详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
+    
+    addAudioFrameListener(listener: VeLiveAudioFrameListener): int;
+    /** {zh}
+     * @detail api
+     * @brief 移除已添加的音频帧监听回调。
+     * @notes <br>
+     *    如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。
+     * @order 47
+     * @param listener 音频帧的监听回调，详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
+     * @return <br>
+     *      - 0：成功；
+     *      - <0：失败。
+     *
+     */
+    
+    removeAudioFrameListener(listener: VeLiveAudioFrameListener): int;
+    /** {zh}
+     * @detail api
+     * @brief 视频截图。
+     * @order 48
+     * @param listener 截图监听对象，详情请参见 [VeLiveSnapshotListener](147519#VeLivePusherDef-VeLiveSnapshotListener)。
+     *
+     */
+    
+    snapshot(listener: VeLiveSnapshotListener): void;
+}
+export declare class VeLiveMediaPlayer {
+    /** {zh}
+     * @detail api
+     * @brief 销毁播放器实例。
+     * @order 1
+     *
+     */
+    
+    release(): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置播放状态的监听。
+     * @notes <br>
+     *      重复调用本方法，仅最后一次调用生效。
+     * @order 4
+     * @param listener 播放状态监听。详情请参见 [VeLiveMediaPlayerListener](147519#VeLivePusherDef-VeLiveMediaPlayerListener)。
+     *
+     */
+    
+    setListener(listener: VeLiveMediaPlayerListener): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
+     * @order 2
+     * @param url 文件路径。
+     * @return <br>
+     *        - 0：成功；
+     *        - ≠0：失败。
+     *
+     */
+    
+    prepare(url: String): int;
+    /** {zh}
+     * @detail api
+     * @brief 开始播放。
+     * @notes <br>
+     *     需要在调用 start{@link #start} 开始播放后，调用本方法。
+     * @order 12
+     *
+     */
+    
+    start(): int;
+    /** {zh}
+     * @detail api
+     * @brief 停止播放。
+     * @notes <br>
+     *     需要在调用 start{@link #start} 开始播放后，调用本方法。
+     * @order 13
+     * @return <br>
+     *        - 0：成功；
+     *        - ≠0：失败。
+     *
+     */
+    
+    stop(): int;
+    /** {zh}
+     * @detail api
+     * @brief 暂停播放。
+     * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start)[start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。
+     * @order 14
+     *
+     */
+    
+    pause(): void;
+    /** {zh}
+     * @detail api
+     * @brief 恢复播放。
+     * @notes <br>需要在调用 [pause](#VeLiveMediaPlayer-pause) 暂停播放后，调用本方法。
+     * @order 15
+     *
+     */
+    
+    resume(): void;
+    /** {zh}
+     * @detail api
+     * @brief 获取文件的总时长，单位为 ms。
+     * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。
+     * @order 3
+     * @return <br>
+     *     - >0：成功，音频文件时长；
+     *     - ≤0：失败。
+     *
+     */
+    
+    getDuration(): long;
+    /** {zh}
+     * @detail api
+     * @brief 设置播放进度。
+     * @order 5
+     * @param posMs 播放时间，单位为 ms。
+     * @return <br>
+     *        - 0：成功；
+     *        - ≠0：失败。
+     *
+     */
+    
+    seek(posMs: long): int;
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭音频是否混音到直播流。
+     * @param enable 开启/关闭，默认为 false。 <br>
+     *        - ture：开启；
+     *        - false：关闭。
+     * @order 6
+     *
+     */
+    
+    enableMixer(enable: boolean): void;
+    /** {zh}
+     * @detail api
+     * @brief 开启/关闭自动音量均衡。
+     * @order 7
+     * @param sourceLufs 源响度。
+     * @param targetLufs 目标响度。
+     *
+     */
+    
+    enableAutoEq(sourceLufs: float, targetLufs: float): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置音视频帧回调的监听。
+     * @notes <br>
+     *      重复调用本方法，仅最后一次调用生效。
+     * @order 8
+     * @param listener 音视频帧回调监听。详情请参见 [VeLiveMediaPlayerFrameListener](147519#VeLivePusherDef-VeLiveMediaPlayerFrameListener)。
+     *
+     */
+    
+    setFrameListener(listener: VeLiveMediaPlayerFrameListener): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置播放音频的音量。
+     * @order 9
+     * @param volume 播放音频音量，取值范围为 [0.0,4.0]。
+     *
+     */
+    
+    setBGMVolume(volume: float): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置音频采集音量。
+     * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放背景音乐后，调用本方法。
+     * @order 10
+     * @param volume 音频采集音量，取值范围为 [0.0,4.0]。
+     *
+     */
+    
+    setVoiceVolume(volume: float): void;
+    /** {zh}
+     * @detail api
+     * @brief 设置是否循环播放。
+     * @param loop 是否循环播放。默认为 false。<br>
+     *               - true：循环播放；
+     *               - false：不循环播放。
+     * @order 11
+     *
+     */
+    
+    enableBGMLoop(loop: boolean): void;
+}
+export declare class VeLiveAudioDevice {
+    /** {zh}
+     * @detail api
+     * @brief 设置音量响度。
+     * @order 74
+     * @param level 音量响度等级，取值范围为 [0.0,4.0]。
+     *
+     */
+    
+    setVoiceLoudness(level: float): void;
+    /** {zh}
+     * @detail api
+     * @brief 获取当前音量响度。
+     * @order 75
+     * @return <br>
+     *      当前音量响度等级。
+     *
+     */
+    
+    getVoiceLoudness(): float;
+}