JRTCSDK-Android  v1.1
API文档
概览

登录管理

方法 描述
create 创建 JCClient 对象
destroy 销毁 JCClient 对象
setForeground 设置是否为前台
getUserId 获得用户标识
getState 当前状态
getDisplayName 昵称
setDisplayName 设置昵称
getServer 获取接入服务器地址
setServer 设置接入服务器地址
getAppKey 获取AppKey
setAppKey 设置AppKey
getAppName 获取应用名称
setAppName 设置应用名称
login 登录 Juphoon RTC 平台
relogin 重登录 Juphoon RTC 平台
logout 登出 Juphoon RTC 平台
getContext 获得上下文
sendOnlineMessage 发送在线消息

登录事件

事件 描述
onLogin 登录结果回调
onLogout 登出回调
onClientStateChange 登录状态变化通知
onOnlineMessageSendResult 发送在线消息结果

|onOnlineMessageReceived收到在线消息|

坐席管理

方法 描述
create 创建 JCAgent 对象
destroy 销毁 JCAgent 对象
queryAllGroups 查询业务组号
checkIn 签入到排队机
checkout 签出排队机
answer 座席端在收到邀请后,调用answer来接听
term 结束通话
checkResult 通知访客业务办理的结果
requestVideo 按设定质量请求频道中指定用户的视频流
applyStatePause 主动发起示忙示闲
enableAudio 开启关闭发送本地音频流
enableVideo 开启关闭发送本地视频流
sendVideoEmptyPack 视频发送空包
sendAudioEmptyPack 音频发送空包
transferCall 转接
getCallState 获取当前通话状态
getGuestParticipant 获取当前的访客成员对象
getSelfParticipant 获取自己对象
getStatistics 获取媒体统计信息
getJsonStats 获取天赛实时统计信息
getOperatorState 坐席签入状态
isPause 当前是否是示忙状态
getParticipants 获取当前通话中的所有成员对象
inviteMember 邀请其他坐席
enableScreenShare 屏幕共享
getShareRenderId 屏幕共享时的渲染id,无屏幕共享时为空
getShareUserId 屏幕共享时的共享成员id,无屏幕共享时为空
setRatio 设置视频本地宽高比
responseUrgent 应答加急请求
getSpkLevel 获取扬声器音量
getMicLevel 获取麦克风音量
queryAvailableAgents 查询指定组号的空闲座席
setScreenMode 设置分屏模式
getRequestSize 视频请求质量
getSerialNumber 获取服务唯一标识
getExtraStr 获取来电额外参数
getTermState 通话结束后默认状态
setRequestSize 设置视频请求尺寸
setTermState 设置通话结束后默认状态
enableLocalRecord 开关本地通话录制
enableRemoteRecord 开关远程通话录制
sendMessage 透明通道发送全员消息
insertStorageRecord 把文件绑定到当前的服务
setHoldState 保持取回
getHoldState 当前通话是否保持
turnCallType 音视频通话切换
getCallType 获取当前通话类型
getMid 获取mid
sendTextMessage 发送文本消息
requestSign 请求访客签名
ControlRecord 控制远程录制
inviteThirdActor 邀请第三方访客加入
requestOneWayVideo 请求单向视频
getUploadUrl 获取文件上传路径
sendNotifyMessage 发送事件通知消息
unRequestVideo 取消订阅通话中其他成员的视频流
requestScreenVideo 订阅通话中屏幕共享的视频流
unRequestScreenVideo 取消订阅通话中屏幕共享的视频流
setVideoDot 视频打点

坐席事件

方法 描述
onGetAllGroups 查询服务动态组号回调
onCheckIn 签入结果
onCheckStateChanged 签出状态改变
onCheckout 签出结果
onCallStateChanged 通话状态改变
onCallQueueCount 排队人数上报
onApply 示忙示闲的结果
onTransferResult 转接的结果
onNewMemberJoin 通话中有新成员加入
onMemberLeave 通话中有成员离开
onMemberUpdate 成员属性有更新
onCallPropertyChange 通话属性改变
onUrgentRequestRecv 收到加急请求
onUrgentResponseResult 处理加急结果
onQueryAvailableAgentListResult 查询空闲座席结果
onMessageReceive 接收频道消息的回调
onHeldNotify 收到保持取回的通知
onCallTypeTurnedNotify 音视频通话切换通知
onTextMessageRecvNotify 收到文本消息
onGetUploadUrlResult 获取文件上传地址等信息回调
onDeliveryAbortNotify 录制异常回调
onInviteOpResult 邀请坐席结果回调
onInviteThirdActorResult 邀请第三方访客结果回调
onNotifyMessageReceive 收到事件通知消息回调

访客管理

