程序包 rtc

类 Room

java.lang.Object
rtc.Room
public class Room extends Object
房间接口类 房间接口定义了房间对象创建和释放、房间功能操作。

  • 方法详细资料

    • obtain

      public static Room obtain(String aroomId)
      获取或创建房间接口
      返回:
      返回房间接口指针。

    • destoryRoom

      public static void destoryRoom(Room room)
      释放房间接口

    • setListener

      public int setListener(Room.Listener listener)
      设置房间回调接口
      返回:
      返回错误代码。
      另请参阅:

    • join

      public int join(User user, String password, Room.JoinResultListener joinresult)
      加入房间
      参数:
      user - 用户信息：用户Id，用户名，用户数据等；当应用层不传入user.deviceId时，SDK将创建一个新的guid作为user.deviceId，同时返回给应用层。
      password - 密码：如果是主持人请用主持人密码；如果是其他参会者，请用房间密码。
      joinresult - 加房间回调接口
      返回:
      返回错误代码。

    • join

      public int join(User user, String password, Room.JoinResultListener joinresult, String roomToken)
      加入房间
      参数:
      user - 用户信息：用户Id，用户名，用户数据等；当应用层不传入user.deviceId时，SDK将创建一个新的guid作为user.deviceId，同时返回给应用层。
      password - 密码：如果是主持人请用主持人密码；如果是其他参会者，请用房间密码。
      joinresult - 加房间回调接口
      roomToken - token
      返回:
      返回错误代码。

    • leave

      public int leave(int reason)
      当前用户离开房间
      返回:
      返回错误代码。

    • close

      public int close()
      关闭房间
      返回:
      返回错误代码。

    • reJoin

      public int reJoin()
      重新加入当前房间
      返回:
      返回错误代码。

    • kickoutUser

      public int kickoutUser(int reason, String userId)
      房间中踢出用户ro
      返回:
      返回错误代码。

    • isWorking

      public boolean isWorking()
      房间是否已正常工作（是否已连接到信令服务器）
      返回:

    • updateRoomStatus

      public int updateRoomStatus(RoomInfo.RoomStatus status)
      更新房间状态
      返回:
      返回错误代码。

    • getRoomStatus

      public RoomInfo.RoomStatus getRoomStatus()
      获取房间状态
      返回:
      返回房间状态。

    • getRoomId

      public String getRoomId()
      获取房间Id
      返回:
      返回房间Id。

    • getAppRoomId

      public String getAppRoomId()
      获取房间应用层Id
      返回:
      返回房间应用层Id。

    • getRoomName

      public String getRoomName()
      获取房间名
      返回:
      返回房间名。

    • getRoomTopic

      public String getRoomTopic()
      获取房间主题
      返回:
      返回房间主题。

    • getRoomInfo

      public RoomInfo getRoomInfo()
      获取房间信息
      返回:
      返回房间信息。

    • sendPublicData

      public int sendPublicData(byte[] data, int len)
      透明通道，发送广播数据
      返回:
      返回错误代码。

    • sendPrivateData

      public int sendPrivateData(byte[] data, int len, String toId)
      透明通道，发送私有数据
      返回:
      返回错误代码。

    • getAppData

      public String getAppData(String key)
      返回应用层的房间数据
      返回:
      返回应用层的相应关键字的房间数据。

    • updateAppData

      public int updateAppData(String key, String value)
      修改应用层的房间数据
      返回:
      返回错误代码。

    • enableStats

      public int enableStats(boolean isEnable)
      当前房间启用或关闭流量统计功能
      返回:
      返回错误代码： AVD_OK 成功

    • getRoomStats

      public NetworkStats.RoomStats getRoomStats()
      获取房间的流量统计信息
      返回:
      返回房间流量统计信息。

    • getMediaStats

      public NetworkStats.MediaStats getMediaStats(String deviceId)
      获取某路媒体（音频或者视频）的流量统计信息
      返回:
      返回媒体统计信息。

    • getAudioStats

      public NetworkStats.MediaStats getAudioStats()
      获取媒体统计信息
      返回:

    • setOption

      public int setOption(Room.Option type, String svalue)
      配置房间选项
      参数:
      type - 选项
      svalue - 配置的值
      返回:

    • getOption

      public String getOption(Room.Option type)
      获取房间选项
      返回:
      返回房间选项值。

    • createFakeDeviceID

      public String createFakeDeviceID(String fakeId)
      创建模拟设备Id，在导入音视频时可用
      返回:
      模拟设备Id。

    • obtain2

      @Deprecated public int obtain2(String roomId, boolean isCheckEngine)
      已过时。

    • joinEfficient

      @Deprecated public int joinEfficient(String url, String accessKey, String secretKey, User user, String password)
      已过时。

    • joinEfficient2

      @Deprecated public int joinEfficient2(String url, String token, User user, String password)
      已过时。