登录管理

‪方法 ‪描述
create‪创建 JCClient 对象
destroy‪销毁 JCClient 对象
setForeground‪设置是否为前台
getUserId‪获得用户标识
getState‪当前状态
getDisplayName‪昵称
setDisplayName‪设置昵称
login‪登录 Juphoon Meeting 平台
relogin‪重登录 Juphoon Meeting 平台
logout‪登出 Juphoon Meeting 平台
setConfig‪设置配置相关参数
getConfig‪获取配置相关参数
getContext‪获得上下文
addCallback‪设置JCClientCallback回调
removeCallback‪删除JCClientCallback回调

登录事件

‪事件 ‪描述
onLogin‪登录结果回调
onLogout‪登出回调
onClientStateChange‪登录状态变化通知

设备管理

‪方法 ‪描述
create‪创建 JCMediaDevice 对象
destroy‪销毁 JCMediaDevice 对象
isAudioInputStart‪音频输入设备是否打开
isAudioOutputStart‪音频输出设备是否打开
isCameraOpen‪摄像头是否打开
‪getCamera ‪当前默认的摄像头
getCameras‪获取摄像头列表
startCameraVideo‪开始自身视频渲染
startVideo‪开始其他端的视频渲染
stopVideo‪停止视频渲染
startAudio‪启动音频
stopAudio‪停止音频
startAudioInput‪打开音频输入设备
stopAudioInput‪关闭音频输入设备
startAudioOutput‪打开音频输出设备
stopAudioOutput‪关闭音频输出设备
startCamera‪开启摄像头
stopCamera‪关闭摄像头
switchCamera‪切换摄像头
switchCameraBetweenFrontAndBack‪切换摄像头,用于手机前置和后置摄像头的切换
specifyCamera‪指定要开启的摄像头,在 startCamera 之前调用
specifyCameraAngle‪指定摄像头采集角度,为90的倍数
setCameraProperty‪设置摄像头采集属性
setScreenCaptureProperty‪设置屏幕共享采集属性
isSpeakerOn‪扬声器是否已打开
getCameraType‪获得摄像头类型
enableSpeaker‪开启关闭扬声器
isVideoFileOpen‪文件视频源是否已开启
getVideoFileId‪获取文件视频源渲染id
startVideoFile‪开启视频文件作为视频输入源
setVideoFileFrame‪逐帧采集视频画面
stopVideoFile‪关闭逐帧采集画面
getAudioRouteType‪音频路由类型
setVideoAngle‪设置视频窗体角度
getVideoAngle‪获取视频窗体角度

设备事件

‪事件 ‪描述
onCameraUpdate‪摄像头变化
onAudioOutputTypeChange‪音频输出类型变化
onRenderReceived‪收到第一帧数据
onRenderStart‪渲染开始
onDeviceError‪设备异常
onScreenSharePermissionResult‪屏幕共享权限申请结果

一对一通话管理

‪方法 ‪描述
create‪创建 JCCall 对象
destroy‪销毁 JCCall 对象
call‪发起一对一呼叫
term‪挂断
answer‪接听
mute‪静音
hold‪呼叫保持
audioRecord‪语音通话录音
videoRecord‪视频通话录制
becomeActive‪切换活跃通话
enableUploadVideoStream‪开启关闭视频流发送
setConference‪设置会议模式
getConference‪获得音频会议模式
getCallItems‪获得通话对象列表
sendMessage‪通过通话建立的通道发送数据
getStatistics‪获得当前通话统计信息

一对一通话事件

‪事件 ‪描述
onCallItemAdd‪新增通话回调
onCallItemRemove‪移除通话回调
onCallItemUpdate‪通话状态更新回调
onMessageReceive‪通话中收到消息的回调

会议控制

