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

文档中心

导航

概览

最近更新时间：2025.07.23 14:54:08首次发布时间：2022.11.11 14:50:45

方法

推流器接口

方法	描述
initWithConfig:	初始化推流器。
destroy	停止采集和推流，并销毁推流器。通常在调用 stopPush 结束推流后调用此方法进行清理。
createPlayer	创建播放器。
setObserver:	设置推流器回调，通过设置回调，监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。
setScreenCaptureObserver:	添加屏幕采集的监听。
setStatisticsObserver:interval:	设置推流器周期性回调，用于定期获取推流状态信息。
setRenderView:	设置本地预览视图。如您对采集到的画面进行了美颜等处理，View 中显示的是美颜后的画面。
setVideoMirror:enable:	开启/关闭镜像。该方法可用于配置预览和推流画面是否镜像。
setOrientation:	设置推流视频帧朝向。默认为竖屏推流。
setRenderFillMode:	设置本地预览填充模式。
startVideoCapture:	开始视频采集。
stopVideoCapture	停止视频采集。
switchVideoCapture:	切换视频采集类型。
getCurrentVideoCaptureType	获取当前视频采集类型。
startAudioCapture:	开始音频采集。
stopAudioCapture	停止音频采集。
switchAudioCapture:	切换音频采集类型。
getCurrentAudioCaptureType	获取当前音频采集类型。
updateCustomImage:	自定义静态图，适用于静态图推流采集类型。使用该接口时，需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage，您可调用 startVideoCapture: 方法，将 VeLiveVideoCaptureType 设置为 VeLiveVideoCaptureCustomImage。
startScreenCapture:	开启屏幕采集。
stopScreenCapture	停止屏幕采集。
pauseScreenCapture	暂停屏幕采集。
setMute:	设置静音。
isMute	当前是否是静音状态。
resumeScreenCapture	恢复屏幕采集。
startPush:	开始推流。
startPushWithUrls:	开始推流，支持备用推流地址。
stopPush	停止推流。
setAudioEncoderConfiguration:	设置推流音频编码参数。
isPushing	当前是否正在推流中，可用来查询推流器的当前状态。
getMixerManager	获取混流管理对象。
getVideoEffectManager	获取视频特效管理对象 `VeLiveVideoEffectManager`。通过视频特效管理，您可以使用以下功能。设置美颜设置特效设置素材设置贴纸设置滤镜
setVideoEncoderConfiguration:	设置推流视频编码参数。
getCameraDevice	获取相机设备管理对象 `VeLiveCameraDevice`。通过设备管理，您可以使用以下功能。控制闪光灯开关设置摄像头缩放比例设置自动对焦
snapshot:	视频截图。
getAudioDevice	获取音频模块管理对象。
setWatermark:x:y:scale:	设置推流水印。
pushExternalVideoFrame:	推送外部视频帧数据。
pushExternalVideoEncodeFrame:	推送外部视频编码数据。
pushExternalAudioFrame:	推送外部音频帧数据。
setVideoFrameFilter:	自定义视频处理。
setProperty:value:	高级配置。您可通过提交工单联系技术支持，了解配置方法。
sendSeiMessage:value:repeat:isKeyFrame:allowsCovered:	通过视频帧发送 SEI 消息。
setAudioFrameFilter:	自定义音频处理。
setEGLVersion:	设置 opengl 的版本号，默认值为 `3`。
getEGLContext	获取 EAGL 的上下文，这是在多线程环境下用于共享的上下文。
requestIDRFrame	强制请求 IDR 帧，发起请求以编码一个新的 IDR 帧。
startFileRecording:config:listener:	开始本地文件录制。
stopFileRecording	停止本地文件录制。
startRecord:config:	开始直播录制。
stopRecord	停止本地直播录制。
setLogLevel:	设置输出到控制台的日志等级。
addVideoFrameListener:	添加视频帧的监听回调，用于获取推流器输出的视频帧。
removeVideoFrameListener:	移除已添加的视频帧监听回调。
addAudioFrameListener:	添加音频帧的监听回调，用于获取推流器输出的音频帧。
removeAudioFrameListener:	移除已添加的音频帧监听回调。

音视频混流器接口

方法	描述
addVideoStream	添加一路需要混流的视频流到混流器中。
addAudioStream	添加一路音频流到混流器中。
addAudioStream:	添加一路音频流到混流器中，并指定混流类型。
removeVideoStream:	从混流器中移除一路非主路的视频流。
removeAudioStream:	从混流器中移除一路非主路的音频流。
setAudioStream:volume:	设置指定混流音频的音量。当你将 VeLiveAudioMixType 设置为 `VeLiveAudioMixPlayAndPush` 时，该方法同时控制该路音频在拉流端和本地的播放音量。
getOriginVideoStream	获取主路视频流 ID。
getOriginAudioStream	获取主路音频流 ID。
getAppAudioStream	获取屏幕推流 App 的音频流 ID。
sendCustomVideoFrame:streamId:	发送指定混流 ID 的自定义视频帧数据。
sendCustomAudioFrame:streamId:	发送指定混流 ID 的自定义音频帧数据。
updateStreamMixDescription:	更新音视频混流的布局。

视频特效接口

