# VeLiveVideoFrame ```java public class VeLiveVideoFrame ``` 视频帧的数据信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | VeLiveVideoFrame | [VeLiveVideoFrame](#VeLiveVideoFrame-velivevideoframe) | | VeLiveVideoFrame | [VeLiveVideoFrame](#VeLiveVideoFrame-velivevideoframe-2) | | VeLiveVideoFrame | [VeLiveVideoFrame](#VeLiveVideoFrame-velivevideoframe-3) | | VeLiveVideoFrame | [VeLiveVideoFrame](#VeLiveVideoFrame-velivevideoframe-4) | | void | [retain](#VeLiveVideoFrame-retain) | | synchronized void | [release](#VeLiveVideoFrame-release) | | VeLiveVideoBufferType | [getBufferType](#VeLiveVideoFrame-getbuffertype) | | VeLiveVideoFrame | [setBufferType](#VeLiveVideoFrame-setbuffertype) | | VeLivePixelFormat | [getPixelFormat](#VeLiveVideoFrame-getpixelformat) | | VeLiveVideoFrame | [setPixelFormat](#VeLiveVideoFrame-setpixelformat) | | VeLiveVideoRotation | [getRotation](#VeLiveVideoFrame-getrotation) | | VeLiveVideoFrame | [setRotation](#VeLiveVideoFrame-setrotation) | | int | [getWidth](#VeLiveVideoFrame-getwidth) | | int | [getHeight](#VeLiveVideoFrame-getheight) | | int | [getRotatedWidth](#VeLiveVideoFrame-getrotatedwidth) | | int | [getRotatedHeight](#VeLiveVideoFrame-getrotatedheight) | | long | [getPts](#VeLiveVideoFrame-getpts) | | int | [getTextureId](#VeLiveVideoFrame-gettextureid) | | Matrix | [getTextureMatrix](#VeLiveVideoFrame-gettexturematrix) | | ByteBuffer | [getBuffer](#VeLiveVideoFrame-getbuffer) | | byte[] | [getData](#VeLiveVideoFrame-getdata) | | Runnable | [getReleaseCallback](#VeLiveVideoFrame-getreleasecallback) | | VeLiveVideoFrame | [setReleaseCallback](#VeLiveVideoFrame-setreleasecallback) | ## 函数说明 ### VeLiveVideoFrame ```java public VeLiveVideoFrame() ``` 视频帧初始化方法。 ### VeLiveVideoFrame ```java public VeLiveVideoFrame( int width, int height, long pts, int texId, boolean isOes, Matrix matrix ) ``` 视频帧初始化方法。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 视频帧的宽度，单位为 px。 | | height | int | 视频帧的高度，单位为 px。 | | pts | long | 视频帧的时间戳，单位为 µs。 | | texId | int | 纹理 ID。 | | isOes | boolean | 是否是 OES 纹理。 | | matrix | Matrix | 纹理矩阵。 | ### VeLiveVideoFrame ```java public VeLiveVideoFrame( int width, int height, long pts, ByteBuffer byteBuffer ) ``` 视频帧初始化方法。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 视频帧的宽度，单位为 px。 | | height | int | 视频帧的高度，单位为 px。 | | pts | long | 视频帧的时间戳，单位为 µs。 | | byteBuffer | ByteBuffer | ByteBuffer 格式的视频数据，ByteBuffer 默认为 I420 格式，如果您的视频数据为其他格式，可通过调用 setPixelFormat 方法设置 | **注意** 调用该方法时，需要保证 YUV 数据的 stride 等于 `width`。 ### VeLiveVideoFrame ```java public VeLiveVideoFrame( int width, int height, long pts, byte[] data ) ``` 视频帧初始化方法。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | width | int | 视频帧的宽度，单位为 px。 | | height | int | 视频帧的高度，单位为 px。 | | pts | long | 视频帧的时间戳，单位为 µs。 | | data | byte[] | byte[] 格式的视频数据，默认为 I420 格式，如果您的视频数据为其他格式，可通过调用 [setPixelFormat](#VeLiveVideoFrame-setpixelformat) 方法设置。 | **注意** 调用该方法时，需要保证 YUV 数据的 stride 等于 `width`。 ### retain ```java public void retain() ``` 增加 VeLiveVideoFrame 对象的引用计数。当您需要继续使用 VeLiveVideoFrame 对象时，请调用此方法将引用计数增加 1。 ### release ```java public synchronized void release() ``` 释放对 VeLiveVideoFrame 对象的引用。在您不再需要使用 VeLiveVideoFrame 对象时，应调用此方法将引用计数减少 1。当引用计数减少到零，表示不再有引用指向该对象，可以安全地释放或销毁该对象。 ### getBufferType ```java public VeLiveVideoBufferType getBufferType() ``` 获取视频数据类型。 **返回值** 视频数据类型，详情请参见 [VeLiveVideoBufferType](147521#VeLiveVideoBufferType)。 ### setBufferType ```java public VeLiveVideoFrame setBufferType(VeLiveVideoBufferType bufferType) ``` 设置视频数据类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | bufferType | VeLiveVideoBufferType | 视频数据类型，详情请参见 [VeLiveVideoBufferType](147521#VeLiveVideoBufferType) | **返回值** 视频帧对象，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。 ### getPixelFormat ```java public VeLivePixelFormat getPixelFormat() ``` 获取视频像素格式。 **返回值** 视频像素格式，详情请参见 [VeLivePixelFormat](147521#VeLivePixelFormat)。 ### setPixelFormat ```java public VeLiveVideoFrame setPixelFormat(VeLivePixelFormat pixelFormat) ``` 设置视频像素格式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | pixelFormat | VeLivePixelFormat | 视频像素格式，详情请参见 [VeLivePixelFormat](147521#VeLivePixelFormat) | **返回值** 视频帧对象，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。 ### getRotation ```java public VeLiveVideoRotation getRotation() ``` 获取视频帧旋转角度。 **返回值** 视频帧旋转角度，详情请参见 [VeLiveVideoRotation](147521#VeLiveVideoRotation)。 ### setRotation ```java public VeLiveVideoFrame setRotation(VeLiveVideoRotation rotation) ``` 设置视频帧旋转角度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | rotation | VeLiveVideoRotation | 视频帧旋转角度，详情请参见 [VeLiveVideoRotation](147521#VeLiveVideoRotation) | **返回值** 视频帧对象，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。 ### getWidth ```java public int getWidth() ``` 获取视频帧宽度。 **返回值** 视频帧宽度。 ### getHeight ```java public int getHeight() ``` 获取视频帧高度。 **返回值** 视频帧高度。 ### getRotatedWidth ```java public int getRotatedWidth() ``` 获取带旋转角度的视频帧宽度。 **返回值** 带旋转角度的视频帧宽度。 ### getRotatedHeight ```java public int getRotatedHeight() ``` 获取带旋转角度的视频帧高度。 **返回值** 带旋转角度的视频帧高度。 ### getPts ```java public long getPts() ``` 获取视频帧时间戳。 **返回值** 视频帧时间戳，单位为 μs。 ### getTextureId ```java public int getTextureId() ``` 获取视频帧纹理 ID。 **返回值** 视频帧纹理 ID。 ### getTextureMatrix ```java public Matrix getTextureMatrix() ``` 获取视频帧纹理矩阵。 **返回值** 视频帧纹理矩阵。 ### getBuffer ```java public ByteBuffer getBuffer() ``` 获取 ByteBuffer 格式的视频数据。 **返回值** ByteBuffer 格式的视频数据。 ### getData ```java public byte[] getData() ``` 获取 byte[] 格式的视频数据。 **返回值** byte[] 格式的视频数据。 ### getReleaseCallback ```java public Runnable getReleaseCallback() ``` 获取视频帧内部销毁回调。 **返回值** 视频帧内部销毁回调。 ### setReleaseCallback ```java public VeLiveVideoFrame setReleaseCallback(Runnable releaseCallback) ``` 设置视频帧内部销毁回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | releaseCallback | Runnable | 视频帧内部销毁回调 | **返回值** 视频帧对象，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。 # VeLiveCameraDevice ```java public interface VeLiveCameraDevice ``` 相机设备管理对象。 ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [setParameter](#VeLiveCameraDevice-setparameter) | | Parameter | [getParameter](#VeLiveCameraDevice-getparameter) | | int[] | [getRealFpsRange](#VeLiveCameraDevice-getrealfpsrange) | | int | [enableTorch](#VeLiveCameraDevice-enabletorch) | | int | [setZoomRatio](#VeLiveCameraDevice-setzoomratio) | | float | [getCurrentZoomRatio](#VeLiveCameraDevice-getcurrentzoomratio) | | float | [getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio) | | float | [getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio) | | boolean | [isAutoFocusEnabled](#VeLiveCameraDevice-isautofocusenabled) | | int | [enableAutoFocus](#VeLiveCameraDevice-enableautofocus) | | int | [setFocusPosition](#VeLiveCameraDevice-setfocusposition) | | boolean | [isExposurePositionSupported](#VeLiveCameraDevice-isexposurepositionsupported) | | int | [setExposurePosition](#VeLiveCameraDevice-setexposureposition) | | float | [getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation) | | float | [getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation) | | int | [setExposureCompensation](#VeLiveCameraDevice-setexposurecompensation) | ## 函数说明 ### setParameter ```java int setParameter(Parameter parameter) ``` 设置相机参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | parameter | Parameter | 相机参数对象，用于指定要设置的相机参数。 | **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### getParameter ```java Parameter getParameter() ``` 获取相机参数。 **返回值** 相机参数的值，具体类型需要根据参数名称确定。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### getRealFpsRange ```java int[] getRealFpsRange() ``` 获取相机支持帧率范围。 **返回值** 相机支持帧率范围。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### enableTorch ```java int enableTorch(boolean enable) ``` 开启/关闭闪光灯。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enable | boolean | 是否开启闪光灯。默认为 false。

