概览

• JRTCClient 用于初始化 SDK 以及登录登出 Juphoon RTC 平台
• JRTCClientCallback 用于回调登录登出相关事件
• JRTCMediaDevice 用于管理媒体设备
• JRTCMediaDeviceCallback 用于回调媒体设备相关事件
• JRTCRoom 用于管理房间通话
• JRTCRoomCallback 用于回调房间通话相关事件
• 事件码 包含错误码
• ReasonCode 原因码

登录登出管理

方法	描述
create	创建 JRTCClient 对象
destroy	销毁 JRTCClient 对象
setForeground	设置是否为前台
getUserId	获取用户ID
getState	获取当前登录状态
getDisplayName	获取用户昵称
setDisplayName	设置用户昵称
getServer	获取接入服务器地址
setServer	设置接入服务器地址
getAppKey	获取 AppKey
setAppKey	设置 AppKey
getAppName	获取应用名称
setAppName	设置应用名称
login	登录 Juphoon RTC 平台
reLogin	重登录 Juphoon RTC 平台
logout	登出 Juphoon RTC 平台
sendOnlineMessage	发送在线消息
getUploadUrl	获取文件上传路径
createP2PSession	创建 P2P 会话
requestFileUploadInfo	获取文件上传或断点续传信息
completeFileUpload	文件上传完成确认
getUploadFileInfo	获取上传文件信息列表

登录登出事件

事件	描述
onLogin	登录结果回调
onLogout	登出回调
onClientStateChange	登录状态变化通知
onOnlineMessageSendResult	在线消息发送结果回调
onOnlineMessageReceived	收到在线消息回调
onGetUploadUrlResponse	获取文件上传地址等信息回调
onSDKEvent	上报事件回调
onP2PSessionCreate	P2P 会话创建结果
onP2PSessionConnect	P2P 会话连接
onP2PSessionClose	P2P 会话关闭
onP2PMessageReceived	收到 P2P 会话消息
onRequestFileUploadInfoResponse	获取文件上传或断点续传信息响应
onCompleteFileUploadResponse	文件上传完成确认响应
onGetUploadFileInfoResponse	获取上传文件信息列表响应
onFileUploadPlatformNotify	文件上传到影像平台结果通知

设备管理

方法	描述
create	创建 JRTCMediaDevice 对象
destroy	销毁 JRTCMediaDevice 对象
isCameraOpen	摄像头是否打开
isSpeakerOn	扬声器是否已打开
getCurrentCamera	获取当前摄像头
getCameras	获取摄像头列表
startCameraVideo	开始本端视频渲染
startVideo	开始远端视频渲染
stopVideo	停止视频渲染
isAudioInputStart	音频输入是否打开
isAudioOutputStart	音频输出是否打开
startAudio	启动音频
stopAudio	停止音频
startAudioInput	打开音频输入
stopAudioInput	关闭音频输入
startAudioOutput	打开音频输出
stopAudioOutput	关闭音频输出
startCamera	开启摄像头
stopCamera	关闭摄像头
switchCamera	切换摄像头
switchCameraBetweenFrontAndBack	切换摄像头
specifyCamera	指定要开启的摄像头
specifyCameraAngle	指定摄像头采集角度
setCameraProperty	设置摄像头采集属性
setScreenCaptureProperty	设置屏幕共享采集属性
getCameraType	获取摄像头类型
enableSpeaker	开启/关闭扬声器
changeAudioOutput	切换音频输出通道
getBluetoothName	获取连接的蓝牙名称
isVideoFileOpen	是否开启文件视频源
getVideoFileId	获取文件视频源ID
startVideoFile	开启视频文件作为视频输入源
setVideoFileFrame	逐帧采集视频画面
stopVideoFile	关闭视频文件作为视频输入源
getAudioRouteType	获得当前音频输出通道类型
setVideoAngle	设置视频窗体角度
getVideoAngle	获取视频窗体角度
startVideoCaptureRecord	开启视频录制
stopVideoCaptureRecord	关闭视频录制
startAudioRecord	开启音频录制
stopAudioRecord	关闭音频录制
getScreenCaptureId	获取屏幕共享采集ID
enableScreenCapture	开启/关闭屏幕采集
stopAllVideos	停止所有视频渲染
snapshotWithStreamID	截图
setAudioInputFrameCallback	设置音频输入帧回调
setVideoCaptureFrameCallback	设置视频采集帧数据回调
startAudioTest	检测音频设备是否正常
stopAudioTest	停止检测音频设备
getMicLevel	获取当前本地音量级别
getSpkLevel	获取当前扬声器音量级别
getAnrNoiseLevel	获取当前噪声强度
getAnrNoiseRatio	获取当前信噪比强度
startRing	开始播放音频
stopRing	结束播放音频
setAec	设置开启自适应回声消除
setAgc	设置是否开启自动增益控制

