• 文档首页

房间接口

Room 模块可通过 RongRTC 获取

new Room(option)

option 对象说明:

参数	类型	必填	默认值	说明	最低版本
id	string	是		房间 Id，长度 64 个字符，可包含：A-Z、a-z、0-9、+、=、-、_	3.0.4
joined	function	是		加入房间后，有人加入通知事件	3.0.4
left	function	是		加入房间后，有人离开通知事件	3.0.4

事件返回参数 user 说明:

属性	类型	说明	最低版本
id	string	成员 Id，区分当前加入、离开成员	3.0.4

示例:

var room = new Room({
  id: 'roomId',
  joined: function(user){
    // user.id 加入房间
  },
  left: function(user){
    // user.id 离开房间
  }
});

room.join(user)

room 实例获取方式，参考 Room 实例化

加入房间, 每个 RongRTC 实例只允许加入 一个 房间

user 参数说明:

参数	类型	必填	说明	最低版本
id	string	是	当前成员 Id	3.0.4

示例:

var user = {
  id: 'djdka1901'
};
room.join(user).then(function() {
  console.log('join successfully');
}, function(error) {
  console.log(error);
});

room.leave()

room 实例获取方式，参考 Room 实例化

离开房间，退出后将不能再与其他成员进行音视频通话

room.leave().then(function() {
  console.log('leave successfully');
}, function(error) {
  console.log(error);
});

room.get()

room 实例获取方式，参考 Room 实例化

获取房间基本信息

room.get().then(function(room) {
  console.log(room);
}, function(error) {
  console.log(error);
});

返回值 room 说明:

属性	类型	说明	最低版本
id	string	房间 Id	3.0.4
total	number	房间存在人数（发布资源 + 未发布资源）	3.0.4
--	--	包含调用 Storage 自定义的属性	3.0.4