public interface com.ss.avframework.live.VeLiveCameraDevice

相机设备管理对象。

成员函数 #

函数说明 #

getRealFpsRange #

int[] com.ss.avframework.live.VeLiveCameraDevice.getRealFpsRange()

获取相机支持帧率范围。

返回值

相机支持帧率范围。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

enableTorch #

int com.ss.avframework.live.VeLiveCameraDevice.enableTorch(boolean enable)

开启/关闭闪光灯。

传入参数

返回值

• 0：开启/关闭成功；
• ≠0：开启/关闭失败。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

setZoomRatio #

int com.ss.avframework.live.VeLiveCameraDevice.setZoomRatio(float ratio)

设置摄像头的缩放倍数。

传入参数

返回值

• 0：缩放成功；
• ≠0：缩放失败。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

getCurrentZoomRatio #

float com.ss.avframework.live.VeLiveCameraDevice.getCurrentZoomRatio()

获取摄像头当前的缩放倍数。

返回值

• ≤0：表示不支持缩放；
• >0：支持缩放，数值表示当前缩放倍数。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

getMaxZoomRatio #

float com.ss.avframework.live.VeLiveCameraDevice.getMaxZoomRatio()

获取摄像头的最大缩放倍数。

返回值

• ≤0：表示不支持缩放；
• >0：支持缩放，数值表示最大缩放倍数。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

getMinZoomRatio #

float com.ss.avframework.live.VeLiveCameraDevice.getMinZoomRatio()

获取摄像头的最小缩放倍数。

返回值

• ≤0：表示不支持缩放；
• >0：支持缩放，数值表示最小缩放倍数。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

isAutoFocusEnabled #

boolean com.ss.avframework.live.VeLiveCameraDevice.isAutoFocusEnabled()

是否支持自动对焦。

返回值

• true：支持；
• false：不支持。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

enableAutoFocus #

int com.ss.avframework.live.VeLiveCameraDevice.enableAutoFocus(boolean enable)

开启/关闭自动对焦功能。

传入参数

返回值

• 0：开启/关闭成功；
• ≠0：开启/关闭失败。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

setFocusPosition #

int com.ss.avframework.live.VeLiveCameraDevice.setFocusPosition(
    int viewW,
    int viewH,
    int x,
    int y
)

设置摄像头的对焦位置。

传入参数

返回值

• 0：设置成功；
• ≠0：设置失败。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

isExposurePositionSupported #

boolean com.ss.avframework.live.VeLiveCameraDevice.isExposurePositionSupported()

检查当前使用的摄像头是否支持手动设置曝光点。

返回值

• YES：支持；
• NO：不支持。

注意

必须已调用 startVideoCapture 使用 SDK 内部采集模块进行视频采集时，才能检查曝光点设置能力。

setExposurePosition #

int com.ss.avframework.live.VeLiveCameraDevice.setExposurePosition(
    int viewW,
    int viewH,
    int x,
    int y
)

设置当前使用的摄像头的曝光点。

传入参数

返回值

• =0：成功；
• ≠0：失败。

注意

• 必须已调用 startVideoCapture 使用 SDK 内部采集模块进行视频采集，并且使用 SDK 内部渲染时，才能设置曝光点；
• 调用 stopVideoCapture 关闭内部采集后，设置的曝光点失效。
  

getMinExposureCompensation #

float com.ss.avframework.live.VeLiveCameraDevice.getMinExposureCompensation()

获取摄像头的最小曝光补偿值。

返回值

• ≤0：表示不支持曝光补偿；
• >0：支持曝光补偿，数值表示最小曝光补偿。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

getMaxExposureCompensation #

float com.ss.avframework.live.VeLiveCameraDevice.getMaxExposureCompensation()

获取摄像头的最大曝光补偿值。

返回值

• ≤0：表示不支持曝光补偿；
• >0：支持曝光补偿，数值表示最大曝光补偿。

注意

需要在调用 startVideoCapture 启动相机采集后，调用本方法。

setExposureCompensation #

int com.ss.avframework.live.VeLiveCameraDevice.setExposureCompensation(float value)

设置当前使用的摄像头的曝光补偿。

传入参数

返回值

• =0：设置成功；
• ≠0：设置失败。

注意

• 必须已调用 startVideoCapture 使用 SDK 内部采集模块进行视频采集时，才能设置曝光补偿。
• 调用 stopVideoCapture 关闭内部采集后，设置的曝光补偿失效。
  

public interface com.ss.avframework.live.VeLiveVideoEffectManager

视频特效管理对象。用于管理和设置视频特效，包括美颜、美形、美体、美妆、滤镜等。

成员函数 #

函数说明 #

