You need to enable JavaScript to run this app.
导航
概览
最近更新时间:2024.04.19 14:57:37首次发布时间:2022.11.11 14:50:45
方法
方法描述
initWithConfig:初始化推流器。
startRecord:config:开始直播录制。
setOrientation:设置推流视频帧朝向。默认为竖屏推流。
setScreenCaptureObserver:添加屏幕采集的监听。
setAdvancedFeature:isGLThread:isAsync:智能美化特效(简称 CV)高级接口。
setObserver:设置推流器回调,通过设置回调,监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。
setStatisticsObserver:interval:设置推流器周期性回调,用于定期获取推流状态信息。
addVideoFrameListener:添加视频帧的监听回调,用于获取推流器输出的视频帧。
removeVideoFrameListener:移除已添加的视频帧监听回调。
addAudioFrameListener:添加音频帧的监听回调,用于获取推流器输出的音频帧。
setRenderView:设置本地预览视图。如您对采集到的画面进行了美颜等处理,View 中显示的是美颜后的画面。
setVideoMirror:enable:开启/关闭镜像。
startPush:开始推流。
startPushWithUrls:开始推流,支持备用推流地址。
removeAudioFrameListener:移除已添加的音频帧监听回调。
isPushing当前是否正在推流中,可用来查询推流器的当前状态。
destroy停止采集和推流,并销毁推流器。通常在调用 stopPush 结束推流后调用此方法进行清理。
getAppAudioStream获取屏幕推流App音频流 ID。
stopPush停止推流。
startVideoCapture:开始视频采集。
stopVideoCapture停止视频采集。
switchVideoCapture:切换视频采集类型。
getCurrentVideoCaptureType获取当前视频采集类型。
getCurrentAudioCaptureType获取当前音频采集类型。
startAudioCapture:开始音频采集。
setMute:设置静音。
isMute当前是否是静音状态。
setVideoEncoderConfiguration:设置推流视频编码参数。
stopAudioCapture停止音频采集。
startFileRecording:config:listener:开始本地文件录制。
stopFileRecording停止本地文件录制。
switchAudioCapture:切换音频采集类型。
updateCustomImage:自定义静态图,适用于静态图推流采集类型。
getMixerManager获取混流管理对象。
getVideoEffectManager获取视频特效管理对象 VeLiveVideoEffectManager。通过视频特效管理,您可以使用以下功能。
  • 设置美颜
  • 设置特效
  • 设置素材
  • 设置贴纸
  • 设置滤镜
createPlayer创建播放器。
setVideoFrameFilter:自定义视频处理。
setAudioFrameFilter:自定义音频处理。
setWatermark:x:y:scale:设置推流水印。
snapshot:视频截图。
setAudioEncoderConfiguration:设置推流音频编码参数。
getCameraDevice获取相机设备管理对象 VeLiveCameraDevice。通过设备管理,您可以使用以下功能。
  • 控制闪光灯开关
  • 设置摄像头缩放比例
  • 设置自动对焦
