# 概览
- JRTCClient (opens new window) 用于初始化 SDK 以及登录 Juphoon RTC 平台
- JRTCClientCallback (opens new window) 用于回调登录登出相关事件
- JRTCMediaDevice (opens new window) 用于管理媒体设备
- JRTCMediaDeviceCallback (opens new window) 用于回调媒体设备相关事件
- JRTCRecord (opens new window) 用于新上传服务和切片录制等录制功能
- JRTCRecordCallback (opens new window) 用于新上传服务和切片录制等录制功能相关事件
- JRTCRoom (opens new window) 用于管理多方通话
- JRTCRoomCallback (opens new window) 用于回调多方通话相关事件
- 事件码 (opens new window) 包含错误码
- ReasonCode (opens new window) 原因码
# 登录登出管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCClient (opens new window) 实例 |
destroy | 销毁 JRTCClient (opens new window) 对象 |
getUserId | 获得用户ID |
getState | 获取当前登录状态 |
getDisplayName | 获取用户昵称 |
setDisplayName | 设置用户昵称 |
getServer | 获取接入服务器地址 |
setServer | 设置接入服务器地址 |
getAppKey | 获取 AppKey |
setAppKey | 设置 AppKey |
getAppName | 获取应用名称 |
setAppName | 设置应用名称 |
login | 登录 Juphoon RTC 平台 |
login | 登录 Juphoon RTC 平台 |
reLogin | 重登录 Juphoon RTC 平台 |
logout | 登出 Juphoon RTC 平台 |
sendOnlineMessage | 发送在线消息 |
createP2PSession | 创建 P2P 会话 |
getUploadUrl | 获取文件上传路径 |
requestFileUploadInfo | 获取文件上传路径 |
completeFileUpload | 文件上传完成确认 |
getUploadFileInfo | 获取上传文件信息列表 |
# 登录登出事件
| 事件 | 描述 |
|---|---|
onLogin | 登录结果回调 |
onLogout | 登出回调 |
onClientStateChanged | 登录状态变化通知 |
onOnlineMessageSendResult | 在线消息发送结果通知 |
onOnlineMessageReceived | 收到在线消息通知 |
onSDKEvent | 上报事件回调 |
onP2PSessionCreate | P2P 会话创建结果 |
onP2PSessionConnect | P2P 会话连接 |
onP2PSessionClose | P2P 会话关闭 |
onP2PMessageReceived | 收到 P2P 会话消息 |
onGetUploadUrlResponse | 获取文件上传地址等信息回调 |
onRequestFileUploadInfoResponse | 获取文件上传或断点续传信息响应 |
onCompleteFileUploadResponse | 文件上传完成确认响应 |
onGetUploadFileInfoResponse | 获取上传文件信息列表响应 |
onFileUploadPlatformNotify | 文件上传到影像平台结果通知 |
# 设备管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCMediaDevice (opens new window) 对象 |
destroy | 销毁 JRTCMediaDevice (opens new window) 对象 |
getOpenedAudioOutput | 获取使用中的音频输出设备 |
getOpenedAudioInputs | 获取使用中的音频输入设备列表 |
getAudioInputs | 获取所有音频输入设备列表 |
getAudioOutputs | 获取所有音频输出设备列表 |
setDefaultAudioInput | 设置默认音频输入设备 |
getDefaultAudioInput | 获取默认音频输入设备 |
setDefaultAudioOutput | 设置默认音频输出设备 |
getDefaultAudioOutput | 获取默认音频输出设备 |
startAudio | 启动音频 |
isAudioStart | 音频设备是否打开 |
stopAudio | 停止音频 |
startAudioInput | 打开音频输入设备 |
stopAudioInput | 关闭音频输入设备 |
stopAllAudioInputs | 关闭当前所有打开的音频输入设备 |
startAudioOutput | 打开音频输出设备 |
stopAudioOutput | 关闭当前打开的音频输出设备 |
enableLoopback | 开启/关闭 loopback 音频采集 |
loginIPCamera | 第三方网络摄像头登录 |
logoutIPCamera | 第三方网络摄像头登出 |
getCameras | 获取摄像头列表 |
getOpenedCameras | 获取当前打开的摄像头列表 |
getWindows | 获取当前窗口列表 |
getDesktops | 获取当前桌面列表 |
getBeautyEffectParam | 获取当前美颜设置参数 |
startCameraVideo | 开始本端视频渲染 |
startCameraVideo | 开始本端视频渲染 |
startVideo | 开始其他端的视频渲染 |
startVideo | 开始其他端的视频渲染 |
stopVideo | 停止视频渲染 |
stopAllVideo | 停止所有视频渲染 |
startCamera | 开启指定摄像头 |
isCameraOpen | 摄像头是否已打开 |
stopCamera | 关闭指定摄像头 |
stopAllCameras | 关闭当前打开的所有摄像头 |
switchCamera | 切换摄像头 |
setCameraProperty | 设置摄像头采集属性 |
setCameraWatermarkList | 设置摄像头采集数据水印信息 |
isVideoFileOpen | 是否开启文件视频源 |
getVideoFileId | 获取文件视频流ID |
startVideoFile | 开启视频文件作为视频输入源 |
setVideoFileFrame | 逐帧采集视频画面 |
stopVideoFile | 关闭逐帧采集画面 |
setScreenCaptureProperty | 设置屏幕共享采集属性 |
enableScreenOrWindowCapture | 开启/关闭屏幕采集 |
enableScreenOrWindowAreaCapture | 开启/关闭屏幕区域采集 |
snapshotWithStreamId | 截图 |
snapshotWithStreamId | 截图 |
setAudioInputFrameCallback | 设置音频输入帧回调 |
setVideoCaptureFrameCallback | 设置视频采集帧数据回调 |
setScreenCaptureData | 设置屏幕采集数据为指定图片数据 |
resetScreenCaptureData | 重置屏幕采集数据 |
setVideoAngle | 设置视频窗体角度 |
getVideoAngle | 获取视频窗体角度 |
videoRecordEncodeTest | 当前设备视频录制编码性能测试 |
startVideoCaptureRecord | 开启视频录制 |
startVideoCaptureRecord | 开启视频录制 |
stopVideoCaptureRecord | 关闭视频录制 |
startAudioRecord | 开启音频录制 |
stopAudioRecord | 关闭音频录制 |
recoveryRecordFile | 恢复录制文件 |
enableVirtualBacklot | 开启/关闭虚拟背景墙 |
startAudioTest | 检测音频设备是否正常 |
stopAudioTest | 停止检测音频设备 |
getMicLevel | 获取当前本地音量级别 |
getSpkLevel | 获取当前扬声器音量级别 |
getAnrNoiseLevel | 获取当前噪声强度 |
getAnrNoiseRatio | 获取当前信噪比强度 |
controlBeautyEffect | 开启/关闭摄像头美颜功能 |
controlBeautyFilter | 设置摄像头滤镜 |
startRing | 开始播放音频 |
stopRing | 结束播放音频 |
enableAudioInputFromFile | 开始/结束播放本地音频文件作为音频源输入 |
suspendAudioInputFromFile | 暂停/继续播放语音文件作为音频源输入 |
setAec | 设置开启自适应回声消除 |
setAgc | 设置是否开启自动增益控制 |
# 设备事件
| 事件 | 描述 |
|---|---|
onAudioOutputDeviceChanged | 当前音频输出设备切换回调 |
onAudioInputDeviceChanged | 当前音频输入设备切换回调 |
onAudioInputVolumeChanged | 音频输入音量变化通知 |
onAudioInputDeviceStateChanged | 音频输入设备状态变化通知 |
onAudioError | 音频异常回调 |
onCameraUpdate | 摄像头变化 |
onVideoCaptureDidStart | 视频采集开始回调 |
onRenderReceived | 收到第一帧数据回调 |
onRenderStart | 渲染开始回调 |
onRenderResized | 数据宽高比例变化回调 |
onVideoError | 视频异常，渲染错误，包括摄像头采集错误、屏幕采集错误等回调 |
onVideoError | 视频异常，渲染错误，包括摄像头采集错误、屏幕采集错误等回调 |
onIPCameraChange | 第三方网路摄像头状态变化通知 |
onSnapshotComplete | 截图完成回调 |
onMemoryAvailable | 上报剩余可用内存回调 |
onEventHandler | 其他媒体事件回调 |
onRingPlayFinish | 音频播放完成回调 |
onFileAudioInputDidFinish | 本地文件音频源输入完成回调 |
onVideoRecordEncodeTestResult | 当前设备视频录制编码性能测试结果回调 |
onVideoCaptureRecordEnd | 本地视频录制完成通知 |
onVideoCaptureRecordFileSlice | 分片录制文件录制完成回调 |
onVideoCaptureRecordError | 视频录制异常回调 |
onTessarEvent | 天赛事件上报，包含警告和错误事件 |
# 录制模块管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCRecord (opens new window) 对象 |
destroy | 销毁 JRTCRecord (opens new window) 对象 |
startVideoCaptureRecord | 开启视频录制（本地录制，不需要建立通信） |
stopVideoCaptureRecord | 关闭视频录制（本地录制，不需要建立通信，不能和音频同时录制） |
mergeRecordFile | 合并录制文件（用于合并分片录制的文件） |
requestSliceUploadInfo | 请求分片录制文件上传信息，包括上传URL、token等 |
completeSliceUpload | 完成分片录制文件上传 |
reportRecordUploadEvent | 录制上传事件上报 |
# 录制模块事件
| 事件 | 描述 |
|---|---|
onVideoCaptureRecordEnd | 本地视频录制完成通知 |
onVideoCaptureRecordFileSlice | 分片录制文件录制完成回调 |
onVideoCaptureRecordError | 视频录制异常回调 |
onRequestSliceUploadInfoResponse | 请求分片录制文件上传信息响应 |
onCompleteSliceUploadResponse | 完成分片录制文件上传响应 |
# 多方通话管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCRoom (opens new window) 对象 |
destroy | 销毁 JRTCRoom (opens new window) 对象 |
getRoomId | 获取房间号 |
getDeliveryUserUri | 获取虚拟成员CD用户Uri |
getPassword | 获取房间密码 |
getSerialId | 获取业务流水号 |
getCallId | 获取房间唯一标识（服务器生成） |
getTitle | 获取房间标题 |
getState | 获取自己当前在房间中的状态 |
getParticipants | 获取房间中的所有成员 |
getUploadLocalAudio | 获取本地音频数据是否在上传 |
getUploadLocalVideo | 获取本地视频数据是否在上传 |
getAudioOutput | 获取音频是否输出 |
getShareStreamId | 获取屏幕共享时的视频流ID |
getShareUserId | 获取发起屏幕共享者的用户ID |
isLocalRecording | 获取是否正在本地录制 |
getRemoteRecordState | 获取远程视频录制状态 |
getCDNState | 获得CDN推流状态 |
setUseExternalScreenCaptureControl | 设置是否由应用层自行控制屏幕采集逻辑 |
setNotifyVolumeChange | 设置是否上报音量变化 |
isNotifyVolumeChange | 获取是否上报音量变化 |
getSupportVideoSizes | 获取房间支持的视频分辨率列表 |
query | 查询房间相关信息 |
join | 加入房间 |
leave | 离开房间 |
stop | 解散房间 |
kickUser | 把成员踢出房间 |
enableUploadAudioStream | 开启/关闭发送本地音频流 |
enableUploadVideoStream | 开启/关闭发送本地视频流 |
enableAudioOutput | 开启/关闭音频输出 |
requestVideo | 订阅房间中其他用户的视频流 |
unRequestVideo | 取消订阅房间中其他用户的视频流 |
requestScreenVideo | 订阅屏幕共享的视频流 |
unRequestScreenVideo | 取消订阅屏幕共享的视频流 |
enableLocalRecord | 开启/关闭本地录制 |
updateLocalRecordLayout | 更新本地录制自定义布局 |
enableCdn | 开启/关闭CDN推流 |
enableRemoteRecord | 开启/关闭远程录制 |
updateRemoteRecordLayout | 更新远程录制自定义布局 |
updateRemoteRecordWatermark | 更新远程录制水印信息 |
enableRemoteAdvancedRecord | 开启远程录制 |
enableScreenOrWindowShare | 开启/关闭屏幕共享 |
enableScreenOrWindowShare | 开启/关闭区域共享 |
suspendScreenShare | 暂停/继续屏幕共享 |
isSuspendScreenShare | 是否屏幕共享暂停 |
enableAudioInputFromFile | 开启/结束播放本地音频文件作为音频源输入 |
suspendAudioInputFromFile | 暂停/继续播放语音文件 |
getParticipant | 根据用户ID获取房间成员 |
getStatistics | 获取统计信息 |
getJsonStats | 获取实时统计信息 |
setCustomProperty | 设置房间属性 |
getCustomProperty | 获取房间属性 |
sendMessage | 发送房间消息 |
inviteSipUser | 邀请Sip用户 |
setRatio | 设置本端视频宽高比 |
sendAudioEmptyPack | 发送音频空包 |
sendVideoEmptyPack | 发送视频空包 |
setVideoDot | 视频打点 |
inviteRecordAgentToOtherRoom | 邀请录制虚拟成员进入其他房间 |
enableMicAgc | 开启或关闭本地麦克风的增益（软件增益） |
setSubScreenShare | 设置是否订阅屏幕共享 |
isSubScreenShare | 获取是否订阅屏幕共享 |
# 多方通话事件
| 事件 | 描述 |
|---|---|
onRoomStateChanged | 自身在房间中的状态变化回调 |
onRoomPropertyChanged | 房间属性变化回调 |
onJoin | 加入房间结果回调 |
onLeave | 离开房间结果回调 |
onKickUserResult | 踢出成员结果回调 |
onStop | 解散房间结果回调 |
onQuery | 查询房间信息结果回调 |
onParticipantJoin | 新成员加入回调 |
onParticipantLeft | 成员离开回调 |
onParticipantUpdate | 成员属性更新回调 |
onMessageReceived | 接收房间消息的回调 |
onInviteSipUserResult | 邀请Sip用户结果回调 |
onDeliveryAbort | 录制异常回调 |
onFileAudioInputFinish | 本地文件音频源输入完成回调 |
onEnableRemoteAdvancedRecordResult | 开启远程录制（增强录制）结果回调 |