setupWithConfig #

int com.ss.avframework.live.VeLiveVideoEffectManager.setupWithConfig(VeLiveVideoEffectLicenseConfiguration config)

视频特效许可证配置，用于初始化视频特效管理对象。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。
  

updateLicense #

void com.ss.avframework.live.VeLiveVideoEffectManager.updateLicense(VeLiveVideoEffectCallback callback)

如果您使用在线 License 认证方式，在许可证过期后，可调用该方法更新 License；

传入参数

注意

• 需要通过调用 setupWithConfig 设置视频特效许可证后调用；
• 本方法为异步操作。
  

setEnable #

void com.ss.avframework.live.VeLiveVideoEffectManager.setEnable(
    boolean enable,
    VeLiveVideoEffectCallback callback
)

创建/销毁特效引擎。

传入参数

返回值

• 0：成功；
• -1：失败。

注意

• 该方法需要在调用 setupWithConfig 和 setAlgorithmModelPath 后调用；
• 该方法不直接开启/关闭视频特效，您需要在调用该方法后，调用 setComposeNodes 开启视频特效；
• 通用场景下，特效引擎会随 EffectManager 销毁而销毁。如果您对性能有较高要求，也可以在不使用特效相关功能时，调用该方法销毁特效引擎；
• 如果重复创建/销毁特效引擎，会产生时间消耗。
  

setAlgorithmModelPath #

int com.ss.avframework.live.VeLiveVideoEffectManager.setAlgorithmModelPath(String path)

设置特效算法模型包的路径。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

需要通过调用 setupWithConfig 设置视频特效许可证后调用。

setComposeNodes #

int com.ss.avframework.live.VeLiveVideoEffectManager.setComposeNodes(String[] nodes)

设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能，包括美颜、美形、美体、美妆等。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

• 需要在调用 setEnable 创建特效引擎后，调用本方法；
• 重复调用本方法，仅最后一次调用生效；
• 如果需要在当前的视频特效组合中叠加特效，可调用 appendComposeNodes 方法。
  

appendComposeNodes #

int com.ss.avframework.live.VeLiveVideoEffectManager.appendComposeNodes(String[] nodes)

在已有的视频特效组合上，叠加视频特效素材包，您可以调用 setComposeNodes 设置视频特效组合。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

需要在调用 setEnable 创建特效引擎后，调用本方法。

removeComposeNodes #

int com.ss.avframework.live.VeLiveVideoEffectManager.removeComposeNodes(String[] nodes)

调用本方法，可移除调用 setComposeNodes 和 appendComposeNodes 设置的视频特效资源。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

需要在调用 setEnable 创建特效引擎后，调用本方法。

updateComposerNodeIntensity #

int com.ss.avframework.live.VeLiveVideoEffectManager.updateComposerNodeIntensity(
    String node,
    String key,
    float intensity
)

设置视频特效强度。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

• 需要在调用 setComposeNodes 设置视频特效组合或调用 appendComposeNodes 叠加视频特效素材包后，调用本方法；
• 该方法仅适用于同时含有上述三个参数的特效资源，对于没有强度参数的特效（如贴纸），该方法无效。
  

setFilter #

int com.ss.avframework.live.VeLiveVideoEffectManager.setFilter(String path)

设置颜色滤镜。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

请在调用 setEnable 开启视频特效后，调用该方法。

updateFilterIntensity #

int com.ss.avframework.live.VeLiveVideoEffectManager.updateFilterIntensity(float intensity)

设置已启用的颜色滤镜强度。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

请在调用 setFilter 设置颜色滤镜后调用。

setSticker #

int com.ss.avframework.live.VeLiveVideoEffectManager.setSticker(String path)

设置贴纸特效。

传入参数

返回值

• 0：调用成功；
• -1：调用失败。

注意

请在调用 setEnable 开启视频特效后，调用该方法。

setAdvancedFeature #

int com.ss.avframework.live.VeLiveVideoEffectManager.setAdvancedFeature(
    VeLiveVideoEffectHandleCallback callback,
    boolean isGLThread,
    boolean isAsync
)

智能美化特效的高级功能。

传入参数

注意

请在调用 setEnable 开启视频特效后，调用该方法，不要在主线程中频繁执行同步操作。

public interface com.ss.avframework.live.VeLivePusher

直播推流器。

静态函数 #

成员函数 #

函数说明 #

setLogLevel #

static void com.ss.avframework.live.VeLivePusher.setLogLevel(VeLivePusherLogLevel logLevel)

设置输出到控制台的日志等级。

传入参数

setEGLVersion #

static void com.ss.avframework.live.VeLivePusher.setEGLVersion(int version)

