登录管理

方法 描述
create创建 JCClient 对象
destroy销毁 JCClient 对象
login登录 Juphoon Cloud 平台
logout登出 Juphoon Cloud 平台
appkey 获取Appkey
displayName设置/获取昵称
userId获得用户标识
state获取当前状态
createParam获取创建参数
loginParam获取登录参数
sendOnlineMessage发送在线消息

登录事件

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

设备管理

方法 描述
create创建 JCMediaDevice 对象
destroy销毁 JCMediaDevice 对象
startCameraVideo开始自身视频渲染
startVideo开始其他端的视频渲染
stopVideo停止视频渲染
audioStart音频是否已打开
startAudio启动音频
stopAudio停止音频
startCamer开启摄像头
stopCamera关闭摄像头
switchCamera切换摄像头
switchCamera2切换摄像头(指定摄像头)
setCameraProperty设置摄像头采集属性
setScreenCaptureProperty设置屏幕共享采集属性
startVideoFile开启视频文件作为视频输入源
setVideoFileFrame逐帧采集视频画面
stopVideoFile关闭逐帧采集画面
cameraOpen摄像头是否已打开
camera获取当前的摄像头
cameras获取摄像头列表
videoFileOpen文件视频源是否已开启
videoFileId获取文件视频源渲染id
videoAngle设置/获取视频窗体角度
isSpeakerOn扬声器是否已打开
enableSpeaker开启关闭扬声器
getAudioRouteType获得当前音频类型

设备事件

事件 描述
onCameraUpdate摄像头变化
onAudioOutputTypeChange音频输出类型变化
onRenderReceived收到第一帧数据
onRenderStart渲染开始

一对一通话管理

方法 描述
create创建 JCCall 对象
destroy销毁 JCCall 对象
call发起一对一呼叫
term挂断
answer接听
mute静音
hold呼叫保持
audioRecord语音通话录音
videoRecord视频通话录制
becomeActive切换活跃通话
enableUploadVideoStream开启关闭视频流发送
callItems获得通话对象列表
getActiveCallItem获得当前活跃的通话
sendMessage通过通话建立的通道发送数据
getStatistics获得当前通话统计信息
mediaConfig更新/获取媒体参数
sendDtmf发送DTMF信息

一对一通话事件

事件 描述
onCallItemAdd新增通话回调
onCallItemRemove移除通话回调
onCallItemUpdate通话状态更新回调
onMessageReceive通话中收到消息的回调
onMissedCallItem上报服务器拉取的未接来电
onDtmfReceived通话中收到DTMF回调

多方通话管理

方法 描述
create创建 JCMediaChannel 对象
destroy销毁 JCMediaChannel 对象
channelUri获得频道 Uri
channelId获得频道标识
confId获得confId
password获得频道密码
channelNumber获得频道号
title返回频道标题
state返回当前在频道中的状态
participants获得所有频道中的成员
uploadLocalAudio获取本地音频数据是否在上传
uploadLocalVideo获取本地视频数据是否在上传
audioOutput获取音频是否输出
screenRenderId获取屏幕共享渲染标识
screenUserId获取开启屏幕共享的用户标识
recordState获取视频录制状态
cdnState获得cdn推流状态
query查询频道相关信息
join加入频道
leave离开频道
stop关闭频道
enableUploadAudioStream开启关闭发送本地音频流
enableUploadVideoStream开启关闭发送本地视频流
enableAudioOutput开启关闭音频输出
requestVideo请求频道中其他用户的视频流
requestScreenVideo请求频道成员屏幕共享的视频流
enableCdn开关Cdn推流
enableRecord开关视频录制
enableScreenShare开关屏幕分享
getParticipant获取频道成员
getStatistics获取统计信息
customProperty设置/获取频道自定义属性
sendMessage发送消息
sendCommand发送指令
inviteSipUser邀请Sip用户
setCustomRole设置自定义角色
getCustomRole获得自定义角色
setCustomState设置自定义状态
getCustomState获得自定义状态
kick将成员踢出会议
sendCommandToDelivery发送命令给推流或录制器
enableSelfVideoRatio设置自身视频宽高比
startScreenShareVideo启动频道成员的屏幕分享视频渲染
stopScreenShareVideo停止屏幕分享视频渲染
selfParticipant获得自身 JCMediaChannelParticipant 对象

多方通话事件

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

账号管理

方法 描述
create创建 JCAccount 对象
destroy销毁 JCAccount 对象
queryUserStatus查询账号状态
queryServerUid查询账号 uid
queryUserId查询账号 userId
refreshContacts查询所有的联系人
dealContact操作联系人
setDnd设置免打扰

账号事件

事件 描述
onQueryUserStatusResult查询账号状态结果回调
onQueryServerUidResult查询账号 ServerUid 结果回调
onQueryUserIdResult查询账号 UserId 结果回调
onRefreshContacts查询网络联系人列表结果回调
onDealContact处理联系人结果回调
onContactsChange服务器联系人变化回调
onSetContactDnd设置免打扰回调

文件存储管理

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

文件存储事件

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

群组管理

方法 描述
create创建 JCGroup 对象
destroy销毁 JCGroup 对象
fetchGroups获取当前用户加入的群列表
fetchGroupInfo刷新群组信息
createGroup创建群
updateGroup更新群
dissolve解散群组
leave离开群组
dealMembers操作成员
updateGroupComment更新群备注信息
setDnd设置免打扰

群组事件

事件 描述
onFetchGroups拉取群列表结果回调
onFetchGroupInfo拉取群详情结果回调
onGroupListChange群列表更新
onGroupInfoChange群信息更新
onCreateGroup创建群回调
onUpdateGroup更新群信息调用回调
onDissolve解散群组回调
onLeave离开群组回调
onDealMembers操作成员结果回调
onUpdateGroupComment更新备注信息结果回调
onSetGroupDnd设置免打扰回调

消息通道管理

方法 描述
create创建 JCMessageChannel 对象
destroy销毁 JCMessageChannel 对象
sendMessage发送文本消息
sendFile发送文件消息
refreshConversation获取消息会话
fetchMessages获取历史消息
markReadMessage标志消息为已读
markRecvMessage标志消息为已收
withdrawalMessage撤回消息

消息通道事件

事件 描述
onMessageSendUpdate消息发送状态更新回调
onMessageRecv收到消息回调
onRefreshConversation刷新消息结果回调
onFetchMessageResult拉取消息结果回调
onMarkReadResult标志消息已读结果回调
onMarkRecvResult标志消息已收结果回调
onReceiveMarkRecv对方已收消息回执回调
onReceiveMarkRead对方已读消息回执回调
onMessageListRecv拉取历史消息回调
onWithdrawalMessageResult撤回消息结果回调