概览

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

登录管理

方法	描述
create	创建 JRTCClient (opens new window) 对象
destroy	销毁 JRTCClient (opens new window) 对象
setForeground	设置是否为前台
getUserId	获得用户ID
getState	获取当前登录状态
getDisplayName	获取用户昵称
setDisplayName	设置用户昵称
getServer	获取接入服务器地址
setServer	设置接入服务器地址
getAppKey	获取AppKey
setAppKey	设置AppKey
getAppName	获取应用名称
setAppName	设置应用名称
login	登录 Juphoon RTC 平台
reLogin	重登录 Juphoon RTC 平台
logout	登出 Juphoon RTC 平台
sendOnlineMessage	发送在线消息
getUploadUrl	获取文件上传路径
createP2PSession	创建 P2P 会话
requestFileUploadInfo	获取文件上传或断点续传信息
completeFileUpload	文件上传完成确认
getUploadFileInfo	获取上传文件信息列表

登录登出事件

事件	描述
onLogin	登录结果回调
onLogout	登出回调
onClientStateChange	登录状态变化通知
onOnlineMessageSendResult	在线消息发送结果回调
onOnlineMessageReceived	收到在线消息回调
onGetUploadUrlResponse	获取文件上传地址等信息回调
onSDKEvent	上报事件回调
onP2PSessionCreate	P2P 会话创建结果
onP2PSessionConnect	P2P 会话连接
onP2PSessionClose	P2P 会话关闭
onP2PMessageReceived	收到 P2P 会话消息
onRequestFileUploadInfoResponse	获取文件上传或断点续传信息响应
onCompleteFileUploadResponse	文件上传完成确认响应
onGetUploadFileInfoResponse	获取上传文件信息列表响应
onFileUploadPlatformNotify	文件上传到影像平台结果通知

设备管理

方法	描述
create (opens new window)	创建 JRTCMediaDevice (opens new window) 对象
destroy (opens new window)	销毁 JRTCMediaDevice (opens new window) 对象
isCameraOpen (opens new window)	摄像头是否打开
isSpeakerOn (opens new window)	扬声器是否已打开
getCurrentCamera (opens new window)	获取当前摄像头
getCameras (opens new window)	获取摄像头列表
startCameraVideo (opens new window)	开始本端视频渲染
startVideo (opens new window)	开始远端视频渲染
stopVideo (opens new window)	停止视频渲染
isAudioInputStart (opens new window)	音频输入是否打开
isAudioOutputStart (opens new window)	音频输出是否打开
startAudio (opens new window)	启动音频
stopAudio (opens new window)	停止音频
startAudioInput (opens new window)	打开音频输入
stopAudioInput (opens new window)	关闭音频输入
startAudioOutput (opens new window)	打开音频输出
stopAudioOutput (opens new window)	关闭音频输出
startCamera (opens new window)	开启摄像头
stopCamera (opens new window)	关闭摄像头
switchCamera (opens new window)	切换摄像头
switchCameraBetweenFrontAndBack (opens new window)	切换摄像头
specifyCamera (opens new window)	指定要开启的摄像头
specifyCameraAngle (opens new window)	指定摄像头采集角度
setCameraProperty (opens new window)	设置摄像头采集属性
setScreenCaptureProperty (opens new window)	设置屏幕共享采集属性
getCameraType (opens new window)	获取摄像头类型
enableSpeaker (opens new window)	开启/关闭扬声器
changeAudioOutput (opens new window)	切换音频输出通道
getBluetoothName (opens new window)	获取连接的蓝牙名称
isVideoFileOpen (opens new window)	是否开启文件视频源
getVideoFileId (opens new window)	获取文件视频源ID
startVideoFile (opens new window)	开启视频文件作为视频输入源
setVideoFileFrame (opens new window)	逐帧采集视频画面
stopVideoFile (opens new window)	关闭视频文件作为视频输入源
getAudioRouteType (opens new window)	获得当前音频输出通道类型
setVideoAngle (opens new window)	设置视频窗体角度
getVideoAngle (opens new window)	获取视频窗体角度
startVideoCaptureRecord (opens new window)	开启视频录制
startVideoCaptureRecord (opens new window)	开启视频录制
stopVideoCaptureRecord (opens new window)	关闭视频录制
startAudioRecord (opens new window)	开启音频录制
stopAudioRecord (opens new window)	关闭音频录制
getScreenCaptureId (opens new window)	获取屏幕共享采集ID
enableScreenCapture (opens new window)	开启/关闭屏幕采集
stopAllVideos (opens new window)	停止所有视频渲染
snapshotWithStreamID (opens new window)	截图
setAudioInputFrameCallback (opens new window)	设置音频输入帧回调
setVideoCaptureFrameCallback (opens new window)	设置视频采集帧数据回调
startAudioTest (opens new window)	检测音频设备是否正常
stopAudioTest (opens new window)	停止检测音频设备
getMicLevel (opens new window)	获取当前本地音量级别
getSpkLevel (opens new window)	获取当前扬声器音量级别
getAnrNoiseLevel (opens new window)	获取当前噪声强度
getAnrNoiseRatio (opens new window)	获取当前信噪比强度
startRing (opens new window)	开始播放音频
stopRing (opens new window)	结束播放音频
setAec (opens new window)	设置开启自适应回声消除
setAgc (opens new window)	设置是否开启自动增益控制

