Interface 接口文档
接口定义总览
本页面包含所有的接口类型定义，按字母顺序排列。
TUIRoomInfo
房间信息，用户可使用 roomEngine.fetchRoomInfo获取房间信息。
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| roomId | string |
房间 ID |
| roomName | string |
房间名称，默认为 roomId |
| roomType | TUIRoomType |
房间类型，默认为 TUIRoomType.kConference |
| isSeatEnabled | boolean |
是否开启麦位控制，该属性 2.0.0 版本以后支持，默认为 false |
| seatMode | TUISeatMode |
上麦模式(开启麦位控制后生效)，该属性 2.0.0 版本以后支持，默认为 TUISeatMode.kFreeToTake |
| password | string |
房间密码，默认为空字符串，该属性 2.5.0 版本以后支持 |
| isMicrophoneDisableForAllUser | boolean |
是否开启全员禁音（创建房间可选参数，默认值为 false） |
| isScreenShareDisableForAllUser | boolean |
是否开启禁止屏幕分享（创建房间可选参数，该属性自 v2.2.0 版本以后支持，默认值为 false） |
| isCameraDisableForAllUser | boolean |
是否开启全员禁画（创建房间可选参数， 默认值为 false） |
| isMessageDisableForAllUser | boolean |
是否允许所有用户发消息（创建房间可选参数，默认值为 false） |
| maxSeatCount | number |
最大麦位数量，默认为 6 |
| roomOwner | string |
房间主持人ID，只读，v2.4.1 以上建议使用 ownerId |
| ownerId | string |
房间主持人ID，只读，该属性 2.4.1 版本以后支持 |
| ownerName | string |
房间主持人昵称，只读，该属性 2.4.1 版本以后支持 |
| ownerAvatarUrl | string |
房间主持人头像地址，只读，该属性 2.4.1 版本以后支持 |
| createTime | number |
房间创建时间，只读，精确到秒 |
| roomMemberCount | number |
房间成员数量，只读 |
TUIEnterRoomOptions
进房可选择参数。
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| password | string |
房间密码，默认为空，表示没有密码 |
TUILoginUserInfo
当前登录用户信息，userId, userName, avatarUrl。
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| userId | string |
登录用户的 userId |
| userName | string |
登录用户的 userName |
| avatarUrl | string |
登录用户的头像 |
| customInfo | object |
自定义资料信息 |
TUISeatLockParams
锁定麦位的操作参数
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| lockSeat | boolean |
锁定麦位 |
| lockVideo | boolean |
锁定麦位视频 |
| lockAudio | boolean |
锁定麦位音频 |
TUIMessage
消息结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| messageId | string |
消息 Id |
| message | string |
消息内容 |
| timestamp | number |
时间戳信息, 精确到秒 |
| userId | TUIRole |
用户 Id |
| userName | boolean |
用户名称 |
| avatarUrl | boolean |
用户头像地址 |
TUINetwork
消息结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| userId | string |
用户 Id |
| quality | TUINetworkQuality |
网络质量 |
| upLoss | number |
上行丢包率，单位 (%) 该数值越小越好，目前仅本地用户有该信息 |
| downLoss | TUIRole |
下行丢包率，单位 (%) 该数值越小越好，目前仅本地用户有该信息 |
| delay | Number |
网络延迟，单位 ms，目前仅本地用户有该信息 |
TUIVideoEncoderParams
视频编码参数
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| fps | number |
帧率设置 |
| bitrate | number |
目标编码码率设置 |
| quality | TUIVideoQuality |
上行视频分辨率 |
| videoResolution | TUIVideoQuality |
上行视频分辨率（自 v1.6.0 版本开始支持，v1.6.0 之前版本请使用 quality 参数） |
| resolutionMode | TUIResolutionMode |
横竖屏模式 |
TUIUserInfo
用户信息结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| userId | string |
用户 Id |
| userName | string |
用户名称 |
| nameCard | string |
房间内用户名称，自 v2.5.0 支持 |
| avatarUrl | string |
用户头像地址 |
| userRole | TUIRole |
用户角色 |
| hasAudioStream | boolean |
是否有音频流 |
| hasVideoStream | boolean |
是否有视频流 |
| hasScreenStream | boolean |
是否有屏幕分享流 |
| isMessageDisabled | boolean |
是否被禁止发送消息 |
| roomCustomInfo | object |
用户房间自定义字段 |
TUISeatInfo
麦位信息结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| index | number |
麦位序号 |
| userId | string |
麦位对应的用户 Id |
| userName | string |
用户名称 |
| nameCard | string |
房间内用户名称，自 v2.5.0 支持 |
| avatarUrl | string |
用户头像地址 |
| locked | boolean |
当前麦位是否被锁 |
| isVideoLocked | boolean |
当前麦位是否禁止视频 |
| isAudioLocked | boolean |
当前麦位是否禁止音频 |
TUIRequest
请求结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| requestAction | TUIRequestAction |
请求类型 |
| timestamp | number |
请求发起时间 |
| requestId | string |
请求 ID |
| userId | string |
发起请求的用户 ID |
| userName | string |
用户名称 |
| nameCard | string |
房间内用户名称，自 v2.5.0 支持 |
| avatarUrl | string |
用户头像地址 |
| content | string |
其他内容 |
TUIRequestCallback
请求回调结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| requestCallbackType | TUIRequestCallbackType |
请求回调类型 |
| requestId | string |
请求 ID |
| userId | string |
用户 Id |
| code | number |
请求响应码 |
| message | string |
请求补充说明 |
TUIDeviceInfo
请求回调结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| deviceId | string |
设备 Id |
| deviceName | string |
设备名称 |
| deviceProperties | object |
设备属性 |
TUIConferenceInfo
会议信息结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| scheduleStartTime | number |
预定会议开始时间。 |
| scheduleEndTime | number |
预定会议结束时间。 |
| scheduleAttendees | string[] |
邀请参会成员列表。 |
| reminderSecondsBeforeStart | number |
会议开始前提醒时间（秒）。 |
| status | TUIConferenceStatus |
房间状态（只读）。 |
| basicRoomInfo | TUIRoomInfo |
房间信息。 |
TUIConferenceModifyInfo
会议信息发生修改结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| scheduleStartTime | number |
预定会议开始时间。 |
| scheduleEndTime | number |
预定会议结束时间。 |
| basicRoomInfo | object |
房间信息。 |
| basicRoomInfo | string |
.roomId 房间 ID。 |
| basicRoomInfo | string |
.roomName 房间名称。 |
TUIInvitation
会中邀请信息结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| status | TUIInvitationStatus |
会中邀请状态 |
| invitee | TUIUserInfo |
受邀者 |
| inviter | TUIUserInfo |
邀请者 |
TUILiveInfo
直播间信息
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| basicRoomInfo | TUIRoomInfo |
房间信息，只读 |
| isGiftEnabled | boolean |
直播间是否支持礼物 |
| isLikeEnabled | boolean |
直播间是否支持点赞 |
| isPublicVisible | boolean |
直播间是否公开 |
| activityStatus | number |
直播间活跃状态: 用户自定义标记 |
| viewCount | number |
累计观看次数，只读 |
| coverUrl | string |
直播间封面图片 HTTP URL 地址，最大支持 200 个字节 |
| backgroundUrl | string |
直播间背景图片 HTTP URL 地址，最大支持 200 个字节 |
| categoryList | Array |
直播间分类标签，单个房间最大支持3个标记 |
TUILiveModifyInfo
直播间信息发生修改结构体
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| roomId | string |
直播间 ID |
| isPublicVisible | boolean |
可选，直播间是否公开 |
| activityStatus | number |
可选，直播间活跃状态: 用户自定义标记 |
| coverUrl | string |
可选，直播间封面图片 HTTP URL 地址，最大支持 200 个字节 |
| backgroundUrl | string |
可选，直播间背景图片 HTTP URL 地址，最大支持 200 个字节 |
| categoryList | Array |
可选，直播间分类标签，单个房间最大支持3个标记 |
TUILiveModifyFlag
直播间修改标记位
属性列表
| 属性名 | 类型 | 描述 |
|---|---|---|
| kNone | number |
不修改 |
| kActivityStatus | number |
直播间活跃状态，支持自定义设置 |
| kCoverUrl | number |
直播间封面 |
| kCategory | number |
直播间分类 |
| kEnableGift | number |
直播间支持发送礼物标记 |
| kEnableLike | number |
直播支持点赞标记 |
| kPublic | number |
直播间公开标记 |
| kBackgroundUrl | number |
直播间背景 |