音视频通话

API概述

模块介绍

组件位于com.rtc.sdk下

组件名称 描述
RTCSDK 基础组件,负责整个SDK的初始化和反初始化操作。整个程序的生命过程中只能有一个实例。
RTCMgr 管理组件,实现登录、呼叫、房间创建销毁、透明传输等功能。 整个程序的生命过程中只能有一个实例。
RTCMeeting 房间核心组件,实现通话建立、音频采集播入、视频采集编解码、屏幕共享、录制、影音播放等功能。整个程序的生命过程中只能有一个实例。
RTCQueue 队列组件,实现队列功能,目的是为了实现用户自动分配。整个程序的生命过程中只能有一个实例。
MediaUIView 影音播放显示组件
ScreenShareUIView 屏幕共享显示、标注组件
VideoUIView 摄像头画面显示组件

功能模块介绍

API主要模块包括:基础函数、初始化/反初始化、登录/注销、队列管理、透明通道/呼叫排队、邀请、房间管理、进出房间、房间内基础消息、房间成员管理、房间、用户属性、音频管理、视频管理、屏幕共享、影音共享、本地录制/本地直播、云端录制/互动直播

基础函数

方法 描述 所属组件
GetRTCSDKVer 获取SDK版本号 RTCSDK

初始化/反初始化

方法 描述 所属组件
init SDK初始化 RTCSDK
uninit SDK反初始化 RTCSDK

登录/注销/掉线(主调)

方法 描述 所属组件
setServerAddr 设置服务器地址 RTCSDK
serverAddr 获取服务器地址 RTCSDK
login appID登录 RTCMgr
loginByToken Token登录 RTCMgr
updateToken 更新Token RTCMgr
logout 注销 RTCMgr
getUserAuthErrCode 获取第三方鉴权失败码 RTCMgr
getUserAuthErrDesc 获取第三方鉴权失败描述 RTCMgr
setDNDStatus 设置免打扰状态 RTCMgr
getUserStatus 获取项目下所有用户在线状态 RTCMgr
startUserStatusNotify 开启用户的状态推送 RTCMgr
stopUserStatusNotify 关闭用户的状态推送 RTCMgr

登录/注销/掉线(回调)

方法 描述 所属组件
loginSuccess 登陆成功 RTCMgr
loginFail 登录失败 RTCMgr
lineOff 掉线 RTCMgr
notifyTokenWillExpire Token即将失效 RTCMgr
setDNDStatusSuccess 设置免打扰状态操作成功 RTCMgr
setDNDStatusFail 设置免打扰状态操作失败 RTCMgr
getUserStatusRslt 获取所有用户在线状态响应 RTCMgr
startStatusPushRslt 开启用户状态推送结果 RTCMgr
stopStatusPushRslt 关闭用户状态推送结果 RTCMgr
notifyUserStatus 用户状态变化通知 RTCMgr

队列管理(主调)

方法 描述 所属组件
initQueue 初始化队列 RTCQueue
refreshAllQueueStatus 刷新所有队列状态 RTCQueue
getAllQueueInfo 查询队列 RTCQueue
getQueueStatus 获取队列状态 RTCQueue
getQueuingInfo 获取我的排队信息 RTCQueue
getServiceQueues 获取我服务的所有队列 RTCQueue
getSessionInfo 获取我的会话信息 RTCQueue
startQueuing 开始排队 RTCQueue
stopQueuing 停止排队 RTCQueue
startService 开始服务队列 RTCQueue
stopService 停止服务队列 RTCQueue
reqAssignUser 请求分配一个客户 RTCQueue
acceptAssignUser 接受分配的客户 RTCQueue
rejectAssignUser 拒绝分配的客户 RTCQueue

队列管理(回调)

