You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /视频直播/客户端 SDK/推流 SDK/Android/SDK API 参考/概览
概览
最近更新时间：2024.08.21 12:13:45首次发布时间：2022.11.01 18:14:39
我的收藏
方法
方法描述
setRenderFillMode设置本地预览画面的填充模式。
build构造推流引擎。
setReconnectIntervalSeconds设置推流器推流失败后尝试重连的时间间隔。
getReconnectIntervalSeconds获取推流器推流失败后尝试重连的时间间隔。
setReconnectCount设置推流器推流失败后尝试重连的次数。
getReconnectCount获取推流器推流失败后尝试重连的次数。
setVideoCaptureConfig设置视频采集参数，用于调整和设置视频采集相关的参数。
getVideoCaptureConfig获取视频采集参数，用于调整和设置视频采集相关的参数。
setAudioCaptureConfig设置音频采集参数，用于调整和设置音频采集相关的参数。
getAudioCaptureConfig获取音频采集参数，用于调整和设置音频采集相关的参数。
setContext设置应用上下文。
getContext获取应用上下文。
setExtraParameters设置扩展参数，默认不需要设置。如果需要使用，您可通过提交工单联系技术支持。
getExtraParams获取扩展参数。
release停止采集和推流，并销毁推流器。通常在调用 stopPush 结束推流后调用此方法进行清理。
setObserver设置推流器回调，通过设置回调，监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。
setStatisticsObserver设置推流器周期性回调，用于定期获取推流状态信息。
setRenderView设置本地摄像头预览视图。摄像头采集到的画面，经过美颜、脸形调整、滤镜等多种效果叠加之后，最终会显示到传入的 View 上。
setVideoMirror开启/关闭镜像。
startVideoCapture开始视频采集。
stopVideoCapture停止视频采集。
startAudioCapture开始音频采集。
stopAudioCapture停止音频采集。
switchVideoCapture切换视频采集类型。
switchAudioCapture切换音频采集类型。
getCurrentVideoCaptureType获取当前视频采集类型。
getCurrentAudioCaptureType获取当前音频采集类型。
updateCustomImage自定义静态图，适用于静态图推流采集类型。
getCameraDevice获取相机设备管理对象 VeLiveCameraDevice。通过设备管理，您可以使用以下功能。
  • 控制闪光灯开关
  • 设置摄像头缩放比例
  • 设置自动对焦
setVideoEncoderConfiguration设置推流视频编码参数。
getVideoEncoderConfiguration获取推流视频编码参数。
setAudioEncoderConfiguration设置推流音频编码参数。
getAudioEncoderConfiguration获取推流音频编码参数。
startPush开始推流。
startPushWithUrls开始推流，支持备用推流地址。
stopPush停止推流。
isPushing当前是否正在推流中，可用来查询推流器的当前状态。
setWatermark设置推流水印。
startFileRecording开始本地文件录制。
stopFileRecording停止本地文件录制。
setProperty高级配置。
pushExternalVideoFrame推送外部视频帧数据。
pushExternalAudioFrame推送外部音频帧数据。
setOrientation设置推流视频帧朝向。默认为竖屏推流。
sendSeiMessage通过视频帧发送 SEI 消息。
setMute设置静音。
isMute当前是否是静音状态。
getVideoEffectManager获取视频特效管理对象 VeLiveVideoEffectManager。通过视频特效管理，您可以使用以下功能。
  • 设置美颜
  • 设置特效
  • 设置素材
  • 设置贴图
  • 设置滤镜
