# 概览
- 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) 对象 |
appKey | 设置/获取 AppKey |
displayName | 设置/获取用户昵称 |
userId | 获取用户ID |
server | 设置/获取接入服务器地址 |
appName | 设置/获取应用名称 |
state | 获取当前登录状态 |
login | 登录 Juphoon RTC 平台 |
login | 登录 Juphoon RTC 平台 |
relogin | 重登录 Juphoon RTC 平台 |
logout | 登出 Juphoon RTC 平台 |
setForeground | 设置是否是前台 |
sendOnlineMessage | 发送在线消息 |
createP2PSession | 创建 P2P 会话 |
getUploadUrl | 获取文件上传路径 |
requestFileUploadInfo | 获取文件上传或断点续传信息 |
completeFileUpload | 文件上传完成确认 |
# 登录登出事件
| 事件 | 描述 |
|---|---|
onLogin | 登录结果回调 |
onLogout | 登出回调 |
onClientStateChanged | 登录状态变化通知 |
onOnlineMessageSendResult | 在线消息发送结果通知 |
onOnlineMessageReceive | 收到在线消息通知 |
onGetUploadUrlResponse | 获取文件上传地址等信息回调 |
onSDKEvent | 上报事件回调 |
onP2PSessionCreate | P2P 会话创建回调 |
onP2PSessionConnect | P2P 会话连接回调 |
onP2PSessionClose | P2P 会话关闭回调 |
onP2PMessageReceived | P2P 会话消息回调 |
onRequestFileUploadInfoResponse | 获取文件上传或断点续传信息响应 |
onCompleteFileUploadResponse | 文件上传完成确认响应 |
# 设备管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCMediaDevice (opens new window) 对象 |
destroy | 销毁 JRTCMediaDevice (opens new window) 对象 |
startCameraVideo | 开始本端视频渲染 |
startCameraVideo | 开始本端视频渲染 |
startVideo | 开始远端视频渲染 |
startVideo | 开始远端视频渲染 |
stopVideo | 停止视频渲染 |
stopAllVideos | 停止所有视频渲染 |
isAudioOutputStart | 音频输出是否打开 |
isAudioInputStart | 音频输入是否打开 |
startAudioInput | 打开设备音频输入 |
startAudioOutput | 打开设备音频输出 |
stopAudioInput | 关闭设备音频输入 |
stopAudioOutput | 关闭设备音频输出 |
startAudio | 启动音频 |
stopAudio | 停止音频 |
startCamera | 开启摄像头 |
stopCamera | 关闭摄像头 |
switchCamera | 切换摄像头 |
switchCamera | 切换到指定摄像头 |
specifyCamera | 指定要开启的摄像头 |
specifyCameraAngle | 指定摄像头采集角度 |
setCameraProperty | 设置摄像头采集属性 |
setScreenCaptureProperty | 设置屏幕共享采集属性 |
getScreenFramerate | 获取当前屏幕共享帧率 |
startVideoFile | 开启视频文件作为视频输入源 |
stopVideoFile | 关闭视频文件作为视频输入源 |
setVideoFileFrame | 逐帧采集视频画面 |
setVideoFileFrame | 向文件视频源逐帧添加视频数据 |
startVideoCaptureRecord | 开启视频录制 |
stopVideoCaptureRecord | 关闭视频录制 |
startAudioRecord | 开启音频录制 |
stopAudioRecord | 停止音频录制 |
snapshotWithStreamId | 截图 |
cameraOpen | 摄像头是否已打开 |
currentCamera | 获取当前摄像头 |
cameras | 获取摄像头列表 |
defaultCamera | 获取默认摄像头 |
videoFileOpen | 文件视频源是否已开启 |
audioParam | 音频参数 |
videoFileId | 获取文件视频源渲染ID |
setVideoAngle | 设置视频窗体角度 |
videoAngle | 获取视频窗体角度 |
defaultSpeakerOn | 是否默认开启扬声器 |
isSpeakerOn | 扬声器是否已打开 |
enableSpeaker | 开启关闭扬声器 |
enableScreenCapture | 开启关闭屏幕采集 |
getScreenCaptureId | 获取屏幕采集视频流ID |
getAudioRouteType | 获取当前音频输出通道类型 |
audioInterrupt | 是否声音被中断 |
aec | 回声消除 |
getSpkLevel | 获取当前扬声器音量级别 |
getMicLevel | 获取当前本地音量级别 |
setAudioInputFrameCallback | 设置音频输入帧回调 |
setVideoCaptureFrameCallback | 设置音频输入帧回调 |
startAudioTest | 检测音频设备是否正常 |
stopAudioTest | 停止检测音频设备 |
startRing | 开始播放音频 |
stopRing | 结束播放音频 |
getAnrNoiseLevel | 获取当前噪声强度 |
getAnrNoiseRatio | 获取当前信噪比强度 |
setScreenCaptureData | 设置屏幕采集数据 |
resetScreenCaptureData | 重置屏幕采集数据 |
setAec | 设置开启自适应回声消除 |
setAgc | 设置是否开启自动增益控制 |
recoveryRecordFile | 恢复录制文件 |
# 设备事件
| 事件 | 描述 |
|---|---|
onAudioError | 音频异常回调 |
onVideoError | 视频异常回调 |
onVideoError | 视频异常回调 |
onAudioRouteTypeChanged | 音频输出通道变化回调 |
onCameraUpdate | 摄像头变化回调 |
onRenderReceived | 收到第一帧数据回调 |
onRenderResized | 数据宽高比例变化回调 |
onRenderStart | 渲染开始回调 |
onMemoryAvailable | 上报剩余可用内存回调 |
onAudioInerruptAndResume | 声音中断恢复回调 |
onSnapshotComplete | 截图完成回调 |
onVideoCaptureDidStart | 视频采集开始回调 |
onScreenCaptureStart | 屏幕采集开始回调 |
onScreenCaptureStop | 屏幕采集结束回调 |
onRingPlayFinish | 音频播放完成回调 |
# 视频客服座席管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCAgent (opens new window) 对象 |
destroy | 销毁 JRTCAgent (opens new window) 对象 |
termState | 获取结束通话后的示闲示忙状态 |
operatorState | 获取座席签入状态 |
callState | 获取当前通话状态 |
isMainAgent | 是否主座席 |
mainGuestParticipant | 获取主访客成员 |
guestParticipants | 获取访客成员列表 |
participants | 获取通话中所有成员 |
selfParticipant | 获取自己对象 |
statistics | 获取统计信息 |
jsonStats | 获取网络统计信息 |
pause | 获取示忙示闲状态 |
shareStreamId | 获取屏幕共享时的视频流ID |
shareUserId | 获取发起屏幕共享者的用户ID |
requestSize | 获取/设置视频请求尺寸 |
serialNumber | 获取服务唯一标识 |
callId | 获取通话唯一标识 |
isAutoRecord | 是否由服务器自动开启录制 |
queryAllGroups | 获取业务号列表 |
queryAvailableAgentList | 查询指定组号的空闲座席 |
checkIn | 签入 |
checkIn | 签入 |
checkIn | 签入 |
checkIn | 签入 |
checkout | 签出 |
recall | 座席回呼 |
answer | 接听 |
term | 结束通话 |
applyStatePause | 示忙示闲 |
applyStatePause | 示忙示闲 |
transferCall | 通话转接 |
turnCallType | 音视频通话切换 |
inviteThirdGuest | 邀请第三方访客加入 |
inviteThirdAgent | 邀请第三方座席加入 |
requestSign | 请求访客签名 |
requestSign | 请求访客签名 |
requestOnewayVideo | 请求单向视频 |
isOnewayVideo | 获取单向视频状态 |
responseUrgent | 处理加急请求 |
sendMessage | 透明通道发送消息给某个成员 |
sendNotifyMessage | 发送事件通知消息 |
enableUploadVideoStream | 开启关闭发送视频流 |
enableUploadAudioStream | 开启关闭发送音频流 |
sendVideoEmptyPack | 视频发送空包 |
sendAudioEmptyPack | 音频发送空包 |
enableScreenShare | 开关屏幕分享 |
suspendScreenShare | 暂停继续屏幕共享 |
isSuspendScreenShare | 是否屏幕共享暂停 |
setSubScreenShare | 设置订阅屏幕共享属性 |
isSubScreenShare | 获取是否订阅屏幕共享属性 |
setRatio | 设置本端视频宽高比 |
requestVideo | 订阅通话中其他成员的视频流 |
unRequestVideo | 取消订阅通话中其他成员的视频流 |
requestScreenVideo | 订阅通话中屏幕共享的视频流 |
unRequestScreenVideo | 订阅通话中屏幕共享的视频流 |
controlRecord | 开启关闭远程录制 |
controlRecord | 开启关闭远程录制 |
enableLocalRecord | 开关本地通话录制 |
isLocalRecording | 是否正在本地录制 |
updateLocalRecordLayout | 更新本地录制自定义布局 |
enableRemoteRecord | 开启关闭远程录制 |
updateRemoteRecordLayout | 更新远程录制自定义布局 |
updateRemoteRecordWatermark | 更新远程录制水印信息 |
getRemoteRecordState | 获取远程视频录制状态 |
setHoldState | 保持取回 |
getHoldState | 获取当前通话保持状态 |
getCallType | 获取当前通话类型 |
getSupportVideoSizes | 获取该通话支持的视频分辨率列表 |
setVideoDot | 视频打点 |
joinCall | 加入通话 |
switchPartRole | 切换自己在通话中角色 |
kickParticipant | 踢出通话成员 |
enableMicAgc | 开启或关闭本地麦克风的增益 |
# 视频客服座席事件
| 事件 | 描述 |
|---|---|
onGetAllGroups | 获取业务号列表结果回调 |
onCheckin | 签入结果回调 |
onCheckout | 签出结果回调 |
onCheckStateChanged | 签入签出状态改变回调 |
onCallStateChanged | 通话状态改变回调 |
onCallQueryWaitCount | 排队人数回调 |
onApplyResult | 示忙示闲结果回调 |
onTransferCallResult | 转接结果回调 |
onCallPropertyChanged | 通话属性改变回调 |
onMemberJoin | 通话中有新成员加入回调 |
onMemberLeave | 通话中有成员离开回调 |
onMemberUpdate | 通话中有成员属性更新回调 |
onUrgentRequest | 收到加急请求回调 |
onResponseUrgentResult | 处理加急结果回调 |
onQueryAvailableAgentList | 查询空闲座席结果回调 |
onMessageReceived | 接收消息的回调 |
onHoldStateChanged | 收到保持取回的回调 |
onCallTypeChanged | 音视频通话切换回调 |
onDeliveryAbort | 录制异常回调 |
onInviteThirdAgentResult | 邀请座席结果回调 |
onInviteThirdGuestResult | 邀请第三方访客结果回调 |
onNotifyMessageReceived | 收到事件通知消息回调 |
onOnewayVideoChanged | 收到单向视频变化回调 |
onSignResultResponse | 收到访客签名请求结果回调 |
onSwitchPartRoleResult | 切换自己在通话中角色结果回调 |
onKickParticipantResult | 踢出通话成员结果回调 |
# 视频客服访客管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCGuest (opens new window) 对象 |
destroy | 销毁 JRTCGuest (opens new window) 对象 |
callState | 获取当前通话状态 |
isMainGuest | 是否主访客 |
mainAgentParticipant | 获取主座席成员 |
agentParticipants | 获取座席成员列表 |
selfParticipant | 获取自己对象 |
participants | 获取通话中所有成员 |
statistics | 获取媒体统计信息 |
jsonStats | 获取网络统计信息 |
shareStreamId | 获取屏幕共享时的视频流ID |
shareUserId | 获取发起屏幕共享者的用户ID |
requestSize | 获取/设置视频请求尺寸 |
serialNumber | 获取服务唯一标识 |
callId | 获取通话唯一标识 |
getSupportVideoSizes | 获取房间支持的视频分辨率列表 |
queryAllGroups | 获取业务号列表 |
call | 呼叫指定业务 |
oneToOneCall | 呼叫指定座席 |
term | 结束通话 |
answer | 接受作为第三方访客的邀请 |
requestUrgent | 请求加急 |
enableUploadVideoStream | 开启关闭发送视频流 |
enableUploadAudioStream | 开启关闭发送音频流 |
sendVideoEmptyPack | 视频发送空包 |
sendAudioEmptyPack | 音频发送空包 |
enableScreenShare | 开关屏幕共享 |
suspendScreenShare | 暂停继续屏幕共享 |
isSuspendScreenShare | 是否屏幕共享暂停 |
setSubScreenShare | 设置订阅屏幕共享属性 |
isSubScreenShare | 获取是否订阅屏幕共享属性 |
setRatio | 设置本端视频宽高比 |
requestVideo | 订阅通话中其他成员的视频流 |
unRequestVideo | 取消订阅通话中其他成员的视频流 |
requestScreenVideo | 订阅通话中屏幕共享的视频流 |
unRequestScreenVideo | 取消订阅通话中屏幕共享的视频流 |
enableLocalRecord | 开关本地通话录制 |
isLocalRecording | 是否正在本地录制 |
updateLocalRecordLayout | 更新本地录制自定义布局 |
enableRemoteRecord | 开启关闭远程录制 |
updateRemoteRecordLayout | 更新远程录制自定义布局 |
updateRemoteRecordWatermark | 更新远程录制水印信息 |
getRemoteRecordState | 获取远程视频录制状态 |
sendMessage | 透明通道发送消息给某个成员 |
sendNotifyMessage | 发送事件通知消息 |
getHoldState | 获取当前通话保持状态 |
turnCallType | 音视频通话切换 |
getCallType | 获取当前通话类型 |
isOnewayVideo | 获取单向视频状态 |
setVideoDot | 视频打点 |
responseSignResult | 响应座席签名请求 |
enableMicAgc | 开启或关闭本地麦克风的增益 |
# 视频客服访客事件
| 事件 | 描述 |
|---|---|
onGetAllGroups | 获取业务号列表结果回调 |
onCallStateChanged | 通话状态改变回调 |
onCallQueueCount | 当前排队人数上报回调 |
onCallQueueCount | 当前排队人数上报回调 |
onCallPropertyChanged | 通话属性改变回调 |
onMemberJoin | 通话中有新成员加入回调 |
onMemberLeave | 通话中有成员离开回调 |
onMemberUpdate | 通话中有成员属性更新回调 |
onUrgentResultResponse | 加急结果回调 |
onMessageReceived | 收到消息回调 |
onHoldStateChanged | 收到保持取回回调 |
onCallTypeChanged | 音视频通话切换回调 |
onSignRequest | 收到签名请求回调 |
onOnewayVideoChanged | 收到单向视频回调 |
onDeliveryAbort | 录制异常回调 |
onCallForwarding | 座席通话转接回调 |
onNotifyMessageReceived | 收到事件通知消息回调 |