音视频通话

API概述

模块介绍

API接口由多个模块组成 ,主要模块包括:基础函数、设置/移除回调、登录/反注册、透明通道、房间属性、用户属性、房间成员管理、队列管理、呼叫、房间管理、进出房间、音频管理、视频管理、屏幕共享、美颜、虚拟背景、影音共享、本地录制/本地直播、云端录制/互动直播、邀请

基础函数

方法 描述 所属文件
getRTCSDKVer 获取sdk的版本信息 RTCSDK.h
initSDK SDK初始化 RTCSDK.h
uninit SDK反初始化 RTCSDK.h
serverAddr 获取服务器地址 RTCSDK.h
setServerAddr 设置服务器地址 RTCSDK.h
isInitSuccess 初始化是否成功 RTCSDK.h
writeLog 向sdk的日志文件写入日志 RTCSDK.h

设置/移除回调

方法 描述 所属文件
addMgrCallback 房间管理注册监听回调 RTCMgr.h
removeMgrCallback 房间管理反注册监听回调 RTCMgr.h
addMeetingCallBack 注册视频房间核心管理监听回调 RTCMeeting.h
removeMeetingCallBack 反注册房间管理监听回调 RTCMeeting.h
addQueueCallback 注册队列管理监听回调 RTCQueue.h
removeQueueCallback 反注册队列管理监听回调 RTCQueue.h

登录/反注册(主调)

方法 描述 所属文件
login 登录服务器 RTCMgr.h
logout 反注册本次登录 RTCMgr.h
loginByToken token登录 RTCMgr.h
updateToken 更新token RTCMgr.h
getUserAuthErrCode 获取用户认证错误码 RTCMgr.h
getUserAuthErrDesc 获取用户验证错误描述信息 RTCMgr.h
setDNDStatus 设置免打扰状态 RTCMgr.h
getUserStatus 获取企业下指定用户的在线状态(包括呼叫房间状态、免打扰状态) RTCMgr.h
startUserStatusNotify 开启用户的状态推送 RTCMgr.h
stopUserStatusNotify 关闭用户的状态推送 RTCMgr.h

登录/反注册(回调)

方法 描述 所属文件
loginSuccess 登录成功响应 RTCMgr.h
loginFail 登录失败响应 RTCMgr.h
lineOff 通知用户掉线 RTCMgr.h
setDNDStatusSuccess 客户端设置免打扰状态操作成功响应 RTCMgr.h
setDNDStatusFail 客户端设置免打扰状态操作失败响应 RTCMgr.h
getUserStatusRsp 获取企业内所有用户在线状态响应 RTCMgr.h
startStatusPushRsp 启动用户状态推送响应 RTCMgr.h
stopStatusPushRsp 结束用户状态推送响应 RTCMgr.h
notifyUserStatus 某个用户状态变化通知 RTCMgr.h

房间成员管理(主调)

方法 描述 所属文件
getAllMembers 获取房间所有成员的列表 RTCMeeting.h
getMemberInfo 获取某个用户的信息 RTCMeeting.h
getNickName 获取某个用户的昵称 RTCMeeting.h
setNickName 设置某个用户的昵称 RTCMeeting.h
isUserInMeeting 判断某个用户是否在房间中 RTCMeeting.h
kickout 将他人请出房间 RTCMeeting.h

房间成员管理(回调)

方法 描述 所属文件
setNickNameRsp 设置房间成员昵称的结果 RTCMgr.h
notifyNickNameChanged 某用户改变了昵称(改昵称的用户自身不会接收到此通知) RTCMgr.h
userEnterMeeting 某用户进入了房间 RTCMeeting.h
userLeftMeeting 某用户离开了房间 RTCMeeting.h
kickoutRslt 将他人请出房间结果 RTCMeeting.h

队列管理(主调)

方法 描述 所属文件
initQueue 初始化用户队列功能数据 RTCQueue.h
refreshAllQueueStatus 刷新所有队列状态信息 RTCQueue.h
getAllQueueInfo 获取队列信息 RTCQueue.h
getQueueStatus 获取指定队列状态 RTCQueue.h
getQueuingInfo 获取我的排队信息 RTCQueue.h
getServiceQueues 获取我服务的所有队列 RTCQueue.h
getSessionInfo 获取我的会话信息 RTCQueue.h
startQueuing 客户开始排队 RTCQueue.h
stopQueuing 客户停止排队 RTCQueue.h
startService 开始服务某个队列(可以多次调用,开启对多个队列的服务) RTCQueue.h
stopService 停止服务某个队列 RTCQueue.h
reqAssignUser 请求分配一个客户 RTCQueue.h
acceptAssignUser 接受系统安排的客户 RTCQueue.h
rejectAssignUser 拒绝系统安排的客户 RTCQueue.h