设置 OpenGL 的版本号，默认值为 2。

传入参数

setEGLContext #

static void com.ss.avframework.live.VeLivePusher.setEGLContext(EGLContext context)

设置 OpenGL 的上下文。

传入参数

getEGLContext #

static EGLContext com.ss.avframework.live.VeLivePusher.getEGLContext()

获取 OpenGL 的上下文。

返回值

当前 OpenGL 的上下文。

release #

void com.ss.avframework.live.VeLivePusher.release()

停止采集和推流，并销毁推流器。通常在调用 stopPush 结束推流后调用此方法进行清理。

setObserver #

void com.ss.avframework.live.VeLivePusher.setObserver(VeLivePusherObserver observer)

设置推流器回调，通过设置回调，监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。

传入参数

注意

• 需要在创建推流引擎后，调用本方法；
• 重复调用本方法，仅最后一次调用生效。
  

setStatisticsObserver #

void com.ss.avframework.live.VeLivePusher.setStatisticsObserver(
    VeLivePusherStatisticsObserver observer,
    int interval
)

设置推流器周期性回调，用于定期获取推流状态信息。

传入参数

注意

• 需要在创建推流引擎后，调用本方法；
• 重复调用本方法，仅最后一次调用生效。
  

setRenderView #

void com.ss.avframework.live.VeLivePusher.setRenderView(View view)

设置本地摄像头预览视图。摄像头采集到的画面，经过美颜、脸形调整、滤镜等多种效果叠加之后，最终会显示到传入的 View 上。

传入参数

setRenderFillMode #

void com.ss.avframework.live.VeLivePusher.setRenderFillMode(VeLivePusherRenderMode mode)

设置本地预览画面的填充模式。

传入参数

setVideoMirror #

void com.ss.avframework.live.VeLivePusher.setVideoMirror(
    VeLiveVideoMirrorType type,
    boolean mirror
)

开启/关闭镜像。

传入参数

注意

用于配置视频镜像效果，影响采集、预览和推流画面。

isMirror #

boolean com.ss.avframework.live.VeLivePusher.isMirror(
    VeLiveVideoMirrorType mirrorType,
    VeLiveVideoCaptureType captureType
)

获取指定镜像类型和采集类型下的视频镜像状态。适用于主播需要了解当前镜像状态的场景，例如直播前确认预览画面是否符合预期。

传入参数

返回值

视频镜像状态。

• true：已开启镜像。
• false：未开启镜像。
  

startVideoCapture #

void com.ss.avframework.live.VeLivePusher.startVideoCapture(VeLiveVideoCaptureType type)

开始视频采集。

传入参数

注意

调用该接口后，可以通过调用接口 stopVideoCapture 停止视频采集。

stopVideoCapture #

void com.ss.avframework.live.VeLivePusher.stopVideoCapture()

停止视频采集。

注意

调用该接口后，可以通过调用接口 startVideoCapture 开始视频采集。

startAudioCapture #

void com.ss.avframework.live.VeLivePusher.startAudioCapture(VeLiveAudioCaptureType type)

开始音频采集。

传入参数

注意

调用该接口后，可以通过调用接口 stopAudioCapture 停止音频采集。

stopAudioCapture #

void com.ss.avframework.live.VeLivePusher.stopAudioCapture()

停止音频采集。

注意

调用该接口后，可以通过调用接口 startAudioCapture 开始音频采集。

switchVideoCapture #

void com.ss.avframework.live.VeLivePusher.switchVideoCapture(VeLiveVideoCaptureType type)

切换视频采集类型。

传入参数

注意

该接口必须在调用接口 startVideoCapture 后调用才能生效。

switchAudioCapture #

void com.ss.avframework.live.VeLivePusher.switchAudioCapture(VeLiveAudioCaptureType type)

切换音频采集类型。

传入参数

注意

该接口必须在调用接口 startVideoCapture 后调用才能生效。

getCurrentVideoCaptureType #

VeLiveVideoCaptureType com.ss.avframework.live.VeLivePusher.getCurrentVideoCaptureType()

获取当前视频采集类型。

返回值

视频采集类型，详细信息请参见 VeLiveVideoCaptureType。

getCurrentAudioCaptureType #

VeLiveAudioCaptureType com.ss.avframework.live.VeLivePusher.getCurrentAudioCaptureType()

获取当前音频采集类型。

返回值

音频采集类型，详细信息请参见 VeLiveAudioCaptureType。

updateCustomImage #

void com.ss.avframework.live.VeLivePusher.updateCustomImage(Bitmap image)

自定义静态图，适用于静态图推流采集类型。使用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage，您可调用 startVideoCapture 方法，将 VeLiveVideoCaptureType 设置为 VeLiveVideoCaptureCustomImage。

