# 概览
- JRTCClient (opens new window) 用于初始化SDK以及登录 Juphoon RTC 平台
- JRTCClientCallback (opens new window) 用于回调登录登出相关事件
- JRTCMediaDevice (opens new window) 用于管理媒体设备
- JRTCMediaDeviceCallback (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) 对象 |
appKey | 设置/获取 AppKey |
displayName | 设置/获取用户昵称 |
userId | 获取用户ID |
server | 设置/获取接入服务器地址 |
appName | 设置/获取应用名称 |
state | 获取当前登录状态 |
login | 登录 Juphoon RTC 平台 |
login | 登录 Juphoon RTC 平台 |
relogin | 重登录 Juphoon RTC 平台 |
logout | 登出 Juphoon RTC 平台 |
setForeground | 设置是否是前台 |
sendOnlineMessage | 发送在线消息 |
createP2PSession | 创建 P2P 会话 |
getUploadUrl | 获取文件上传路径 |
requestFileUploadInfo | 获取文件上传或断点续传信息 |
completeFileUpload | 文件上传完成确认 |
# 登录登出事件
| 事件 | 描述 |
|---|---|
onLogin | 登录结果回调 |
onLogout | 登出回调 |
onClientStateChanged | 登录状态变化通知 |
onOnlineMessageSendResult | 在线消息发送结果通知 |
onOnlineMessageReceive | 收到在线消息通知 |
onGetUploadUrlResponse | 获取文件上传地址等信息回调 |
onSDKEvent | 上报事件回调 |
onP2PSessionCreate | P2P 会话创建回调 |
onP2PSessionConnect | P2P 会话连接回调 |
onP2PSessionClose | P2P 会话关闭回调 |
onP2PMessageReceived | P2P 会话消息回调 |
onRequestFileUploadInfoResponse | 获取文件上传或断点续传信息响应 |
onCompleteFileUploadResponse | 文件上传完成确认响应 |
# 设备管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCMediaDevice (opens new window) 对象 |
destroy | 销毁 JRTCMediaDevice (opens new window) 对象 |
startCameraVideo | 开始本端视频渲染 |
startCameraVideo | 开始本端视频渲染 |
startVideo | 开始远端视频渲染 |
startVideo | 开始远端视频渲染 |
stopVideo | 停止视频渲染 |
stopAllVideos | 停止所有视频渲染 |
isAudioOutputStart | 音频输出是否打开 |
isAudioInputStart | 音频输入是否打开 |
startAudioInput | 打开设备音频输入 |
startAudioOutput | 打开设备音频输出 |
stopAudioInput | 关闭设备音频输入 |
stopAudioOutput | 关闭设备音频输出 |
startAudio | 启动音频 |
stopAudio | 停止音频 |
startCamera | 开启摄像头 |
stopCamera | 关闭摄像头 |
switchCamera | 切换摄像头 |
switchCamera | 切换到指定摄像头 |
specifyCamera | 指定要开启的摄像头 |
specifyCameraAngle | 指定摄像头采集角度 |
setCameraProperty | 设置摄像头采集属性 |
setScreenCaptureProperty | 设置屏幕共享采集属性 |
getScreenFramerate | 获取当前屏幕共享帧率 |
startVideoFile | 开启视频文件作为视频输入源 |
stopVideoFile | 关闭视频文件作为视频输入源 |
setVideoFileFrame | 逐帧采集视频画面 |
setVideoFileFrame | 向文件视频源逐帧添加视频数据 |
startVideoCaptureRecord | 开启视频录制 |
stopVideoCaptureRecord | 关闭视频录制 |
startAudioRecord | 开启音频录制 |
stopAudioRecord | 停止音频录制 |
snapshotWithStreamId | 截图 |
cameraOpen | 摄像头是否已打开 |
currentCamera | 获取当前摄像头 |
cameras | 获取摄像头列表 |
defaultCamera | 获取默认摄像头 |
videoFileOpen | 文件视频源是否已开启 |
audioParam | 音频参数 |
videoFileId | 获取文件视频源渲染ID |
setVideoAngle | 设置视频窗体角度 |
videoAngle | 获取视频窗体角度 |
defaultSpeakerOn | 是否默认开启扬声器 |
isSpeakerOn | 扬声器是否已打开 |
enableSpeaker | 开启关闭扬声器 |
enableScreenCapture | 开启关闭屏幕采集 |
getScreenCaptureId | 获取屏幕采集视频流ID |
getAudioRouteType | 获取当前音频输出通道类型 |
audioInterrupt | 是否声音被中断 |
aec | 回声消除 |
getSpkLevel | 获取当前扬声器音量级别 |
getMicLevel | 获取当前本地音量级别 |
setAudioInputFrameCallback | 设置音频输入帧回调 |
setVideoCaptureFrameCallback | 设置音频输入帧回调 |
startAudioTest | 检测音频设备是否正常 |
stopAudioTest | 停止检测音频设备 |
startRing | 开始播放音频 |
stopRing | 结束播放音频 |
getAnrNoiseLevel | 获取当前噪声强度 |
getAnrNoiseRatio | 获取当前信噪比强度 |
setScreenCaptureData | 设置屏幕采集数据 |
resetScreenCaptureData | 重置屏幕采集数据 |
setAec | 设置开启自适应回声消除 |
setAgc | 设置是否开启自动增益控制 |
recoveryRecordFile | 恢复录制文件 |
# 设备事件
| 事件 | 描述 |
|---|---|
onAudioError | 音频异常回调 |
onVideoError | 视频异常回调 |
onVideoError | 视频异常回调 |
onAudioRouteTypeChanged | 音频输出通道变化回调 |
onCameraUpdate | 摄像头变化回调 |
onRenderReceived | 收到第一帧数据回调 |
onRenderResized | 数据宽高比例变化回调 |
onRenderStart | 渲染开始回调 |
onMemoryAvailable | 上报剩余可用内存回调 |
onAudioInerruptAndResume | 声音中断恢复回调 |
onSnapshotComplete | 截图完成回调 |
onVideoCaptureDidStart | 视频采集开始回调 |
onScreenCaptureStart | 屏幕采集开始回调 |
onScreenCaptureStop | 屏幕采集结束回调 |
onRingPlayFinish | 音频播放完成回调 |
# 多方通话管理
| 方法 | 描述 |
|---|---|
create | 创建 JRTCRoom (opens new window) 对象 |
destroy | 销毁 JRTCRoom (opens new window) 对象 |
roomId | 获取房间号 |
roomHandle | 本地房间句柄 |
password | 获取房间密码 |
callId | 获取房间唯一标识 |
title | 获取房间标题 |
state | 获取自己当前在房间中的状态 |
participants | 获取房间中的所有成员 |
uploadLocalAudio | 获取本地音频数据是否在上传 |
uploadLocalVideo | 获取本地视频数据是否在上传 |
audioOutput | 是否音频输出 |
shareStreamId | 获取屏幕共享的视频流ID |
shareUserId | 获取发起屏幕共享者的用户ID |
localRecording | 是否正在本地录制 |
remoteRecordState | 获取远程视频录制状态 |
cdnState | 获取cdn推流状态 |
canBindCamera | 是否可以绑定摄像头发送流 |
notifyVolumeChange | 设置是否上报音量变化 |
getSupportVideoSizes | 获取房间支持的视频分辨率列表 |
query | 查询房间相关信息 |
join | 加入房间 |
leave | 离开房间 |
enableUploadAudioStream | 开启关闭发送本地音频流 |
enableUploadVideoStream | 开启关闭发送本地视频流 |
enableAudioOutput | 开启关闭音频输出 |
requestVideo | 订阅通话中其他成员的视频流 |
unRequestVideo | 取消订阅通话中其他成员的视频流 |
requestScreenVideo | 订阅通话中屏幕共享的视频流 |
unRequestScreenVideo | 取消订阅通话中屏幕共享的视频流 |
enableCdn | 开关cdn推流 |
enableRemoteRecord | 开启关闭远程录制 |
updateRemoteRecordLayout | 更新远程录制自定义布局 |
updateRemoteRecordWatermark | 更新远程录制水印信息 |
enableLocalRecord | 开关本地录制 |
updateLocalRecordLayout | 更新本地录制自定义布局 |
getParticipant | 根据用户Id获取房间成员 |
getStatistics | 获取统计信息 |
getJsonStats | 获取天赛实时统计信息 |
setCustomProperty | 设置房间自定义属性 |
getCustomProperty | 获取房间自定义属性 |
sendMessage | 发送消息 |
inviteSipUser | 邀请Sip用户 |
setRatio | 设置视频宽高比 |
enableScreenShare | 开启关闭屏幕共享 |
suspendScreenShare | 暂停继续屏幕共享 |
isSuspendScreenShare | 是否屏幕共享暂停 |
setSubScreenShare | 设置订阅屏幕共享属性 |
isSubScreenShare | 获取是否订阅屏幕共享属性 |
sendVideoEmptyPack | 视频发送空包 |
sendAudioEmptyPack | 音频发送空包 |
setVideoDot | 视频打点 |
enableAudioInputFromFile | 开始结束本地文件音频源输入 |
suspendAudioInputFromFile | 暂停继续本地文件音频源输入 |
enableMicAgc | 开启或关闭本地麦克风的增益 |
# 多方通话事件
| 事件 | 描述 |
|---|---|
onRoomStateChanged | 自身在房间中的状态变化回调 |
onRoomPropertyChanged | 房间属性变化回调 |
onJoin | 加入房间结果回调 |
onLeave | 离开房间结果回调 |
onQuery | 查询房间信息结果回调 |
onParticipantJoin | 新成员加入回调 |
onParticipantLeft | 成员离开回调 |
onParticipantUpdate | 成员属性更新回调 |
onMessageReceived | 接收房间消息的回调 |
onInviteSipUserResult | 邀请Sip用户操作结果回调 |
onDeliveryAbort | 录制异常回调 |
onFileAudioInputFinish | 本地文件音频源输入完成回调 |
onEnableRemoteAdvancedRecordResult | 开启远程录制（增强录制）结果回调 |