概览--视频直播-火山引擎

文档中心

导航

概览

最近更新时间：2025.05.26 21:22:39首次发布时间：2022.11.01 18:14:39

方法

方法	描述
build	构造推流引擎。
setReconnectIntervalSeconds	设置推流器推流失败后尝试重连的时间间隔。
getReconnectIntervalSeconds	获取推流器推流失败后尝试重连的时间间隔。
setReconnectCount	设置推流器推流失败后尝试重连的次数。
getReconnectCount	获取推流器推流失败后尝试重连的次数。
setVideoCaptureConfig	设置视频采集参数，用于调整和设置视频采集相关的参数。
getVideoCaptureConfig	获取视频采集参数，用于调整和设置视频采集相关的参数。
setAudioCaptureConfig	设置音频采集参数，用于调整和设置音频采集相关的参数。
getAudioCaptureConfig	获取音频采集参数，用于调整和设置音频采集相关的参数。
setContext	设置应用上下文。
getContext	获取应用上下文。
setExtraParameters	设置扩展参数，默认不需要设置。如果需要使用，您可通过提交工单联系技术支持。
getExtraParams	获取扩展参数。

推流器接口

方法	描述
createPlayer	创建播放器。
setObserver	设置推流器回调，通过设置回调，监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。
setStatisticsObserver	设置推流器周期性回调，用于定期获取推流状态信息。
release	停止采集和推流，并销毁推流器。通常在调用 stopPush 结束推流后调用此方法进行清理。
setRenderView	设置本地摄像头预览视图。摄像头采集到的画面，经过美颜、脸形调整、滤镜等多种效果叠加之后，最终会显示到传入的 View 上。
setRenderFillMode	设置本地预览画面的填充模式。
setVideoMirror	开启/关闭镜像。
startVideoCapture	开始视频采集。
startAudioCapture	开始音频采集。
stopVideoCapture	停止视频采集。
stopAudioCapture	停止音频采集。
switchVideoCapture	切换视频采集类型。
switchAudioCapture	切换音频采集类型。
getCurrentVideoCaptureType	获取当前视频采集类型。
getCurrentAudioCaptureType	获取当前音频采集类型。
updateCustomImage	自定义静态图，适用于静态图推流采集类型。使用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage，您可调用 startVideoCapture 方法，将 VeLiveVideoCaptureType 设置为 VeLiveVideoCaptureCustomImage。
getCameraDevice	获取相机设备管理对象 `VeLiveCameraDevice`。通过设备管理，您可以使用以下功能。控制闪光灯开关设置摄像头缩放比例设置自动对焦
setVideoEncoderConfiguration	设置推流视频编码参数。
getVideoEncoderConfiguration	获取推流视频编码参数。
setAudioEncoderConfiguration	设置推流音频编码参数。
getAudioEncoderConfiguration	获取推流音频编码参数。
startPush	开始推流。
startPushWithUrls	开始推流，支持备用推流地址。
stopPush	停止推流。
isPushing	当前是否正在推流中，可用来查询推流器的当前状态。
setWatermark	设置推流水印。
startFileRecording	开始本地文件录制。
stopFileRecording	停止本地文件录制。
setProperty	高级配置。
pushExternalVideoFrame	推送外部视频帧数据。
pushExternalAudioFrame	推送外部音频帧数据。
setOrientation	设置推流视频帧朝向。默认为竖屏推流。
sendSeiMessage	通过视频帧发送 SEI 消息。
setMute	设置静音。
isMute	当前是否是静音状态。
getVideoEffectManager	获取视频特效管理对象 `VeLiveVideoEffectManager`。通过视频特效管理，您可以使用以下功能。设置美颜设置特效设置素材设置贴图设置滤镜
addVideoFrameFilter	自定义视频处理。
getAudioDevice	获取音频模块管理对象。
setAudioFrameFilter	自定义音频处理。
getMixerManager	获取混流管理对象。
startMixSystemAudio	开始系统音频采集。
stopMixSystemAudio	停止系统音频采集。
isScreenRecording	获取当前是否处于屏幕采集状态。
addVideoFrameListener	添加视频帧的监听回调，用于获取推流器输出的视频帧。
removeVideoFrameListener	移除已添加的视频帧监听回调。
addAudioFrameListener	添加音频帧的监听回调，用于获取推流器输出的音频帧。
removeAudioFrameListener	移除已添加的音频帧监听回调。
snapshot	视频截图。
setLogLevel	设置输出到控制台的日志等级。
setEGLContext	设置 OpenGL 的上下文。
setEGLVersion	设置 OpenGL 的版本号，默认值为 `2`。
getEGLContext	获取 OpenGL 的上下文。
removeVideoFrameFilter	移除已添加的视频帧自定义处理监听。

音视频混流器接口

方法	描述
updateStreamMixDescription	更新音视频混流的布局。
addVideoStream	添加一路需要混流的视频流到混流器中。
removeVideoStream	从混流器中移除一路非主路的视频流。
VeLiveMixerManager.addAudioStream	添加一路音频流到混流器中。
VeLiveMixerManager.addAudioStream	添加一路音频流到混流器中，并指定混流类型。
removeAudioStream	从混流器中移除一路非主路的音频流。
getOriginVideoStream	获取主路视频流 ID。
getOriginAudioStream	获取主路音频流 ID。
getOriginScreenStream	获取主路屏幕流 ID。
getOriginSystemAudioStream	获取主路系统音频流 ID。
sendCustomVideoFrame	发送指定混流 ID 的自定义视频帧数据。
sendCustomAudioFrame	发送指定混流 ID 的自定义音频帧数据。