方法 描述 所属组件
initQueueDatRslt 列初始化操作结果 RTCQueue
queueStatusChanged 队列状态变化通知 RTCQueue
queuingInfoChanged 排队信息变化通知 RTCQueue
startQueuingRslt 开始排队结果 RTCQueue
stopQueuingRslt 停止排队结果 RTCQueue
startServiceRslt 开始服务队列结果 RTCQueue
stopServiceRslt 停止服务队列结果 RTCQueue
responseAssignUserRslt 响应分配客户操作结果 RTCQueue
autoAssignUser 自动分配用户通知 RTCQueue
reqAssignUserRslt 请求分配用户结果 RTCQueue
cancelAssignUser 分配用户被取消通知 RTCQueue

透明通道(主调)

方法 描述 所属组件
sendCmd 发送小块数据 RTCMgr
sendBuffer 发送小块数据 RTCMgr
sendFile 发送文件(分块发送 ) RTCMgr
cancelSend 取消数据发送 RTCMgr
sendMeetingCustomMsg 房间内发送广播消息 RTCMeeting

透明通道(回调)

方法 描述 所属组件
sendCmdRlst 发送小块数据 RTCMgr
sendBufferRlst 发送大块数据 RTCMgr
sendFileRlst 发送文件 RTCMgr
sendProgress 发送数据时,通知发送进度 RTCMgr
cancelSendRlst 取消发送响应 RTCMgr
notifyCmdData 通知收到小块数据 RTCMgr
notifyBufferData 通知收到大块数据 RTCMgr
notifyFileData 通知收到文件数据 RTCMgr
notifyCancelSend 通知收到文件数据 RTCMgr
sendMeetingCustomMsgRslt 发送房间内用户广播结果 RTCMeeting
notifyMeetingCustomMsg 接收到房间内用户自定义广播 RTCMeeting

呼叫(主调)

方法 描述 所属组件
call 发起呼叫 RTCMgr
acceptCall 接受对方发起的呼叫 RTCMgr
rejectCall 拒绝对方发起的呼叫 RTCMgr
hangupCall 挂断正在进行的视频呼叫或视频通话 RTCMgr
callMoreParty 发起多方呼叫(或呼转) RTCMgr
cancelCallMoreParty 取消多方呼叫 RTCMgr

呼叫(回调)

方法 描述 所属组件
callSuccess 发起呼叫操作成功 RTCMgr
callFail 发起呼叫操作失败 RTCMgr
acceptCallSuccess 接受他人呼叫操作成功 RTCMgr
acceptCallFail 接受他人呼叫操作失败 RTCMgr
rejectCallSuccess 拒绝他人的呼叫成功 RTCMgr
rejectCallFail 拒绝他人的呼叫失败响应 RTCMgr
hangupCallSuccess 挂断呼叫操作成功响应 RTCMgr
hangupCallFail 挂断他人的呼叫失败 RTCMgr
notifyCallIn 通知有人呼入 RTCMgr
notifyCallAccepted 通知呼叫被对方接受 RTCMgr
notifyCallRejected 通知呼叫被对方拒绝 RTCMgr
notifyCallHungup 通知呼叫被对方挂断 RTCMgr
callMorePartyRslt 发起多方呼叫结果 RTCMgr
cancelCallMorePartyRslt 取消多方呼叫结果 RTCMgr
notifyCallMorePartyStatus 通知多方呼叫状态 RTCMgr

邀请(主调)

方法 描述 所属组件
invite 发送邀请 RTCMgr
acceptInvite 接受对方发送的邀请 RTCMgr
rejectInvite 拒绝对方发送的邀请 RTCMgr
cancelInvite 取消自己发送的邀请 RTCMgr

邀请(回调)

方法 描述 所属组件
inviteSuccess 发送邀请成功 RTCMgr
inviteFail 发送邀请失败 RTCMgr
cancelInviteSuccess 取消自己发送的邀请成功 RTCMgr
cancelInviteFail 取消自己发送的邀请失败 RTCMgr
acceptInviteSuccess 接受对方发送的邀请成功 RTCMgr
acceptInviteFail 接受对方发送的邀请失败 RTCMgr
rejectInviteSuccess 拒绝对方发送的邀请成功 RTCMgr
rejectInviteFail 拒绝对方发送的邀请失败 RTCMgr
notifyInviteIn 通知有人邀请 RTCMgr
notifyInviteAccepted 通知邀请被对方接受 RTCMgr
notifyInviteRejected 通知邀请被对方拒绝 RTCMgr
notifyInviteCanceled 通知有邀请被取消 RTCMgr