传入参数

getCameraDevice #

VeLiveCameraDevice com.ss.avframework.live.VeLivePusher.getCameraDevice()

获取相机设备管理对象 VeLiveCameraDevice。通过设备管理，您可以使用以下功能。

• 控制闪光灯开关
• 设置摄像头缩放比例
• 设置自动对焦

返回值

相机设备管理对象 VeLiveCameraDevice。

注意

该接口需要在 startVideoCapture 方法中设置 VeLiveVideoCaptureType 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureBackCamera。

setVideoEncoderConfiguration #

void com.ss.avframework.live.VeLivePusher.setVideoEncoderConfiguration(VeLiveVideoEncoderConfiguration config)

设置推流视频编码参数。

传入参数

注意

该接口可在推流开始前或开始后调用。

getVideoEncoderConfiguration #

VeLiveVideoEncoderConfiguration com.ss.avframework.live.VeLivePusher.getVideoEncoderConfiguration()

获取推流视频编码参数。

返回值

推流视频参数，支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 VeLiveVideoEncoderConfiguration。

setAudioEncoderConfiguration #

void com.ss.avframework.live.VeLivePusher.setAudioEncoderConfiguration(VeLiveAudioEncoderConfiguration config)

设置推流音频编码参数。

传入参数

注意

该接口需要在 startPush 或 startPushWithUrls 方法之前调用。

getAudioEncoderConfiguration #

VeLiveAudioEncoderConfiguration com.ss.avframework.live.VeLivePusher.getAudioEncoderConfiguration()

获取推流音频编码参数。

返回值

推流音频编码参数，详情请参见 VeLiveAudioEncoderConfiguration。

startPush #

void com.ss.avframework.live.VeLivePusher.startPush(String url)

开始推流。

传入参数

startPushWithUrls #

void com.ss.avframework.live.VeLivePusher.startPushWithUrls(String[] urls)

开始推流，支持备用推流地址。

传入参数

注意

当主推流地址不可用时，会自动切换到备用推流地址继续推流。

stopPush #

void com.ss.avframework.live.VeLivePusher.stopPush()

停止推流。

注意

停止推流后，可以通过调用 startPush 或 startPushWithUrls 方法重新开始推流。

isPushing #

boolean com.ss.avframework.live.VeLivePusher.isPushing()

当前是否正在推流中，可用来查询推流器的当前状态。

返回值

是否正在推流。

• true：正在推流中；
• false：已经停止推流。
  

setWatermark #

int com.ss.avframework.live.VeLivePusher.setWatermark(
    Bitmap image,
    float x,
    float y,
    float scale
)

设置推流水印。

传入参数

返回值

• 0：水印设置成功；
• <0：水印设置失败。
  

startFileRecording #

void com.ss.avframework.live.VeLivePusher.startFileRecording(
    String path,
    VeLiveFileRecorderConfiguration config,
    VeLiveFileRecordingListener listener
)

开始本地文件录制。

传入参数

stopFileRecording #

void com.ss.avframework.live.VeLivePusher.stopFileRecording()

停止本地文件录制。

注意

该接口需要在 startFileRecording 方法之后调用。

setProperty #

int com.ss.avframework.live.VeLivePusher.setProperty(
    String key,
    Object value
)

高级配置。

传入参数

返回值

• 0：成功；
• -1：失败，参数错误。
  

pushExternalVideoFrame #

int com.ss.avframework.live.VeLivePusher.pushExternalVideoFrame(VeLiveVideoFrame frame)

推送外部视频帧数据。

传入参数

返回值

• 0：成功；
• <0：失败。

注意

调用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureExternal，您可调用 startVideoCapture 方法，将 VeLiveVideoCaptureType 设置为 VeLiveVideoCaptureExternal。

pushExternalAudioFrame #

int com.ss.avframework.live.VeLivePusher.pushExternalAudioFrame(VeLiveAudioFrame frame)

推送外部音频帧数据。

传入参数

返回值

• 0：成功；
• <0：失败。

注意

该接口需要在 startAudioCapture 方法中设置 VeLiveAudioCaptureType 为 VeLiveAudioCaptureExternal。

setOrientation #

void com.ss.avframework.live.VeLivePusher.setOrientation(VeLiveOrientation orientation)

设置推流视频帧朝向。默认为竖屏推流。

传入参数

sendSeiMessage #

int com.ss.avframework.live.VeLivePusher.sendSeiMessage(
    String key,
    Object value,
    int repeat,
    boolean isKeyFrame,
    boolean allowsCovered
)

通过视频帧发送 SEI 消息。

传入参数