Package com.qiniu.rtc.service

Class RoomService

java.lang.Object

com.qiniu.rtc.service.AbstractService

com.qiniu.rtc.service.RoomService

public class RoomService
extends AbstractService

房间相关处理的api

Field Summary

Fields inherited from class com.qiniu.rtc.service.AbstractService

JSON_MIME

Constructor Summary

Constructors

Constructor	Description
RoomService(Auth auth)	初始化

Method Summary

Modifier and Type	Method	Description
Response	createRoom(java.lang.String appId, RoomParam roomParam)	创建房间
Response	deleteRoom(java.lang.String appId, java.lang.String roomName)	删除房间
java.lang.String	getRoomToken(RoomAccess access)	获取房间TOKEN
Response	kickUser(java.lang.String appId, java.lang.String roomName, java.lang.String userId)	踢出房间内的某个用户
Response	listActiveRoom(java.lang.String appId, java.lang.String roomNamePrefix, UrlParam urlParam)	获取当前所有活跃的房间
Response	listUser(java.lang.String appId, java.lang.String roomName)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoomService

public RoomService(Auth auth)

初始化

Parameters:

auth - auth

Method Detail

createRoom

public Response createRoom(java.lang.String appId,
                           RoomParam roomParam)
                    throws QiniuException

创建房间

Parameters:

appId - appId

roomParam - roomParam

Returns:

Response

Throws:

QiniuException - 异常

deleteRoom

public Response deleteRoom(java.lang.String appId,
                           java.lang.String roomName)
                    throws QiniuException

删除房间

Parameters:

appId - appId

roomName - roomName

Returns:

Response

Throws:

QiniuException - 异常

listUser

public Response listUser(java.lang.String appId,
                         java.lang.String roomName)
                  throws QiniuException

Parameters:

appId - 房间所属帐号的 app

roomName - 操作所查询的连麦房间

Returns:

Response 如果不读取Response的数据，请注意调用Close方法关闭

Throws:

QiniuException - 异常

kickUser

public Response kickUser(java.lang.String appId,
                         java.lang.String roomName,
                         java.lang.String userId)
                  throws QiniuException

踢出房间内的某个用户

Parameters:

appId - appId

roomName - roomName

userId - userId

Returns:

Response

Throws:

QiniuException - 异常

listActiveRoom

public Response listActiveRoom(java.lang.String appId,
                               java.lang.String roomNamePrefix,
                               UrlParam urlParam)
                        throws QiniuException

获取当前所有活跃的房间

Parameters:

appId - appId

roomNamePrefix - roomNamePrefix

urlParam - 分页参数

Returns:

Response

Throws:

QiniuException - 异常

getRoomToken

public java.lang.String getRoomToken(RoomAccess access)
                              throws java.lang.Exception

获取房间TOKEN

Parameters:

access - access

Returns:

roomToken 房间token

Throws:

java.lang.Exception - 未知异常