音视频通话

API 概述

方法概述

基础函数

CrSDK.instance

接口 描述
init SDK 初始化
uninit SDK 反初始化
getServerAddr 获取服务器地址
setServerAddr 设置服务器地址
log 写日志
getVersion 获取 SDK 版本
getStoreDirectory 获取 SDK 数据存储目录
getMoviesStorageDirectory 获取录像推荐目录
getSdkLogFilePath 获取 SDK 日志路径
getApplicationId 获取应用包名 / Bundle ID

登录/注销

CrSDK.instance

接口 描述
login 登录
loginByToken Token 登录
updateToken 更新 Token
logout 注销
getUserAuthErrCode 获取第三方鉴权失败码
getUserAuthErrDesc 获取第三方鉴权失败描述
setDNDStatus 设置免打扰状态
getUserStatus 获取用户在线状态
startUserStatusNotify 开启用户状态推送
stopUserStatusNotify 关闭用户状态推送
订阅 描述
onLineOff 通知用户掉线
onNotifyTokenWillExpire 通知 Token 即将失效
onNotifyUserStatus 用户状态变化通知

成员管理

CrSDK.instance

接口 描述
getMyUserID 获取我的用户 ID
getAllMembers 获取房间所有成员的列表
getMemberInfo 获取某个用户的信息
getNickName 获取某个用户的昵称
setNickName 设置某个用户的昵称
isUserInMeeting 判断某个用户是否在房间中

房间管理

CrSDK.instance

接口 描述
createMeeting 创建视频房间
destroyMeeting 销毁视频房间
enterMeeting 使用房间 ID 和密码(可为空)进入指定的视频房间
exitMeeting 离开房间
kickout 把某个成员踢出房间
sendMeetingCustomMsg 房间内发送广播消息
订阅 描述
onUserEnterMeeting 某用户进入了房间
onUserLeftMeeting 某用户离开了房间
onMeetingDropped 通知从房间里掉线了,收到该通知后可以调用 enterMeeting 尝试重新进入房间
onMeetingStopped 房间已被结束通知
onNetStateChanged 网络变化通知
onNotifyMeetingCustomMsg 通知发送房间内自定义广播消息结果

视频管理

CrSDK.instance

接口 描述
getWatchableVideos 获取房间内所有可观看的摄像头
getAllVideoInfo 获取用户所有的摄像头信息
openVideo 打开用户的摄像头,以便本地、远端显示视频图像
closeVideo 关闭用户的摄像头
getVideoCfg 获取设置的摄像头参数
setVideoCfg 设置摄像头参数
getDefaultVideo 获取指定用户的默认摄像头
setDefaultVideo 设置默认的摄像头
getUsrVideoId 获取当前显示的用户
setUsrVideoId 设置观看的摄像头
getVideoEffects 获取视频效果配置
setVideoEffects 设置视频效果配置
createCustomVideoDev 创建自定义摄像头
destroyCustomVideoDev 销毁自定义摄像头
inputCustomVideoDat 输入摄像头图像数据
getVideoStatus 获取用户的摄像头状态
getEnableMutiVideo 获取是否启用多摄像头
setEnableMutiVideo 设置用户是否启用多摄像头
getVideoImg 摄像头图像数据
getLocVideoAttributes 获取某个摄像头私有参数
setLocVideoAttributes 设置某个摄像头私有参数
createView 创建视频观看组件
getScaleType 获取视频显示模式(ref)
isPicEmpty 获取当前是否有图像(ref)
getShowPic 获取当前显示图像(ref)
getPicFrameTime 获取当前图像帧的显示时间戳(ref)
getPicWidth 获取图片宽度(ref)
getPicHeight 获取图片高度(ref)
clear 清空显示(ref)

setUsrVideoId、setScaleType 已改为 <CrVideoView> 的 props;destroyPlatformView 由组件卸载自动管理。

订阅 描述
onVideoStatusChanged 通知摄像头状态变化
onVideoDevChanged 通知用户的视频设备有变化
onDefVideoChanged 通知用户的视频默认设备有变化

音频管理

CrSDK.instance

接口 描述
getAudioCfg 获取麦克风音频参数
setAudioCfg 设置麦克风音频参数
getAudioStatus 获取用户的麦状态
openMic 打开用户的麦克风
closeMic 关闭用户的麦克风
getMicEnergy 获取用户说话声音大小
getSpeakerOut 获取外放状态
setSpeakerOut 设置外放状态
getSpeakerVolume 获取本地扬声器音量
setSpeakerVolume 设置本地扬声器音量
setSpeakerMute 设置播放静音
getSpeakerMute 获取播放静音状态
setAllAudioClose 关闭所有用户的麦克风
startGetAudioPCM 开始获取语音 pcm 数据
stopGetAudioPCM 停止获取语音 pcm 数据
订阅 描述
onAudioStatusChanged 通知音频状态变化
onAudioDevChanged 通知本地音频设备有变化
onMicEnergyUpdate 通知用户的说话声音强度更新

屏幕共享

CrSDK.instance

接口 描述
isScreenShareStarted 获取屏幕共享是否已开启
getScreenShareCfg 获取屏幕共享配置
setScreenShareCfg 设置屏幕共享配置
startScreenShare 开始屏幕共享
stopScreenShare 停止屏幕共享
createView 创建屏幕共享观看组件

