JMSDK Windows  v2.8.0
概览

登录管理

方法 描述
create 创建 JCClient 对象
destroy 销毁 JCClient 对象
login 登录 Juphoon Meeting 平台
reLogin 重登录 Juphoon Meeting 平台
Login 登录 Juphoon Meeting 平台
logout 登出 Juphoon Meeting 平台
setConfig 设置登录相关属性
getConfig 获取设置属性的值
isSelf 是否为自己
addCallback 设置JCClientCallback回调
removeCallback 删除JCClientCallback回调

登录事件

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

设备管理

方法 描述
create 创建 JCMediaDevice 对象
destroy 销毁 JCMediaDevice 对象
startCameraVideo 开始自身视频渲染
startVideo 开始其他端的视频渲染
stopVideo 停止视频渲染
startAudio 启动音频
stopAudio 停止音频
startCamer 开启摄像头
stopCamera 关闭摄像头
switchCamera 切换摄像头
setCameraProperty 设置摄像头采集属性
setScreenCaptureProperty 设置屏幕共享采集属性
enableScreenOrWindowCapture 开启关闭桌面或窗口采集
enableScreenOrWindowCapture2 开启关闭桌面或窗口采集
startVideoFile 开启视频文件作为视频输入源
setVideoFileFrame 逐帧采集视频画面
stopVideoFile 关闭逐帧采集画面

设备事件

事件 描述
onCameraUpdate 摄像头变化
onAudioOutputTypeChange 音频输出设备变化
onAudioInputTypeChange 音频输入设备变化
onRenderReceived 收到第一帧数据
onRenderStart 渲染开始
onDeviceError 设备异常

一对一通话管理

方法 描述
create 创建 JCCall 对象
destroy 销毁 JCCall 对象
call 发起一对一呼叫
term 挂断
answer 接听
mute 静音
hold 呼叫保持
audioRecord 语音通话录音
videoRecord 视频通话录制
becomeActive 切换活跃通话
enableUploadVideoStream 开启关闭视频流发送
sendMessage 通过通话建立的通道发送数据
getStatistics 获得当前通话统计信息
addCallback 添加回调
removeCallback 删除回调

一对一通话事件

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

会议控制