方法 描述
create 创建 JCGuest 对象
destroy 销毁 JCGuest 对象
queryAllGroups 查询业务组号
call 发起呼叫
oneToOneCall 点对点呼叫
term 结束通话
requestVideo 按设定质量请求频道中指定用户的视频流
enableAudio 开启关闭发送本地音频流
enableVideo 开启关闭发送本地视频流
sendVideoEmptyPack 视频发送空包
sendAudioEmptyPack 音频发送空包
getAgentParticipant 通话中可以取得正在通话的座席对象
getCallState 获取当前通话状态
getSelfParticipant 获取自己对象
getStatistics 获取媒体统计信息
getJsonStats 获取天赛实时统计信息
getParticipants 获取当前通话中的所有成员对象
enableScreenShare 屏幕共享
getShareRenderId 屏幕共享时的渲染id,无屏幕共享时为空
getShareUserId 屏幕共享时的共享成员id,无屏幕共享时为空
setRatio 设置视频本地宽高比
requestUrgent 请求加急
getSpkLevel 获取扬声器音量
getMicLevel 获取麦克风音量
setScreenMode 设置分屏模式
getRequestSize 视频请求质量
getSerialNumber 获取服务唯一标识
setRequestSize 设置视频请求尺寸
enableLocalRecord 开关本地通话录制
enableRemoteRecord 开关远程通话录制
sendMessage 透明通道发送全员消息
insertStorageRecord 把文件绑定到当前的服务
getHoldState 当前通话是否保持
turnCallType 音视频通话切换
getCallType 获取当前通话类型
getMid 获取mid
sendTextMessage 发送文本消息
getUploadUrl 获取文件上传路径
sendNotifyMessage 发送事件通知消息
unRequestVideo 取消订阅通话中其他成员的视频流
requestScreenVideo 订阅通话中屏幕共享的视频流
unRequestScreenVideo 取消订阅通话中屏幕共享的视频流

访客事件

方法 描述
onGetAllGroups 查询服务动态组号回调
onCallStateChanged 通话状态改变
onCallQueueCount 排队人数上报
onNewMemberJoin 通话中有新成员加入
onMemberLeave 通话中有成员离开
onMemberUpdate 成员属性有更新
onCallPropertyChange 通话属性改变
onUrgentResult 坐席处理加急的结果
onCheckVerifyResult 业务是否办理成功
onMessageReceive 接收频道消息的回调
onInviteDeclined 邀请被拒绝
onHeldNotify 收到保持取回的通知
onCallTypeTurnedNotify 音视频通话切换通知
onTextMessageRecvNotify 收到文本消息
onSignRequestRecvNotify 收到签名请求
onInvitedAsThirdActorFromAgent 收到坐席邀请作为第三方访客回调
onJoinAsThirdActor 已作为第三方访客进入会议回调
onOneWayVideoRequestRecvNotify 收到单向视频请求回调
onGetUploadUrlResult 获取文件上传地址等信息回调
onDeliveryAbortNotify 录制异常回调
onNotifyMessageReceive 收到事件通知消息回调
onCallForwarding 坐席通话转接回调

设备管理

方法 描述
create 创建 JCMediaDevice 对象
destroy 销毁 JCMediaDevice 对象
isAudioInputStart 音频输入设备是否打开
isAudioOutputStart 音频输出设备是否打开
isCameraOpen 摄像头是否打开
getCurrentCamera 当前默认的摄像头
getCameras 获取摄像头列表
startCameraVideo 开始自身视频渲染
startVideo 开始其他端的视频渲染
stopVideo 停止视频渲染
startAudio 启动音频
stopAudio 停止音频
startAudioInput 打开音频输入设备
stopAudioInput 关闭音频输入设备
startAudioOutput 打开音频输出设备
stopAudioOutput 关闭音频输出设备
startCamera 开启摄像头
stopCamera 关闭摄像头
switchCamera 切换摄像头
switchCameraBetweenFrontAndBack 切换摄像头,用于手机前置和后置摄像头的切换
specifyCamera 指定要开启的摄像头,在 startCamera 之前调用
specifyCameraAngle 指定摄像头采集角度,为90的倍数
setCameraProperty 设置摄像头采集属性
setScreenCaptureProperty 设置屏幕共享采集属性
isSpeakerOn 扬声器是否已打开
enableSpeaker 开启关闭扬声器
changeAudioOutput 切换音频输出
getBluetoothName 获取连接的蓝牙名称
isVideoFileOpen 文件视频源是否已开启
getVideoFileId 获取文件视频源渲染id
startVideoFile 开启视频文件作为视频输入源
setVideoFileFrame 逐帧采集视频画面
stopVideoFile 关闭逐帧采集画面
getAudioRouteType 音频路由类型
setVideoAngle 设置视频窗体角度
getVideoAngle 获取视频窗体角度
startVideoCaptureRecord 开启本地视频录制
stopVideoCaptureRecord 关闭本地视频录制
startAudioRecord 开启本地音频录制
stopAudioRecord 关闭本本地音频录制
getScreenCaptureId 获取屏幕共享采集Id
enableScreenCapture 开关屏幕采集
enableScreenOrWindowsAreaCapture 开启关闭区域共享
stopAllVideos 关闭媒体资源
snapshotWithRenderId 截图
setAudioInputCallback 设置音频输入帧回调
setAudioOutputCallback 设置音频输出帧回调
startAudioTest 检测音频设备是否正常
stopAudioTest 停止检测音频设备

设备事件

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

文件存储管理

方法 描述
create 创建 JCStorage 对象
destroy 销毁 JCStorage 对象
uploadFile 上传文件
downloadFile 下载文件
cancelFile 取消正在进行的文件上传下载

文件存储事件

事件 描述
onFileUpdate 文件传输结果回调
onFileResult 文件状态更新回调
onUploadFileError upload文件传输失败回调
onUploadFileResult upload文件传输回调
onUploadFileProgress 文件上传进度