队列管理(回调)

方法 描述 所属文件
initQueueDatRslt 队列初始化操作结果 RTCQueue.h
queueStatusChanged 队列状态变化通知 RTCQueue.h
queuingInfoChanged 排队信息变化通知 RTCQueue.h
startQueuingRslt startQueuing 开始排队操作结果 RTCQueue.h
stopQueuingRslt stopQueuing 停止排队操作结果 RTCQueue.h
startServiceRslt startService 开始服务队列操作结果 RTCQueue.h
reqAssignUserRslt 请求分配客户操作结果 RTCQueue.h
autoAssignUser 队列系统自动分配客户 RTCQueue.h
cancelAssignUser 队列系统取消之前自动分配的的客户 RTCQueue.h
responseAssignUserRslt 接受分配的用户 RTCQueue.h

透明通道(主调)

方法 描述 所属文件
sendCmd 发送小块数据(50K以内) RTCMgr.h
sendBuffer 发送大块数据 RTCMgr.h
sendFile 发送文件 RTCMgr.h
cancelSend 取消数据发送 RTCMgr.h
sendMeetingCustomMsg 房间内发送广播消息 RTCMgr.h

透明通道(回调)

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

呼叫(主调)

方法 描述 所属文件
call 发起呼叫,邀请用户参加视频会话 RTCMgr.h
acceptCall 接受对方发起的视频请求,开始进入视频会话 RTCMgr.h
rejectCall 拒绝对方的视频请求 RTCMgr.h
hangupCall 挂断正在进行的视频呼叫或视频通话 RTCMgr.h
callMoreParty 呼叫其他人进入房间 RTCMgr.h
cancelCallMoreParty 取消呼叫他人进入房间 RTCMgr.h

呼叫(回调)

方法 描述 所属文件
callSuccess 呼叫他人操作成功响应 RTCMgr.h
callFail 呼叫他人操作失败响应 RTCMgr.h
acceptCallSuccess 接受他人呼叫操作成功响应 RTCMgr.h
acceptCallFail 接受他人呼叫操作失败响应 RTCMgr.h
rejectCallSuccess 拒绝他人的呼叫成功响应 RTCMgr.h
rejectCallFail 拒绝他人的呼叫失败响应 RTCMgr.h
hangupCallSuccess 挂断呼叫操作成功响应 RTCMgr.h
hangupCallFail 拒绝他人呼叫操作失败响应 RTCMgr.h
notifyCallIn SDK通知自己被呼叫 RTCMgr.h
notifyCallAccepted SDK通知自己视频呼叫被对方接受 RTCMgr.h
notifyCallRejected SDK通知自己呼叫被对方拒绝 RTCMgr.h
notifyCallhangup SDK通知呼叫被挂断 RTCMgr.h
callMorePartyRslt 呼叫操作结果 RTCMgr.h
cancelCallMorePartyRslt 取消呼叫操作结果 RTCMgr.h
notifyCallMorePartyStatus 通知呼叫状态改变 RTCMgr.h

房间管理(主调)

方法 描述 所属文件
createMeeting 创建视频房间 RTCMgr.h
destroyMeeting 销毁视频房间 RTCMgr.h

房间管理(回调)

方法 描述 所属文件
createMeetingSuccess 创建房间成功响应 RTCMgr.h
createMeetingFail 创建房间失败响应 RTCMgr.h
notifyTokenNearTimeout Token失效通知 RTCMgr.h
destroyMeetingRslt 结束房间响应 RTCMgr.h
getMeetingListSuccess 获取当前房间列表响应 RTCMgr.h
getMeetingListFail 获取当前房间列表失败 RTCMgr.h
stopMeetingRslt 通知结束视频房间结果 RTCMgr.h
meetingStopped 房间已被结束 RTCMgr.h

进出房间(主调)

方法 描述 所属文件
enterMeeting 使用房间ID进入指定的视频房间 RTCMeeting.h
exitMeeting 离开房间 RTCMeeting.h

进出房间(回调)

方法 描述 所属文件
meetingDropped 通知从房间里掉线了,收到该通知后可以调用enterMeeting尝试重新进入房间 RTCMgr.h
netStateChanged 网络变化通知 RTCMgr.h

音频管理(主调)

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

音频管理(回调)

方法 描述 所属文件
audioDevChanged 通知本地音频设备有变化 RTCMeeting.h
audioStatusChanged 通知音频状态变化 RTCMeeting.h
micEnergyUpdate 通知用户的说话声音强度更新 RTCMeeting.h
onRecordAudioFrame 安装语音观测器后本地采集的原始音频数据回调 RTCMeeting.h
onPlaybackAudioFrame 安装语音观测器后本地播放的原始音频数据 RTCMeeting.h
onPlaybackAudioFrameBeforeMixing 安装语音观测器后的用户的音频数据回调 RTCMeeting.h
onMixedAudioFrame 安装语音观测器后的采集+播放混音后数据回调 RTCMeeting.h
notifySetVoiceChange 通知被设置变声 RTCMeeting.h
notifyEchoTestState 通知环回测试状态变化 RTCMeeting.h

