登录管理

方法 描述
Create创建 JCClient 对象
Destroy销毁 JCClient 对象
Login登录 Juphoon Cloud 平台
Login登录 Juphoon Cloud 平台
Logout登出 Juphoon Cloud 平台
SetAppkey 设置Appkey
DisplayName设置/获取昵称
UserId获得用户标识
IsSelf是否为自己
State获取当前状态
SetConfig设置登录相关属性
GetConfig获取登录相关属性
SendOnlineMessage发送在线消息

登录事件

事件 描述
OnLogin登录结果回调
OnLogout登出回调
OnClientStateChange登录状态变化通知
OnOnlineMessageSendResult在线消息发送结果通知
OnOnlineMessageReceive收到在线消息通知

视频客服座席管理

方法 描述
Create创建 JCAgent 对象
Destroy销毁 JCAgent 对象
QueryAllGroups查询业务组号
OperatorState坐席签入状态
Checkin签入
Checkout签出
CallState通话状态
Answer接听
TermState获取结束通话状态
Term结束通话
ApplyStatePause发起示忙示闲
EnableVideo 开启关闭发送视频流
EnableAudio 开启关闭发送音频流
SendVideoEmptyPack 视频发送空包
SendAudioEmptyPack 音频发送空包
SetRatio 设置视频本地宽高比
SetScreenMode 设置分屏模式
QueryAvailableAgents 查询空闲座席
TransferCall转接
InviteMember邀请其他座席
CheckResult通知访客服务的结果
ResponseUrgent应答加急请求
EnableDesktopOrWindowShare屏幕/窗口共享
RequestSize设置/获取视频请求质量
RequestVideo按设定质量请求成员视频画面
EnableLocalRecord开关本地通话录制
EnableRemoteRecord开关远程视频通话录制
SendMessage透明通道发送全员消息
SendMessage透明通道发送消息给某个成员
InsertStorageRecord把文件绑定到当前的服务
SerialNumber获取服务唯一标识
Statistics获取媒体统计信息
ExtraStr获取来电额外参数
GetSpkLevel获取扬声器音量
GetMicLevel获取麦克风音量
getShareRenderId屏幕共享时的渲染id
ShareUserId屏幕共享时的共享成员id
SetHoldState保持取回
GetHoldState通话是否保持
TurnCallType音视频通话切换
GetCallType当前通话类型
SendTextMessage发送文本消息
GuestParticipant访客成员对象
Participants当前通话中的所有成员对象
requestSign请求访客签名
SetPictureInPictureLayout设置画中画布局
WatermarkSetLibPath动态加载水印sdk
WatermarkSetPicture设置水印图片
WatermarkSetText设置水印文字
WatermarkSetTimestamp设置水印时间戳
WatermarkSetState设置水印状态
ControlRecord控制远程录制

视频客服座席事件

事件 描述
OnGetAllGroups查询服务动态组号回调
OnCheckin签入结果
OnCheckout签出结果
OnCallStateChanged通话状态改变
OnCallQueryWaitCount排队人数上报
OnApply示忙示闲的结果
OnTransferResult转接的结果
OnCallPropertyChange通话属性改变
OnNewMemberJoin通话中新成员加入
OnMemberLeave通话中有成员离开
OnMemberUpdate成员属性有更新
OnUrgentRequestRecv收到加急请求
OnUrgentResponseResult处理加急结果
OnQueryAvailableAgentsListResult查询空闲座席结果
OnMessageReceive接收消息的回调
OnCallerWaitTimeNotify客户呼叫等待时长
OnHeldNotify收到保持取回的通知
OnCallTypeTurnedNotify音视频通话切换通知
OnTextMessageRecvNotify收到文本消息的通知

访客管理

方法 描述
Create创建 JCGuest 对象
Destroy销毁 JCGuest 对象
QueryAllGroups查询业务组号
CallState通话状态
Call发起呼叫
OneToOneCall呼叫到指定坐席
Term结束通话
EnableVideo 开启关闭发送视频流
EnableAudio 开启关闭发送音频流
SendVideoEmptyPack 视频发送空包
SendAudioEmptyPack 音频发送空包
SetRatio 设置视频本地宽高比
SetScreenMode 设置分屏模式
RequestVideo按设置的尺寸请求指定成员的视频画面
RequestUrgent请求加急
RequestSize设置/获取视频请求质量
EnableLocalRecord开关本地通话录制
EnableRemoteRecord开关远程视频通话录制
SendMessage透明通道发送全员消息
SendMessage透明通道发送消息给某个成员
InsertStorageRecord把文件绑定到当前的服务
SerialNumber获取服务唯一标识
Statistics获取媒体统计信息
GetSpkLevel获取扬声器音量
GetMicLevel获取麦克风音量
ShareRenderId屏幕共享时的渲染id
ShareUserId屏幕共享时的共享成员id
GetHoldState通话是否保持
TurnCallType音视频通话切换
GetCallType当前通话类型
SendTextMessage发送文本消息
Participants当前通话中的所有成员对象
AgentParticipant坐席成员对象
SetPictureInPictureLayout设置画中画布局
WatermarkSetLibPath动态加载水印sdk
WatermarkSetPicture设置水印图片
WatermarkSetText设置水印文字
WatermarkSetTimestamp设置水印时间戳
WatermarkSetState设置水印状态

访客事件

事件 描述
OnGetAllGroups查询服务动态组号回调
OnCallStateChanged通话状态改变
OnCallQueueCount当前排队人数
OnCallPropertyChange通话属性改变
OnNewMemberJoin通话中新成员加入
OnMemberLeave通话中有成员离开
OnMemberUpdate成员属性有更新
OnUrgentResult收到加急的结果
OnCheckVerifyResult业务办理结果
OnMessageReceive接收消息的回调
OnInviteDeclined邀请被拒绝
OnSignRequestRecvNotify收到签名请求
OnHeldNotify收到保持取回的通知
OnCallTypeTurnedNotify音视频通话切换通知
OnTextMessageRecvNotify收到文本消息的通知
OnRemotePathResult远程控制path回调