设备事件

事件	描述
onAudioError (opens new window)	音频异常回调
onAudioRouteTypeChanged (opens new window)	音频输出通道变化回调
onCameraUpdate (opens new window)	摄像头变化回调
onVideoCaptureDidStart (opens new window)	视频采集开始回调
onRenderStart (opens new window)	渲染开始回调
onRenderReceived (opens new window)	收到第一帧数据回调
onRenderResized (opens new window)	数据宽高比例变化回调
onScreenSharePermissionResult (opens new window)	屏幕共享权限申请结果回调
onVideoError (opens new window)	视频设备异常回调
onSnapshotComplete (opens new window)	截图完成回调
onMemoryAvailable (opens new window)	上报剩余可用内存回调
onRingPlayFinish (opens new window)	音频播放完成

视频客服座席管理

方法	描述
create	创建 JRTCAgent (opens new window) 对象
destroy	销毁 JRTCAgent (opens new window) 对象
isAutoRecord	是否由服务器自动开启录制
getCallState	获取当前通话状态
getCallType	获取当前通话类型
isOnewayVideo	获取单向视频状态
getHoldState	当前通话是否保持
setHoldState	保持/取回
getTermState	获取结束通话后的示闲/示忙状态，默认为示闲状态
setTermState	设置通话结束后示闲/示忙状态，默认为示闲状态
getOperatorState	获取座席签入状态
isPause	获取示忙/示闲状态
isMainAgent	是否主座席
getMainGuestParticipant	获取主访客成员
getGuestParticipants	获取访客成员列表
getSelfParticipant	获取自己对象
getParticipants	获取当前通话中的所有成员对象
getSerialNumber	获取服务唯一标识
getCallId	获取通话唯一标识
getStatistics	获取媒体统计信息
getJsonStats	获取天赛实时统计信息
getSupportVideoSizes	获取该通话支持的视频分辨率列表
setUseExternalScreenCaptureControl	设置是否由应用层自行控制屏幕采集逻辑，默认 false
queryAllGroups	获取当前业务组列表
queryAvailableAgentList	查询指定组号的空闲座席
checkIn	签入到排队机
checkout	签出排队机
recall	座席回呼
answer	接听通话
term	结束通话
applyStatePause	示忙/示闲
transferCall	通话转接
turnCallType	音视频通话切换
inviteThirdGuest	邀请第三方访客加入
inviteThirdAgent	邀请第三方座席加入
requestSign	请求访客签名
requestOnewayVideo	请求单向视频
responseUrgent	处理加急请求
sendMessage	发送消息，消息内容不能大于4K
sendNotifyMessage	发送事件通知消息
enableUploadAudioStream	开启/关闭发送本地音频流
enableUploadVideoStream	开启/关闭发送本地视频流
sendVideoEmptyPack	发送视频空包
sendAudioEmptyPack	发送音频空包
enableScreenShare	开启/关闭屏幕共享
suspendScreenShare	暂停/继续屏幕共享
isSuspendScreenShare	是否屏幕共享暂停
getShareStreamId	获取屏幕共享的视频流ID
getShareUserId	获取发起屏幕共享者的用户ID
setRatio	设置视频本地宽高比
getRequestSize	获取视频请求尺寸
setRequestSize	设置视频请求尺寸
requestVideo	订阅通话中其他成员的视频流
unRequestVideo	取消订阅通话中其他成员的视频流
requestScreenVideo	订阅通话中屏幕共享的视频流
unRequestScreenVideo	取消订阅通话中屏幕共享的视频流
controlRecord	开启/关闭远程录制
enableLocalRecord	开启/关闭本地录制
updateLocalRecordLayout	更新本地录制自定义布局
isLocalRecording	是否正在本地录制
enableRemoteRecord	开启/关闭远程录制
updateRemoteRecordLayout	更新远程录制自定义布局
updateRemoteRecordWatermark	更新远程录制水印信息
getRemoteRecordState	获取当前服务器录制状态
setVideoDot	视频打点
switchPartRole	切换自己在通话中角色
kickParticipant	踢出通话成员
enableMicAgc	开启或关闭本地麦克风的增益（软件增益）,默认开启