房间管理(主调)

方法 描述 所属组件
createMeeting 创建房间 RTCMgr
destroyMeeting 销毁房间 RTCMgr

房间管理(回调)

方法 描述 所属组件
createMeetingSuccess 创建房间成功 RTCMgr
createMeetingFail 创建房间失败 RTCMgr
destroyMeetingRslt 销毁房间响应 RTCMgr

进出房间(主调)

方法 描述 所属组件
enterMeeting 进入房间 RTCMeeting
exitMeeting 离开房间 RTCMeeting
kickout 把某个成员踢出房间 RTCMeeting

进出房间(回调)

方法 描述 所属组件
enterMeetingRslt 进入房间结果 RTCMeeting
userEnterMeeting 有人进入房间通知 RTCMeeting
userLeftMeeting 有人离开房间通知 RTCMeeting
meetingDropped 通知从房间里掉线了,收到该通知后可以调用enterMeeting尝试重新进入房间 RTCMgr
meetingStopped 房间已停止通知 RTCMeeting
kickoutRslt 踢人结果 RTCMeeting

房间内基础消息

方法 描述 所属组件
netStateChanged 通知我的网络变化 RTCMeeting

房间成员管理(主调)

方法 描述 所属组件
getAllMembers 获取房间内所有人员 RTCMeeting
getMemberInfo 获取指定人员信息 RTCMeeting
setNickName 设置指定人的昵称 RTCMeeting
isUserInMeeting 检查某人是否在房间里 RTCMeeting

房间成员管理(回调)

方法 描述 所属组件
setNickNameRsp 设置指定人昵称响应 RTCMeeting
notifyNickNameChanged 用户昵称变更通知 RTCMeeting

房间、用户属性(主调)

方法 描述 所属组件
getMeetingAllAttrs 获取房间所有属性 RTCMeeting
getMeetingAttrs 获取房间部份属性 RTCMeeting
setMeetingAttrs 设置房间信息 RTCMeeting
addOrUpdateMeetingAttrs 增加或者更新房间属性 RTCMeeting
delMeetingAttrs 删除特定房间属性 RTCMeeting
clearMeetingAttrs 清除房间属性 RTCMeeting
getUserAttrs 获取用户属性 RTCMeeting
setUserAttrs 设置用户属性 RTCMeeting
addOrUpdateUserAttrs 增加或者更新房间属性 RTCMeeting
delUserAttrs 删除特定用户的特定属性 RTCMeeting
clearUserAttrs 清除特定用户的所有属性 RTCMeeting
clearAllUserAttrs 清除所有用户的属性 RTCMeeting

房间、用户属性(回调)

方法 描述 所属组件
getMeetingAllAttrsSuccess 成功获取到房间所有属性 RTCMeeting
getMeetingAllAttrsFail 获取房间所有属性失败 RTCMeeting
getMeetingAttrsSuccess 成功获取到房间属性 RTCMeeting
getMeetingAttrsFail 获取房间属性失败 RTCMeeting
setMeetingAttrsRslt 设置房间属性结果 RTCMeeting
addOrUpdateMeetingAttrsRslt 增加或更新房间属性结果 RTCMeeting
delMeetingAttrsRslt 删除房间属性结果 RTCMeeting
clearMeetingAttrsRslt 清除房间属性结果 RTCMeeting
getUserAttrsSuccess 获取用户属性 RTCMeeting
getUserAttrsFail 获取用户属性失败 RTCMeeting
setUserAttrsRslt 设置用户属性结果 RTCMeeting
addOrUpdateUserAttrsRslt 增加或更新用户属性结果 RTCMeeting
delUserAttrsRslt 删除用户属性结果 RTCMeeting
clearUserAttrsRslt 清除特定用户的所有属性结果 RTCMeeting
clearAllUserAttrsRslt 清除所有用户的属性结果 RTCMeeting
notifyMeetingAttrsChanged 房间属性发生改变 RTCMeeting
notifyUserAttrsChanged 用户属性发生改变 RTCMeeting

