跳转至
400-881-9892

文档中心

官方文档,可查阅产品介绍、快速入门、用户指南、开发指南、API参考、SDK参考、帮助等信息。

文档中心 互动课堂

相关扩展字段

最近更新时间:2025-01-13 11:02:46 星期一

房间初始化相关

Builder类

方法名称 方法描述
setHasWhiteboard(boolean hasWhiteboard) 设置是否接收白板通知
setTkCheckroomInterrupt(boolean tkCheckroomInterrupt) 设置是否需要中断进房间流程(SAAS 用户专用
setTkRoomType(@TK_ROOM_TYPE.ROOM_TYPE int tkRoomType) 房间类型(value值查看enum定义的TK_ROOM_TYPE)
setUseSecureSocket(boolean useSecureSocket) socekt是否使用加密
setTkPort(int tkPort) 私有部署端口
setTkHost(String tkHost) 访问域名

joinRoom进入房间相关

RoomParams类

方法名称 方法描述
setRoomId(String roomId) 设置房间id
setThirdRoomId(String thirdRoomId) 设置第三方房间id
setTkVersion(String tkVersion) 设置app版本
setUserId(String userId) 设置用户id
setTkToken(String tkToken) 设置token
setRoomType(int roomType) 房间类型(value值查看enum定义的TK_ROOM_TYPE)
setPassword(String password) 设置密码
setDomain(String domain) 设置私有部署地址
setExtensions(Map extensions) 设置房间自定义扩展参数

UserParams类

方法名称 方法描述
setUserId(String nickname) 设置用户id
setNickname(String nickname) 设置用户昵称
setUserRole(@RoomRole.ROLE int userRole) 设置用户身份 value值查看enum定义的RoomRole)
setExtensions(Map extensions) 设置用户自定义扩展参数

TKVideoMirrorMode类

方法名称 方法描述
TKVideoMirrorModeAuto 默认设置,前置摄像头时开启镜像模式,后置摄像头时不开启镜像
TKVideoMirrorModeEnable 前置和后置均开启镜像模式
TKVideoMirrorModeDisabled 前置和后置均不开启镜像模式

VideoProfile类

方法名称 方法描述
width 视频宽度
height 视频高度
maxfps 最大FPS

TK_VIDEO_STATE枚举

方法名称 方法描述
TK_VIDEO_STATE_FROZEN 停止
TK_VIDEO_STATE_RESUME 恢复

TK_AUDIO_STATE 枚举

方法名称 方法描述
TK_AUDIO_STATE_FROZEN 停止
TK_AUDIO_STATE_RESUME 恢复