TUIRoomDefine
TUIRoomDefine
结构体类型
函数列表 | 描述 |
房间信息 | |
用户登录信息 | |
房间内用户信息 | |
视频编码参数 | |
房间内座位信息 | |
锁定麦位操作参数 | |
房间内用户音量 | |
信令请求 | |
进房参数 | |
搜索参数 | |
房间内文本消息 | |
房间内自定义消息 |
枚举类型
枚举类型 | 描述 |
房间类型 | |
上麦模式 | |
房间内媒体设备类型 | |
房间内角色类型 | |
房间解散原因 | |
视频质量 | |
音频质量 | |
视频流类型 | |
音视频状态更改原因（分类: 自己主动修改 或者 被房主、管理员修改） | |
用户被踢出房间原因（分类: 被主持人或管理员踢出、在其它设备进入房间被踢出 或者 被服务端踢出） | |
分辨率模式（横屏 or 竖屏） | |
屏幕分享捕获源类型 | |
请求类型 |
TUIRoomType
TUIRoomType
房间类型
枚举 | 取值 | 描述 |
TUIRoomTypeConference | 1 | 会议类型房间，适用于会议，教育场景，该房间中可以开启自由发言，申请发言、上麦发言等不同模式。 |
TUIRoomTypeLive | 2 | 直播类型房间，适用于直播场景，该房间可以开启自由发言，上麦发言模式。 |
TUISeatMode
TUISeatMode
上麦模式
枚举 | 取值 | 描述 |
TUISeatModeFreeToTake | 1 | 自由上麦模式，台下观众可以自由上麦，无需申请。 |
TUISeatModeApplyToTake | 2 | 申请上麦模式，台下观众上麦需要房主或者管理员同意后才能上麦。 |
TUIMediaDevice
TUIMediaDevice
房间内媒体设备类型
枚举 | 取值 | 描述 |
TUIMediaDeviceMicrophone | 1 | 麦克风。 |
TUIMediaDeviceCamera | 2 | 摄像头。 |
TUIMediaDeviceScreenSharing | 3 | 屏幕共享。 |
TUIRole
TUIRole
房间内角色类型
枚举 | 取值 | 描述 |
TUIRoleRoomOwner | 0 | 房主，一般指房间的创建者，房间内最高权限拥有者。 |
TUIRoleAdministrator | 1 | 房间管理员。 |
TUIRoleGeneralUser | 2 | 房间内普通成员。 |
TUIRoomDismissedReason
TUIRoomDismissedReason
房间解散原因
枚举 | 取值 | 描述 |
TUIRoomDismissedReasonByOwner | 1 | 被房主解散。 |
TUIRoomDismissedReasonByServer | 2 | 被服务器解散。 |
TUIVideoQuality
TUIVideoQuality
视频质量
枚举 | 取值 | 描述 |
TUIVideoQuality360P | 1 | 低清360P。 |
TUIVideoQuality540P | 2 | 标清540P。 |
TUIVideoQuality720P | 3 | 高清720P。 |
TUIVideoQuality1080P | 4 | 超清1080P。 |
TUIAudioQuality
TUIAudioQuality
音频质量
枚举 | 取值 | 描述 |
TUIAudioQualitySpeech | 0 | 人声模式。 |
TUIAudioQualityDefault | 1 | 默认模式。 |
TUIAudioQualityMusic | 2 | 音乐模式。 |
TUIVideoStreamType
TUIVideoStreamType
视频流类型
枚举 | 取值 | 描述 |
TUIVideoStreamTypeCameraStream | 0 | 高清摄像头视频流。 |
TUIVideoStreamTypeScreenStream | 1 | 屏幕分享视频流。 |
TUIVideoStreamTypeCameraStreamLow | 2 | 低清摄像头视频流。 |
TUIChangeReason
TUIChangeReason
音视频状态更改原因（分类: 自己主动修改 或者 被房主、管理员修改）
枚举 | 取值 | 描述 |
TUIChangeReasonBySelf | 0 | 自己操作。 |
TUIChangeReasonByAdmin | 1 | 房主或管理员操作。 |
TUIKickedOutOfRoomReason
TUIKickedOutOfRoomReason
用户被踢出房间原因（分类: 被主持人或管理员踢出、在其它设备进入房间被踢出 或者 被服务端踢出）
枚举 | 取值 | 描述 |
TUIKickedOutOfRoomReasonByAdmin | 0 | 被主持人或管理员踢出。 |
TUIKickedOutOfRoomReasonByLoggedOnOtherDevice | 1 | 在其它设备进入房间被踢出。 |
TUIKickedOutOfRoomReasonByServer | 2 | 被服务端踢出。 |
TUIKickedOutOfRoomReasonForNetworkDisconnected | 3 | 网络中断超时退房。 |
TUIKickedOutOfRoomReasonForJoinRoomStatusInvalidDuringOffline | 4 | 离线期间态进房状发生变化（被踢出房间或者房间已解散）。 |
TUIKickedOutOfRoomReasonForCountOfJoinedRoomsExceedLimit | 5 | 超过了单设备最大可同时加入的房间个数，导致最早加入的房间自动退出 |
TUIResolutionMode
TUIResolutionMode
分辨率模式（横屏 or 竖屏）
枚举 | 取值 | 描述 |
TUIResolutionModeLandscape | 0 | 横屏。 |
TUIResolutionModePortrait | 1 | 竖屏。 |
TUICaptureSourceType
TUICaptureSourceType
屏幕分享捕获源类型
枚举 | 取值 | 描述 |
TUICaptureSourceTypeUnknown | -1 | 未定义。 |
TUICaptureSourceTypeWindow | 0 | 窗口。 |
TUICaptureSourceTypeScreen | 1 | 屏幕。 |
TUIRequestAction
TUIRequestAction
请求类型
枚举 | 取值 | 描述 |
TUIRequestActionInvalidAction | 0 | 无效请求。 |
TUIRequestActionOpenRemoteCamera | 1 | 请求远端用户打开摄像头。 |
TUIRequestActionOpenRemoteMicrophone | 2 | 请求远端用户打开麦克风。 |
TUIRequestActionTakeSeat | 4 | 请求上麦。 |
TUIRequestActionRemoteUserOnSeat | 5 | 请求远端用户上麦。 |
TUIRequestActionApplyToAdminToOpenLocalCamera | 6 | 向管理员请求打开本地摄像头。 |
TUIRequestActionApplyToAdminToOpenLocalMicrophone | 7 | 向管理员请求打开本地麦克风。 |
TUIRequestActionApplyToAdminToOpenLocalScreenShare | 8 | 向管理员请求打开屏幕分享。 |
TUIRoomInfo
TUIRoomInfo
房间信息
TUIRoomEngine 只支持字符串房间ID。
枚举类型 | 描述 |
createTime | 房间创建时间（只读）。 |
isCameraDisableForAllUser | 是否禁止打开摄像头（创建房间可选参数），默认值：NO。 |
isMessageDisableForAllUser | 是否禁止发送消息（创建房间可选参数），默认值：NO。 |
isMicrophoneDisableForAllUser | 是否禁止打开麦克风（创建房间可选参数），默认值：NO。 |
isScreenShareDisableForAllUser | 是否禁止打开屏幕分享（创建房间可选参数），默认值：NO。 |
isSeatEnabled | 是否开启麦位控制。 |
keepOwnerOnSeat | 房主上麦后常驻麦位。 |
maxSeatCount | 最大麦位数。 |
memberCount | 房间内成员数量（只读）。 |
name | 房间名称（创建房间可选参数，默认房间ID，最大支持100个字节）。 |
ownerAvatarUrl | 房主头像URL: 默认为房间创建者头像URL（只读）。 |
ownerId | 房主ID: 默认为房间创建者ID（只读）。 |
ownerName | 房主昵称: 默认为房间创建者昵称（只读）。 |
password | 房间密码。 |
roomId | 房间ID (创建房间必填参数，最大支持48个字节)。 |
roomType | |
seatMode | 上麦模式(只有开启麦位控制后生效)。 |
TUILoginUserInfo
TUILoginUserInfo
用户登录信息
枚举类型 | 描述 |
avatarUrl | 用户头像URL。 |
customInfo | 自定义信息。 |
userId | 用户ID。 |
userName | 用户名称。 |
TUIUserInfo
TUIUserInfo
房间内用户信息
枚举类型 | 描述 |
avatarUrl | 用户头像URL。 |
hasAudioStream | 是否有音频流，默认值：NO。 |
hasScreenStream | 是否有屏幕分享流，默认值：NO。 |
hasVideoStream | 是否有视频流，默认值：NO。 |
isMessageDisabled | 是否被禁止发送消息，默认值：NO。 |
nameCard | 房间内用户昵称，最大支持32个字节。 |
roomCustomInfo | 房间成员自定义信息。 |
userId | 用户ID。 |
userName | 用户名称。 |
userRole |
TUIRoomVideoEncoderParams
TUIRoomVideoEncoderParams
视频编码参数
枚举类型 | 描述 |
bitrate | 目标视频码率。 |
fps | 视频采集帧率。 |
resolutionMode | |
videoResolution |
TUISeatInfo
TUISeatInfo
房间内座位信息
枚举类型 | 描述 |
avatarUrl | 用户头像URL |
index | 麦位序号。 |
isAudioLocked | 麦位是否被禁止打开麦克风，默认值：NO。 |
isLocked | 麦位是否被锁定，默认值：NO。 |
isVideoLocked | 麦位是否被禁止打开摄像头，默认值：NO。 |
nameCard | 房间内用户昵称 |
userId | 用户ID。 |
userName | 用户昵称 |
TUISeatLockParams
TUISeatLockParams
锁定麦位操作参数
枚举类型 | 描述 |
lockAudio | 锁定麦位麦克风，默认值：NO。 |
lockSeat | 锁定麦位，默认值：NO。 |
lockVideo | 锁定麦位摄像头，默认值：NO。 |
TUIUserVoiceVolume
TUIUserVoiceVolume
房间内用户音量
枚举类型 | 描述 |
userId | 用户ID。 |
volume | 音量 用于承载所有正在说话的用户的音量大小，取值范围 0 - 100。 |
TUIRequest
TUIRequest
信令请求
枚举类型 | 描述 |
avatarUrl | 用户头像URL。 |
content | 信令内容。 |
nameCard | 房间内用户昵称。 |
requestAction | 请求类型。 |
requestId | 请求ID。 |
timestamp | 时间戳。 |
userId | 用户ID。 |
userName | 用户昵称。 |
TUIEnterRoomOptions
TUIEnterRoomOptions
进房参数
枚举类型 | 描述 |
password | 房间密码。 |
TUIUserSearchParam
TUIUserSearchParam
搜索参数
枚举类型 | 描述 |
cursor | 获取分页列表的下标。 |
keyword | 搜索关键字，目前支持用户昵称搜索 |
TUIRoomTextMessage
TUIRoomTextMessage
房间内文本消息
枚举类型 | 描述 |
extensionInfo | 消息扩展字段 |
roomId | 房间 ID（只读） |
sender | 消息发送者（只读） |
sequence | 消息序列号（只读） |
textContent | 消息文本 |
timestampInSecond | 消息时间戳（只读） |
TUIRoomCustomMessage
TUIRoomCustomMessage
房间内自定义消息
枚举类型 | 描述 |
businessId | 自定义业务 ID |
data | 自定义业务数据 |
roomId | 房间 ID（只读） |
sender | 消息发送者（只读） |
sequence | 消息序列号（只读） |
timestampInSecond | 消息时间戳（只读） |