视频特效接口

方法	描述
setupWithConfig	视频特效许可证配置，用于初始化视频特效管理对象。
updateLicense	如果您使用在线 License 认证方式，在许可证过期后，可调用该方法更新 License；
setAlgorithmModelPath	设置特效算法模型包的路径。
setEnable	创建/销毁特效引擎。
setComposeNodes	设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能，包括美颜、美形、美体、美妆等。
appendComposeNodes	在已有的视频特效组合上，叠加视频特效素材包，您可以调用 setComposeNodes 设置视频特效组合。
removeComposeNodes	调用本方法，可移除调用 setComposeNodes 和 appendComposeNodes 设置的视频特效资源。
updateComposerNodeIntensity	设置视频特效强度。
setFilter	设置颜色滤镜。
updateFilterIntensity	设置已启用的颜色滤镜强度。
setSticker	设置贴纸特效。
setAdvancedFeature	智能美化特效的高级功能。

相机设备管理接口

方法	描述
getParameter	获取相机参数。
setParameter	设置相机参数。
getRealFpsRange	获取相机支持帧率范围。
getCurrentZoomRatio	获取摄像头当前的缩放倍数。
setZoomRatio	设置摄像头的缩放倍数。
getMaxZoomRatio	获取摄像头的最大缩放倍数。
getMinZoomRatio	获取摄像头的最小缩放倍数。
enableTorch	开启/关闭闪光灯。
isAutoFocusEnabled	是否支持自动对焦。
enableAutoFocus	开启/关闭自动对焦功能。
setFocusPosition	设置摄像头的对焦位置。
isExposurePositionSupported	检查当前使用的摄像头是否支持手动设置曝光点。
setExposurePosition	设置当前使用的摄像头的曝光点。
getMinExposureCompensation	获取摄像头的最小曝光补偿值。
getMaxExposureCompensation	获取摄像头的最大曝光补偿值。
setExposureCompensation	设置当前使用的摄像头的曝光补偿。

音频设备管理接口

方法	描述
setVoiceLoudness	设置音量响度。
getVoiceLoudness	获取当前音量响度。

媒体播放器接口

方法	描述
release	销毁播放器实例。
prepare	设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
getDuration	获取文件的总时长，单位为 ms。
setListener	设置播放状态的监听。
seek	设置播放进度。
enableMixer	开启/关闭音频是否混音到直播流。
enableAutoEq	开启/关闭自动音量均衡。
setFrameListener	设置音视频帧回调的监听。
setBGMVolume	设置播放音频的音量。
setVoiceVolume	设置音频采集音量。
enableBGMLoop	设置是否循环播放。
start	开始播放。
stop	停止播放。
pause	暂停播放。
resume	恢复播放。

推流回调

方法	描述
VeLivePusherObserver.onError	推流错误回调。
onFirstVideoFrame	首帧视频回调，当推流器发送出第一帧视频时，触发该回调。
onFirstAudioFrame	首帧音频回调，当推流器发送出第一帧音频时，触发该回调。
onCameraOpened	摄像头开启/关闭回调，当推流器的摄像头开启或关闭时，触发该回调。
onMicrophoneOpened	麦克风开启/关闭回调，当推流器的麦克风开启或关闭时，触发该回调。
onResult	视频特效处理结果回调。
onStart	开始播放的回调。
onProgress	播放进度的回调，每 100ms 触发一次。
onStop	停止播放的回调。
VeLiveMediaPlayerListener.onError	返错误状态的回调。
onAudioFrame	播放器音频帧回调。
onVideoFrame	播放器视频帧回调。当完成一个新的视频帧的解码后，触发该回调。
onEffectHandle	视频特效对象回调，调用 setAdvancedFeature 接口时触发此回调，如需使用请联系技术支持。
onScreenRecording	屏幕采集开启/关闭回调，当推流器的屏幕采集开启或关闭时，触发该回调。
onAudioPowerQuality	音量等级回调，当推流器的音频音量等级发生变化时，触发该回调。
onStatusChange	推流状态变化回调。
onNetworkQuality	网络质量状态回调，当推流器检测到网络质量发生变化时，触发该回调。
onStatistics	推流周期性统计信息回调，每 5s 回调一次，您可以调用 setStatisticsObserver 修改回调时间间隔。
onSnapshotComplete	截图成功回调。
onVideoProcess	自定义的视频处理方法。
onAudioProcess	自定义的音频处理方法。
onFileRecordingStarted	直播录制开始回调。
onFileRecordingStopped	直播录制停止回调。
onFileRecordingError	直播录制错误回调。
onLogMonitor	周期性日志信息回调。
onCaptureVideoFrame	采集视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 `VeLiveVideoFrameSourceCapture` 时，才会触发该回调。
onPreEncodeVideoFrame	编码前视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 `VeLiveVideoFrameSourcePreEncode` 时，才会触发该回调。
onCaptureAudioFrame	采集音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 `VeLiveAudioFrameSourceCapture` 时，才会触发该回调。
onPreEncodeAudioFrame	编码前音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 `VeLiveAudioFrameSourcePreEncode` 时，才会触发该回调。
getObservedVideoFrameSource	设置当前 Listener 需要的视频帧来源。
getObservedAudioFrameSource	设置当前 Listener 需要的音频帧来源。