视频客服座席事件

方法	描述
onGetAllGroups	查询业务组号回调
onCheckIn	签入结果回调
onCheckout	签出结果回调
onCheckStateChanged	签入/签出状态改变
onCallStateChanged	通话状态改变回调
onCallQueueCount	排队人数回调
onApplyResult	示忙/示闲回调
onTransferCallResult	通话转接回调
onMemberJoin	通话中有新成员加入回调
onMemberLeave	通话中有成员离开回调
onMemberUpdate	通话中成员属性更新回调
onCallPropertyChanged	通话属性改变回调
onResponseUrgentResult	收到加急请求回调
onUrgentResponseResult	处理加急结果回调
onQueryAvailableAgentList	查询空闲座席回调
onHoldStateChanged	收到通话保持或取回的回调
onCallTypeChanged	音视频通话切换回调
onMessageReceived	收到消息回调
onDeliveryAbort	录制异常回调
onInviteThirdAgentResult	邀请第三方座席结果回调
onInviteThirdGuestResult	邀请第三方访客结果回调
onNotifyMessageReceived	收到事件通知消息回调
onOnewayVideoChanged	收到单向视频变化回调
onSignResultResponse	收到访客签名请求结果回调
onSwitchPartRoleResult	切换自己在通话中角色结果回调
onKickParticipantResult	踢出通话成员结果回调

视频客服访客管理

方法	描述
create	创建 JRTCGuest (opens new window) 对象
destroy	销毁 JRTCGuest (opens new window) 对象
getCallState	获取当前通话状态
getCallType	获取当前通话类型
getHoldState	获取当前通话保持状态
isOnewayVideo	获取单向视频状态
isMainGuest	是否主访客
getMainAgentParticipant	获取主座席成员
getAgentParticipants	获取座席成员列表
getSelfParticipant	获取自己对象
getParticipants	获取所有成员（包含自己、座席和其他访客）
getSerialNumber	获取服务唯一标识
getCallId	获取通话唯一标识
getShareStreamId	获取屏幕共享的视频流ID
getShareUserId	获取发起屏幕共享者的用户ID
getStatistics	获取媒体统计信息
getJsonStats	获取天赛实时统计信息
getSupportVideoSizes	获取该通话支持的视频分辨率列表
setUseExternalScreenCaptureControl	设置是否由应用层自行控制屏幕采集逻辑，默认 false
queryAllGroups	获取当前业务组列表
call	呼叫指定业务
oneToOneCall	呼叫指定座席
answer	接听通话邀请
term	结束通话
requestUrgent	请求加急
turnCallType	音视频通话切换
sendMessage	发送消息，消息内容不能大于4K
sendNotifyMessage	发送事件通知消息
enableUploadAudioStream	开启/关闭发送本地音频流
enableUploadVideoStream	开启/关闭发送本地视频流
sendVideoEmptyPack	发送视频空包
sendAudioEmptyPack	发送音频空包
enableScreenShare	开启/关闭屏幕共享
suspendScreenShare	暂停/继续屏幕共享
isSuspendScreenShare	是否屏幕共享暂停
setRatio	设置本端视频宽高比
getRequestSize	获取视频请求尺寸
setRequestSize	设置视频请求尺寸
requestVideo	订阅通话中其他成员的视频流
unRequestVideo	取消订阅通话中其他成员的视频流
requestScreenVideo	订阅通话中屏幕共享的视频流
unRequestScreenVideo	取消订阅通话中屏幕共享的视频流
enableLocalRecord	开启/关闭本地录制
updateLocalRecordLayout	更新本地录制自定义布局
isLocalRecording	是否正在本地录制
enableRemoteRecord	开启/关闭远程视频录制
getRemoteRecordState	获取远程视频录制状态
updateRemoteRecordLayout	更新远程录制自定义布局
updateRemoteRecordWatermark	更新远程录制水印信息
setVideoDot	视频打点
responseSignResult	响应座席签名请求
enableMicAgc	开启或关闭本地麦克风的增益（软件增益）,默认开启

视频客服访客事件

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