- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 在线直播（含 UI）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 在线直播（含 UI）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
枚举定义
TUIRoomDefine
类型 | 说明 |
房间类型 | |
房间麦控模式 | |
房间内媒体设备类型 | |
TUIRole | 房间内角色类型 |
视频质量 | |
音频质量 | |
视频流类型 | |
更改原因（用户音视频状态变更操作原因: 自己主动修改 或者 被房主、管理员修改） | |
屏幕分享捕获源类型 | |
请求类型 |
TUICommonDefine
类型 | 说明 |
网络质量 |
常用结构
TUIRoomDefine
类型 | 说明 |
房间信息 | |
用户登录信息 | |
房间内用户信息 | |
房间内座位信息 | |
锁定麦位操作参数 | |
房间内用户音量 | |
信令请求 | |
屏幕分享采集源信息 |
TUICommonDefine
类型 | 说明 |
网络质量信息 | |
消息 | |
图片信息 |
TUIRoomType
房间类型
枚举 | 取值 | 描述 |
kConference | 1 | Conference 类型房间，适用于会议，教育场景，该房间中麦位是无序的 |
kLivingRoom | 2 | LivingRoom类型房间，适用于直播场景，该房间中麦位是有序的 |
TUISpeechMode
麦控模式
枚举 | 取值 | 描述 |
kFreeToSpeak | 1 | 自由发言模式。 |
kApplyToSpeak | 2 | 申请发言模式。（仅在会议类型房间下生效） |
kApplySpeakAfterTakingSeat | 3 | 上麦发言模式。 |
TUIMediaDevice
房间内媒体设备类型
枚举 | 取值 | 描述 |
kMicrophone | 1 | 麦克风。 |
kCamera | 2 | 摄像头 |
kApplyScreenSharing | 3 | 屏幕共享 |
TUIRole
房间内角色类型
枚举 | 取值 | 描述 |
kRoomOwner | 0 | 房主，一般指房间的创建者，房间内最高权限拥有者 |
kAdministrator | 1 | 房间管理员 |
kGeneralUser | 2 | 房间内普通成员 |
TUIVideoQuality
视频质量
枚举 | 取值 | 描述 |
kVideoQuality_360P | 1 | 低清360P |
kVideoQuality_540P | 2 | 标清540P |
kVideoQuality_720P | 3 | 高清720P |
kVideoQuality_1080P | 4 | 超清1080P |
TUIAudioQuality
音频质量
枚举 | 取值 | 描述 |
kAudioQualitySpeech | 0 | 人声模式 |
kAudioQualityDefault | 1 | 默认模式 |
kAudioQualityMusic | 2 | 音乐模式 |
TUIVideoStreamType
视频流类型
枚举 | 取值 | 描述 |
kCameraStream | 0 | 高清摄像头视频流 |
kScreenStream | 1 | 屏幕分享视频流 |
kCameraStreamLow | 2 | 低清摄像头视频流 |
TUIChangeReason
更改原因（用户音视频状态变更操作原因: 自己主动修改 或者 被房主、管理员修改）
枚举 | 取值 | 描述 |
kChangedBySelf | 0 | 自己操作 |
kChangedByAdmin | 1 | 房主或管理员操作 |
TUICaptureSourceType
屏幕分享捕获源类型
枚举 | 取值 | 描述 |
kUnknown | -1 | 未知类型 |
kWindow | 0 | 窗口类型 |
kScreen | 1 | 屏幕 |
TUIRequestAction
请求类型
枚举 | 取值 | 描述 |
kInvalidAction | 0 | 无效请求 |
kRequestToOpenRemoteCamera | 1 | 请求远端用户打开摄像头 |
kRequestToOpenRemoteMicrophone | 2 | 请求远端用户打开麦克风 |
kRequestToConnectOtherRoom | 3 | 请求连接到其他房间 |
kRequestToTakeSeat | 4 | 请求上麦 |
kRequestRemoteUserOnSeat | 5 | 请求远端用户上麦 |
kApplyToAdminToOpenLocalCamera | 6 | 向管理员请求打开本地摄像头 |
kApplyToAdminToOpenLocalMicrophone | 7 | 向管理员请求打开本地麦克风 |
TUINetworkQuality
网络质量
枚举 | 取值 | 描述 |
kQualityUnknown | 0 | 未定义 |
kQualityExcellent | 1 | 当前网络非常好 |
kQualityGood | 2 | 当前网络比较好 |
kQualityPoor | 3 | 当前网络一般 |
kQualityBad | 4 | 当前网络较差 |
kQualityVeryBad | 5 | 当前网络很差 |
kQualityDown | 6 | 当前网络不满足 TRTC 的最低要求 |
TUIRoomInfo
房间信息
字段 | 类型 | 描述 |
roomId | const char* | 房间ID(创建房间必填参数) |
ownerId | const char* | 主持人ID，默认为房间创建者（只读） |
roomType | 房间类型 | |
name | const char* | 房间名称 |
speechMode | 房间麦控模式 | |
isCameraDisableForAllUser | bool | 是否禁止打开摄像头，默认false |
isMicrophoneDisableForAllUser | bool | 是否禁止打开麦克风，默认false |
isMessageDisableForAllUser | bool | 是否禁止发送消息，默认false |
maxSeatCount | int | 最大麦位数量 |
createTime | long | 房间创建时间（只读） |
memberCountt | int | 房间内成员数量 |
TUILoginUserInfo
用户登录信息
字段 | 类型 | 描述 |
userId | const char* | 用户ID |
userName | const char* | 用户名称 |
avatarUrl | const char* | 用户头像URL |
TUIUserInfo
房间内用户信息
字段 | 类型 | 描述 |
userId | const char* | 用户ID |
userName | const char* | 用户名称 |
avatarUrl | const char* | 用户头像URL |
userRole | 用户角色类型 | |
hasAudioStream | bool | 是否有音频流 |
hasVideoStream | bool | 是否有视频流 |
hasScreenStream | bool | 是否有屏幕分享流 |
TUISeatInfo
房间内座位信息
字段 | 类型 | 描述 |
index | int | 麦位序号 |
userId | const char* | 用户 ID |
isLocked | bool | 麦位是否被锁定，默认 false |
isVideoLocked | bool | 麦位是否被禁止打开视频，默认 false |
isAudioLocked | bool | 麦位是否被禁止打开音频，默认 false |
TUISeatLockParams
锁定麦位操作参数
字段 | 类型 | 描述 |
lockSeat | bool | 锁定麦位，默认 false |
lockVideo | bool | 锁定麦位摄像头，默认 false |
lockAudio | bool | 锁定麦位麦克风，默认 false |
TUIUserVoiceVolume
房间内用户音量
字段 | 类型 | 描述 |
userId | const char* | 用户 ID |
volume | int | 音量 用于承载所有正在说话的用户的音量大小，取值范围 0 - 100 |
TUIRequest
信令请求
字段 | 类型 | 描述 |
requestId | uint32_t | 请求 ID |
requestAction | 请求类型 | |
userId | const char* | 用户 ID |
content | const char* | 信令内容 |
timestamp | uint32_t | 时间戳 |
TUIShareTarget
信令请求
字段 | 类型 | 描述 |
id | TUISourceId | 采集源的ID，对于窗口，该字段代表窗口的 ID；对于屏幕，该字段代表显示器的 ID |
sourceType | 采集源类型 | |
sourceName | const char* | 采集源名称 |
thumbnailImage | 缩略图 | |
iconImage | 图标 | |
isMinimized | bool | 是否最小化 |
TUINetworkInfo
网络质量信息
字段 | 类型 | 描述 |
userId | const char* | 用户ID |
quality | 网络质量 | |
upLoss | int | 上行丢包率 |
downLoss | int | 下行丢包率 |
delay | int | 网络延迟 |
TUIMessage
消息详情
字段 | 类型 | 描述 |
messageId | const char* | 消息 ID |
message | const char* | 消息文本 |
timestamp | int64_t | 消息时间 |
userId | const char* | 消息发送者 |
userName | const char* | 消息发送者昵称 |
avatarUrl | const char* | 消息发送者头像 |
TUIImageBuffer
图片信息
字段 | 类型 | 描述 |
buffer | const char* | 图片数据缓存地址 |
length | uint32_t | 长度 |
width | uint32_t | 宽度 |
height | uint32_t | 高度 |
是
否
本页内容是否解决了您的问题？