设备事件

事件	描述
onAudioError	音频异常回调
onAudioRouteTypeChanged	音频输出通道变化回调
onCameraUpdate	摄像头变化回调
onVideoCaptureDidStart	视频采集开始回调
onRenderStart	渲染开始回调
onRenderReceived	收到第一帧数据回调
onRenderResized	数据宽高比例变化回调
onScreenSharePermissionResult	屏幕共享权限申请结果回调
onVideoError	视频设备异常回调
onSnapshotComplete	截图完成回调
onMemoryAvailable	上报剩余可用内存回调
onRingPlayFinish	音频播放完成

多方通话管理

方法	描述
create	创建 JRTCRoom 对象
destroy	销毁 JRTCRoom 对象
getRoomId	获取房间号
getPassword	获取房间密码
getCallId	获取房间唯一标识（服务器生成）
getTitle	获取房间标题
getState	获取自己当前在房间中的状态
getParticipants	获取房间中的所有成员
getUploadLocalAudio	获取本地音频数据是否在上传
getUploadLocalVideo	获取本地视频数据是否在上传
getAudioOutput	获取音频是否输出
getShareStreamId	获取屏幕共享时的视频流ID，无屏幕共享时为 null
getShareUserId	获取发起屏幕共享者的用户ID，无屏幕共享时为 null
isLocalRecording	获取是否正在本地录制
getRemoteRecordState	获取远程视频录制状态
getCDNState	获取CDN推流状态
setNotifyVolumeChange	设置是否上报音量变化，音量变化会比较频繁，默认为 true，不需要则设置为 false
isNotifyVolumeChange	获取是否上报音量变化
getSupportVideoSizes	获取房间支持的视频分辨率列表
setUseExternalScreenCaptureControl}	设置是否由应用层自行控制屏幕采集逻辑，默认 false
query	查询房间相关信息
join	加入房间
leave	离开房间
enableUploadAudioStream	开启/关闭发送本地音频流
enableUploadVideoStream	开启/关闭发送本地视频流
enableAudioOutput	开启/关闭音频输出
requestVideo	订阅通话中其他用户的视频流
unRequestVideo	取消订阅房间中其他用户的视频流
requestScreenVideo	订阅通话中屏幕共享的视频流
unRequestScreenVideo	取消订阅通话中屏幕共享的视频流
enableLocalRecord	开启/关闭本地录制
updateLocalRecordLayout	更新本地录制自定义布局
enableCdn	开启/关闭Cdn推流
enableRemoteRecord	开启/关闭远程录制
enableScreenShare	开启/关闭屏幕共享
suspendScreenShare	暂停/继续屏幕共享
isSuspendScreenShare	是否屏幕共享暂停
enableAudioInputFromFile	开始/结束本地文件音频源输入
suspendAudioInputFromFile	暂停/继续本地文件音频源输入
getParticipant	根据用户标识获取房间成员
getStatistics	获取统计信息
getJsonStats	获取天赛实时统计信息
setCustomProperty	设置房间自定义属性
getCustomProperty	获取房间自定义属性
sendMessage	发送房间消息，消息内容不能大于4K
inviteSipUser	邀请Sip用户，一般用于对接落地网关等
setRatio	设置本端视频宽高比
sendAudioEmptyPack	发送音频空包
sendVideoEmptyPack	发送视频空包
setVideoDot	视频打点
enableMicAgc	开启或关闭本地麦克风的增益（软件增益）,默认开启

多方通话事件

事件	描述
onRoomStateChanged	自身在房间中的状态变化回调
onRoomPropertyChanged	房间属性变化回调
onJoin	加入房间结果回调
onLeave	离开房间结果回调
onQuery	查询房间信息结果回调
onParticipantJoin	成员加入回调
onParticipantLeft	成员离开回调
onParticipantUpdate	成员更新回调
onMessageReceived	接收房间消息的回调
onInviteSipUserResult	邀请Sip用户结果回调
onDeliveryAbort	录制异常回调
onFileAudioInputFinish	本地文件音频源输入完成回调
onEnableRemoteAdvancedRecordResult	开启远程录制（增强录制）结果回调