音频管理(主调)

方法 描述 所属组件
setAudioCfg 设置音频参数 RTCMeeting
getAudioCfg 获取音频参数 RTCMeeting
setMicVolumeScaling 设置麦克风音量增益 RTCMeeting
getMicEnergy 获取用户说话声音大小 RTCMeeting
openMic 打开用户的麦克风 RTCMeeting
closeMic 关闭用户的麦克风 RTCMeeting
getAudioStatus 获取用户的麦状态 RTCMeeting
setSpeakerVolume 设置本地播放音量 RTCMeeting
getSpeakerVolume 获取本地播放音量 RTCMeeting
setSpeakerMute 设置播放是否静音 RTCMeeting
getSpeakerMute 获取播放是否静音 RTCMeeting
setSpeakerOut 设置外放状态 RTCMeeting
getSpeakerOut 获取外放状态 RTCMeeting
setAllAudioClose 关闭所有用户的麦克风 RTCMeeting
startGetAudioPCM 开始获取语音pcm数据 RTCMeeting
stopGetAudioPCM 停止获取语音pcm数据 RTCMeeting
setAudioFrameObserver 设置语音观测器 RTCMeeting
setAudioSubscribeMode 设置语音订阅模式 RTCMeeting
setAudioSubscribeListForSeparateMode 设置独立音频订阅名单 RTCMeeting
startEchoTest 开始本地语音环回测试 RTCMeeting
stopEchoTest 停止本地语音环回测试 RTCMeeting
isEchoTesting 检测是否在本地语音环回测试 RTCMeeting
getLocMicDevEnergy 获取本地麦克风设备能量等级 RTCMeeting
setVoiceChange 设置指定人变声 RTCMeeting
getVoiceChangeType 获取目标用户变声类型 RTCMeeting
setCustomAudioCapture 自定义音频采集 RTCMeeting
pushCustomAudioDat 向sdk送入自定义音频采集数据 RTCMeeting
setCustomAudioPlayback 自定义音频渲染 RTCMeeting
pullCustomAudioDat 从sdk获取音频数据用于自渲染 RTCMeeting

音频管理(回调)

方法 描述 所属组件
audioStatusChanged 麦克风状态变化 RTCMeeting
micEnergyUpdate 麦克风声音变化 RTCMeeting
notifyAudioPCMDat 通知语音PCM数据 RTCMeeting
notifyAudioErr 通知本地音频相关错误 RTCMeeting
notifyAllAudioClose 通知全体静音 RTCMeeting
onRecordAudioFrame 安装语音观测器后本地采集的原始音频数据回调 RTCMeeting
onPlaybackAudioFrame 安装语音观测器后本地播放的原始音频数据 RTCMeeting
onPlaybackAudioFrameBeforeMixing 安装语音观测器后的用户的音频数据回调 RTCMeetingh
onMixedAudioFrame 安装语音观测器后的采集+播放混音后数据回调 RTCMeeting

视频管理(主调)