‪方法 ‪描述
create‪创建 JCConference 对象
destroy‪销毁 JCConference 对象
getState‪获得当前状态
getConferenceInfo‪获取 JCConferenceInfo 对象
queryGoingConf‪查询进行中的会议,结果回调 onQueryGoingConfResult
start‪创建并加入一个会议,结果回调 onConferenceJoin
stop‪结束会议,主持人才能调用接口结束会议,结果回调 onConferenceLeave
join‪加入会议,结果回调 onConferenceJoin
leave‪离开会议,当前只支持同时加入一个会议
lock‪锁定会议/解除锁定,只有主持人才能调用改接口
changeChairman‪更改主持人,只有主持人才能调用
kick‪踢出成员,主持人才能调用改接口
mute‪成员静音/解除静音,主持人才能调用改接口
muteAll‪全场静音/解除全场静音
delay‪延时预约会议时长,只有主持人才能调用
updateParticipantExpandInfo‪更新成员(自己)扩展信息,会议中的成员会收到 onConferenceParticipantUpdate 回调
focusParticipant‪设置焦点成员,界面可以对焦点成员在视频布局中展示。设置成功会议中所有成员收到onCommandReceivedResult的回调
handUpParticipant‪成员举手/取消举手
setChairman‪设置主持人(自己)设置成功会议中所有成员会收到onChairmanUpdate的回调
changeParticipantRole‪更改成员的角色
setParticipantRoleEx‪设置会议中的成员角色值
enableUploadAudioStream‪开启关闭发送本地音频流,会议中的成员会收到 onConferenceParticipantUpdate 回调。
enableUploadVideoStream‪开启关闭发送本地视频流,会议中的成员会收到 onConferenceParticipantUpdate 回调
enableAudioOutput‪是否订阅会议音频流,关闭订阅将无法听到会议中其他成员的声音
subscribeUserAudio‪订阅/取消订阅某个成员的音频,取消订阅时不会播放该成员的声音
setVideoStream‪设置本地发送的视频流,在会议加入成功后调用
handUpParticipant‪请求用户的视频流
requestScreenVideo‪请求屏幕共享的视频流
enableScreenShare‪开关屏幕共享
enableCdn‪开关Cdn推流,内部根据状态决定是否开启
enableLocalRecord‪开关会议录制(本地录制),内部根据状态决定是否开启
handUpParticipant‪开关服务器视频录制
‪enableRemoteB01Record ‪开关服务器录制,该接口主要针对B01客户双录
‪queryRecordList ‪获取会议录制记录
getStatistics‪获得统计信息
sendMessage‪发送消息,其他成员会收到回调 onMessageReceive
sendCommand‪发送会议指令
setCustomProperty‪设置会议自定义属性
getCustomProperty‪获取会议自定义属性
invite‪邀请成员加入
inviteEx‪邀请成员加入会议,JCConferenceInviteInfo.expandInfo 可携带自定义信息并发送给被邀请人
importCandidates‪设置待加入成员,设置结果回调 onImportCandidatesResult。设置成功后会议的所有成员收到回调onConferenceCandidatesChanged
rejectCandidate‪移除待加入成员,该成员是自己,调用后会议的所有成员收到回调 onConferenceCandidatesChanged
reserve‪预约会议
cancelReserve‪取消预约会议
editReserve‪更新预约会议信息,只有创建者才能更新
refreshReservedConf‪获取预约会议列表,结果回调 onRefreshConfListResult
‪refreshReservedConf2 ‪获取预约会议列表,结果回调 onRefreshReservedConfResult
queryReservedConf‪查询预约会议列表,结果回调 onQueryConfResult
inviteSipUser‪邀请Sip用户,一般用于对接落地网关等 onConferenceCandidatesChanged
querySingleConf‪查询单个预约会议,结果回调onQuerySingConfResult
inviteToScreenShare‪主持人指定人员共享桌面
rejectToScreenShare‪被主持人邀请屏幕共享,拒绝共享
inviteToSpeak‪主持人指定人员发言
transferToAudioConf‪转语音会议
isAudioConf‪是否音频会议
startOrUpdateSubTitle‪开启或者变更会议字幕
stopSubTitle‪关闭会议字幕
startDoodle‪开启涂鸦
stopDoodle‪关闭涂鸦

会议事件