屏幕共享观看组件 <CrScreenShareView scaleType={0} />,组件卸载自动销毁。
画面查询方法通过 ref 调用:shareRef.current?.getScaleType() / isPicEmpty() / getShowPic / getPicFrameTime / getPicWidth / getPicHeight / clear。

订阅 描述
notifyScreenShareStarted 通知开启屏幕共享
notifyScreenShareStopped 通知停止屏幕共享
notifyScreenMarkStarted 通知开启屏幕共享标注
notifyScreenMarkStopped 通知停止屏幕共享标注

影音共享

CrSDK.instance

接口 描述
getMediaCfg 获取影音共享图像质量参数
setMediaCfg 配置远程影音共享时,图像质量参数
startPlayMedia 播放影音文件
pausePlayMedia 暂停播放影音
stopPlayMedia 停止影音播放
setMediaPlayPos 设置播放进度
getMediaInfo 取得影音文件信息
createView 创建影音观看组件

影音观看组件 <CrMediaView scaleType={0} />,组件卸载自动销毁。
画面查询方法通过 ref 调用:mediaRef.current?.getScaleType() / isPicEmpty() / getShowPic / getPicFrameTime / getPicWidth / getPicHeight / clear。

订阅 描述
onNotifyMediaOpened 通知影音文件打开
onNotifyMediaStart 通知影音开始播放
onNotifyMediaPause 通知影音是否暂停播放
onNotifyMediaStop 通知影音播放停止

本地录制/本地直播

CrSDK.instance

接口 描述
createLocMixer 创建本地混图器
updateLocMixerContent 更新本地混图器内容
destroyLocMixer 销毁本地混图器
getLocMixerState 获取本地混图器状态
addLocMixerOutput 开启本地录制、开启直播推流
订阅 描述
onLocMixerOutputInfo 本地录制文件、本地直播信息通知
onLocMixerStateChanged 本地混图器状态变化通知

云端录制/互动直播

CrSDK.instance

接口 描述
createCloudMixer 开始云端录制、云端直播
updateCloudMixerContent 更新云端录制、云端直播内容
destroyCloudMixer 停止云端录制、云端直播
getCloudMixerInfo 得到云端混图器信息
getAllCloudMixerInfo 得到所有云端混图器信息
订阅 描述
onCreateCloudMixerFailed 启动云端录制、云端直播失败通知
onCloudMixerStateChanged 云端录制、云端直播状态变化通知
onCloudMixerInfoChanged 云端录制、云端直播配置变化通知
onCloudMixerOutputInfoChanged 云端录制文件、云端直播输出变化通知

房间、用户属性:

CrSDK.instance

接口 描述
getMeetingAllAttrs 获取房间所有属性
getMeetingAttrs 获取房间部份属性
setMeetingAttrs 设置房间信息
addOrUpdateMeetingAttrs 增加或者更新房间属性
delMeetingAttrs 删除特定房间属性
clearMeetingAttrs 清除房间属性
getUserAttrs 获取用户属性
setUserAttrs 设置用户属性
addOrUpdateUserAttrs 增加或者更新房间属性
delUserAttrs 删除特定用户的特定属性
clearUserAttrs 清除特定用户的所有属性
clearAllUserAttrs 清除所有用户的属性
订阅 描述
onNotifyMeetingAttrsChanged 房间属性发生改变
onNotifyUserAttrsChanged 用户属性发生改变

呼叫

CrSDK.instance

接口 描述
call 发起呼叫
acceptCall 接受对方发起的呼叫
rejectCall 拒绝对方发起的呼叫
hangupCall 挂断正在进行的视频呼叫或视频通话
订阅 描述
onNotifyCallIn 通知有人呼入
onNotifyCallAccepted 通知呼叫被对方接受
onNotifyCallRejected 通知呼叫被对方拒绝
onNotifyCallHangup 通知呼叫被对方挂断

邀请

CrSDK.instance

接口 描述
invite 发送邀请
acceptInvite 接受对方发送的邀请
rejectInvite 拒绝对方发送的邀请
cancelInvite 取消自己发送的邀请
订阅 描述
onNotifyInviteIn 通知有人邀请
onNotifyInviteAccepted 通知邀请被对方接受
onNotifyInviteRejected 通知邀请被对方拒绝
onNotifyInviteCanceled 通知有邀请被取消

队列

CrSDK.instance

接口 描述
initQueue 初始化队列
refreshAllQueueStatus 刷新所有队列状态
getAllQueueInfo 查询队列
getQueueStatus 获取队列状态
getQueuingInfo 获取我的排队信息
getServiceQueues 获取我服务的所有队列
getSessionInfo 获取我的会话信息
startQueuing 开始排队
stopQueuing 停止排队
startService 开始服务队列
stopService 停止服务队列
reqAssignUser 请求分配一个客户
acceptAssignUser 接受分配的客户
rejectAssignUser 拒绝分配的客户
订阅 描述
onQueueStatusChanged 队列状态变化通知
onQueuingInfoChanged 排队信息变化通知
onAutoAssignUser 自动分配用户通知
onCancelAssignUser 分配用户被取消通知

透明通道

CrSDK.instance

接口 描述
sendCmd 发送小块数据
sendBuffer 发送大块数据
sendFile 发送文件(分块发送 )
cancelSend 取消数据发送
订阅 描述
onSendProgress 发送数据时,通知发送进度
onNotifyCmdData 通知收到小块数据
onNotifyBufferData 通知收到大块数据
onNotifyFileData 通知收到文件数据
onNotifyCancelSend 通知取消发送文件数据