方法 描述 所属组件
getVideoCfg 获取视频参数 RTCMeeting
setVideoCfg 设置视频参数 RTCMeeting
getDefaultVideo 获取默认摄像头ID RTCMeeting
setDefaultVideo 设置默认默认摄像头 RTCMeeting
getAllVideoInfo 摄像头设备列表 RTCMeeting
setVideoEffects 视频效果配置 RTCMeeting
getVideoEffects 获取视频效果配置 RTCMeeting
createCustomVideoDev 创建自定义摄像头(sdk最大支持5个) RTCMeeting
destroyCustomVideoDev 销毁自定义摄像头 RTCMeeting
inputCustomVideoDat 输入摄像头图像数据 RTCMeeting
getWatchableVideos 房间内可观看摄像头列表 RTCMeeting
getVideoStatus 获取视频状态 RTCMeeting
openVideo 打开用户的摄像头 RTCMeeting
closeVideo 关闭用户的摄像头 RTCMeeting
setEnableMutiVideo 配置用户是否启用多摄像头 RTCMeeting
getEnableMutiVideo 获取是否启用多摄像头 RTCMeeting
setMutiVideos 开启关闭多视频设备功能 RTCMeeting
getMutiVideos 获取开启的多视频设备 RTCMeeting
getVideoImg 摄像头图像数据 RTCMeeting
setLocVideoAttributes 视频设备私有参数配置 RTCMeeting
getLocVideoAttributes 获取某个摄像头私有参数 RTCMeeting
isVirtualBackgroundStarted 检查是否支持虚拟背景功能 RTCMeeting
startVirtualBackground 启动虚拟背景 RTCMeeting
updateVirtualBackgroundParams 更新虚拟背景参数 RTCMeeting
getVirtualBackgroundParams 获取虚拟背景参数 RTCMeeting
stopVirtualBackground 停止虚拟背景 RTCMeeting
isPicEmpty 获取当前是否有图像 VideoUIView
getScaleType 获取图像显示模式 VideoUIView
setScaleType 设置图像显示模式 VideoUIView
getMirrorType 获取图像镜像模式 VideoUIView
setMirrorType 设置图像镜像模式 VideoUIView
getShowPic 获取当前显示图像 VideoUIView
getPicFrameTime 获取当前图像帧的显示时间戳 VideoUIView
getPicWidth 获取图片宽度 VideoUIView
getPicHeight 获取图片高度 VideoUIView
clear 清空显示 VideoUIView
setUsrVideoId 设置显示的目标用户视频 VideoUIView
getUsrVideoId 获取当前显示的用户视频 VideoUIView
getQualityLevel 获取视频档位 VideoUIView
getVideoStreamInfo 获取摄像头流信息 RTCMeeting

视频管理(回调)

方法 描述 所属组件
videoDevChanged 通知用户的视频设备有变化 RTCMeeting
videoStatusChanged 通知打开本地视频状态变化 RTCMeeting
defVideoChanged 通知用户的视频默认设备有变化 RTCMeeting
openVideoRslt 通知打开摄像头结果 RTCMeeting

屏幕共享(主调)

方法 描述 所属组件
getScreenShareCfg 获取屏幕共享配置 RTCMeeting
setScreenShareCfg 设置本地屏幕共享配置 RTCMeeting
startScreenShare 开始屏幕共享 RTCMeeting
stopScreenShare 停止屏幕共享 RTCMeeting
setCustomizeCatchScreen 开启/关闭自定义的抓屏 RTCMeeting
setCustomizeScreenImg 送入自定义的抓屏图像数据 RTCMeeting
startScreenMark 开始屏幕标注 RTCMeeting
stopScreenMark 停止屏幕标注 RTCMeeting
enableOtherMark 允许他人标注 RTCMeeting
isEnableOtherMark 检查是否允许他人标注 RTCMeeting
isPicEmpty 获取当前是否有图像 ScreenShareUIView
getScaleType 获取图像显示模式 ScreenShareUIView
setScaleType 设置图像显示模式 ScreenShareUIView
getShowPic 获取当前显示图像 ScreenShareUIView
getPicFrameTime 获取当前图像帧的显示时间戳 ScreenShareUIView
getPicWidth 获取图片宽度 ScreenShareUIView
getPicHeight 获取图片高度 ScreenShareUIView
clear 清空显示 ScreenShareUIView

屏幕共享(回调)

