Package com.qiniu.rtc

Class QRTCClient

java.lang.Object

com.qiniu.rtc.QRTCClient

public class QRTCClient
extends java.lang.Object

QRTC core api

Constructor Summary

Constructors

Constructor	Description
QRTCClient(java.lang.String accessKey, java.lang.String secretKey, java.lang.String appId)

Method Summary

Modifier and Type	Method	Description
QRTCResult<ForwardResult>	createForwardJob(java.lang.String roomId, ForwardParam param)	创建单路转推任务
QRTCResult<MergeResult>	createMergeJob(java.lang.String roomName, MergeJob job)
QRTCResult<MergeResult>	createMergeJob(java.lang.String roomName, MergeParam mergeParam)	Deprecated.
QRTCResult<RoomResult>	createRoom(RoomParam roomParam)	创建房间
QRTCResult<AppResult>	deleteApp()	删除当前的app
QRTCResult<RoomResult>	deleteRoom(java.lang.String roomName)	删除房间
QRTCResult<AppResult>	getApp()	获取当前绑定的client的app信息
java.lang.String	getRoomToken(java.lang.String roomName, java.lang.String userId, long expireAt, java.lang.String permission)	获取房间token
QRTCResult<RoomResult>	kickUser(java.lang.String roomName, java.lang.String userId)	指定一个用户踢出房间
QRTCResult<RoomResult>	listActiveRoom(java.lang.String roomNamePrefix, int offset, int limit)	获取当前所有活跃的房间
QRTCResult<RoomResult>	listUser(java.lang.String roomName)	获取房间内的所有用户
QRTCResult<java.util.Map>	setHttpCallback(CallbackParam param)	设置服务端回调接口
QRTCResult<ForwardResult>	stopForwardJob(java.lang.String roomId, ForwardParam param)	停止单路转推的能力
QRTCResult<MergeResult>	stopMergeJob(java.lang.String roomName, java.lang.String jobId)	Deprecated.
QRTCResult<MergeResult>	stopMergeJobById(java.lang.String roomName, java.lang.String jobId)
QRTCResult<AppResult>	updateApp(AppParam appParam)	更新app信息
QRTCResult<MergeResult>	updateMergeJob(java.lang.String roomName, MergeJob job)
QRTCResult<MergeResult>	updateMergeTrack(MergeTrackParam mergeTrackParam, java.lang.String roomName, java.lang.String jobId)	Deprecated.
QRTCResult<MergeResult>	updateMergeWatermarks(WatermarksParam watermarksParam, java.lang.String roomName, java.lang.String jobId)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

QRTCClient

public QRTCClient(java.lang.String accessKey,
                  java.lang.String secretKey,
                  java.lang.String appId)

Method Detail

getApp

public QRTCResult<AppResult> getApp()
                             throws QiniuException

获取当前绑定的client的app信息

Returns:

QRTCResult

Throws:

QiniuException - 异常

deleteApp

public QRTCResult<AppResult> deleteApp()
                                throws QiniuException

删除当前的app

Returns:

QRTCResult

Throws:

QiniuException - 异常

updateApp

public QRTCResult<AppResult> updateApp(AppParam appParam)
                                throws QiniuException

更新app信息

Parameters:

appParam - appParam

Returns:

QRTCResult

Throws:

QiniuException - 异常

createRoom

public QRTCResult<RoomResult> createRoom(RoomParam roomParam)
                                  throws QiniuException

创建房间

Parameters:

roomParam - roomParam

Returns:

QRTCResult

Throws:

QiniuException - 异常

deleteRoom

public QRTCResult<RoomResult> deleteRoom(java.lang.String roomName)
                                  throws QiniuException

删除房间

Parameters:

roomName - roomName

Returns:

QRTCResult

Throws:

QiniuException - 异常

listUser

public QRTCResult<RoomResult> listUser(java.lang.String roomName)
                                throws QiniuException

获取房间内的所有用户

Parameters:

roomName - roomName

Returns:

QRTCResult

Throws:

QiniuException - 异常

kickUser

public QRTCResult<RoomResult> kickUser(java.lang.String roomName,
                                       java.lang.String userId)
                                throws QiniuException

指定一个用户踢出房间

Parameters:

roomName - roomName

userId - userId

Returns:

QRTCResult

