veRTCRoom
名称描述
createRTCRoom()创建房间实例
getRoomId()获取房间 ID
destroy()退出并销毁房间。
joinRoom()加入房间。
leaveRoom()离开房间。
setUserVisibility()设置用户可见性。默认可见。
setMultiDeviceAVSync()设置发流端音画同步。
updateToken()更新 Token。
setRemoteVideoConfig()设置期望订阅的远端视频流的参数。
publishStream()在当前所在房间内发布本地通过摄像头/麦克风采集的媒体流
unpublishStream()停止将本地摄像头/麦克风采集的媒体流发布到当前所在房间中
publishScreen()在当前所在房间内发布本地屏幕共享音视频流
unpublishScreen()停止将本地屏幕共享音视频流发布到当前所在房间中
subscribeStream()订阅房间内指定的通过摄像头/麦克风采集的媒体流,或更新对指定远端用户的订阅选项
unsubscribeStream()取消订阅房间内指定的通过摄像头/麦克风采集的媒体流。该方法对自动订阅和手动订阅模式均适用。
subscribeScreen()订阅房间内指定的远端屏幕共享音视频流,或更新对指定远端用户的订阅选项
unsubscribeScreen()取消订阅房间内指定的远端屏幕共享音视频流。
该方法对自动订阅和手动订阅模式均适用。
pauseAllSubscribedStream()暂停接收来自远端的媒体流。
resumeAllSubscribedStream()恢复接收来自远端的媒体流
sendUserMessage()给房间内指定的用户发送点对点文本消息
sendUserBinaryMessage()给房间内指定的用户发送点对点二进制消息。
sendRoomMessage()给房间内的所有其他用户群发文本消息。
sendRoomBinaryMessage()给房间内的所有其他用户群发二进制消息。
startForwardStreamToRooms()开始跨房间转发媒体流。
updateForwardStreamToRooms()更新跨房间媒体流转发信息。
stopForwardStreamToRooms()停止跨房间媒体流转发。
pauseForwardStreamToAllRooms()暂停跨房间媒体流转发。
resumeForwardStreamToAllRooms()恢复跨房间媒体流转发。
enableRangeAudio()开启/关闭范围语音功能。
updateReceiveRange()更新本地用户的音频收听范围。
updateRangePosition()更新本地用户在房间内空间直角坐标系中的位置坐标。
registerRangeAudioObserver()设置范围语音衰减系数监测器。
setAttenuationModel()设置范围语音的音量衰减模式。
enableSpatialAudio()开启/关闭空间音频功能。
updateSpatialPosition()更新本地用户在房间内空间直角坐标系中的位置坐标。
updateSelfOrientation()更新本地用户在空间音频坐标系下的朝向。
disableRemoteOrientation()参与通话的各端调用本接口后,将忽略远端用户的朝向,认为所有远端用户都面向本地用户。
veRTCVideo
名称描述
createRTCVideo()创建引擎对象
createRTCRoom()创建房间
destroyRTCVideo()销毁引擎实例对象
feedback()本次通话质量打分评价
getErrorDescription()获取错误码的描述
setBusinessId()设置业务标识参数
setEncryptInfo()设置传输时使用内置加密的方式
startAudioCapture()开启内部音频采集。默认为关闭状态。
stopAudioCapture()关闭内部音频采集。默认为关闭状态。
enumerateAudioPlaybackDevices()获取当前系统内音频播放设备列表。如果后续设备有变更,你会收到 onAudioDeviceStateChanged] 回调通知,然后需要重新调用本接口以获得新的设备列表。
enumerateAudioCaptureDevices()获取当前系统内音频采集设备列表。如果后续设备有变更,你需要重新调用本接口以获得新的设备列表。
setAudioPlaybackDevice()设置音频播放设备。
setAudioCaptureDevice()设置音频采集设备。
getAudioPlaybackDevice()获取当前音频播放设备 ID。
getAudioCaptureDevice()获取当前音频采集设备 ID。
setAudioPlaybackDeviceVolume()设置当前音频播放设备音量
getAudioPlaybackDeviceVolume()获取当前音频播放设备音量
setAudioCaptureDeviceVolume()设置当前音频采集设备音量
getAudioCaptureDeviceVolume()获取当前音频采集设备音量
setAudioPlaybackDeviceMute()设置当前音频播放设备静音状态,默认为非静音。
getAudioPlaybackDeviceMute()获取当前音频播放设备是否静音的信息。
setAudioCaptureDeviceMute()设置当前音频采集设备静音状态,默认为非静音。
getAudioCaptureDeviceMute()获取当前音频采集设备是否静音的信息。
setCaptureVolume()调节音频采集音量
setPlaybackVolume()调节本地播放的所有远端用户混音后的音量。播放音频前或播放音频时,你都可以使用此接口设定播放音量。
setRemoteAudioPlaybackVolume()调节来自远端用户的音频播放音量
muteAudioPlayback()控制本地音频流播放状态:播放/不播放
stopAudioPlaybackDeviceTest()停止音频播放设备测试。
setVoiceChangerType()设置变声特效类型
setVoiceReverbType()设置混响特效类型
setAudioProfile()设置音质档位。
startAudioPlaybackDeviceTest()启动音频播放设备测试。 该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件,测试者如果能听到声音,说明播放设备能正常工作。
startEchoTest()开始音频设备回路测试。
stopEchoTest()停止音频设备回路测试。
initAudioPlaybackDeviceForTest()尝试初始化音频播放设备,可检测出设备不存在、权限被拒绝/禁用等异常问题。
initAudioCaptureDeviceForTest()尝试初始化音频播放设备,可检测出设备不存在、权限被拒绝/禁用等异常问题。
enableAudioPropertiesReport()启用音频信息提示。
enableVocalInstrumentBalance()开启/关闭音量均衡功能。
stopVideoCapture()关闭内部视频采集。默认为关闭状态。
enumerateVideoCaptureDevices()获取当前系统内视频采集设备列表。
followSystemPlaybackDevice()设置音频播放路由是否跟随系统,默认跟随系统。
followSystemCaptureDevice()设置音频采集路由是否跟随系统。
setVideoCaptureDevice()设置当前视频采集设备
getVideoCaptureDevice()获取当前 SDK 正在使用的视频采集设备 ID
setVideoEncoderConfig()视频发布端设置期望发布的最大分辨率视频流参数,包括分辨率、帧率、码率、网络不佳时的回退策略等。
setMaxVideoEncoderConfig()视频发布端设置期望发布的最大分辨率视频流参数,包括分辨率、帧率、码率、网络不佳时的回退策略等。
setLocalVideoMirrorType()为采集到的视频流开启镜像
checkLicense()视频特效许可证检查
getAuthMessage()从 CV SDK 获取授权消息,用于获取在线许可证。
enableEffect()开启关闭视频特效
enableEffectBeauty()开启/关闭基础美颜
setBeautyIntensity()调整基础美颜强度
setAlgoModelPath()设置视频特效算法模型路径
setEffectNodes()设置视频特效素材包,支持同时设置多个素材包
updateNode()设置特效强度
setColorFilter()设置颜色滤镜
setColorFilterIntensity()设置已启用颜色滤镜的强度
startLiveTranscoding()开启转推直播,并设置合流的视频视图布局和音频属性。
stopLiveTranscoding()停止转推直播。
updateLiveTranscoding()更新转推直播参数。
startPushSingleStreamToCDN()新增单流转推直播任务。
stopPushStreamToCDN()停止转推直播。
setPublicStreamVideoSink()为指定公共流绑定自定义渲染器。
startPushPublicStream()发布一路公共流。
stopPushPublicStream()停止发布当前用户发布的公共流
updatePublicStreamParam()更新公共流参数
startPlayPublicStream()订阅指定公共流。无论用户是否在房间内,都可以调用本接口获取和播放指定的公共流。
stopPlayPublicStream()取消订阅指定公共流
startScreenAudioCapture()在屏幕共享时,开始使用 RTC SDK 内部采集方式,采集屏幕音频
startScreenVideoCapture()采集屏幕视频流,用于共享。屏幕视频流包括:屏幕上显示的内容,应用窗口中显示的内容,或虚拟屏幕中显示的内容。其中,虚拟屏幕中显示的内容仅在 Windows 平台上支持。
stopScreenAudioCapture()在屏幕共享时,停止使用 RTC SDK 内部采集方式,采集屏幕音频。
stopScreenVideoCapture()停止屏幕视频流采集。
updateScreenCaptureRegion()更新屏幕共享区域。
updateScreenCaptureHighlightConfig()通过 RTC SDK 提供的采集模块采集屏幕视频流时,更新边框高亮设置。默认展示表框。
updateScreenCaptureMouseCursor()通过 RTC SDK 提供的采集模块采集屏幕视频流时,更新对鼠标的处理设置。默认采集鼠标。
updateScreenCaptureFilterConfig()通过 RTC SDK 提供的采集模块采集屏幕视频流时,设置需要过滤的窗口。
getScreenCaptureSourceList()获取屏幕采集对象列表。
getThumbnail()获取共享对象缩略图
getWindowAppIcon()获取应用窗体所属应用的图标。
setScreenAudioStreamIndex()在屏幕共享时,设置屏幕音频流和麦克风采集到的音频流的混流方式
setScreenVideoEncoderConfig()为发布的屏幕共享视频流设置期望的编码参数,包括分辨率、帧率、码率、网络不佳时的回退策略等。
login()必须先登录,才能发送房间外点对点消息和向应用服务器发送消息
logout()调用本接口登出后,无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。
updateLoginToken()更新用户用于登录的 Token。
setServerParams()设置业务服务器参数。
getPeerOnlineStatus()查询对端用户或本端用户的登录状态
sendUserMessageOutsideRoom()给房间外指定的用户发送文本消息(P2P)
sendUserBinaryMessageOutsideRoom()给房间外指定的用户发送二进制消息(P2P)
sendServerMessage()客户端给业务服务器发送文本消息(P2Server)
sendServerBinaryMessage()客户端给业务服务器发送二进制消息(P2Server)
sendSEIMessage()通过视频帧发送 SEI 数据。
setVideoCaptureConfig()设置 RTC SDK 内部采集时的视频采集参数。指定视频采集参数包括模式、分辨率、帧率。
startAudioMixing()开始播放音乐文件及混音
stopAudioMixing()停止播放音乐文件及混音
pauseAudioMixing()暂停播放音乐文件及混音
resumeAudioMixing()恢复播放音乐文件及混音
preloadAudioMixing()预加载指定音乐文件到内存中,以避免频繁播放同一文件时的重复加载,减少 CPU 占用。
unloadAudioMixing()卸载指定音乐文件
setAudioMixingVolume()调节音乐文件在本地和远端播放的音量大小
getAudioMixingDuration()获取音乐文件时长
getAudioMixingCurrentPosition()获取音乐文件播放进度
setAudioMixingPosition()设置音乐文件的播放位置
setAudioMixingDualMonoMode()设置当前音频文件的声道模式
setAudioMixingPitch()开启本地播放音乐文件变调功能,多用于 K 歌场景。
setAudioMixingPlaybackSpeed()设置混音时音频文件的播放速度
setAudioMixingLoudness()如果你需要使用 enableVocalInstrumentBalance 对混音使音频文件/PCM 音频数据进行音量调整,你必须通过此接口传入其原始响度。
setAudioMixingProgressInterval()设置混音时音频文件播放进度回调的间隔
getAudioTrackCount()获取当前音频文件的音轨索引
selectAudioTrack()指定当前音频文件的播放音轨
setLocalVoicePitch()开启本地语音变调功能,多用于 K 歌场景。使用该方法,你可以对本地语音的音调进行升调或降调等调整。
startASR()开启自动语音识别服务。
stopASR()关闭语音识别服务
startFileRecording()该方法将通话过程中的音视频数据录制到本地的文件中。
stopFileRecording()停止本地录制
setPublishFallbackOption()设置发布的音视频流回退选项 。你可以调用这个接口来设置网络情况不佳或设备性能不足时只发送小流,以保证通话质量。
setSubscribeFallbackOption()设置订阅的音视频流回退选项。 你可以通过调用该接口来设置网络情况不佳或性能不足时只订阅小流或音频流,以保证通话质量。
setRemoteUserPriority()设置用户优先级
startNetworkDetection()开启通话前网络探测
stopNetworkDetection()停止通话前网络探测
setBackgroundSticker()将摄像头采集画面中的人像背景替换为指定图片或纯色背景。
setVideoWatermark()在指定视频流上添加水印。
clearVideoWatermark()移除指定视频流的水印。
setupLocalVideo()为本地采集到的视频流绑定本地渲染视图
removeLocalVideo()解绑本地视频流已绑定的渲染视图
setupRemoteVideo()为远端视频流绑定本地渲染视图
removeRemoteVideo()解绑指定远端视频流已绑定的本地视图
removeAllRemoteVideo()解绑所有已绑定本地视图的指定远端视频流
setupLocalScreen()为本地屏幕共享流绑定视图
removeLocalScreen()解绑屏幕共享流已绑定的视图
setupRemoteScreen()为远端屏幕共享流绑定本地视图
removeRemoteScreen()解绑远端屏幕共享流已绑定的本地视图
setupPublicStreamVideo()为公共流绑定本地视图
removePublicStreamVideo()为公共流解绑本地视图
static getSDKVersion()获取当前 SDK 版本信息
static getCurrentProcessId()获取加载引擎进程的 ID 方便调试
RTCROOMCALLBACK
名称描述
onRoomStateChanged()房间状态改变回调,加入房间、离开房间、发生房间相关的警告或错误时会收到此回调。
onStreamStateChanged()流状态改变回调,发生流相关的警告或错误时会收到此回调。
onLeaveRoom()离开房间成功回调。
onUserJoined()可见用户加入房间,或房内隐身用户切换为可见的回调。
1.远端可见用户调用 setUserVisibility 方法将自身设为可见后加入房间时,房间内其他用户将收到该事件。
2.远端可见用户断网后重新连入房间时,房间内其他用户将收到该事件。
3.房间内隐身远端用户调用 setUserVisibility 方法切换至可见时,房间内其他用户将收到该事件。
4.新进房用户也会收到进房前已在房内的主播角色用户的进房回调通知。
onUserLeave()远端用户离开房间,或切至不可见时,本地用户会收到此事件
onTokenWillExpire()Token 过期前 30 秒将触发该回调。
onAVSyncStateChange()发布端调用 setMultiDeviceAVSync 后音视频同步状态发生改变时,会收到此回调。
onRoomStats()房间通话统计信息回调。
用户进房开始通话后,每 2s 收到一次本回调。
onLocalStreamStats()反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调。
本地用户发布音视频流成功后,每隔 2s 收到此回调。
onRemoteStreamStats()反映通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况的回调。每隔 2s 收到此回调。
onUserPublishStream()房间内新增远端麦克风采集的音频流的回调。
onUserUnpublishStream()房间内远端麦克风采集的音频流移除的回调。
onUserPublishScreen()房间内新增远端屏幕共享音视频流的回调。
onUserUnpublishScreen()房间内远端屏幕共享音视频流移除的回调。
onStreamSubscribed()关于订阅媒体流状态改变的回调
onVideoStreamBanned()通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户视频流的发送时,触发此回调。
onAudioStreamBanned()通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户音频流的发送时,触发此回调。
onRoomMessageReceived()接收到房间内广播消息的回调。
onRoomBinaryMessageReceived()接收到房间内广播二进制消息的回调。
onUserMessageReceived()收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时,会收到此回调。
onUserBinaryMessageReceived()收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时,会收到此回调。
onUserMessageSendResult()向房间内单个用户发送点对点文本或点对点二进制消息后,消息发送方会收到该消息发送结果回调。
onRoomMessageSendResult()调用 sendRoomMessage 或 sendRoomBinaryMessage 向房间内群发文本或二进制消息后,消息发送方会收到该消息发送结果回调。
onForwardStreamStateChanged()跨房间媒体流转发状态和错误回调
onForwardStreamEvent()跨房间媒体流转发事件回调
onRangeAudioInfo()关于当前范围语音衰减系数的回调。
你可以通过关注该回调中包含的远端用户的衰减系数决定是否订阅该远端用户的流。
onNetworkQuality()加入房间并发布或订阅流后, 以每 2 秒一次的频率,报告本地用户和已订阅的远端用户的上下行网络质量信息。
RTCVIDEOCALLBACK
名称描述
onLogReport()端监控日志回调。当产生一个端监控事件时触发该回调。
onFirstPublicStreamAudioFrame()公共流的音频首帧解码成功
关于订阅公共流,详见 startPlayPublicStream。
onPushPublicStreamResult()公共流的音频首帧解码成功
onFirstPublicStreamVideoFrameDecoded()公共流的首帧视频解码成功
关于订阅公共流,详见 startPlayPublicStream。
onPublicStreamSEIMessageReceived()回调公共流中包含的 SEI 信息
通过 startPlayPublicStream 开始播放公共流后,可以通过本回调获取公共流中包含的 SEI 信息。
onPlayPublicStreamResult()订阅公共流的结果回调
通过 startPlayPublicStream 订阅公共流后,可以通过本回调获取订阅结果。
onLocalScreenFrame()获取采集成功的本地屏幕视频帧,用于自定义处理或渲染。
onLocalVideoFrame()获取采集成功的本地摄像头流视频帧,用于自定义处理或渲染。
onRemoteScreenFrame()视频管理获取采集成功的远端屏幕视频帧,用于自定义处理或渲染。
onRemoteVideoFrame()获取采集成功的远端摄像头流视频帧,用于自定义处理或渲染。
onPublicStreamVideoFrame()公共流视频数据回调,绑定公共流到自定义渲染器后,通过该回调获取公共流视频数据。
onWarning()当内部发生警告事件时触发该回调
onError()当内部发生不可逆转错误时触发该回调
onAudioMixingFinished()本地音乐文件播放已结束回调。
onAudioMixingStateChanged()音频混音文件播放状态改变时回调
onAudioMixingPlayingProgress()混音音频文件播放进度回调
onConnectionStateChanged()SDK 与信令服务器连接状态改变回调。连接状态改变时触发。
onNetworkTypeChanged()SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。
onPerformanceAlarms()本地未开启发布性能回退,检测到设备性能不足时,收到此回调。本地开启发布性能回退,因设备性能/网络原因,造成发布性能回退/恢复时,收到此回调。
onSysStats()周期性地发出回调,报告当前cpu与memory使用率
onUserStartAudioCapture()房间内的用户调用 startAudioCapture 开启音频采集时,房间内其他用户会收到此回调。
onUserStopAudioCapture()房间内的用户调用 stopAudioCapture 关闭音频采集时,房间内其他用户会收到此回调。
onFirstLocalAudioFrame()本地采集到第一帧音频帧时,收到该回调
onFirstRemoteAudioFrame()收到房间内每一路音频流的第一帧时,收到该回调。
onSimulcastSubscribeFallback()因发布/订阅性能回退或退出回退状态,订阅的音视频流,发生流的切换时,收到该回调。
onFirstLocalVideoFrameCaptured()第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时,收到此回调。
onLocalVideoSizeChanged()本地视频大小或旋转配置发生改变时,收到此回调。
onRemoteVideoSizeChanged()远端视频大小或旋转配置发生改变时,房间内订阅此视频流的用户会收到此回调。
onFirstRemoteVideoFrameRendered()第一帧远端视频流在视图上渲染成功后,收到此回调。
onFirstRemoteVideoFrameDecoded()SDK 接收并解码远端视频流首帧后,收到此回调。
onUserStartVideoCapture()房间内的用户调用 startVideoCapture 开启视频采集时,房间内其他用户会收到此回调。
onUserStopVideoCapture()房间内的用户调用 stopVideoCapture 关闭视频采集时,房间内其他用户会收到此回调。
onLocalAudioStateChanged()本地音频的状态发生改变时,该回调通知当前的本地音频状态。
onRemoteAudioStateChanged()用户订阅来自远端的音频流状态发生改变时,会收到此回调,了解当前的远端音频流状态。
onActiveSpeaker()调用 enableAudioPropertiesReport 后,根据设置的 config.interval,你会周期性地收到此回调,获取房间内的最活跃用户信息。
onLocalVideoStateChanged()本地视频流的状态发生改变时,收到该事件。
onRemoteVideoStateChanged()远端视频流的状态发生改变时,房间内订阅此流的用户会收到该事件。
onAudioFrameSendStateChanged()音频首帧发送状态改变回调
onVideoFrameSendStateChanged()视频首帧发送状态改变回调
onScreenVideoFrameSendStateChanged()屏幕共享流视频首帧发送状态改变回调
onAudioFramePlayStateChanged()音频首帧播放状态改变回调
onVideoFramePlayStateChanged()视频首帧播放状态改变回调
onScreenVideoFramePlayStateChanged()屏幕共享流视频首帧播放状态改变回调
onUserMessageSendResult()当调用 sendMessageToUser 函数发送消息后,回调此条消息的发送结果(反馈)。
onUserBinaryMessageReceived()单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调(P2P)。
onStreamSubscribed()当订阅一个流成功的时候回调该事件
onSEIMessageReceived()收到通过 sendSEIMessage 发送的带有 SEI 消息的视频帧时,收到此回调
onStreamMixingEvent()通知转推直播关键事件
onStreamPushEvent()单流转推直播状态回调
onRecordingStateUpdate()获取本地录制状态回调。
onRecordingProgressUpdate()本地录制进度回调。
onLoginResult()调用 login 后,会收到此回调。
onLogout()登出结果回调
onServerParamsSetResult()设置业务服务器参数的返回结果
onGetPeerOnlineStatus()查询对端或本端用户登录状态的返回结果
onUserMessageReceivedOutsideRoom()收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时,会收到此回调
onUserBinaryMessageReceivedOutsideRoom()收到房间外用户调用 sendUserBinaryMessageOutsideRoom 发来的二进制消息时,会收到此回调
onUserMessageSendResultOutsideRoom()给房间外指定的用户发送消息的回调
onServerMessageSendResult()给业务服务器发送消息的回调
onRecordAudioFrame()返回麦克风录制的音频数据
onPlaybackAudioFrame()返回远端所有用户混音后的音频数据
onMixedAudioFrame()返回本地麦克风录制和远端所有用户混音后的音频数据
onASRSuccess()语音识别服务开启成功回调
onMessage()语音转文字成功回调,该回调返回识别后的全量消息。
onASRError()当语音识别服务内部发生错误事件时触发该回调。
onNetworkDetectionResult()成功调用 startNetworkDetection 接口开始探测后,会在 3s 内首次收到该回调,之后每 2s 收到一次该回调。
onNetworkDetectionStopped()通话前网络探测结束
onLocalAudioPropertiesReport()调用 enableAudioPropertiesReport 后,根据设置的 interval 值,你会周期性地收到此回调,了解本地音频的相关信息。
onRemoteAudioPropertiesReport()远端用户进房后,本地调用 enableAudioPropertiesReport,根据设置的 interval 值,本地会周期性地收到此回调,了解订阅的远端用户的音频信息。
onEchoTestResult()通话前网络探测结束
onVideoDeviceStateChanged()视频频设备状态回调。提示摄像头视频采集、屏幕视频采集等设备的状态。
onAudioDeviceStateChanged()音频设备状态回调。提示音频采集、音频播放等设备设备的状态。
onAudioPlaybackDeviceTestVolume()回调音频设备测试时的播放音量