房间属性(主调)

方法 描述 所属文件
getMeetingAllAttrs 获取房间所有属性 RTCMgr.h
getMeetingAttrs 获取房间部份属性 RTCMgr.h
setMeetingAttrs 设置房间信息 RTCMgr.h
addOrUpdateMeetingAttrs 增加或者更新房间属性 RTCMgr.h
delMeetingAttrs 删除特定房间属性 RTCMgr.h
clearMeetingAttrs 清除房间属性 RTCMgr.h

房间属性(回调)

方法 描述 所属文件
getMeetingAllAttrsSuccess 成功获取到房间所有属性 RTCMgr.h
getMeetingAllAttrsFail 获取房间所有属性失败 RTCMgr.h
getMeetingAttrsSuccess 成功获取到房间属性 RTCMgr.h
getMeetingAttrsFail 获取房间属性失败 RTCMgr.h
resetMeetingAttrsRslt 设置房间属性结果 RTCMgr.h
addOrUpdateMeetingAttrsRslt 增加或更新房间属性结果 RTCMgr.h
delMeetingAttrsRslt 删除房间属性结果 RTCMgr.h
clearMeetingAttrsRslt 清除房间属性结果 RTCMgr.h

用户属性(主调)

方法 描述 所属文件
getUserAttrs 获取用户属性 RTCMgr.h
setUserAttrs 设置用户属性 RTCMgr.h
addOrUpdateUserAttrs 增加或者更新房间属性 RTCMgr.h
delUserAttrs 删除特定用户的特定属性 RTCMgr.h
clearUserAttrs 清除特定用户的所有属性 RTCMgr.h
clearAllUserAttrs 清除所有用户的属性 RTCMgr.h

用户属性(回调)

方法 描述 所属文件
getUserAttrsSuccess 获取用户属性 RTCMgr.h
getUserAttrsFail 获取用户属性失败 RTCMgr.h
setUserAttrsRslt 设置用户属性结果 RTCMgr.h
addOrUpdateUserAttrsRslt 增加或更新用户属性结果 RTCMgr.h
delUserAttrsRslt 删除用户属性结果 RTCMgr.h
clearUserAttrsRslt 清除特定用户的所有属性结果 RTCMgr.h
clearAllUserAttrsRslt 清除所有用户的属性结果 RTCMgr.h
notifyMeetingAttrsChanged 房间属性发生改变 RTCMgr.h
notifyUserAttrsChanged 用户属性发生改变 RTCMgr.h

视频管理(主调)

方法 描述 所属文件
getAllVideoInfo 获取用户所有的摄像头信息 RTCMeeting.h
createCustomVideoDev 创建自定义摄像头 RTCMeeting.h
destroyCustomVideoDev 销毁自定义摄像头 RTCMeeting.h
inputCustomVideoDat 输入摄像头图像数据 RTCMeeting.h
addIPCam 添加网络摄像头 RTCMeeting.h
delIPCam 移除网络摄像头 RTCMeeting.h
createScreenCamDev 添加屏幕摄像头 RTCMeeting.h
updateScreenCamDev 调整屏幕摄像头对应的屏幕 RTCMeeting.h
destroyScreenCamDev 删除屏幕摄像头 RTCMeeting.h
setVideoCfg 设置摄像头参数 RTCMeeting.h
getVideoCfg 获取设置的摄像头参数 RTCMeeting.h
setLocVideoAttributes 设置某个摄像头私有参数 RTCMeeting.h
getWatchableVideos 获取房间内所有可观看的摄像头 RTCMeeting.h
openVideo 打开用户的摄像头,以便本地、远端显示视频图像 RTCMeeting.h
closeVideo 关闭用户的摄像头 RTCMeeting.h
getVideoStatus 获取用户的摄像头状态 RTCMeeting.h
getDefaultVideo 获取指定用户的默认摄像头 RTCMeeting.h
setDefaultVideo 设置默认的摄像头 RTCMeeting.h
getVideoImg 获取指定用户摄像头的最新图像 RTCMeeting.h
getLocalVideoParams 获取指定本地摄像头参数 RTCMeeting.h
setLocalVideoParam 设置指定本地摄像头参数 RTCMeeting.h
getVideoStreamInfo 获取摄像头流信息 RTCMeeting.h

视频管理(回调)