Throws:

QiniuException - 异常

listActiveRoom

public QRTCResult<RoomResult> listActiveRoom(java.lang.String roomNamePrefix,
                                             int offset,
                                             int limit)
                                      throws QiniuException

获取当前所有活跃的房间

Parameters:

roomNamePrefix - roomNamePrefix

offset - offset

limit - limit

Returns:

QRTCResult

Throws:

QiniuException - 异常

getRoomToken

public java.lang.String getRoomToken(java.lang.String roomName,
                                     java.lang.String userId,
                                     long expireAt,
                                     java.lang.String permission)
                              throws java.lang.Exception

获取房间token

Parameters:

roomName - 房间名称，需满足规格 ^[a-zA-Z0-9_-]{3,64}$

userId - 请求加入房间的用户 ID，需满足规格 ^[a-zA-Z0-9_-]{3,50}$

expireAt - int64 类型，鉴权的有效时间，传入以秒为单位的64位Unix绝对时间，token 将在该时间后失效

permission - 该用户的房间管理权限，"admin" 或 "user"，默认为 "user" 。当权限角色为 "admin" 时，拥有将其他用户移除出房 间等特权.

Returns:

roomToken 房间TOKEN

Throws:

java.lang.Exception - 异常

createForwardJob

public QRTCResult<ForwardResult> createForwardJob(java.lang.String roomId,
                                                  ForwardParam param)
                                           throws QiniuException

创建单路转推任务

Parameters:

roomId - roomId

param - param

Returns:

QRTCResult

Throws:

QiniuException - 异常

stopForwardJob

public QRTCResult<ForwardResult> stopForwardJob(java.lang.String roomId,
                                                ForwardParam param)
                                         throws QiniuException

停止单路转推的能力

Parameters:

roomId - roomId

param - param

Returns:

QRTCResult

Throws:

QiniuException - 异常

setHttpCallback

public QRTCResult<java.util.Map> setHttpCallback(CallbackParam param)
                                          throws QiniuException

设置服务端回调接口

Parameters:

param - param

Returns:

QRTCResult

Throws:

QiniuException - 异常

createMergeJob

@Deprecated
public QRTCResult<MergeResult> createMergeJob(java.lang.String roomName,
                                              MergeParam mergeParam)
                                       throws QiniuException

Deprecated.

创建合流任务

Parameters:

roomName - roomName

mergeParam - mergeParam

Returns:

QRTCResult

Throws:

QiniuException - 异常

updateMergeTrack

@Deprecated
public QRTCResult<MergeResult> updateMergeTrack(MergeTrackParam mergeTrackParam,
                                                java.lang.String roomName,
                                                java.lang.String jobId)
                                         throws QiniuException

Deprecated.

更新合流track信息

Parameters:

mergeTrackParam - mergeTrackParam

roomName - roomName

jobId - jobId

Returns:

QRTCResult

Throws:

QiniuException - 异常

updateMergeWatermarks

@Deprecated
public QRTCResult<MergeResult> updateMergeWatermarks(WatermarksParam watermarksParam,
                                                     java.lang.String roomName,
                                                     java.lang.String jobId)
                                              throws QiniuException

Deprecated.

更新合理水印信息

Parameters:

watermarksParam - watermarksParam

roomName - roomName

jobId - jobId

Returns:

QRTCResult

Throws:

QiniuException - 异常

stopMergeJob

@Deprecated
public QRTCResult<MergeResult> stopMergeJob(java.lang.String roomName,
                                            java.lang.String jobId)
                                     throws QiniuException

Deprecated.

停止合流任务

Parameters:

roomName - 房间名

jobId - 合流任务ID

Returns:

QRTCResult

Throws:

QiniuException - 异常

createMergeJob

public QRTCResult<MergeResult> createMergeJob(java.lang.String roomName,
                                              MergeJob job)
                                       throws QiniuException

Throws:

QiniuException

updateMergeJob

public QRTCResult<MergeResult> updateMergeJob(java.lang.String roomName,
                                              MergeJob job)
                                       throws QiniuException

Throws:

QiniuException

stopMergeJobById

public QRTCResult<MergeResult> stopMergeJobById(java.lang.String roomName,
                                                java.lang.String jobId)
                                         throws QiniuException

Throws:

QiniuException