概览

• JRTCClient 用于初始化 SDK 以及登录登出 Juphoon RTC 平台
• JRTCClientCallback 用于回调登录登出相关事件
• JRTCMediaDevice 用于管理媒体设备
• JRTCMediaDeviceCallback 用于回调媒体设备相关事件
• JRTCGuest 用于管理视频客服访客功能
• JRTCGuestCallback 用于回调视频客服访客相关事件
• 事件码 包含错误码
• ReasonCode 原因码

登录登出管理

方法	描述
create	创建 JRTCClient 对象
destroy	销毁 JRTCClient 对象
login	登录 Juphoon RTC 平台
logout	登出 Juphoon RTC 平台
getUserId	获取用户ID
getState	获取当前登录状态
getDisplayName	获取用户昵称
setDisplayName	设置用户昵称
getServer	获取接入服务器地址
setServer	设置接入服务器地址
getAppKey	获取 Appkey
setAppKey	设置 Appkey
getAppName	获取应用名称
setAppName	设置应用名称
sendOnlineMessage	发送在线消息

登录登出事件

事件	描述
onLogin	登录结果回调
onLogout	登出回调
onClientStateChanged	登录状态变化通知
onSDKEvent	上报事件回调
onOnlineMessageSendResult	在线消息发送结果回调
onOnlineMessageReceived	收到在线消息回调

设备管理

方法	描述
create	创建 JRTCMediaDevice 对象
destroy	销毁 JRTCMediaDevice 对象
startCameraVideo	开始本端视频渲染
startVideo	开始远端视频渲染
stopVideo	停止视频渲染
stopAllMedia	关闭所有媒体资源，包括远端和本端音视频
startAudioOutput	打开音频输出
stopAudioOutput	关闭音频输出
switchCamera	切换摄像头/切换到指定摄像头
isCameraOpen	摄像头是否打开
getCurrentCamera	获取当前摄像头
getCameras	获取摄像头列表
isAudioStart	音频设备是否打开
setCameraProperty	设置摄像头采集属性

设备事件

事件	描述
onCameraUpdate	摄像头变化回调
onAudioInputUpdate	输入音频变化回调

视频客服访客管理

方法	描述
create	创建 JRTCGuest 对象
destroy	销毁 JRTCGuest 对象
getCallState	获取当前通话状态
getCallType	获取当前通话类型
getHoldState	获取当前通话保持状态
isOnewayVideo	获取单向视频状态
isMainGuest	是否主访客
getMainAgentParticipant	获取主座席成员
getAgentParticipants	获取座席成员列表
getSelfParticipant	获取自己对象
getParticipants	获取所有成员
getSerialNumber	获取服务唯一标识
getCallId	获取通话唯一标识
getShareStreamId	获取屏幕共享的视频流ID
getShareUserId	获取发起屏幕共享者的用户ID
queryAllGroups	获取当前业务组列表
call	呼叫指定业务
oneToOneCall	呼叫指定座席
term	结束通话
requestUrgent	请求加急
sendMessage	发送消息，消息内容不能大于4K
sendNotifyMessage	发送事件通知消息
enableUploadAudioStream	开启/关闭发送本地音频流
enableUploadVideoStream	开启/关闭发送本地视频流
setRatio	设置本端视频宽高比
getRequestSize	获取视频请求尺寸
setRequestSize	设置视频请求尺寸
requestVideo	订阅通话中其他成员的视频流
unRequestVideo	取消订阅通话中其他成员的视频流
enableRemoteRecord	开启/关闭远程视频录制
getRemoteRecordState	获取远程视频录制状态
responseSignResult	响应座席签名请求

视频客服访客事件

事件	描述
onGetAllGroups	查询业务组号结果回调
onCallStateChanged	通话状态改变回调
onCallQueueCount	当前排队人数上报回调
onCallPropertyChanged	通话属性改变回调
onMemberJoin	通话中有新成员加入回调
onMemberLeave	通话中有成员离开回调
onMemberUpdate	通话中成员属性更新回调
onHoldStateChanged	收到通话保持或取回的回调
onCallTypeChanged	音视频通话切换回调
onMessageReceived	收到消息回调
onSignRequest	收到签名请求回调
onOnewayVideoChanged	收到单向视频状态变化回调
onDeliveryAbort	录制异常回调
onNotifyMessageReceived	收到事件通知消息回调
onUrgentResultResponse	座席处理加急的结果回调