JCSDK-Android
概览

坐席管理

方法 描述
create 创建 JCAgent 对象
destroy 销毁 JCAgent 对象
queryAllGroups 查询业务组号
checkin 签入到排队机
checkout 签出排队机
answer 座席端在收到邀请后,调用answer来接听
term 结束通话
checkResult 通知访客业务办理的结果
requestVideo 按设定质量请求频道中指定用户的视频流
applyStatePause 主动发起示忙示闲
enableAudio 开启关闭发送本地音频流
enableVideo 开启关闭发送本地视频流
sendVideoEmptyPack 视频发送空包
sendAudioEmptyPack 音频发送空包
transferCall 转接
getCallState 获取当前通话状态
getGuestParticipant 获取当前的访客成员对象
getSelfParticipant 获取自己对象
getStatistics 获取媒体统计信息
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 把文件绑定到当前的服务
getCallerWaitTime 获取访客呼叫等待时长
setHoldState 保持取回
getHoldState 当前通话是否保持
turnCallType 音视频通话切换
getCallType 获取当前通话类型
sendTextMessage 发送文本消息
requestSign 请求访客签名
ControlRecord 控制远程录制

坐席事件

方法 描述
onGetAllGroups 查询服务动态组号回调
onCheckin 签入结果
onCheckout 签出结果
onCallStateChanged 通话状态改变
onCallQueueCount 排队人数上报
OnApply 示忙示闲的结果
onTransferResult 转接的结果
onNewMemberJoin 通话中有新成员加入
onMemberLeave 通话中有成员离开
onMemberUpdate 成员属性有更新
onCallPropertyChange 通话属性改变
onUrgentRequestRecv 收到加急请求
onUrgentResponseResult 处理加急结果
OnQueryAvailableAgentsListResult 查询空闲座席结果
onMessageReceive 接收频道消息的回调
onCallerWaitTimeNotify 客户呼叫等待时长
onHeldNotify 收到保持取回的通知
onCallTypeTurnedNotify 音视频通话切换通知
onTextMessageRecvNotify 收到文本消息
onSignRequestRecvNotify 收到签名请求

访客管理

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

访客事件

方法 描述
onGetAllGroups 查询服务动态组号回调
onCallStateChanged 通话状态改变
onCallQueueCount 排队人数上报
onNewMemberJoin 通话中有新成员加入
onMemberLeave 通话中有成员离开
onMemberUpdate 成员属性有更新
onCallPropertyChange 通话属性改变
onUrgentResult 坐席处理加急的结果
onCheckVerifyResult 业务是否办理成功
onMessageReceive 接收频道消息的回调
onInviteDeclined 邀请被拒绝
onOfflineResult 离线排队结果
onPassOffline 离线排队过号
onHeldNotify 收到保持取回的通知
onCallTypeTurnedNotify 音视频通话切换通知
onTextMessageRecvNotify 收到文本消息
onSignRequestRecvNotify 收到签名请求

登录管理

方法 描述
create 创建 JCClient 对象
destroy 销毁 JCClient 对象
login 登录 Juphoon Cloud 平台
logout 登出 Juphoon Cloud 平台
getDisplayName 获取昵称
setDisplayName 设置昵称
getUserId 获得用户标识
getState 获取当前状态
setForeground 是否设置为前台
setAppkey 设置appkey
setConfig 设置配置相关参数
getConfig 获取配置相关参数
sendOnlineMessage 发送在线消息

登录事件

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

设备管理