‪事件 ‪描述
onConferenceStateChange‪状态变化回调
onQueryGoingConfResult‪查询进行中的会议结果
onConferenceJoin‪加入会议结果回调
onConferenceLeave‪离开会议结果回调
onConferenceParticipantJoin‪成员加入会议回调
onConferenceParticipantLeft‪成员离开会议回调
onConferenceParticipantUpdate‪查询会议信息结果回调
onConferenceCandidatesChanged‪待加入成员列表变化回调
onImportCandidatesResult‪设置待加入成员结果回调
onInviteResult‪邀请结果回调
onInviteReceived‪收到会议邀请回调
onCommandReceivedResult‪收到会议属性变化或会议其他通知
onLockResult‪锁定/解锁会议结果回调
onChangeChairmanResult‪更改主持人结果回调
onUpdateParticipantExpandInfoResult‪更新成员扩展信息结果回调
onDelayResult‪会议延长结果回调
onMessageReceive‪收到其他成员发送的消息
onReserveResult‪预约会议结果回调
onCancelReserveResult‪取消预约会议的结果回调
onEditReserveResult‪编辑预约会议的结果回调
onReserveConfStart‪预约会议开始回调
onRefreshReservedConfResult‪获取预约会议列表回调
onQueryReservedConfResult‪查询预约会议结果
oonQuerySingleConfResult‪查询单个预约会议结果
onInviteSipUserResult‪邀请Sip用户操作结果回调,成功后会触发 onParticipantJoin
‪onQueryRecordListResult ‪查询录制列表结果回调
onChairmanUpdate‪设置主持人操作结果回调,成功后会触发 onChairmanUpdate 回调
onConferenceParticipantVolumeChanged‪成员音量变化回调
onConferenceParticipantNetChanged‪成员网络变化回调
onInviteToScreenShare‪收到邀请屏幕共享通知
onRejectToScreenShare‪收到拒绝屏幕共享
onInviteToSpeak‪收到邀请发言通知
onTransferToAudioConf‪通知转为音频会议
onSubTitleStartOrUpdate‪收到会议字幕开启或者变更通知
onSubTitleStop‪收到会议字幕关闭通知
onDoodleStart‪涂鸦开启通知
onDoodleStop‪涂鸦关闭通知

账号查询

‪方法 ‪描述
create‪创建 JCAccount 对象
destroy‪销毁 JCAccount 对象
addCallback‪添加JCAccountCallback回调
removeCallback‪删除JCAccountCallback回调
queryAccount‪查询账号是否已被注册,结果通过 onQueryAccount 通知
requestAuthCode‪请求业务验证码,结果通过 onRequestAuthCode 通知
registerAccount‪注册账号,结果通过 onRegister 通知
resetPassword‪重置密码,在登录后调用,结果通过 onResetPassword 通知
changePassword‪修改密码,在登录后调用,结果通过 onChangePassword 通知
fetchPassword‪找回密码,结果通过 onFetchPassword 通知
setAccountProperty‪设置账号自定义属性,结果通过 onSetAccountProperty 通知
getAccountProperty‪获取账号自定义属性,结果通过 onGetAccountProperty 通知

账号事件

‪事件 ‪描述
onQueryUserStatusResult‪查询账号状态结果回调
onQueryAccount‪账号查询回调
onRequestAuthCode‪请求验证码结果回调
onRegister‪注册结果回调
onResetPassword‪重置密码结果回调
onChangePassword‪修改密码结果回调
onFetchPassword‪找回密码结果回调
onSetAccountProperty‪设置自定义属性回调
onGetAccountProperty‪获取自定义属性回调

涂鸦

‪方法 ‪描述
create‪创建 JCDoodle 对象
destroy‪销毁 JCDoodle 对象
sendDoodleAction‪发送涂鸦数据
clearDoodle‪清除涂鸦
addCallback‪设置JCDoodleCallback回调
removeCallback‪删除JCDoodleCallback回调

涂鸦事件

‪事件 ‪描述
onDoodleReceived‪涂鸦回调