true：开启；
false：关闭。

| **返回值** - 0：开启/关闭成功； - ≠0：开启/关闭失败。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### setZoomRatio ```java int setZoomRatio(float ratio) ``` 设置摄像头的缩放倍数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | ratio | float | 缩放倍数。默认为原尺寸。缩放倍数的取值范围为 [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)]。 | **返回值** - 0：缩放成功； - ≠0：缩放失败。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### getCurrentZoomRatio ```java float getCurrentZoomRatio() ``` 获取摄像头当前的缩放倍数。 **返回值** - ≤0：表示不支持缩放； - \>0：支持缩放，数值表示当前缩放倍数。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### getMaxZoomRatio ```java float getMaxZoomRatio() ``` 获取摄像头的最大缩放倍数。 **返回值** - ≤0：表示不支持缩放； - \>0：支持缩放，数值表示最大缩放倍数。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### getMinZoomRatio ```java float getMinZoomRatio() ``` 获取摄像头的最小缩放倍数。 **返回值** - ≤0：表示不支持缩放； - \>0：支持缩放，数值表示最小缩放倍数。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### isAutoFocusEnabled ```java boolean isAutoFocusEnabled() ``` 是否支持自动对焦。 **返回值** - true：支持； - false：不支持。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### enableAutoFocus ```java int enableAutoFocus(boolean enable) ``` 开启/关闭自动对焦功能。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enable | boolean | 是否开启自动对焦，默认为 true。

true：开启；
false：关闭。

| **返回值** - 0：开启/关闭成功； - ≠0：开启/关闭失败。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### setFocusPosition ```java int setFocusPosition( int viewW, int viewH, int x, int y ) ``` 设置摄像头的对焦位置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewW | int | 当前视图宽度。 | | viewH | int | 当前视图高度。 | | x | int | 以左上角为原点，对焦点距当前视图的横向坐标值。 | | y | int | 以左上角为原点，对焦点距当前视图的纵向坐标值。 | **返回值** - 0：设置成功； - ≠0：设置失败。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### isExposurePositionSupported ```java boolean isExposurePositionSupported() ``` 检查当前使用的摄像头是否支持手动设置曝光点。 **返回值** - YES：支持； - NO：不支持。 **注意** 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。 ### setExposurePosition ```java int setExposurePosition( int viewW, int viewH, int x, int y ) ``` 设置当前使用的摄像头的曝光点。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewW | int | 当前视图宽度。 | | viewH | int | 当前视图高度。 | | x | int | 以左上角为原点，对焦点距当前视图的横向坐标值。 | | y | int | 以左上角为原点，对焦点距当前视图的纵向坐标值。 | **返回值** - =0：成功； - ≠0：失败。 **注意** - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集，并且使用 SDK 内部渲染时，才能设置曝光点； - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后，设置的曝光点失效。 ### getMinExposureCompensation ```java float getMinExposureCompensation() ``` 获取摄像头的最小曝光补偿值。 **返回值** - ≤0：表示不支持曝光补偿； - \>0：支持曝光补偿，数值表示最小曝光补偿。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### getMaxExposureCompensation ```java float getMaxExposureCompensation() ``` 获取摄像头的最大曝光补偿值。 **返回值** - ≤0：表示不支持曝光补偿； - \>0：支持曝光补偿，数值表示最大曝光补偿。 **注意** 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后，调用本方法。 ### setExposureCompensation ```java int setExposureCompensation(float value) ``` 设置当前使用的摄像头的曝光补偿。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | value | float | 曝光补偿值，取值范围 [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation),[getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)]，0 为系统默认值，表示没有曝光补偿。 | **返回值** - =0：设置成功； - ≠0：设置失败。 **注意** - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时，才能设置曝光补偿。 - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后，设置的曝光补偿失效。 # VeLiveVideoEffectManager ```java public interface VeLiveVideoEffectManager ``` 视频特效管理对象。用于管理和设置视频特效，包括美颜、美形、美体、美妆、滤镜等。 ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) | | void | [updateLicense](#VeLiveVideoEffectManager-updatelicense) | | void | [setEnable](#VeLiveVideoEffectManager-setenable) | | int | [setAlgorithmModelPath](#VeLiveVideoEffectManager-setalgorithmmodelpath) | | int | [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) | | int | [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) | | int | [removeComposeNodes](#VeLiveVideoEffectManager-removecomposenodes) | | int | [updateComposerNodeIntensity](#VeLiveVideoEffectManager-updatecomposernodeintensity) | | int | [setFilter](#VeLiveVideoEffectManager-setfilter) | | int | [updateFilterIntensity](#VeLiveVideoEffectManager-updatefilterintensity) | | int | [setSticker](#VeLiveVideoEffectManager-setsticker) | | int | [setAdvancedFeature](#VeLiveVideoEffectManager-setadvancedfeature) | ## 函数说明 ### setupWithConfig ```java int setupWithConfig(VeLiveVideoEffectLicenseConfiguration config) ``` 视频特效许可证配置，用于初始化视频特效管理对象。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | VeLiveVideoEffectLicenseConfiguration | 特效初始化配置，详情请参见 [VeLiveVideoEffectLicenseConfiguration](147521#VeLiveVideoEffectLicenseConfiguration)。 | **返回值** - 0：调用成功； - -1：调用失败。 ### updateLicense ```java void updateLicense(VeLiveVideoEffectCallback callback) ``` 更新在线 License。本方法仅对在线 License 有效。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | callback | VeLiveVideoEffectCallback | 结果回调信息 | **注意** - 需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用； - 如果您使用在线 License 认证方式，在许可证过期后，可调用该方法更新 License； - 本方法为异步操作。 ### setEnable ```java void setEnable( boolean enable, VeLiveVideoEffectCallback callback ) ``` 创建/销毁特效引擎。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enable | boolean | 是否创建特效引擎。默认为 false。

