房间管理类
房间管理类（Room）
Room.js 是SDK主要的接口类文件，其中定义了房间调用相关的主要接口。以下是该类中定义的属性和方法。
实例化
1 | |
初始化设置
| 接口名称 | 接口功能 |
|---|---|
| init | 初始化Room对象 |
| uninit | 重置Room对象到未初始化状态 |
| checkInit | 检测房间的初始化状态 |
进出房间和房间信息
| 接口名称 | 接口功能 |
|---|---|
| joinroom | 进入普通房间，房间需要在后台创建后才能进入 |
| joinRoomEx | 进入即时房间，房间无需在后台创建 |
| leaveRoom | 离开房间 |
| getRoomProperties | 获取房间相关属性 |
用户信息
| 接口名称 | 接口功能 |
|---|---|
| getMySelf | 获取自己的用户对象 |
| getUser | 获取指定用户对象 |
| getUsers | 获取房间中所有用户对象 |
| getUsersByProperty | 获取拥有指定属性的用户对象 |
| getRoomUsers | 获取房间的用户列表 (大规模房间) |
| getRoomUserNum | 获取房间的用户总数 (大规模房间) |
| getUserList | 获取房间的用户列表 |
信令和修改属性
| 接口名称 | 接口功能 |
|---|---|
| sendMessage | 发送聊天消息 |
| pubMsg | 发布自定义信令消息 |
| delMsg | 删除发布的自定义信令消息 |
| evictUser | 将用户请出房间 |
| changeUserProperty | 修改用户属性 |
| batchChangeUserProperty | 批量改变用户属性 |
| changeUserPropertyByRole | 改变指定角色的用户属性 |
发布和播放音视频
| 接口名称 | 接口功能 |
|---|---|
| publishVideo | 发布本地视频 |
| unpublishVideo | 停止发布本地视频 |
| publishAudio | 发布本地音频 |
| unpublishAudio | 停止发布本地音频 |
| playVideo | 播放视频 |
| playAudio | 播放音频 |
| unplayVideo | 停止播放视频 |
| unplayAudio | 停止播放音频 |
| muteAllRemoteAudio | 暂停/恢复播放所有远端用户的音频流 |
设置本地音视频属性
| 接口名称 | 接口功能 |
|---|---|
| getDeviceMgr | 获取本地设备管理类对象 |
| setLocalVideoMirror | 设置本地视频的镜像 |
| getVideoProfile | 获取视频属性 |
| setVideoProfile | 设置我的视频采集和发布分辨率 |
| setRemoteAudioVolume | 设置远程音频流的音量 |
| getAudioVolume | 获取音量级别 |
| registerAudioVolumeListener | 注册音量监听器 |
| unregisterAudioVolumeListener | 移除音量监听器 |
| disableVideoDevice | 是否禁用本地摄像头 |
| setAutoProcessDeviceChangeEvent | 设置是否自动处理设备改变（插拔）事件 |
分享和播放桌面共享流
| 接口名称 | 接口功能 |
|---|---|
| startShareScreen | 开始桌面共享 |
| stopShareScreen | 停止桌面共享 |
| playRemoteScreen | 播放桌面共享音视频流 |
| unplayRemoteScreen | 停止播放桌面共享音视频流 |
分享和播放媒体流
| 接口名称 | 接口功能 |
|---|---|
| startShareMedia | 开始共享媒体文件 |
| stopShareMedia | 停止共享媒体文件 |
| pauseShareMedia | 暂停/播放媒体文件 |
| seekMedia | seek媒体文件 |
| playRemoteMedia | 播放共享媒体 |
| unplayRemoteMedia | 取消播放共享媒体 |
| playRemoteMediaFile | 播放远端共享的媒体文件 |
| unplayRemoteMediaFile | 取消播放远端共享的媒体文件 |
| startPlayAudioFile | 播放音频文件链接 |
| stopPlayAudioFile | 取消播放音频文件链接 |
房间状态
| 接口名称 | 接口功能 |
|---|---|
| switchOnlyAudioRoom | 切换房间音视频状态 |
服务器录制和本地录制
| 接口名称 | 接口功能 |
|---|---|
| startServerRecord | 开启服务器录制课程 |
| stopServerRecord | 停止服务器录制课程 |
| pauseServerRecord | 暂停服务器录制课程 |
| resumeServerRecord | 恢复服务器录制课程 |