设备管理

方法 描述
Create创建 JCMediaDevice 对象
Destroy销毁 JCMediaDevice 对象
StartCameraVideo开始自身视频渲染
StartVideo开始其他端的视频渲染
StopVideo停止视频渲染
AudioInputDevices音频输入设备列表
AudioOutputDevices音频输出设备列表
AudioInputs获取当前音频输入设备
AudioOutput获取当前音频输出设备
StartInput打开输入设备
StopInput关闭输入设备
StartOutput打开输出设备
StopOutput关闭输出设备
StartAudio启动音频
StopAudio停止音频
StartSelfHelpRecord开始自助双录
AttachSelfHelpRecordCaptureSource将新一路视频流合并到录制文件
DetachSelfHelpRecordCaptureSource解除录制中的一路视频
StopSelfHelpRecord解除录制中的一路视频
StartCamera开启摄像头
EnableLoopback操作loopback采集
StopCamera关闭摄像头
SwitchCamera切换摄像头
SetCameraProperty设置摄像头采集属性
SetScreenCaptureProperty设置屏幕共享采集属性
EnableScreenOrWindowCapture开启关闭桌面或窗口采集
EnableScreenOrWindowsAreaCapture开启关闭区域共享
SnapshotWithRenderId截图
StartVideoFile开启视频文件作为视频输入源
SetVideoFileFrame逐帧采集视频画面
StopVideoFile关闭逐帧采集画面
CameraOpen摄像头是否已打开
Camera获取当前的摄像头
Cameras当前打开的摄像头列表
CameraDevices摄像头列表
VideoFileOpen是否在采集视频文件
VideoFileId共享视频文件时的captureId
GetVersionSDK版本信息
StartFileRecordVideo开启本地录制
StopFileRecord关闭本地录制
WindowsDevices窗口列表
DesktopDevices桌面列表
DefaultInput默认输入设备
DefaultOutput默认输出设备

设备事件

事件 描述
OnCameraUpdate摄像头变化
OnAudioOutputTypeChange音频输出设备变化
OnSnapshotComplete截图完成
OnVideoError视频渲染错误
OnEventHandler其他媒体事件
OnRenderReceived收到第一帧数据
OnRenderStart渲染开始
OnVideoCaptureDidStart视频采集开始

媒体频道模块

方法 描述
Create创建 JCMediaChannel 对象
Destroy销毁 JCMediaChannel 对象
ChannelUri获得频道 Uri
ChannelId获得频道标识
ConfId获得confId
Password获得频道密码
ChannelNumber获得频道号
Title返回频道标题
GetState返回当前在频道中的状态
GetParticipants获得所有频道中的成员
GetParticipant根据用户标识获取频道内成员
UploadLocalAudio获取本地音频数据是否在上传
UploadLocalVideo获取本地视频数据是否在上传
ScreenRenderId获取屏幕共享渲染标识
ScreenUserId获取开启屏幕共享的用户标识
RecordState获取视频录制状态
CdnState获得cdn推流状态
Query查询频道相关信息
Join加入频道
Leave离开频道
Stop关闭频道
EnableUploadAudioStream开启关闭发送本地音频流
EnableUploadVideoStream开启关闭发送本地视频流
EnableAudioOutput开启关闭音频输出
RequestVideo请求频道中其他用户的视频流
RequestScreenVideo请求频道成员屏幕共享的视频流
EnableCdn开关Cdn推流
LocalRecording本地录制
EnableLocalRecord开关本地会议录制
EnableRemoteRecord开关远程视频录制
EnableScreenOrWindowShare开关屏幕分享
GetStatistics获取统计信息
SetCustomProperty设置频道自定义属性
GetCustomProperty获取频道自定义属性
SendMessage发送消息
SendCommand发送指令
InviteSipUser邀请Sip用户
SetConfig设置相关配置参数
GetConfig获取相关配置参数
SetPictureLayout设置画中画布局
SetVideoCapture设置本地视频文件替代摄像头
SetRatio设置比率
GetSpkLevel获取扬声器音量
GetMicLevel获取麦克风音量
GenerateRoomId获取会议号
SendVideoEmptyPack视频发送空包
SendAudioEmptyPack音频发送空包
WatermarkSetLibPath动态加载水印sdk
WatermarkSetPicture设置水印图片
WatermarkSetText设置水印文字
WatermarkSetTimestamp设置水印时间戳
WatermarkSetState设置水印状态
DeliveryUriCD URI
selfParticipant获得自身 JCMediaChannelParticipant 对象

媒体频道模块事件

事件 描述
OnMediaChannelStateChange自身状态变化回调
OnMediaChannelPropertyChange属性变化回调
OnJoin加入频道结果回调
OnLeave离开频道结果回调
OnStop解散频道结果回调
OnQuery查询频道信息结果回调
OnParticipantJoin新成员加入回调
OnParticipantLeft成员离开回调
OnParticipantUpdate成员更新回调
OnMessageReceive接收频道消息的回调
OnInviteSipUserResult邀请Sip用户操作结果回调
OnGenerateRoomIdResult获取会议号结果

文件存储管理

方法 描述
Create创建 JCStorage 对象
Destroy销毁 JCStorage 对象
UploadFile上传文件
DownloadFile下载文件

文件存储事件

事件 描述
OnFileUpdate文件传输结果回调
0nFileResult文件状态更新回调