true：创建；
false：销毁。

| | callback | VeLiveVideoEffectCallback | 视频特效回调 [VeLiveVideoEffectCallback](147519#velivevideoeffectcallback)。 | **返回值** - 0：成功； - -1：失败。 **注意** - 该方法需要在调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 和 [setAlgorithmModelPath](#VeLiveVideoEffectManager-setalgorithmmodelpath) 后调用； - 该方法不直接开启/关闭视频特效，您需要在调用该方法后，调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 开启视频特效； - 通用场景下，特效引擎会随 EffectManager 销毁而销毁。如果您对性能有较高要求，也可以在不使用特效相关功能时，调用该方法销毁特效引擎； - 如果重复创建/销毁特效引擎，会产生时间消耗。 ### setAlgorithmModelPath ```java int setAlgorithmModelPath(String path) ``` 设置特效算法模型包的路径。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | path | String | 特效算法模型包的路径 | **返回值** - 0：调用成功； - -1：调用失败。 **注意** 需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用。 ### setComposeNodes ```java int setComposeNodes(String[] nodes) ``` 设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能，包括美颜、美形、美体、美妆等。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | nodes | String[] | 视频特效素材包路径数组 | **返回值** - 0：调用成功； - -1：调用失败。 **注意** - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法； - 重复调用本方法，仅最后一次调用生效； - 如果需要在当前的视频特效组合中叠加特效，可调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 方法。 ### appendComposeNodes ```java int appendComposeNodes(String[] nodes) ``` 在已有的视频特效组合上，叠加视频特效素材包。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | nodes | String[] | 视频特效素材包路径数组 | **返回值** - 0：调用成功； - -1：调用失败。 **注意** - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法。 - 调用本方法，会在 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置的视频特效组合的基础上叠加特效。 ### removeComposeNodes ```java int removeComposeNodes(String[] nodes) ``` 移除指定的视频特效资源。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | nodes | String[] | 视频特效素材包路径数组 | **返回值** - 0：调用成功； - -1：调用失败。 **注意** - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后，调用本方法。 - 调用本方法，可移除调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 和 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 设置的视频特效资源。 ### updateComposerNodeIntensity ```java int updateComposerNodeIntensity( String node, String key, float intensity ) ``` 设置视频特效强度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | node | String | 视频特效素材包路径 | | key | String | 需要设置的素材 key 名称 | | intensity | float | 需要设置的强度值。取值范围为 [0.0,1.0] | **返回值** - 0：调用成功； - -1：调用失败。 **注意** - 需要在调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合或调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 叠加视频特效素材包后，调用本方法； - 该方法仅适用于同时含有上述三个参数的特效资源，对于没有强度参数的特效（如贴纸），该方法无效。 ### setFilter ```java int setFilter(String path) ``` 设置颜色滤镜。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | path | String | 滤镜资源包绝对路径 | **返回值** - 0：调用成功； - -1：调用失败。 **注意** 请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法。 ### updateFilterIntensity ```java int updateFilterIntensity(float intensity) ``` 设置已启用的颜色滤镜强度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | intensity | float | 滤镜强度，取值范围为 [0.0,1.0]。 | **返回值** - 0：调用成功； - -1：调用失败。 **注意** 请在调用 [setFilter](#VeLiveVideoEffectManager-setfilter) 设置颜色滤镜后调用。 ### setSticker ```java int setSticker(String path) ``` 设置贴纸特效。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | path | String | 贴纸素材包的绝对路径 | **返回值** - 0：调用成功； - -1：调用失败。 **注意** 请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法。 ### setAdvancedFeature ```java int setAdvancedFeature( VeLiveVideoEffectHandleCallback callback, boolean isGLThread, boolean isAsync ) ``` CV 高级接口。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | callback | VeLiveVideoEffectHandleCallback | 回调 CV 的 handle。 | | isGLThread | boolean | 是否在 GL 线程回调 callback。 | | isAsync | boolean | 是否同步执行 callback。 | **注意** 请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后，调用该方法，不要在主线程中频繁执行同步操作。 # VeLivePusher ```java public interface VeLivePusher ``` 直播推流器。 ## 静态函数 | 返回 | 名称 | | --- | --- | | static void | [setLogLevel](#VeLivePusher-setloglevel) | | static void | [setEGLVersion](#VeLivePusher-seteglversion) | | static void | [setEGLContext](#VeLivePusher-seteglcontext) | | static EGLContext | [getEGLContext](#VeLivePusher-geteglcontext) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [release](#VeLivePusher-release) | | void | [setObserver](#VeLivePusher-setobserver) | | void | [setStatisticsObserver](#VeLivePusher-setstatisticsobserver) | | void | [setRenderView](#VeLivePusher-setrenderview) | | void | [setRenderFillMode](#VeLivePusher-setrenderfillmode) | | void | [setVideoMirror](#VeLivePusher-setvideomirror) | | void | [startVideoCapture](#VeLivePusher-startvideocapture) | | void | [stopVideoCapture](#VeLivePusher-stopvideocapture) | | void | [startAudioCapture](#VeLivePusher-startaudiocapture) | | void | [stopAudioCapture](#VeLivePusher-stopaudiocapture) | | void | [switchVideoCapture](#VeLivePusher-switchvideocapture) | | void | [switchAudioCapture](#VeLivePusher-switchaudiocapture) | | VeLiveVideoCaptureType | [getCurrentVideoCaptureType](#VeLivePusher-getcurrentvideocapturetype) | | VeLiveAudioCaptureType | [getCurrentAudioCaptureType](#VeLivePusher-getcurrentaudiocapturetype) | | void | [updateCustomImage](#VeLivePusher-updatecustomimage) | | VeLiveCameraDevice | [getCameraDevice](#VeLivePusher-getcameradevice) | | void | [setVideoEncoderConfiguration](#VeLivePusher-setvideoencoderconfiguration) | | VeLiveVideoEncoderConfiguration | [getVideoEncoderConfiguration](#VeLivePusher-getvideoencoderconfiguration) | | void | [setAudioEncoderConfiguration](#VeLivePusher-setaudioencoderconfiguration) | | VeLiveAudioEncoderConfiguration | [getAudioEncoderConfiguration](#VeLivePusher-getaudioencoderconfiguration) | | void | [startPush](#VeLivePusher-startpush) | | void | [startPushWithUrls](#VeLivePusher-startpushwithurls) | | void | [stopPush](#VeLivePusher-stoppush) | | boolean | [isPushing](#VeLivePusher-ispushing) | | int | [setWatermark](#VeLivePusher-setwatermark) | | void | [startFileRecording](#VeLivePusher-startfilerecording) | | void | [stopFileRecording](#VeLivePusher-stopfilerecording) | | int | [setProperty](#VeLivePusher-setproperty) | | int | [pushExternalVideoFrame](#VeLivePusher-pushexternalvideoframe) | | int | [pushExternalAudioFrame](#VeLivePusher-pushexternalaudioframe) | | void | [setOrientation](#VeLivePusher-setorientation) | | int | [sendSeiMessage](#VeLivePusher-sendseimessage) | | void | [setMute](#VeLivePusher-setmute) | | boolean | [isMute](#VeLivePusher-ismute) | | VeLiveVideoEffectManager | [getVideoEffectManager](#VeLivePusher-getvideoeffectmanager) | | void | [setVideoFrameFilter](#VeLivePusher-setvideoframefilter) | | VeLiveAudioDevice | [getAudioDevice](#VeLivePusher-getaudiodevice) | | void | [setAudioFrameFilter](#VeLivePusher-setaudioframefilter) | | VeLiveMediaPlayer | [createPlayer](#VeLivePusher-createplayer) | | VeLiveMixerManager | [getMixerManager](#VeLivePusher-getmixermanager) | | void | [startScreenRecording](#VeLivePusher-startscreenrecording) | | void | [stopScreenRecording](#VeLivePusher-stopscreenrecording) | | boolean | [isScreenRecording](#VeLivePusher-isscreenrecording) | | int | [addVideoFrameListener](#VeLivePusher-addvideoframelistener) | | int | [removeVideoFrameListener](#VeLivePusher-removevideoframelistener) | | int | [addAudioFrameListener](#VeLivePusher-addaudioframelistener) | | int | [removeAudioFrameListener](#VeLivePusher-removeaudioframelistener) | | void | [snapshot](#VeLivePusher-snapshot) | ## 函数说明 ### setLogLevel ```java static void setLogLevel(VeLivePusherLogLevel logLevel) ``` 设置输出到控制台的日志等级。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | logLevel | VeLivePusherLogLevel | 输出的日志级别。级别详情请参见 [VeLivePusherLogLevel](147521#VeLivePusherLogLevel)。 | ### setEGLVersion ```java static void setEGLVersion(int version) ``` 设置 OpenGL 的版本号，默认值为 `3`。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | version | int | OpenGL 版本号，支持的取值包括 `2` 和 `3`，分别对应 OpenGL 2.0 和 3.0 版本。 | ### setEGLContext ```java static void setEGLContext(EGLContext context) ``` 设置 OpenGL 的上下文。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | context | EGLContext | OpenGL 上下文。 | ### getEGLContext ```java static EGLContext getEGLContext() ``` 获取 OpenGL 的上下文。 **返回值** 当前 OpenGL 的上下文。 ### release ```java void release() ``` 停止采集和推流，并销毁推流器。通常在调用 [stopPush](#VeLivePusher-stoppush) 结束推流后调用此方法进行清理。 ### setObserver ```java void setObserver(VeLivePusherObserver observer) ``` 设置推流器回调，通过设置回调，监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | observer | VeLivePusherObserver | 推流器回调对象，详细信息请参见 [VeLivePusherObserver](147519#VeLivePusherObserver)。 | **注意** - 需要在创建推流引擎后，调用本方法； - 重复调用本方法，仅最后一次调用生效。 ### setStatisticsObserver ```java void setStatisticsObserver( VeLivePusherStatisticsObserver observer, int interval ) ``` 设置推流器周期性回调，用于定期获取推流状态信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | observer | VeLivePusherStatisticsObserver | 推流器周期性回调对象，详细信息请参见 [VeLivePusherStatisticsObserver](147519#VeLivePusherStatisticsObserver)。 | | interval | int | 周期性回调的时间间隔，单位为 s，默认值为 5。 | **注意** - 需要在创建推流引擎后，调用本方法； - 重复调用本方法，仅最后一次调用生效。 ### setRenderView ```java void setRenderView(View view) ``` 设置本地摄像头预览视图。摄像头采集到的画面，经过美颜、脸形调整、滤镜等多种效果叠加之后，最终会显示到传入的 View 上。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | view | View | 摄像头预览视图 | ### setRenderFillMode ```java void setRenderFillMode(VeLivePusherRenderMode mode) ``` 设置本地预览画面的填充模式。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mode | VeLivePusherRenderMode | 填充模式。 | ### setVideoMirror ```java void setVideoMirror( VeLiveVideoMirrorType type, boolean mirror ) ``` 开启/关闭镜像。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | VeLiveVideoMirrorType | 镜像类型，详细信息请参见 [VeLiveVideoMirrorType](147521#VeLiveVideoMirrorType)。 | | mirror | boolean | 是否开启镜像。

true：开启；
false：关闭。

| **注意** 用于配置视频镜像效果，影响采集、预览和推流画面。 ### startVideoCapture ```java void startVideoCapture(VeLiveVideoCaptureType type) ``` 开始视频采集。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | VeLiveVideoCaptureType | 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) | **注意** 调用该接口后，可以通过调用接口 [stopVideoCapture](#VeLivePusher-stopvideocapture) 停止视频采集。 ### stopVideoCapture ```java void stopVideoCapture() ``` 停止视频采集。 **注意** 调用该接口后，可以通过调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 开始视频采集。 ### startAudioCapture ```java void startAudioCapture(VeLiveAudioCaptureType type) ``` 开始音频采集。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | VeLiveAudioCaptureType | 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。 | **注意** 调用该接口后，可以通过调用接口 [stopAudioCapture](#VeLivePusher-stopaudiocapture) 停止音频采集。 ### stopAudioCapture ```java void stopAudioCapture() ``` 停止音频采集。 **注意** 调用该接口后，可以通过调用接口 [startAudioCapture](#VeLivePusher-startaudiocapture) 开始音频采集。 ### switchVideoCapture ```java void switchVideoCapture(VeLiveVideoCaptureType type) ``` 切换视频采集类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | VeLiveVideoCaptureType | 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。 | **注意** 该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。 ### switchAudioCapture ```java void switchAudioCapture(VeLiveAudioCaptureType type) ``` 切换音频采集类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | VeLiveAudioCaptureType | 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。 | **注意** 该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。 ### getCurrentVideoCaptureType ```java VeLiveVideoCaptureType getCurrentVideoCaptureType() ``` 获取当前视频采集类型。 **返回值** 视频采集类型，详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。 ### getCurrentAudioCaptureType ```java VeLiveAudioCaptureType getCurrentAudioCaptureType() ``` 获取当前音频采集类型。 **返回值** 音频采集类型，详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。 ### updateCustomImage ```java void updateCustomImage(Bitmap image) ``` 自定义静态图，适用于静态图推流采集类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | Bitmap | 静态图片，用于在静态图推流采集类型下设置静态图。 | **注意** 使用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage，您可调用 [startVideoCapture](#VeLivePusher-startvideocapture) 方法，将 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。 ### getCameraDevice ```java VeLiveCameraDevice getCameraDevice() ``` 获取相机设备管理对象 `VeLiveCameraDevice`。通过设备管理，您可以使用以下功能。 - 控制闪光灯开关 - 设置摄像头缩放比例 - 设置自动对焦 **返回值** 相机设备管理对象 [VeLiveCameraDevice](#VeLiveCameraDevice)。 **注意** 该接口需要在 startVideoCapture 方法中设置 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureBackCamera。 ### setVideoEncoderConfiguration ```java void setVideoEncoderConfiguration(VeLiveVideoEncoderConfiguration config) ``` 设置推流视频编码参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | VeLiveVideoEncoderConfiguration | 推流视频参数，支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLiveVideoEncoderConfiguration) | **注意** 该接口可在推流开始前或开始后调用。 ### getVideoEncoderConfiguration ```java VeLiveVideoEncoderConfiguration getVideoEncoderConfiguration() ``` 获取推流视频编码参数。 **返回值** 推流视频参数，支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLiveVideoEncoderConfiguration) ### setAudioEncoderConfiguration ```java void setAudioEncoderConfiguration(VeLiveAudioEncoderConfiguration config) ``` 设置推流音频编码参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | VeLiveAudioEncoderConfiguration | 推流音频编码参数，详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLiveAudioEncoderConfiguration)。 | **注意** 该接口需要在 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之前调用。 ### getAudioEncoderConfiguration ```java VeLiveAudioEncoderConfiguration getAudioEncoderConfiguration() ``` 获取推流音频编码参数。 **返回值** 推流音频编码参数，详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLiveAudioEncoderConfiguration)。 ### startPush ```java void startPush(String url) ``` 开始推流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | String | 推流地址，用于将直播流推送到目标服务器。 | ### startPushWithUrls ```java void startPushWithUrls(String[] urls) ``` 开始推流，支持备用推流地址。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | urls | String[] | 推流地址列表，包含一个或多个推流地址。 | **注意** 当主推流地址不可用时，会自动切换到备用推流地址继续推流。 ### stopPush ```java void stopPush() ``` 停止推流。 **注意** 停止推流后，可以通过调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法重新开始推流。 ### isPushing ```java boolean isPushing() ``` 当前是否正在推流中，可用来查询推流器的当前状态。 **返回值** 是否正在推流。 - true：正在推流中； - false：已经停止推流。 ### setWatermark ```java int setWatermark( Bitmap image, float x, float y, float scale ) ``` 设置推流水印。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | image | Bitmap | 水印图片。取值为 null 时，表示禁用水印。 | | x | float | 水印的水平偏移量，即水印图片相对视频流左上角的横向偏移与视频流宽度的比值，取值范围为 [0.0,1.0]。 | | y | float | 水印的垂直偏移量，即水印图片相对视频流左上角的纵向偏移与视频流高度的比值，取值范围为 [0.0,1.0]。 | | scale | float | 水印图片的缩放比例，取值范围为 [0.0,1.0]。 | **返回值** - 0：水印设置成功； - <0：水印设置失败。 ### startFileRecording ```java void startFileRecording( String path, VeLiveFileRecorderConfiguration config, VeLiveFileRecordingListener listener ) ``` 开始本地文件录制。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | path | String | 录制文件保存路径，不能为空。 | | config | VeLiveFileRecorderConfiguration | 文件录制设置，详情请参见 [VeLiveFileRecorderConfiguration](147521#VeLiveFileRecorderConfiguration)。 | | listener | VeLiveFileRecordingListener | 本地文件录制的监听，详情请参见 [VeLiveFileRecordingListener](147519#VeLiveFileRecordingListener) 。 | ### stopFileRecording ```java void stopFileRecording() ``` 停止本地文件录制。 **注意** 该接口需要在 [startFileRecording](#VeLivePusher-startfilerecording) 方法之后调用。 ### setProperty ```java int setProperty( String key, Object value ) ``` 高级配置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | String | 推流高级配置为 JSON 格式的字符串，此参数为 JSON 结构中的 Key。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)，了解配置方法。 | | value | Object | 推流高级配置为 JSON 格式的字符串，此参数为 JSON 结构中的 Value。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)，了解配置方法。 | **返回值** - 0：成功； - -1：失败，参数错误。 ### pushExternalVideoFrame ```java int pushExternalVideoFrame(VeLiveVideoFrame frame) ``` 推送外部视频帧数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | frame | VeLiveVideoFrame | 视频帧的数据信息，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。 | **返回值** - 0：成功； - <0：失败。 **注意** 调用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureExternal，您可调用 startVideoCapture 方法，将 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureExternal。 ### pushExternalAudioFrame ```java int pushExternalAudioFrame(VeLiveAudioFrame frame) ``` 推送外部音频帧数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | frame | VeLiveAudioFrame | 外部音频数据。详情请参见 [VeLiveAudioFrame](#VeLiveAudioFrame)。 | **返回值** - 0：成功； - <0：失败。 **注意** 该接口需要在 startAudioCapture 方法中设置 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType) 为 VeLiveAudioCaptureExternal。 ### setOrientation ```java void setOrientation(VeLiveOrientation orientation) ``` 设置推流视频帧朝向。默认为竖屏推流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | orientation | VeLiveOrientation | 视频帧朝向，详情请参见 [VeLiveOrientation](147521#VeLiveOrientation)。 | ### sendSeiMessage ```java int sendSeiMessage( String key, Object value, int repeat, boolean isKeyFrame, boolean allowsCovered ) ``` 通过视频帧发送 SEI 消息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | String | SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Key。 | | value | Object | SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Value。 | | repeat | int | 消息发送重复的次数。例如，`repeat` 取值为 20，`isKeyFrame` 取值为 YES，则会在视频帧开始的连续 20 个关键帧中添加 SEI 消息。 | | isKeyFrame | boolean | 是否仅在关键帧中包含 SEI 消息。

true：仅在关键帧中包含；
false：所有帧中均包含。

| | allowsCovered | boolean | 是否允许覆盖。

true：允许；
false：不允许。

| **返回值** - 0：成功； - <0：失败。 **注意** 该接口需要在调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之后调用。 ### setMute ```java void setMute(boolean mute) ``` 设置静音。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mute | boolean | 是否设置为静音。默认为正常推流。

true：静音推流；
false：正常推流。

| ### isMute ```java boolean isMute() ``` 当前是否是静音状态。 **返回值** - true：当前是静音状态； - false：当前非静音状态。 ### getVideoEffectManager ```java VeLiveVideoEffectManager getVideoEffectManager() ``` 获取视频特效管理对象 `VeLiveVideoEffectManager`。通过视频特效管理，您可以使用以下功能。 - 设置美颜 - 设置特效 - 设置素材 - 设置贴图 - 设置滤镜 **返回值** 视频特效管理对象 [VeLiveVideoEffectManager](#VeLiveVideoEffectManager)。 **注意** 该接口需要集成美颜特效 CV SDK 后才能使用。 ### setVideoFrameFilter ```java void setVideoFrameFilter(VeLiveVideoFrameFilter filter) ``` 自定义视频处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | filter | VeLiveVideoFrameFilter | 视频数据处理回调，详情请参见 [VeLiveVideoFrameFilter](147519#VeLiveVideoFrameFilter)。 | ### getAudioDevice ```java VeLiveAudioDevice getAudioDevice() ``` 获取音频模块管理对象。 **返回值** 音频模块管理对象 [VeLiveAudioDevice](#VeLiveAudioDevice)。 **注意** 该接口需要在 startAudioCapture 方法中设置 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType) 为 VeLiveAudioCaptureMicrophone。 ### setAudioFrameFilter ```java void setAudioFrameFilter(VeLiveAudioFrameFilter filter) ``` 自定义音频处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | filter | VeLiveAudioFrameFilter | 音频帧滤镜对象 VeLiveAudioFrameFilter 。 | ### createPlayer ```java VeLiveMediaPlayer createPlayer() ``` 创建播放器。 **返回值** 播放器管理对象 [VeLiveMediaPlayer](#VeLiveMediaPlayer)。 ### getMixerManager ```java VeLiveMixerManager getMixerManager() ``` 获取混流管理对象。 **返回值** 混流管理对象 [VeLiveMixerManager](#VeLiveMixerManager)。 ### startScreenRecording ```java void startScreenRecording( boolean enableAppAudio, Intent screenIntent ) ``` 开始屏幕采集。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enableAppAudio | boolean | 是否支持应用内音频数据，默认为 true，该参数暂不支持修改。 | | screenIntent | Intent | 系统屏幕录制权限。 | ### stopScreenRecording ```java void stopScreenRecording() ``` 停止屏幕采集。 ### isScreenRecording ```java boolean isScreenRecording() ``` 获取当前是否处于屏幕采集状态。 ### addVideoFrameListener ```java int addVideoFrameListener(VeLiveVideoFrameListener listener) ``` 添加视频帧的监听回调，用于获取推流器输出的视频帧。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | listener | VeLiveVideoFrameListener | 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](147519#VeLiveVideoFrameListener)。 | **返回值** - 0：成功； - <0：失败。 ### removeVideoFrameListener ```java int removeVideoFrameListener(VeLiveVideoFrameListener listener) ``` 移除已添加的视频帧监听回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | listener | VeLiveVideoFrameListener | 视频帧的监听回调，详细信息请参见 [VeLiveVideoFrameListener](147519#VeLiveVideoFrameListener)。 | **返回值** - 0：成功； - <0：失败。 **注意** 如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。 ### addAudioFrameListener ```java int addAudioFrameListener(VeLiveAudioFrameListener listener) ``` 添加音频帧的监听回调，用于获取推流器输出的音频帧。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | listener | VeLiveAudioFrameListener | 音频帧监听回调，详细信息请参见 [VeLiveAudioFrameListener](147519#VeLiveAudioFrameListener)。 | **返回值** - 0：成功； - <0：失败。 ### removeAudioFrameListener ```java int removeAudioFrameListener(VeLiveAudioFrameListener listener) ``` 移除已添加的音频帧监听回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | listener | VeLiveAudioFrameListener | 音频帧的监听回调，详细信息请参见 [VeLiveAudioFrameListener](147519#VeLiveAudioFrameListener) 。 | **返回值** - 0：成功； - <0：失败。 **注意** 如果没有添加过此监听回调或者监听回调已被移除，调用此方法将返回失败。 ### snapshot ```java void snapshot(VeLiveSnapshotListener listener) ``` 视频截图。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | listener | VeLiveSnapshotListener | 截图监听对象，详情请参见 [VeLiveSnapshotListener](147519#VeLiveSnapshotListener)。 | # VeLiveMixerManager ```java public interface VeLiveMixerManager ``` 音视频混流器管理对象。支持添加/移除音视频流、发送自定义音视频帧、更新混流布局等。 ## 成员函数 | 返回 | 名称 | | --- | --- | | int | [addVideoStream](#VeLiveMixerManager-addvideostream) | | int | [addAudioStream](#VeLiveMixerManager-addaudiostream) | | int | [addAudioStream](#VeLiveMixerManager-addaudiostream-2) | | int | [getOriginVideoStream](#VeLiveMixerManager-getoriginvideostream) | | int | [getOriginAudioStream](#VeLiveMixerManager-getoriginaudiostream) | | int | [getOriginScreenStream](#VeLiveMixerManager-getoriginscreenstream) | | int | [getOriginSystemAudioStream](#VeLiveMixerManager-getoriginsystemaudiostream) | | void | [sendCustomVideoFrame](#VeLiveMixerManager-sendcustomvideoframe) | | void | [sendCustomAudioFrame](#VeLiveMixerManager-sendcustomaudioframe) | | void | [updateStreamMixDescription](#VeLiveMixerManager-updatestreammixdescription) | | void | [removeVideoStream](#VeLiveMixerManager-removevideostream) | | void | [removeAudioStream](#VeLiveMixerManager-removeaudiostream) | ## 函数说明 ### addVideoStream ```java int addVideoStream() ``` 添加一路需要混流的视频流到混流器中。 **返回值** 视频流 ID。 ### addAudioStream ```java int addAudioStream() ``` 添加一路音频流到混流器中。 **返回值** 音频流 ID。 ### addAudioStream ```java int addAudioStream(VeLiveAudioMixType type) ``` 添加一路音频流到混流器中，并指定混流类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | VeLiveAudioMixType | 混流类型，详情请参见 [VeLiveAudioMixType](147521#VeLiveAudioMixType) 。 | **返回值** 音频流 ID。 ### getOriginVideoStream ```java int getOriginVideoStream() ``` 获取主路视频流 ID。 ### getOriginAudioStream ```java int getOriginAudioStream() ``` 获取主路音频流 ID。 ### getOriginScreenStream ```java int getOriginScreenStream() ``` 获取主路屏幕流 ID。 ### getOriginSystemAudioStream ```java int getOriginSystemAudioStream() ``` 获取主路系统音频流 ID。 ### sendCustomVideoFrame ```java void sendCustomVideoFrame( VeLiveVideoFrame frame, int streamId ) ``` 发送指定混流 ID 的自定义视频帧数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | frame | VeLiveVideoFrame | 自定义的视频帧，详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame) 。 | | streamId | int | 需要混流的视频流 ID。 | ### sendCustomAudioFrame ```java void sendCustomAudioFrame( VeLiveAudioFrame frame, int streamId ) ``` 发送指定混流 ID 的自定义音频帧数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | frame | VeLiveAudioFrame | 自定义的音频帧，详情请参见 [VeLiveAudioFrame](#VeLiveAudioFrame) 。 | | streamId | int | 混流的音频流 ID。 | ### updateStreamMixDescription ```java void updateStreamMixDescription(VeLiveStreamMixDescription mixDescription) ``` 更新音视频混流的布局。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mixDescription | VeLiveStreamMixDescription | 新的音视频混流布局，详情请参见 [VeLiveStreamMixDescription](147521#VeLiveStreamMixDescription)。 | ### removeVideoStream ```java void removeVideoStream(int streamId) ``` 从混流器中移除一路非主路的视频流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | int | 需要移除的非主路视频流 ID。 | ### removeAudioStream ```java void removeAudioStream(int streamId) ``` 从混流器中移除一路非主路的音频流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | streamId | int | 需要移除的非主路音频流 ID。 | # VeLiveMediaPlayer ```java public interface VeLiveMediaPlayer ``` 媒体播放器对象。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [release](#VeLiveMediaPlayer-release) | | void | [setListener](#VeLiveMediaPlayer-setlistener) | | int | [prepare](#VeLiveMediaPlayer-prepare) | | int | [start](#VeLiveMediaPlayer-start) | | int | [stop](#VeLiveMediaPlayer-stop) | | void | [pause](#VeLiveMediaPlayer-pause) | | void | [resume](#VeLiveMediaPlayer-resume) | | long | [getDuration](#VeLiveMediaPlayer-getduration) | | int | [seek](#VeLiveMediaPlayer-seek) | | void | [enableMixer](#VeLiveMediaPlayer-enablemixer) | | void | [enableAutoEq](#VeLiveMediaPlayer-enableautoeq) | | void | [setRenderView](#VeLiveMediaPlayer-setrenderview) | | void | [setFrameListener](#VeLiveMediaPlayer-setframelistener) | | void | [setBGMVolume](#VeLiveMediaPlayer-setbgmvolume) | | void | [setVoiceVolume](#VeLiveMediaPlayer-setvoicevolume) | | void | [enableBGMLoop](#VeLiveMediaPlayer-enablebgmloop) | ## 函数说明 ### release ```java void release() ``` 销毁播放器实例。 ### setListener ```java void setListener(VeLiveMediaPlayerListener listener) ``` 设置播放状态的监听。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | listener | VeLiveMediaPlayerListener | 播放状态监听。详情请参见 [VeLiveMediaPlayerListener](147519#VeLiveMediaPlayerListener)。 | **注意** 重复调用本方法，仅最后一次调用生效。 ### prepare ```java int prepare(String url) ``` 设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | url | String | 文件路径。 | **返回值** - 0：成功； - ≠0：失败。 ### start ```java int start() ``` 暂停播放。 **注意** 需要在调用 start 开始播放后，调用本方法。 ### stop ```java int stop() ``` 停止播放。 **返回值** - 0：成功； - ≠0：失败。 **注意** 需要在调用 start 开始播放后，调用本方法。 ### pause ```java void pause() ``` 暂停播放。 **注意** 需要在调用 [start](#VeLiveMediaPlayer-start)[start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。 ### resume ```java void resume() ``` 恢复播放。 **注意** 需要在调用 [pause](#VeLiveMediaPlayer-pause) 暂停播放后，调用本方法。 ### getDuration ```java long getDuration() ``` 获取文件的总时长，单位为 ms。 **返回值** - \>0：成功，音频文件时长； - ≤0：失败。 **注意** 需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后，调用本方法。 ### seek ```java int seek(long posMs) ``` 设置播放进度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | posMs | long | 播放时间，单位为 ms。 | **返回值** - 0：成功； - ≠0：失败。 ### enableMixer ```java void enableMixer(boolean enable) ``` 开启/关闭音频是否混音到直播流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enable | boolean | 开启/关闭，默认为 false。

ture：开启；
false：关闭。

| ### enableAutoEq ```java void enableAutoEq( float sourceLufs, float targetLufs ) ``` 开启/关闭自动音量均衡。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | sourceLufs | float | 源响度。 | | targetLufs | float | 目标响度。 | ### setRenderView ```java void setRenderView(View view) ``` 支持 MP4 格式的视频渲染。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | view | View | 渲染视图。 | ### setFrameListener ```java void setFrameListener(VeLiveMediaPlayerFrameListener listener) ``` 设置音视频帧回调的监听。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | listener | VeLiveMediaPlayerFrameListener | 音视频帧回调监听。详情请参见 [VeLiveMediaPlayerFrameListener](147519#VeLiveMediaPlayerFrameListener)。 | **注意** 重复调用本方法，仅最后一次调用生效。 ### setBGMVolume ```java void setBGMVolume(float volume) ``` 设置播放音频的音量。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | volume | float | 播放音频音量，取值范围为 [0.0,4.0]。 | ### setVoiceVolume ```java void setVoiceVolume(float volume) ``` 设置音频采集音量。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | volume | float | 音频采集音量，取值范围为 [0.0,4.0]。 | **注意** 需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放背景音乐后，调用本方法。 ### enableBGMLoop ```java void enableBGMLoop(boolean loop) ``` 设置是否循环播放。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | loop | boolean | 是否循环播放。默认为 false。

true：循环播放；
false：不循环播放。

| # VeLiveAudioFrame ```java public class VeLiveAudioFrame ``` 音频帧的数据信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | VeLiveAudioFrame | [VeLiveAudioFrame](#VeLiveAudioFrame-veliveaudioframe) | | VeLiveAudioBufferType | [getBufferType](#VeLiveAudioFrame-getbuffertype) | | VeLiveAudioSampleRate | [getSampleRate](#VeLiveAudioFrame-getsamplerate) | | VeLiveAudioChannel | [getChannels](#VeLiveAudioFrame-getchannels) | | int | [getSamplesPerChannel](#VeLiveAudioFrame-getsamplesperchannel) | | long | [getPts](#VeLiveAudioFrame-getpts) | | ByteBuffer | [getBuffer](#VeLiveAudioFrame-getbuffer) | ## 函数说明 ### VeLiveAudioFrame ```java public VeLiveAudioFrame( VeLiveAudioSampleRate sampleRate, VeLiveAudioChannel channel, long pts, ByteBuffer buffer ) ``` 音频帧初始化方法。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | sampleRate | VeLiveAudioSampleRate | 音频采样率。详情请参见 [VeLiveAudioSampleRate](147521#VeLiveAudioSampleRate)。 | | channel | VeLiveAudioChannel | 音频声道数。详情请参见 [VeLiveAudioChannel](147521#VeLiveAudioChannel)。 | | pts | long | 音频时间戳，单位为 μs。 | | buffer | ByteBuffer | ByteBuffer 格式的音频数据。 | ### getBufferType ```java public VeLiveAudioBufferType getBufferType() ``` 获取音频数据类型。 **返回值** 音频数据类型，详情请参见 [VeLiveAudioBufferType](147521#VeLiveAudioBufferType)。 ### getSampleRate ```java public VeLiveAudioSampleRate getSampleRate() ``` 获取音频采样率。 **返回值** 音频采样率，详情请参见 [VeLiveAudioSampleRate](147521#VeLiveAudioSampleRate)。 ### getChannels ```java public VeLiveAudioChannel getChannels() ``` 获取音频声道数。 **返回值** 音频声道数，详情请参见 [VeLiveAudioChannel](147521#VeLiveAudioChannel)。 ### getSamplesPerChannel ```java public int getSamplesPerChannel() ``` 获取音频位深度。 **返回值** 音频位深度。 ### getPts ```java public long getPts() ``` 获取音频时间戳，单位为 μs。 **返回值** 音频时间戳，单位为 μs。 ### getBuffer ```java public ByteBuffer getBuffer() ``` 获取音频数据。音频帧数据为 float32 格式小端字节序存储。 **返回值** 格式为 ByteBuffer 的音频数据。 # VeLiveAudioDevice ```java public interface VeLiveAudioDevice ``` 音频设备管理类。该类提供了用于管理和控制音频设备，包括设置音量、获取当前音量、检查硬件耳返支持情况、开启或关闭耳返的方法。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setVoiceLoudness](#VeLiveAudioDevice-setvoiceloudness) | | float | [getVoiceLoudness](#VeLiveAudioDevice-getvoiceloudness) | | boolean | [isSupportHardwareEcho](#VeLiveAudioDevice-issupporthardwareecho) | | void | [enableEcho](#VeLiveAudioDevice-enableecho) | | boolean | [isEnableEcho](#VeLiveAudioDevice-isenableecho) | ## 函数说明 ### setVoiceLoudness ```java void setVoiceLoudness(float level) ``` 设置音量响度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | level | float | 音量响度等级，取值范围为 [0.0,4.0]。 | ### getVoiceLoudness ```java float getVoiceLoudness() ``` 获取当前音量响度。 **返回值** 当前音量响度等级。 ### isSupportHardwareEcho ```java boolean isSupportHardwareEcho() ``` 查询是否支持硬件耳返。 **返回值** - true：支持； - false：不支持。 ### enableEcho ```java void enableEcho(boolean enable) ``` 是否开启耳返功能。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | enable | boolean | 耳返功能开关。默认值为 false。

true：开启；
false：关闭。

| ### isEnableEcho ```java boolean isEnableEcho() ``` 获取当前耳返开启状态。 **返回值** - true：开启； - false：关闭。 # VeLivePusherConfiguration ```java public class VeLivePusherConfiguration ``` 推流引擎初始化配置。 ## 成员函数 | 返回 | 名称 | | --- | --- | | VeLivePusherConfiguration | [setReconnectIntervalSeconds](#VeLivePusherConfiguration-setreconnectintervalseconds) | | int | [getReconnectIntervalSeconds](#VeLivePusherConfiguration-getreconnectintervalseconds) | | VeLivePusherConfiguration | [setReconnectCount](#VeLivePusherConfiguration-setreconnectcount) | | int | [getReconnectCount](#VeLivePusherConfiguration-getreconnectcount) | | VeLivePusherConfiguration | [setVideoCaptureConfig](#VeLivePusherConfiguration-setvideocaptureconfig) | | VeLiveVideoCaptureConfiguration | [getVideoCaptureConfig](#VeLivePusherConfiguration-getvideocaptureconfig) | | VeLivePusherConfiguration | [setAudioCaptureConfig](#VeLivePusherConfiguration-setaudiocaptureconfig) | | VeLiveAudioCaptureConfiguration | [getAudioCaptureConfig](#VeLivePusherConfiguration-getaudiocaptureconfig) | | VeLivePusherConfiguration | [setContext](#VeLivePusherConfiguration-setcontext) | | Context | [getContext](#VeLivePusherConfiguration-getcontext) | | VeLivePusherConfiguration | [setExtraParameters](#VeLivePusherConfiguration-setextraparameters) | | LiveSdkSetting | [getExtraParams](#VeLivePusherConfiguration-getextraparams) | | VeLivePusher | [build](#VeLivePusherConfiguration-build) | ## 函数说明 ### setReconnectIntervalSeconds ```java public VeLivePusherConfiguration setReconnectIntervalSeconds(int interval) ``` 设置推流器推流失败后尝试重连的时间间隔。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | interval | int | 时间间隔，单位为 s，默认值为 5 | ### getReconnectIntervalSeconds ```java public int getReconnectIntervalSeconds() ``` 获取推流器推流失败后尝试重连的时间间隔。 **返回值** 时间间隔，单位为 s。 ### setReconnectCount ```java public VeLivePusherConfiguration setReconnectCount(int maxCount) ``` 设置推流器推流失败后尝试重连的次数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | maxCount | int | 重连次数，默认值为 3 | ### getReconnectCount ```java public int getReconnectCount() ``` 获取推流器推流失败后尝试重连的次数。 **返回值** 重连次数。 ### setVideoCaptureConfig ```java public VeLivePusherConfiguration setVideoCaptureConfig(VeLiveVideoCaptureConfiguration config) ``` 设置视频采集参数，用于调整和设置视频采集相关的参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | VeLiveVideoCaptureConfiguration | 视频采集参数，详情请参见 [VeLiveVideoCaptureConfiguration](147521#VeLiveVideoCaptureConfiguration)。 | **返回值** 推流引擎初始化配置对象，详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。 ### getVideoCaptureConfig ```java public VeLiveVideoCaptureConfiguration getVideoCaptureConfig() ``` 获取视频采集参数，用于调整和设置视频采集相关的参数。 **返回值** 视频采集参数配置对象，详情请参见 [VeLiveVideoCaptureConfiguration](147521#VeLiveVideoCaptureConfiguration)。 ### setAudioCaptureConfig ```java public VeLivePusherConfiguration setAudioCaptureConfig(VeLiveAudioCaptureConfiguration config) ``` 设置音频采集参数，用于调整和设置音频采集相关的参数。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | config | VeLiveAudioCaptureConfiguration | 音频采集参数，详情请参见 [VeLiveAudioCaptureConfiguration](147521#VeLiveAudioCaptureConfiguration)。 | **返回值** 推流引擎初始化配置对象，详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。 ### getAudioCaptureConfig ```java public VeLiveAudioCaptureConfiguration getAudioCaptureConfig() ``` 获取音频采集参数，用于调整和设置音频采集相关的参数。 **返回值** 音频采集参数配置对象，详情请参见 [VeLiveAudioCaptureConfiguration](147521#VeLiveAudioCaptureConfiguration)。 ### setContext ```java public VeLivePusherConfiguration setContext(Context context) ``` 设置应用上下文。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | context | Context | 应用上下文。 | **返回值** 推流引擎初始化配置对象，详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。 ### getContext ```java public Context getContext() ``` 获取应用上下文。 **返回值** 应用上下文。 ### setExtraParameters ```java public VeLivePusherConfiguration setExtraParameters(String params) ``` 设置扩展参数，默认不需要设置。如果需要使用，您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | params | String | 扩展参数 | **返回值** 推流引擎初始化配置对象，详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。 ### getExtraParams ```java public LiveSdkSetting getExtraParams() ``` 获取扩展参数。 **返回值** 扩展参数。 ### build ```java public VeLivePusher build() ``` 构造推流引擎。 **返回值** 推流引擎，详情请参见 [VeLivePusher](#VeLivePusher)。

视频直播