方法 描述
create 创建 JCMediaDevice 对象
destroy 销毁 JCMediaDevice 对象
startCameraVideo 开始自身视频渲染
startVideo 开始其他端的视频渲染
stopVideo 停止视频渲染
isAudioInputStart 内置音频输入是否打开
isAudioOutputStart 音频外放是否打开
startAudioInput 打开设备内置音频采集
stopAudioInput 关闭设备内置音频采集
startAudioOutput 打开设备音频输出
stopAudioOutput 关闭设备音频输出
startAudio 启动音频
stopAudio 停止音频
getAudioRouteType 音频路由类型
enableSpeaker 开启关闭扬声器
startCamer 开启摄像头
stopCamera 关闭摄像头
switchCamera 切换摄像头
specifyCamera 指定要开启的摄像头
specifyCameraAngle 指定摄像头采集角度
getCameraType 获得摄像头类型
setCameraProperty 设置摄像头采集属性
setScreenCaptureProperty 设置屏幕共享采集属性
startVideoFile 开启视频文件作为视频输入源
setVideoFileFrame 逐帧采集视频画面
stopVideoFile 关闭逐帧采集画面
isCameraOpen 摄像头是否已打开
isSpeakerOn 扬声器是否已打开
getCamera 获取当前的摄像头
getCameras 获取摄像头列表
enableScreenOrWindowsAreaCapture 开启/关闭区域采集
enableScreenCapture 开启/关闭屏幕采集
snapshotWithRenderId 截图
startSelfHelpRecord 开始自助双录
attachSelfHelpRecordCaptureSoure 合并其他窗口视频流到录制文件中
detachSelfHelpRecordCaptureSoure 移除其他窗口视频流
stopSelfHelpRecord 停止自助双录
startFileRecordVideo 打开本地录制
stopFileRecord 关闭本地录制
isVideoFileOpen 文件视频源是否已开启
getVideoFileId 获取文件视频源渲染id
getVersion 获取MTC ZMF版本信息

设备事件

事件 描述
onCameraUpdate 摄像头变化
onAudioOutputTypeChange 音频输出变化
onRenderCallback 渲染数据上报
onSnapshotComplete 截图完成
onVideoError 视频渲染错误,包括摄像头采集错误
onInputCallback 实时音频数据
onRenderReceived 收到第一帧数据
onRenderStart 渲染开始
onVideoCaptureDidStart 视频采集开始

多方通话管理

方法 描述
create 创建 JCMediaChannel 对象
destroy 销毁 JCMediaChannel 对象
getChannelUri 获得频道 Uri
getChannelId 获得频道标识
getConfId 获得confid
getPassword 获得频道密码
getChannelNumber 获得频道号
getTitle 返回频道标题
getState 返回当前在频道中的状态
getParticipants 获得所有频道中的成员
getUploadLocalAudio 获取本地音频数据是否在上传
getUploadLocalVideo 获取本地视频数据是否在上传
getAudioOutput 获取音频是否输出
getScreenRenderId 获取屏幕共享渲染标识
getScreenUserId 获取开启屏幕共享的用户标识
isLocalRecording 获取是否本地录制
getRecordState 获取视频录制状态
getCdnState 获得cdn推流状态
setConfig 设置相关配置参数
getConfig 获取相关配置参数
query 查询频道相关信息
join 加入频道
leave 离开频道
stop 关闭频道
enableUploadAudioStream 开启关闭发送本地音频流
enableUploadVideoStream 开启关闭发送本地视频流
enableAudioOutput 开启关闭音频输出
requestVideo 请求频道中其他用户的视频流
requestScreenVideo 请求频道成员屏幕共享的视频流
enableLocalRecord 开关本地会议录制
enableCdn 开关Cdn推流
enableRemoteRecord 开关远程视频录制
enableScreenShare 开关屏幕分享
getParticipant 获取频道成员
getStatistics 获取统计信息
setCustomProperty 设置频道自定义属性
getCustomProperty 获取频道自定义属性
sendMessage 发送消息
sendCommand 发送指令
inviteSipUser 邀请Sip用户
getSpkLevel 获取扬声器音量
getMicLevel 获取麦克风音量
setScreenMode 设置分屏模式
setRatio 设置宽高比
generateRoomId 生成会议号
sendVideoEmptyPack 视频发送空包
sendAudioEmptyPack 音频发送空包

多方通话事件

事件 描述
onMediaChannelStateChange 自身状态变化回调
onMediaChannelPropertyChange 属性变化回调
onJoin 加入频道结果回调
onLeave 离开频道结果回调
onStop 解散频道结果回调
onQuery 查询频道信息结果回调
onParticipantJoin 新成员加入回调
onParticipantLeft 成员离开回调
onParticipantUpdate 成员更新回调
onMessageReceive 接收频道消息的回调
onInviteSipUserResult 邀请Sip用户操作结果回调
onGenerateRoomIdResult 成员声音变化

文件存储管理

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

文件存储事件

事件 描述
onFileUpdate 文件传输结果回调
onFileResult 文件状态更新回调