JRTCSDK-iOS  v1.0.9
API文档
概览

登录管理

方法 描述
create 创建 JCClient 对象
destroy 销毁 JCClient 对象
login 登录 Juphoon Cloud 平台
login 登录 Juphoon Cloud 平台
logout 登出 Juphoon Cloud 平台
appKey 设置/获取AppKey
displayName 设置/获取昵称
userId 获得用户标识
server 设置/获取服务器地址
appName 设置/获取应用名称
state 获取当前状态
sendOnlineMessage 发送在线消息

登录事件

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

设备管理

方法 描述
create 创建 JCMediaDevice 对象
destroy 销毁 JCMediaDevice 对象
startCameraVideo 开始自身视频渲染
startCameraVideo 开始自身视频渲染
startVideo 开始其他端的视频渲染
startVideo 开始其他端的视频渲染
stopVideo 停止视频渲染
isAudioOutputStart 音频输出是否打开
isAudioInputStart 内置音频输入是否打开
startAudioInput 打开设备内置音频输出
startAudioOutput 打开设备内置音频输出
stopAudioInput 关闭设备内置音频采集
stopAudioOutput 关闭设备内置音频输出
getAudioOutputType 获得当前音频输出类型
startAudio 启动音频
stopAudio 停止音频
startCamera 开启摄像头
stopCamera 关闭摄像头
switchCamera 切换摄像头
specifyCamera 指定要开启的摄像头
specifyCameraAngle 指定摄像头采集角度
setCameraProperty 设置摄像头采集属性
setScreenCaptureProperty 设置屏幕共享采集属性
getScreenFramerate 设获得当前屏幕共享帧率
startVideoFile 开启视频文件作为视频输入源
setVideoFileFrame 逐帧采集视频画面
setVideoFileFrame 向文件视频源逐帧添加视频数据
stopVideoFile 关闭逐帧采集画面
cameraOpen 摄像头是否已打开
currentCamera 获取当前的摄像头
cameras 获取摄像头列表
defaultCamera 获取默认摄像头
videoFileOpen 文件视频源是否已开启
videoFileId 获取文件视频源渲染id
setVideoAngle 设置视频窗体角度
videoAngle 获取视频窗体角度
isSpeakerOn 扬声器是否已打开
enableSpeaker 开启关闭扬声器
snapshotWithRenderId 截图
startSelfHelpRecord 开始自助双录
stopSelfHelpRecord 停止自助双录
attachSelfHelpRecordCaptureSource 合并其他窗口视频流到录制文件中
detachSelfHelpRecordCaptureSource 从录制文件移除其他窗口视频流
ringPlay 播放铃声
ringStop 停止铃声
getScreenCaptureWindowId 获取屏幕id
audioInterrupt 是否声音被中断
aec 回声消除
setAudioInputCallback 设置音频输入帧回调
setAudioOutputCallback 设置音频输出帧回调

设备事件

事件 描述
onCameraUpdate 摄像头变化
onAudioOutputTypeChange 音频输出类型变化
onRenderReceived 收到第一帧数据
onRenderStart 渲染开始
onVideoError 视频异常
onAudioInerruptAndResume 声音的中断恢复
onSnapshotComplete 截图完成事件
onVideoCaptureDidStart 视频采集开始

涂鸦

方法 描述
create 创建JCDoodle对象
destroy 销毁JCDoodle对象
sendDoodleAction 发送涂鸦数据
clearDoodle 清除涂鸦
unDoDoodle 撤消涂鸦最后一笔

涂鸦事件

事件 描述
onDoodleActionReceived 涂鸦回调

视频会议控制

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

视频会议事件

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