方法 描述 所属组件
startScreenShareRslt 开启屏幕共享的响应事件 RTCMeeting
stopScreenShareRslt 停止屏幕共享的响应事件 RTCMeeting
notifyScreenShareStarted 通知屏幕共享开始 RTCMeeting
notifyScreenShareStopped 通知屏幕共享停止
notifyReleaseCtrlRight 通知某人释放控制权限 RTCMeeting
startScreenMarkRslt 开始屏幕标注结果 RTCMeeting
stopScreenMarkRslt 停止屏幕标注结果 RTCMeeting
notifyScreenMarkStarted 通知屏幕标注开始 RTCMeeting
notifyScreenMarkStopped 通知屏幕标注停止 RTCMeeting

影音共享(主调)

方法 描述 所属组件
setMediaCfg 设置影音共享配置 RTCMeeting
getMediaCfg 获取影音共享参数 RTCMeeting
startPlayMedia 开始播放影音 RTCMeeting
getMediaVolume 获取播放音量 RTCMeeting
pausePlayMedia 暂停或恢复播放影音 RTCMeeting
stopPlayMedia 停止播放影音 RTCMeeting
setMediaPlayPos 设置播放进度 RTCMeeting
getMediaInfo 影音播放信息 RTCMeeting
isPicEmpty 获取当前是否有图像 MediaUIView
getScaleType 获取图像显示模式 MediaUIView
setScaleType 设置图像显示模式 MediaUIView
getShowPic 获取当前显示图像 MediaUIView
getPicFrameTime 获取当前图像帧的显示时间戳 MediaUIView
getPicWidth 获取图片宽度 MediaUIView
getPicHeight 获取图片高度 MediaUIView
clear 清空显示 MediaUIView

影音共享(回调)

方法 描述 所属组件
notifyMediaOpened 通知影音文件打开 RTCMeeting
notifyMediaStart 通知影音开始播放 RTCMeeting
notifyMediaStop 通知影音播放停止 RTCMeeting
notifyMediaPause 通知影音播放是否暂停 RTCMeeting
notifyPlayPosSetted 通知播放进度已设置完成 RTCMeeting

本地录制/本地直播(主调)

方法 描述 所属组件
createLocMixer 创建本地混图器 RTCMeeting
updateLocMixerContent 更新本地混图器内容 RTCMeeting
destroyLocMixer 销毁本地混图器 RTCMeeting
setPicResource 添加图片资源 RTCMeeting
getLocMixerState 获取本地混图器状态 RTCMeeting
addLocMixerOutput 开启本地录制、直播推流 RTCMeeting
rmLocMixerOutput 停止本地录制、直播推流 RTCMeeting
setMarkText 添加打点信息 RTCMeeting
removeMarkText 移除打点信息 RTCMeeting
getAllMarks 获取所有打点信息 RTCMeeting
getVideoMarkFile 获取打点文件的绝对文件路径名 RTCMeeting

本地录制/本地直播(回调)

方法 描述 所属组件
locMixerStateChanged 本地录制、本地直播状态变化通知 RTCMeeting
locMixerOutputInfo 本地录制文件、本地直播信息通知 RTCMeeting

云端录制/互动直播(主调)

方法 描述 所属组件
createCloudMixer 开始云端录制、云端直播 RTCMeeting
updateCloudMixerContent 更新云端录制、云端直播内容 RTCMeeting
destroyCloudMixer 停止云端录制、云端直播 RTCMeeting
getCloudMixerInfo 获取云端录制、云端直播信息 RTCMeeting
getAllCloudMixerInfo 获取房间内所有云端录制、云端直播信息 RTCMeeting

云端录制/互动直播(回调)

方法 描述 所属组件
createCloudMixerFailed 启动云端录制、云端直播失败通知 RTCMeeting
cloudMixerStateChanged 云端录制、云端直播状态变化通知 RTCMeeting
cloudMixerInfoChanged 云端录制、云端直播配置变化通知 RTCMeeting
cloudMixerOutputInfoChanged 云端录制文件、云端直播输出变化通知 RTCMeeting