方法 描述
Create 创建 JCConference 对象
DealNotify 创建 JCConference 对象
QueryGoingConf 查询进行中的会议,结果回调 onQueryGoingConfResult
Start 创建并加入一个会议,结果回调 onConferenceJoin
Stop 结束会议,主持人才能调用该接口结束会议,结果回调 onConferenceLeave
Join 加入会议,结果回调 onConferenceJoin
Leave 离开会议,结果回调 onConferenceLeave
Lock 锁定会议 / 解除锁定,主持人才能调用该接口
ChangeChairman 移交主持人,主持人才能调用该接口,结果回调onChangeChairmanResult
Kick 踢出成员,主持人才能调用该接口
Mute 成员静音/解除静音,主持人才能调用该接口
MuteAll 全场静音/解除全场静音,主持人才能调用该接口
Delay 延长预约会议的时长,主持人才能调用该接口
UpdateParticipantExpandInfo 更新成员(自己)扩展信息,会议中的成员会收到 onConferenceParticipantUpdate 回调
FocusParticipant 设置焦点成员,主持人才能调用该接口,界面可以对焦点成员在视频布局中展示
HandUpParticipant 成员举手/取消举手
SetChairman 设置主持人(自己)
ExportParticipantsLog 导出参会成员的信息记录,结果回调 onExportParticipantsLogResult
ChangeParticipantRole 设置会议中的成员角色
SetParticipantRoleEx 设置会议中的成员角色值
EnableUploadAudioStream 开启/关闭音频发送,会议中的成员会收到 onConferenceParticipantUpdate 回调
EnableUploadVideoStream 开启/关闭视频发送,会议中的成员会收到 onConferenceParticipantUpdate 回调
EnableAudioOutput 开启/关闭本端会议音频输出
SubscribeUserAudio 订阅/取消订阅某个成员的音频
SetVideoStream 设置本地发送的视频流,在会议加入成功后调用
RequestVideo 请求用户的视频流
RequestVideo2 请求用户的视频流
RequestScreenVideo 订阅屏幕共享的视频
EnableCdn 开关Cdn推流,内部根据状态决定是否开启
EnableRemoteRecord 开关会议录制(服务端录制)
EnableRemoteB01Record 开关服务器录制,该接口主要针对B01客户双录
QueryRecordList 获取会议录制记录
EnableLocalRecord 开关会议录制(本地录制)
EnableScreenShare 开关桌面共享,会议中的成员会收到回调 onCommandReceivedResult
EnableScreenShare2 开关屏幕共享,会议中的成员会收到回调 onCommandReceivedResult
SetCustomProperty 设置会议自定义属性,会议中的成员会收到回调 onCommandReceivedResult
GetCustomProperty 获取会议自定义属性
SendMessage 发送消息,其他成员会收到回调 onMessageReceive
SendCommand 发送会议指令
GetStatistics 获得统计信息
SetVideoCapture 设置本地视频文件替代摄像头
Invite 邀请成员加入会议,被邀请成员收到 onInviteReceived 回调
InviteEx 邀请成员加入会议,被邀请成员收到 onInviteReceived 回调
InviteSipUser 邀邀请Sip用户,一般用于对接落地网关等
ImportCandidates 设置待加入成员,会议成员收到 onConferenceCandidatesChanged 回调
RejectCandidate 删除待加入成员,会议成员收到 onConferenceCandidatesChanged 回调
InviteToScreenShare 主持人指定人员共享桌面
InviteToSpeak 主持人指定人员发言
RejectToScreenShare 被主持人邀请屏幕共享后,拒绝共享
TransferToAudioConf 转语音会议
IsAudioConf 是否音频会议
StartOrUpdateSubTitle 开启或者变更会议字幕
StopSubTitle 关闭会议字幕
StartDoodle 开启涂鸦
StopDoodle 关闭涂鸦
Reserve 预约会议,结果回调 onReserveResult
CancelReserve 取消预约,结果回调 onCancelReserveResult
EditReserve 更新预约信息,只有创建者才能更新,结果回调 onEditReserveResult
RefreshReservedConf 获取预约会议列表,结果回调 onRefreshReservedConfResult
RefreshReservedConf2 获取预约会议列表,结果回调 onRefreshReservedConfResult
QueryReservedConf 查询预约会议列表,结果回调onQueryConfResult
QuerySingleConf 查询单个预约会议,查询结果回调 onQuerySingleConfResult

会议事件

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

账号管理

方法 描述
create 创建 JCAccount 对象
destroy 销毁 JCAccount 对象
addCallback 添加回调
removeCallback 删除回调
QueryAccount 查询账号是否已被注册,结果通过 onQueryAccount 通知
RequestAuthCode 请求业务验证码,结果通过OnRequestAuthCode通知
RegisterAccount 注册账号,结果通过OnRegister通知
ResetPassword 重置密码,在登录后调用,结果通过OnResetPassword通知
ChangePassword 修改密码,在登录后调用,结果通过 OnChangePassword 通知
FetchPassword 找回密码,结果通过 OnFetchPassword 通知
SetAccountProperty 设置账号自定义属性,结果通过 OnSetAccountProperty 通知
GetAccoutProperty 获取账号自定义属性,结果通过 OnGetAccountProperty 通知

账号事件

事件 描述
OnQueryAccount 账号查询回调
OnRequestAuthCode 请求验证码结果回调
OnRegister 注册结果回调
OnResetPassword 重置密码结果回调
OnChangePassword 修改密码结果回调
OnFetchPassword 找回密码结果回调
OnSetAccountProperty 设置自定义属性回调
OnGetAccountProperty 获取自定义属性回调

涂鸦模块类

方法 描述
Create 创建 JCDoodle 对象
Destroy 销毁 JCDoodle 对象
SendDoodleAction 发送涂鸦数据
ClearDoodle 清除涂鸦
GetDoodleActionList 获取涂鸦数据列表
addCallback 添加回调
removeCallback 删除回调

涂鸦事件

事件 描述
onDoodleReceived 生成涂鸦对象的回调