方法	描述
setAdvancedFeature:isGLThread:isAsync:	智能美化特效（简称 CV）高级接口。
setupWithConfig:	视频特效许可证配置，用于初始化视频特效管理对象。
updateLicense:	在许可证过期后，可调用该方法更新 License，本方法仅对在线 License 有效。
setAlgoModelPath:	设置特效算法模型包的路径。
setEnable:	创建/销毁特效引擎。
setComposeNodes:	设置视频特效组合。支持设置 `ComposeMakeup.bundle` 中的功能，包括美颜、美形、美体、美妆等。
appendComposeNodes:	调用本方法，会在 setComposeNodes: 设置的视频特效组合的基础上叠加特效。
removeComposeNodes:	调用本方法，可移除调用 setComposeNodes: 和 ppendComposeNodes: 设置的视频特效资源。
updateComposerNodeIntensity:nodeKey:intensity:	设置视频特效强度。
setSticker:	设置贴纸特效。
setFilter:	设置颜色滤镜。
updateFilterIntensity:	设置已启用的颜色滤镜强度。

相机设备管理接口

方法	描述
isTorchSupported	是否支持闪光灯。
enableTorch:	开启/关闭闪光灯。
setZoomRatio:	设置摄像头的缩放倍数。
getCurrentZoomRatio	获取摄像头当前的缩放倍数。
getMaxZoomRatio	获取摄像头的最大缩放倍数。
getMinZoomRatio	获取摄像头的最小缩放倍数。
isAutoFocusEnabled	是否支持自动对焦。
enableAutoFocus:	开启/关闭自动对焦功能。
setFocusPosition:	设置摄像头的对焦位置。
isAutoExposureEnabled	是否支持自动曝光。
enableAutoExposure:	开启/关闭自动曝光功能。
isExposurePositionSupported	检查当前使用的摄像头是否支持手动设置曝光点。
setExposurePosition:	设置当前使用的摄像头的曝光点。
setExposureCompensation:	设置当前使用的摄像头的曝光补偿。
getMinExposureCompensation	获取摄像头的最小曝光补偿。
getMaxExposureCompensation	获取摄像头的最大曝光补偿。
getCurrentExposureCompensation	获取摄像头的当前曝光补偿。

音频设备管理接口

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

媒体播放器接口

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

回调

方法	描述
onError:subcode:message:	推流错误回调。
onVideoFrame:	播放器视频帧回调。当完成一个新的视频帧的解码后，触发该回调。
onStatusChange:	推流状态变化回调。
onFirstVideoFrame:timestampMs:	首帧视频回调，当推流器发送出第一帧视频时，触发该回调。
onFirstAudioFrame:timestampMs:	首帧音频回调，当推流器发送出第一帧音频时，触发该回调。
onCameraOpened:	摄像头开启/关闭回调，当推流器的摄像头开启或关闭时，触发该回调。
onMicrophoneOpened:	麦克风开启/关闭回调，当推流器的麦克风开启或关闭时，触发该回调。
onNetworkQuality:	网络质量状态回调，当推流器检测到网络质量发生变化时，触发该回调。
onAudioPowerQuality:value:	音量等级回调，当推流器采集的音频音量等级发生变化时，触发该回调。
onSnapshotComplete:	截图成功回调。调用 snapshot: 截图成功后，会收到这个回调。
onError:	返错误状态的回调。
onStop	停止播放的回调。
onProgress:	播放进度的回调，每 100ms 触发一次。
onStart	开始播放的回调。
onPreEncodeAudioFrame:	编码前音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 `VeLiveAudioFrameSourcePreEncode` 时，才会触发该回调。
onCaptureAudioFrame:	采集音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 `VeLiveAudioFrameSourceCapture` 时，才会触发该回调。
onPreEncodeVideoFrame:	编码前视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 `VeLiveVideoFrameSourcePreEncode` 时，才会触发该回调。
onCaptureVideoFrame:	采集视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 `VeLiveVideoFrameSourceCapture` 时，才会触发该回调。
broadcastFinished	屏幕推流结束的回调。当 `[RPBroadcastSampleHandler finishBroadcast]` 回调被触发时，会同时触发该回调。
broadcastResumed	屏幕推流恢复的回调。当 `[RPBroadcastSampleHandler resumeBroadcast]` 回调被触发时，会同时触发该回调。
broadcastPaused	屏幕推流暂停的回调。当 `[RPBroadcastSampleHandler pauseBroadcast]` 回调被触发时，会同时触发该回调。
broadcastStarted	录屏推流开始的回调。当 `[RPBroadcastSampleHandler startBroadcast]` 回调被触发时，会同时触发该回调。
onAudioFrame:	播放器音频帧回调。
onAudioProcess:dstFrame:	自定义的音频处理方法。
onStatistics:	推流周期性统计信息回调。
onLogMonitor:	周期性日志信息回调。
onVideoProcess:dstFrame:	自定义的视频处理方法。
onFileRecordingStarted	直播录制开始回调。
getObservedVideoFrameSource	设置当前 Listener 需要的视频帧来源。
getObservedAudioFrameSource	设置当前 Listener 需要的音频帧来源。
onFileRecordingStopped	直播录制停止回调。
onFileRecordingError:message:	直播录制错误回调。