类型定义
枚举定义
TUIRoomDefine
类型 | 说明 |
房间类型 | |
麦控模式 | |
房间内媒体设备类型 | |
房间内角色类型 | |
视频质量 | |
音频质量 | |
视频流类型 | |
更改原因（用户音视频状态变更操作原因: 自己主动修改 或者 被房主、管理员修改） | |
屏幕分享捕获源类型 | |
请求类型 |
TUICommonDefine
类型 | 说明 |
网络质量 |
常用结构
TUIRoomDefine
类型 | 说明 |
房间信息 | |
用户登录信息 | |
房间内用户信息 | |
房间内座位信息 | |
锁定麦位操作参数 | |
房间内用户音量 | |
信令请求 | |
屏幕分享采集源信息 |
TUICommonDefine
类型 | 说明 |
网络质量信息 | |
消息 |
TUIRoomType
房间类型
枚举 | 取值 | 描述 |
TUIRoomTypeConference | 1 | 会议类型房间，适用于会议，教育场景，该房间中可以开启自由发言，申请发言、上麦发言等不同模式。 |
TUIRoomTypeLivingRoom | 2 | 直播类型房间，适用于直播场景，该房间可以开启自由发言，麦位控制模式，该房间中麦位是有编号的。 |
TUISpeechMode
麦控模式
枚举 | 取值 | 描述 |
TUISpeechModeFreeToSpeak | 1 | 自由发言模式。 |
TUISpeechModeApplyToSpeak | 2 | 申请发言模式。（仅在会议类型房间下生效） |
TUISpeechModeApplySpeakAfterTakingSeat | 3 | 上麦发言模式。 |
TUIMediaDevice
房间内媒体设备类型
枚举 | 取值 | 描述 |
TUIMediaDeviceMicrophone | 1 | 麦克风 |
TUIMediaDeviceCamera | 2 | 摄像头 |
TUIMediaDeviceApplyScreenSharing | 3 | 屏幕共享 |
TUIRole
房间内角色类型
枚举 | 取值 | 描述 |
TUIRoleRoomOwner | 0 | 房主，一般指房间的创建者，房间内最高权限拥有者 |
TUIRoleAdministrator | 1 | 房间管理员 |
TUIRoleGeneralUser | 2 | 房间内普通成员 |
TUIVideoQuality
视频质量
枚举 | 取值 | 描述 |
TUIVideoQuality360P | 1 | 低清360P |
TUIVideoQuality540P | 2 | 标清540P |
TUIVideoQuality720P | 3 | 高清720P |
TUIVideoQuality1080P | 4 | 超清1080P |
TUIAudioQuality
音频质量
枚举 | 取值 | 描述 |
TUIAudioQualitySpeech | 0 | 人声模式 |
TUIAudioQualityDefault | 1 | 默认模式 |
TUIAudioQualityMusic | 2 | 音乐模式 |
TUIVideoStreamType
视频流类型
枚举 | 取值 | 描述 |
TUIVideoStreamTypeCameraStream | 0 | 高清摄像头视频流 |
TUIVideoStreamTypeScreenStream | 1 | 屏幕分享视频流 |
TUIVideoStreamTypeCameraStreamLow | 2 | 低清摄像头视频流 |
TUIChangeReason
更改原因（用户音视频状态变更操作原因: 自己主动修改 或者 被房主、管理员修改）
枚举 | 取值 | 描述 |
TUIChangeReasonBySelf | 0 | 自己操作 |
TUIChangeReasonByAdmin | 1 | 房主或管理员操作 |
TUICaptureSourceType
屏幕分享捕获源类型
枚举 | 取值 | 描述 |
TUICaptureSourceTypeUnknown | -1 | 未定义 |
TUICaptureSourceTypeWindow | 0 | 窗口 |
TUICaptureSourceTypeScreen | 1 | 屏幕 |
TUIRequestAction
请求类型
枚举 | 取值 | 描述 |
TUIRequestActionInvalidAction | 0 | 无效请求 |
TUIRequestActionOpenRemoteCamera | 1 | 请求远端用户打开摄像头 |
TUIRequestActionOpenRemoteMicrophone | 2 | 请求远端用户打开麦克风 |
TUIRequestActionConnectOtherRoom | 3 | 请求连接到其他房间 |
TUIRequestActionTakeSeat | 4 | 请求上麦 |
TUIRequestActionRemoteUserOnSeat | 5 | 请求远端用户上麦 |
TUIRequestActionApplyToAdminToOpenLocalCamera | 6 | 向管理员请求打开本地摄像头 |
TUIRequestActionApplyToAdminToOpenLocalMicrophone | 7 | 向管理员请求打开本地麦克风 |
TUINetworkQuality
网络质量
枚举 | 取值 | 描述 |
TUINetworkQualityUnknown | 0 | 未定义 |
TUINetworkQualityExcellent | 1 | 当前网络非常好 |
TUINetworkQualityGood | 2 | 当前网络比较好 |
TUINetworkQualityPoor | 3 | 当前网络一般 |
TUINetworkQualityBad | 4 | 当前网络较差 |
TUINetworkQualityVeryBad | 5 | 当前网络很差 |
TUINetworkQualityDown | 6 | 当前网络不满足 TRTC 的最低要求 |
TUIRoomInfo
房间信息
字段 | 类型 | 描述 |
roomId | NSString * | 房间 ID |
roomType | 房间类型 | |
ownerId | NSString * | 主持人 ID，默认为房间创建者（只读） |
name | NSString * | 房间名称,默认为房间ID |
speechMode | 麦控模式 | |
createTime | NSUInteger | 房间创建时间（只读） |
memberCount | NSInteger | 房间内成员数量（只读） |
maxSeatCount | NSUInteger | 最大麦位数量（仅支持进房前和创建房间时设置） |
isCameraDisableForAllUser | BOOL | 是否禁止打开摄像头（创建房间可选参数），默认值：false |
isMicrophoneDisableForAllUser | BOOL | 是否禁止打开麦克风（创建房间可选参数），默认值：false |
isMessageDisableForAllUser | BOOL | 是否禁止发送消息（创建房间可选参数），默认值：false |
enableCDNStreaming | BOOL | 是否开启CDN直播（创建房间可选参数，直播房间使用），默认值：false |
cdnStreamDomain | NSString* | 直播推流域名（创建房间可选参数，直播房间使用），默认值：空 |
TUILoginUserInfo
用户登录信息
字段 | 类型 | 含义 |
userId | NSString * | 用户 ID |
userName | NSString * | 用户名称 |
avatarUrl | NSString * | 用户头像URL |
TUIUserInfo
房间内用户信息
字段 | 类型 | 描述 |
userId | NSString * | 用户 ID |
userName | NSString * | 用户名称 |
avatarUrl | NSString * | 用户头像URL |
userRole | 用户角色类型 | |
hasAudioStream | BOOL | 是否有音频流，默认值：false |
hasVideoStream | BOOL | 是否有视频流，默认值：false |
hasScreenStream | BOOL | 是否有屏幕分享流，默认值：false |
TUISeatInfo
房间内座位信息
字段 | 类型 | 描述 |
index | NSInteger | 麦位序号 |
userId | NSString * | 用户 ID |
isLocked | BOOL | 麦位是否被锁定，默认 false |
isVideoLocked | BOOL | 麦位是否被禁止打开摄像头，默认 false |
isAudioLocked | BOOL | 麦位是否被禁止打开麦克风，默认 false |
TUISeatLockParams
锁定麦位操作参数
字段 | 类型 | 含义 |
lockSeat | BOOL | 锁定麦位，默认 false |
lockVideo | BOOL | 锁定麦位摄像头，默认 false |
lockAudio | BOOL | 锁定麦位麦克风，默认 false |
TUIUserVoiceVolume
房间内用户音量
字段 | 类型 | 描述 |
userId | NSString * | 用户 ID |
volume | NSUInteger | 音量 用于承载所有正在说话的用户的音量大小，取值范围 0 - 100 |
TUIRequest
信令请求
字段 | 类型 | 描述 |
requestId | NSString * | 请求 ID |
requestAction | 请求类型 | |
userId | NSString * | 用户 ID |
content | NSString * | 信令内容 |
timestamp | NSUInteger | 时间戳 |
TUIShareTarget
屏幕分享采集源信息
字段 | 类型 | 描述 |
targetId | NSString * | 采集源的 ID，对于窗口，该字段代表窗口的 ID；对于屏幕，该字段代表显示器的 ID |
sourceType | 采集源类型 | |
sourceName | NSString * | 采集源名称 |
thumbnailImage | TUIImage * | 缩略图 |
iconImage | TUIImage * | 图标 |
extInfo | NSDictionary * | 窗口的扩展信息 |
TUINetworkInfo
网络质量信息
字段 | 类型 | 描述 |
userId | NSString * | 用户 ID |
quality | 网络质量 | |
upLoss | uint32_t | 上行丢包率 |
downLoss | uint32_t | 下行丢包率 |
delay | uint32_t | 网络延迟 |
TUIMessage
消息
字段 | 类型 | 描述 |
messageId | NSString * | 消息 ID |
message | NSString * | 消息文本 |
timestamp | uint64_t | 消息时间 |
userId | NSString * | 消息发送者 |
userName | NSString * | 消息发送者昵称 |
avatarUrl | NSString * | 消息发送者头像 |
- 枚举定义
- 常用结构
- TUIRoomType
- TUISpeechMode
- TUIMediaDevice
- TUIRole
- TUIVideoQuality
- TUIAudioQuality
- TUIVideoStreamType
- TUIChangeReason
- TUICaptureSourceType
- TUIRequestAction
- TUINetworkQuality
- TUIRoomInfo
- TUILoginUserInfo
- TUIUserInfo
- TUISeatInfo
- TUISeatLockParams
- TUIUserVoiceVolume
- TUIRequest
- TUIShareTarget
- TUINetworkInfo
- TUIMessage