方法 描述 所属文件
openVideoRslt 打开摄像头设备操作结果 RTCMeeting.h
videoStatusChanged 视频状态变化 RTCMeeting.h
videoDevChanged 通知用户的视频设备有变化 RTCMeeting.h
notifyVideoData 通知用户有新的视频数据 RTCMeeting.h
videoDevChanged 通知用户的视频默认设备有变化 RTCMeeting.h

美颜

方法 描述 所属文件
startBeauty 开启美颜功能 RTCMeeting.h
stopBeauty 停止美颜功能 RTCMeeting.h
isBeautyStarted 获取美颜功能是否开启 RTCMeeting.h
updateBeautyParams 更新美颜参数 RTCMeeting.h
getBeautyParams 获取当前美颜参数 RTCMeeting.h

虚拟背景

方法 描述 所属文件
startVirtualBackground 开启虚拟背景 RTCMeeting.h
stopVirtualBackground 停止虚拟背景 RTCMeeting.h
isVirtualBackgroundStarted 获取虚拟背景是否开启 RTCMeeting.h
updateVirtualBackgroundParams 更新虚拟背景参数 RTCMeeting.h
getVirtualBackgroundParams 获取当前虚拟背景参数 RTCMeeting.h

屏幕共享(主调)

方法 描述 所属文件
isScreenShareStarted 获取屏幕共享是否已开启 RTCMeeting.h
getScreenShareCfg 获取屏幕共享配置 RTCMeeting.h
setScreenShareCfg 设置屏幕共享配置 RTCMeeting.h
getScreenCaptureSources 获取屏幕采集源列表 RTCMeeting.h
startScreenShare 开始屏幕共享 RTCMeeting.h
pauseScreenShare 暂停屏幕共享 RTCMeeting.h
stopScreenShare 停止屏幕共享 RTCMeeting.h
startScreenMark 开启屏幕共享标注 RTCMeeting.h
stopScreenMark 停止屏幕共享标注 RTCMeeting.h
isEnableOtherMark 获取是否允许他人标注屏幕 RTCMeeting.h
enableOtherMark 允许他人标注屏幕 RTCMeeting.h

屏幕共享(回调)

方法 描述 所属文件
startScreenShareRslt 开启屏幕共享的响应事件 RTCMeeting.h
stopScreenShareRslt 停止屏幕共享的响应事件 RTCMeeting.h
notifyScreenShareStarted 通知屏幕共享开始 RTCMeeting.h
notifyScreenShareStopped 通知屏幕共享停止 RTCMeeting.h
startScreenMarkRslt 开始屏幕标注结果 RTCMeeting.h
stopScreenMarkRslt 停止屏幕标注结果 RTCMeeting.h
notifyScreenMarkStarted 通知屏幕标注开始 RTCMeeting.h
notifyScreenMarkStopped 通知屏幕标注停止 RTCMeeting.h

影音共享(主调)

方法 描述 所属文件
setMediaCfg 配置远程影音共享时,图像质量参数 RTCMeeting.h
getMediaCfg 获取影音共享图像质量参数 RTCMeeting.h
startPlayMedia 播放影音文件 RTCMeeting.h
pausePlayMedia 暂停播放影音 RTCMeeting.h
stopPlayMedia 停止影音播放 RTCMeeting.h
setMediaPlayPos 设置播放进度 RTCMeeting.h
getAllFilesInMediaPath 取得影音文件夹下的所有可播放文件 RTCMeeting.h
getMediaInfo 取得影音文件信息 RTCMeeting.h
setMediaVolume 设置影音播放的音量 RTCMeeting.h
getMediaVolume 读取影音播放的音量 RTCMeeting.h
getMediaImg 取得影音帧信息 RTCMeeting.h

影音共享(回调)

方法 描述 所属文件
notifyMediaOpened 通知影音文件打开 RTCMeeting.h
notifyMediaStart 通知影音开始播放 RTCMeeting.h
notifyMediaPause 通知影音暂停播放 RTCMeeting.h
notifyMediaStop 通知影音播放停止 RTCMeeting.h
notifyPlayPosSetted 通知播放进度已设置完成 RTCMeeting.h
notifyMemberMediaData 通知影音帧数据已解码完毕 RTCMeeting.h
notifyAudioPCMDat 通知语音PCM数据 RTCMeeting.h

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

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

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

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

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

方法 描述 所属文件
createCloudMixer 开始云端录制、云端直播 RTCMeeting.h
updateCloudMixerContent 更新云端录制、云端直播内容 RTCMeeting.h
destroyCloudMixer 停止云端录制、云端直播 RTCMeeting.h
getCloudMixerInfo 获取云端录制、云端直播状态 RTCMeeting.h

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

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

邀请(主调)

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

邀请(回调)

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