getAudioDevice获取音频模块管理对象。
sendSeiMessage:value:repeat:isKeyFrame:allowsCovered:通过视频帧发送 SEI 消息。
setProperty:value:高级配置。
pushExternalVideoFrame:推送外部视频帧数据。
setEGLVersion:设置 opengl 的版本号,默认值为 3
getEGLContext获取 EAGL 的上下文,这是在多线程环境下用于共享的上下文。
pushExternalVideoEncodeFrame:推送外部视频编码数据。
pushExternalAudioFrame:推送外部音频帧数据。
requestIDRFrame强制请求 IDR 帧,发起请求以编码一个新的 IDR 帧。
stopRecord停止本地直播录制。
setLogLevel:设置输出到控制台的日志等级。
isTorchSupported是否支持闪光灯。
enableTorch:开启/关闭闪光灯。
setZoomRatio:设置摄像头的缩放倍数。
getCurrentZoomRatio获取摄像头当前的缩放倍数。
getMaxZoomRatio获取摄像头的最大缩放倍数。
getMinZoomRatio获取摄像头的最小缩放倍数。
isAutoFocusEnabled是否支持自动对焦。
enableAutoFocus:开启/关闭自动对焦功能。
setFocusPosition:设置摄像头的对焦位置。
isExposurePositionSupported检查当前使用的摄像头是否支持手动设置曝光点。
setExposurePosition:设置当前使用的摄像头的曝光点。
setVoiceLoudness:设置音量响度。
getVoiceLoudness获取当前音量响度。
isSupportHardwareEcho查询是否支持硬件耳返。
setExposureCompensation:设置当前使用的摄像头的曝光补偿。
enableEcho:是否开启耳返功能。
addVideoStream添加一路需要混流的视频流到混流器中。
removeVideoStream:从混流器中移除一路非主路的视频流。
addAudioStream添加一路音频流到混流器中。
addAudioStream:添加一路音频流到混流器中,并指定混流类型。
removeAudioStream:从混流器中移除一路非主路的音频流。
setAudioStream:volume:设置指定混流音频的音量。当你将 VeLiveAudioMixType 设置为 VeLiveAudioMixPlayAndPush 时,该方法同时控制该路音频在拉流端和本地的播放音量。
getOriginVideoStream获取主路视频流 ID。
sendCustomVideoFrame:streamId:发送指定混流 ID 的自定义视频帧数据。
sendCustomAudioFrame:streamId:发送指定混流 ID 的自定义音频帧数据。
updateStreamMixDescription:更新音视频混流的布局。
updateLicense:更新在线 License。本方法仅对在线 License 有效。
setAlgoModelPath:设置特效算法模型包的路径。
setEnable:创建/销毁特效引擎。
setComposeNodes:设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能,包括美颜、美形、美体、美妆等。
appendComposeNodes:在已有的视频特效组合上,叠加视频特效素材包。
removeComposeNodes:移除指定的视频特效资源。
updateComposerNodeIntensity:nodeKey:intensity:设置视频特效强度。
setFilter:设置颜色滤镜。
setRenderFillMode:设置本地预览填充模式。
updateFilterIntensity:设置已启用的颜色滤镜强度。
setSticker:设置贴纸特效。
setupWithConfig:视频特效许可证配置,用于初始化视频特效管理对象。
getOriginAudioStream获取主路音频流 ID。
isEnableEcho获取当前耳返开启状态。
getMinExposureCompensation获取摄像头的最小曝光补偿。
getMaxExposureCompensation获取摄像头的最大曝光补偿。
setParameter:设置相机参数。
getParameter:获取相机参数。
prepare:设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
destroy销毁播放器实例。
setListener:设置播放状态的监听。
setFrameListener:设置音视频帧回调的监听。
enableMixer:开启/关闭音频是否混音到直播流。
enableAutoEq:targetLufs:开启/关闭自动音量均衡。
setRenderView:支持 MP4 格式的视频渲染。
start开始播放。
enableBGMLoop:设置是否循环播放。
stop停止播放。
pause暂停播放。
resume恢复播放。
seek:设置播放进度。
getDuration获取文件的总时长,单位为 ms。
setBGMVolume:设置播放音频的音量。
setVoiceVolume:设置音频采集音量。
回调
回调描述
onError:subcode:message:推流错误回调。
broadcastStarted录屏推流开始的回调。当 [RPBroadcastSampleHandler startBroadcast] 回调被触发时,会同时触发该回调。
onStatusChange:推流状态变化回调。
onFirstVideoFrame:timestampMs:首帧视频回调,当推流器发送出第一帧视频时,触发该回调。
onFirstAudioFrame:timestampMs:首帧音频回调,当推流器发送出第一帧音频时,触发该回调。
onCameraOpened:摄像头开启/关闭回调,当推流器的摄像头开启或关闭时,触发该回调。
onMicrophoneOpened:麦克风开启/关闭回调,当推流器的麦克风开启或关闭时,触发该回调。
onNetworkQuality:网络质量状态回调,当推流器检测到网络质量发生变化时,触发该回调。
onAudioPowerQuality:value:音量等级回调,当推流器采集的音频音量等级发生变化时,触发该回调。
onSnapshotComplete:截图成功回调。
onPreEncodeAudioFrame:编码前音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 VeLiveAudioFrameSourcePreEncode 时,才会触发该回调。
onCaptureAudioFrame:采集音频帧回调。只有当您通过 getObservedAudioFrameSource 返回 VeLiveAudioFrameSourceCapture 时,才会触发该回调。
onPreEncodeVideoFrame:编码前视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 VeLiveVideoFrameSourcePreEncode 时,才会触发该回调。
onCaptureVideoFrame:采集视频帧回调。只有当您通过 getObservedVideoFrameSource 返回 VeLiveVideoFrameSourceCapture 时,才会触发该回调。
broadcastFinished屏幕推流结束的回调。当 [RPBroadcastSampleHandler finishBroadcast] 回调被触发时,会同时触发该回调。
broadcastResumed屏幕推流恢复的回调。当 [RPBroadcastSampleHandler resumeBroadcast] 回调被触发时,会同时触发该回调。
broadcastPaused屏幕推流暂停的回调。当 [RPBroadcastSampleHandler pauseBroadcast] 回调被触发时,会同时触发该回调。
onStatistics:推流周期性统计信息回调。
onAudioProcess:dstFrame:自定义的音频处理方法。
onLogMonitor:周期性日志信息回调。
onFileRecordingStarted直播录制开始回调。
onFileRecordingStopped直播录制停止回调。
onVideoProcess:dstFrame:自定义的视频处理方法。
onFileRecordingError:message:直播录制错误回调。
getObservedVideoFrameSource设置当前 Listener 需要的视频帧来源。
getObservedAudioFrameSource设置当前 Listener 需要的音频帧来源。