概览

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

登录登出管理

方法	描述
create	创建 JRTCClient 对象
destroy	销毁 JRTCClient 对象
login	登录 Juphoon RTC 平台
logout	登出 Juphoon RTC 平台
getUserId	获取用户ID
getState	获取当前登录状态
getDisplayName	获取用户昵称
setDisplayName	设置用户昵称
getServer	获取接入服务器地址
setServer	设置接入服务器地址
getAppKey	获取 Appkey
setAppKey	设置 Appkey
getAppName	获取应用名称
setAppName	设置应用名称
sendOnlineMessage	发送在线消息

登录登出事件

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

设备管理

方法	描述
create	创建 JRTCMediaDevice 对象
destroy	销毁 JRTCMediaDevice 对象
getAudioInputs	获取所有音频输入设备列表
getAudioOutputs	获取所有音频输出设备列表
startCameraVideo	开始本端视频渲染
startVideo	开始远端视频渲染
stopVideo	停止视频渲染
stopAllMedia	关闭所有媒体资源，包括远端和本端音视频
startAudioInput	打开音频输入
stopAudioInput	关闭音频输入
startAudioOutput	打开音频输出
stopAudioOutput	关闭音频输出
switchCamera	切换摄像头/切换到指定摄像头
isCameraOpen	摄像头是否打开
getCurrentCamera	获取当前摄像头
getCameras	获取摄像头列表
isAudioStart	音频设备是否打开
setCameraProperty	设置摄像头采集属性

设备事件

事件	描述
onVolumeChanged	媒体音量上报
onCameraUpdate	摄像头变化回调
onAudioInputUpdate	输入音频变化回调

房间管理

方法	描述
create	创建 JRTCRoom 对象
destroy	销毁 JRTCRoom 对象
query	查询房间相关信息
join	加入房间
leave	离开房间
getRoomId	获取房间号
getPassword	获取房间密码
getCallId	获取房间唯一标识（服务器生成
getTitle	取房间标题
getState	获取自己当前在房间中的状态
getParticipants	获取房间中的所有成员
getParticipant	根据用户ID获取房间成员
getUploadLocalAudio	获取本地音频数据是否在上传
getUploadLocalVideo	获取本地视频数据是否在上传
getShareStreamId	获取屏幕共享时的视频流ID
getShareUserId	获取发起屏幕共享者的用户ID
getRemoteRecordState	获得远程视频录制状态
enableUploadAudioStream	开启/关闭发送本地音频流
enableUploadVideoStream	开启/关闭发送本地视频流
requestVideo	订阅房间中其他用户的视频流
unRequestVideo	取消订阅房间中其他用户的视频流
requestScreenVideo	订阅屏幕共享的视频流
unRequestScreenVideo	取消订阅屏幕共享的视频流
enableRemoteRecord	开启/关闭远程录制
sendMessage	发送房间消息，消息内容不能大于4K
setRatio	设置本端视频宽高比

房间事件

事件	描述
onRoomStateChanged	自身在房间中的状态变化回调
onRoomPropertyChanged	房间属性变化回调
onJoin	加入房间结果回调
onLeave	离开房间结果回调
onQuery	查询房间信息结果回调
onParticipantJoin	新成员加入回调
onParticipantLeft	成员离开回调
onParticipantUpdate	成员属性更新回调
onMessageReceived	接收房间消息的回调
onDeliveryAbort	录制异常回调