类型定义
枚举定义
TUIRoomDefine
类型 | 说明 |
房间类型 | |
房间模式 | |
房间内媒体设备类型 | |
房间内角色类型 | |
视频质量 | |
音频质量 | |
视频流类型 | |
更改原因（用户音视频状态变更操作原因: 自己主动修改 或者 被房主、管理员修改） | |
请求类型 |
TUICommonDefine
类型 | 说明 |
网络质量 |
常用结构
TUIRoomDefine
类型 | 说明 |
房间信息 | |
登录用户信息 | |
房间内用户信息 | |
房间内座位信息 | |
锁定麦位操作参数 | |
房间内用户音量 | |
信令请求 |
TUICommonDefine
类型 | 说明 |
网络质量信息 | |
消息 |
RoomType
房间类型
枚举 | 取值 | 描述 |
CONFERENCE | 1 | 会议类型房间，适用于会议，教育场景，该房间中可以开启自由发言，申请发言、麦控等不同模式，麦位是无序的 |
LIVE_ROOM | 2 | 直播类型房间，适用于直播场景，该房间可以开启自由发言，麦位控制模式，该房间中麦位是有编号的 |
SpeechMode
房间内麦控模式
枚举 | 取值 | 描述 |
FREE_TO_SPEAK | 1 | 自由发言模式：普通用户可以自由发言 |
APPLY_TO_SPEAK | 2 | 申请发言模式（仅在会议类型房间下生效）：普通用户每次发言均需要先申请，待同意后才可以发言 |
SPEAK_AFTER_TAKING_SEAT | 3 | 上麦发言模式：普通用户需要申请上麦，待同意上麦之后才能发言 |
MediaDevice
房间内媒体设备类型
枚举 | 取值 | 描述 |
MICROPHONE | 1 | 麦克风 |
CAMERA | 2 | 摄像头 |
SCREEN_SHARING | 3 | 屏幕共享 |
Role
房间内角色类型
枚举 | 取值 | 描述 |
ROOM_OWNER | 0 | 房主，一般指房间的创建者，房间内最高权限拥有者 |
MANAGER | 1 | 房间管理员 |
GENERAL_USER | 2 | 房间内普通成员 |
VideoQuality
视频质量
枚举 | 取值 | 描述 |
Q_360P | 1 | 低清360P |
Q_540P | 2 | 标清540P |
Q_720P | 3 | 高清720P |
Q_1080P | 4 | 超清1080P |
AudioQuality
音频质量
枚举 | 取值 | 描述 |
SPEECH | 0 | 人声模式 |
DEFAULT | 1 | 默认模式 |
MUSIC | 2 | 音乐模式 |
VideoStreamType
视频流类型
枚举 | 取值 | 描述 |
CAMERA_STREAM | 0 | 高清摄像头视频流 |
SCREEN_STREAM | 1 | 屏幕分享视频流 |
CAMERA_STREAM_LOW | 2 | 低清摄像头视频流 |
ChangeReason
更改原因（用户音视频状态变更操作原因: 自己主动修改 或者 被房主、管理员修改）
枚举 | 取值 | 描述 |
BY_SELF | 0 | 自己操作 |
BY_ADMIN | 1 | 房主或管理员操作 |
RequestAction
请求类型
枚举 | 取值 | 描述 |
INVALID_ACTION | 0 | 无效请求 |
REQUEST_TO_OPEN_REMOTE_CAMERA | 1 | 请求远端用户打开摄像头 |
REQUEST_TO_OPEN_REMOTE_MICROPHONE | 2 | 请求远端用户打开麦克风 |
REQUEST_TO_CONNECT_OTHER_ROOM | 3 | 请求连接到其他房间 |
REQUEST_TO_TAKE_SEAT | 4 | 请求上麦 |
REQUEST_REMOTE_USER_ON_SEAT | 5 | 请求远端用户上麦 |
REQUEST_APPLY_TO_ADMIN_TO_OPEN_LOCAL_CAMERA | 6 | 向管理员请求打开本地摄像头 |
REQUEST_APPLY_TO_ADMIN_TO_OPEN_LOCAL_MICROPHONE | 7 | 向管理员请求打开本地麦克风 |
NetworkQuality
网络质量
枚举 | 取值 | 描述 |
UNKNOWN | 0 | 未定义 |
EXCELLENT | 1 | 当前网络非常好 |
GOOD | 2 | 当前网络比较好 |
POOR | 3 | 当前网络一般 |
BAD | 4 | 当前网络较差 |
VERY_BAD | 5 | 当前网络很差 |
DOWN | 6 | 当前网络不满足 TRTC 的最低要求 |
RoomInfo
房间信息
字段 | 类型 | 描述 |
roomId | String | 房间 ID(创建房间必填参数) |
ownerId | String | 主持人 ID: 默认为房间创建者（只读） |
roomType | 房间类型（创建房间可选参数，默认 CONFERENCE 类型） | |
name | String | 房间名称（创建房间可选参数，默认房间 ID） |
speechMode | 房间麦控模式,默认 FREE_TO_SPEAK | |
isCameraDisableForAllUser | boolean | 是否禁止打开摄像头（创建房间可选参数），默认值 false |
isMicrophoneDisableForAllUser | boolean | 是否禁止打开麦克风（创建房间可选参数），默认值 false |
isMessageDisableForAllUser | boolean | 是否禁止发送消息（创建房间可选参数），默认值 false |
maxSeatCount | int | 最大麦位数 |
enableCDNStreaming | boolean | 是否开启CDN直播（创建房间可选参数，直播房间使用），默认值 false |
cdnStreamDomain | String | 直播推流域名（创建房间可选参数，直播房间使用），默认值空。 |
createTime | long | 房间创建时间（只读） |
memberCount | int | 房间内成员数量（只读） |
LoginUserInfo
登录用户信息
字段 | 类型 | 描述 |
userId | String | 用户 ID |
userName | String | 用户名称 |
avatarUrl | String | 用户头像 URL |
UserInfo
房间内用户信息
字段 | 类型 | 描述 |
userId | String | 用户 ID |
userName | String | 用户名称 |
avatarUrl | String | 用户头像 URL |
userRole | 用户角色类型 | |
hasAudioStream | boolean | 是否有音频流 |
hasVideoStream | boolean | 是否有视频流 |
hasScreenStream | boolean | 是否有屏幕分享流 |
SeatInfo
房间内座位信息
字段 | 类型 | 描述 |
index | int | 麦位序号 |
userId | String | 用户 ID |
isLocked | boolean | 麦位是否被锁定，默认 false |
isVideoLocked | boolean | 麦位是否被禁止打开摄像头，默认 false |
isAudioLocked | boolean | 麦位是否被禁止打开麦克风，默认 false |
SeatLockParams
锁定麦位操作参数
字段 | 类型 | 描述 |
lockSeat | boolean | 锁定麦位，默认值 false |
lockVideo | boolean | 锁定麦位摄像头，默认值 false |
lockAudio | boolean | 锁定麦位麦克风，默认值 false |
UserVoiceVolume
房间内用户音量
字段 | 类型 | 描述 |
userId | String | 用户 ID |
volume | int | 音量 用于承载所有正在说话的用户的音量大小，取值范围 0 - 100 |
Request
信令请求
字段 | 类型 | 描述 |
requestId | String | 请求 ID |
requestAction | 请求类型 | |
userId | String | 用户 ID |
content | String | 信令内容 |
timestamp | int | 时间戳 |
NetworkInfo
网络质量信息
字段 | 类型 | 描述 |
userId | String | 用户 ID |
quality | 网络质量 | |
upLoss | int | 上行丢包率 |
downLoss | int | 下行丢包率 |
delay | int | 网络延迟 |
Message
消息
字段 | 类型 | 描述 |
messageId | String | 消息 ID |
message | String | 消息文本 |
timestamp | long | 消息时间 |
userId | String | 消息发送者 |
userName | String | 消息发送者昵称 |
avatarUrl | String | 消息发送者头像 |