JRTCSDK-WeChat(多方通话) v2401.0

概览 (opens new window)

• 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) 原因码

登录登出管理 (opens new window)

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

登录登出事件 (opens new window)

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

设备管理 (opens new window)

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

设备事件 (opens new window)

事件	描述
onCameraUpdate (opens new window)	摄像头变化回调
onAudioInputUpdate (opens new window)	输入音频变化回调

房间管理 (opens new window)

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

房间事件 (opens new window)

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