setVideoFrameFilter自定义视频处理。
getAudioDevice获取音频模块管理对象。
setAudioFrameFilter自定义音频处理。
createPlayer创建播放器。
getMixerManager获取混流管理对象。
startScreenRecording开始屏幕采集。
stopScreenRecording停止屏幕采集。
isScreenRecording获取当前是否处于屏幕采集状态。
addVideoFrameListener添加视频帧的监听回调，用于获取推流器输出的视频帧。
removeVideoFrameListener移除已添加的视频帧监听回调。
addAudioFrameListener添加音频帧的监听回调，用于获取推流器输出的音频帧。
removeAudioFrameListener移除已添加的音频帧监听回调。
snapshot视频截图。
setLogLevel设置输出到控制台的日志等级。
setEGLContext设置 OpenGL 的上下文。
setEGLVersion设置 OpenGL 的版本号，默认值为 3。
getEGLContext获取 OpenGL 的上下文。
setParameter设置相机参数。
getParameter获取相机参数。
getRealFpsRange获取相机支持帧率范围。
enableTorch开启/关闭闪光灯。
setZoomRatio设置摄像头的缩放倍数。
getCurrentZoomRatio获取摄像头当前的缩放倍数。
getMaxZoomRatio获取摄像头的最大缩放倍数。
getMinZoomRatio获取摄像头的最小缩放倍数。
isAutoFocusEnabled是否支持自动对焦。
enableAutoFocus开启/关闭自动对焦功能。
setFocusPosition设置摄像头的对焦位置。
setVoiceLoudness设置音量响度。
getVoiceLoudness获取当前音量响度。
isExposurePositionSupported检查当前使用的摄像头是否支持手动设置曝光点。
setExposurePosition设置当前使用的摄像头的曝光点。
getMinExposureCompensation获取摄像头的最小曝光补偿值。
getMaxExposureCompensation获取摄像头的最大曝光补偿值。
setExposureCompensation设置当前使用的摄像头的曝光补偿。
addVideoStream添加一路需要混流的视频流到混流器中。
removeVideoStream从混流器中移除一路非主路的视频流。
addAudioStream添加一路音频流到混流器中。
removeAudioStream从混流器中移除一路非主路的音频流。
addAudioStream添加一路音频流到混流器中，并指定混流类型。
getOriginVideoStream获取主路视频流 ID。
getOriginAudioStream获取主路音频流 ID。
getOriginScreenStream获取主路屏幕流 ID。
getOriginSystemAudioStream获取主路系统音频流 ID。
sendCustomVideoFrame发送指定混流 ID 的自定义视频帧数据。
sendCustomAudioFrame发送指定混流 ID 的自定义音频帧数据。
setupWithConfig视频特效许可证配置，用于初始化视频特效管理对象。
updateLicense更新在线 License。本方法仅对在线 License 有效。
setAlgorithmModelPath设置特效算法模型包的路径。
setEnable创建/销毁特效引擎。
setComposeNodes设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能，包括美颜、美形、美体、美妆等。
appendComposeNodes在已有的视频特效组合上，叠加视频特效素材包。
removeComposeNodes移除指定的视频特效资源。
release销毁播放器实例。
setListener设置播放状态的监听。
prepare设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
start暂停播放。
stop停止播放。
pause暂停播放。
resume恢复播放。
getDuration获取文件的总时长，单位为 ms。
seek设置播放进度。
enableMixer开启/关闭音频是否混音到直播流。
enableAutoEq开启/关闭自动音量均衡。
setRenderView支持 MP4 格式的视频渲染。
setFrameListener设置音视频帧回调的监听。
setBGMVolume设置播放音频的音量。
setVoiceVolume设置音频采集音量。
enableBGMLoop设置是否循环播放。
updateComposerNodeIntensity设置视频特效强度。
setFilter设置颜色滤镜。
updateFilterIntensity设置已启用的颜色滤镜强度。
setSticker设置贴纸特效。
setAdvancedFeatureCV 高级接口。
回调
回调描述
onError推流错误回调。
onStatusChange推流状态变化回调。
onFirstVideoFrame首帧视频回调，当推流器发送出第一帧视频时，触发该回调。
onFirstAudioFrame首帧音频回调，当推流器发送出第一帧音频时，触发该回调。
onCameraOpened摄像头开启/关闭回调，当推流器的摄像头开启或关闭时，触发该回调。
onMicrophoneOpened麦克风开启/关闭回调，当推流器的麦克风开启或关闭时，触发该回调。
onScreenRecording屏幕采集开启/关闭回调，当推流器的屏幕采集开启或关闭时，触发该回调。
onNetworkQuality网络质量状态回调，当推流器检测到网络质量发生变化时，触发该回调。
onAudioPowerQuality音量等级回调，当推流器的音频音量等级发生变化时，触发该回调。
onStatistics推流周期性统计信息回调。
onLogMonitor周期性日志信息回调。
onFileRecordingStarted直播录制开始回调。
onFileRecordingStopped直播录制停止回调。
onFileRecordingError直播录制错误回调。
onVideoProcess自定义的视频处理方法。
onSnapshotComplete截图成功回调。
onAudioProcess自定义的音频处理方法。
getObservedVideoFrameSource设置当前 Listener 需要的视频帧来源。
onCaptureVideoFrame采集视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 VeLiveVideoFrameSourceCapture 时，才会触发该回调。
onPreEncodeVideoFrame编码前视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 VeLiveVideoFrameSourcePreEncode 时，才会触发该回调。
getObservedAudioFrameSource设置当前 Listener 需要的音频帧来源。
onCaptureAudioFrame采集音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 VeLiveAudioFrameSourceCapture 时，才会触发该回调。
onPreEncodeAudioFrame编码前音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 VeLiveAudioFrameSourcePreEncode 时，才会触发该回调。