Interface Documentation
Interface Definition Overview
This page contains all interface type definitions, listed in alphabetical order.
TUIRoomInfo
Room information, users can obtain room information using roomEngine.fetchRoomInfo.
Property List
| Property | Type | Description |
|---|---|---|
| roomId | string |
Room ID |
| roomName | string |
Room name, defaults to roomId |
| roomType | TUIRoomType |
Room type, defaults to TUIRoomType.kConference |
| isSeatEnabled | boolean |
Whether seat control is enabled, supported since version 2.0.0, defaults to false |
| seatMode | TUISeatMode |
Seat mode (effective when seat control is enabled), supported since version 2.0.0, defaults to TUISeatMode.kFreeToTake |
| password | string |
Room password, defaults to empty string, supported since version 2.5.0 |
| isMicrophoneDisableForAllUser | boolean |
Whether to mute all users (optional parameter for room creation, defaults to false) |
| isScreenShareDisableForAllUser | boolean |
Whether to disable screen sharing for all users (optional parameter for room creation, supported since v2.2.0, defaults to false) |
| isCameraDisableForAllUser | boolean |
Whether to disable camera for all users (optional parameter for room creation, defaults to false) |
| isMessageDisableForAllUser | boolean |
Whether to allow all users to send messages (optional parameter for room creation, defaults to false) |
| maxSeatCount | number |
Maximum number of seats, defaults to 6 |
| roomOwner | string |
Room host ID, read-only, use ownerId for v2.4.1 and above |
| ownerId | string |
Room host ID, read-only, supported since version 2.4.1 |
| ownerName | string |
Room host nickname, read-only, supported since version 2.4.1 |
| ownerAvatarUrl | string |
Room host avatar URL, read-only, supported since version 2.4.1 |
| createTime | number |
Room creation time, read-only, in seconds |
| roomMemberCount | number |
Room member count, read-only |
TUIEnterRoomOptions
Optional parameters for entering a room.
Property List
| Property | Type | Description |
|---|---|---|
| password | string |
Room password, defaults to empty, indicating no password |
LoginUserInfo
Current logged-in user information, including user ID, username, avatar, and custom profile information.
Property List
| Property | Type | Description |
|---|---|---|
| userId | string |
Logged-in user's userId |
| userName | string |
Logged-in user's userName |
| avatarUrl | string |
Logged-in user's avatar URL |
| customInfo | Record<string, any> |
Custom profile information object |
SetSelfInfoParams
Parameters for setting user personal information.
Property List
| Property | Type | Description |
|---|---|---|
| userName | string |
User nickname |
| avatarUrl | string |
User avatar URL |
| customInfo | Record<string, any> |
Optional, custom information |
LoginParams
User login parameters.
Property List
| Property | Type | Description |
|---|---|---|
| userId | string |
User ID |
| userSig | string |
User signature |
| sdkAppId | number |
SDK application ID |
TUISeatLockParams
Parameters for seat lock operation
Property List
| Property | Type | Description |
|---|---|---|
| lockSeat | boolean |
Lock seat |
| lockVideo | boolean |
Lock seat video |
| lockAudio | boolean |
Lock seat audio |
TUIMessage
Message structure
Property List
| Property | Type | Description |
|---|---|---|
| messageId | string |
Message ID |
| message | string |
Message content |
| timestamp | number |
Timestamp information, in seconds |
| userId | string |
User ID |
| userName | string |
User name |
| avatarUrl | string |
User avatar URL |
TUINetwork
Network quality structure
Property List
| Property | Type | Description |
|---|---|---|
| userId | string |
User ID |
| quality | TUINetworkQuality |
Network quality |
| upLoss | number |
Uplink packet loss rate, unit (%) lower is better, currently only local user has this info |
| downLoss | number |
Downlink packet loss rate, unit (%) lower is better, currently only local user has this info |
| delay | number |
Network delay, unit ms, currently only local user has this info |
TUIVideoEncoderParams
Video encoding parameters
Property List
| Property | Type | Description |
|---|---|---|
| fps | number |
Frame rate setting |
| bitrate | number |
Target encoding bitrate setting |
| quality | TUIVideoQuality |
Uplink video resolution |
| videoResolution | TUIVideoQuality |
Uplink video resolution (supported since v1.6.0, use quality parameter for versions before v1.6.0) |
| resolutionMode | TUIResolutionMode |
Landscape/portrait mode |
TUIUserInfo
User information structure
Property List
| Property | Type | Description |
|---|---|---|
| userId | string |
User ID |
| userName | string |
User name |
| nameCard | string |
In-room user name, supported since v2.5.0 |
| avatarUrl | string |
User avatar URL |
| userRole | TUIRole |
User role |
| hasAudioStream | boolean |
Whether has audio stream |
| hasVideoStream | boolean |
Whether has video stream |
| hasScreenStream | boolean |
Whether has screen share stream |
| isMessageDisabled | boolean |
Whether messaging is disabled |
| roomCustomInfo | object |
User room custom field |
TUISeatInfo
Seat information structure (from TUIRoomEngine)
Property List
| Property | Type | Description |
|---|---|---|
| index | number |
Seat index number |
| userId | string |
User ID corresponding to the seat |
| userName | string |
User name |
| nameCard | string |
In-room user name, supported since v2.5.0 |
| avatarUrl | string |
User avatar URL |
| isLocked | boolean |
Whether current seat is locked |
| isVideoLocked | boolean |
Whether current seat video is disabled |
| isAudioLocked | boolean |
Whether current seat audio is disabled |
SeatInfo
Seat information (UIKit extension), includes additional information such as device status
Property List
| Property | Type | Description |
|---|---|---|
| index | number |
Seat index |
| isLocked | boolean |
Whether seat is locked |
| isVideoLocked | boolean |
Whether seat video is locked |
| isAudioLocked | boolean |
Whether seat audio is locked |
| userInfo | SeatUserInfo | undefined |
User information on the seat, undefined when seat is empty |
SeatUserInfo
User information on the seat, including device status and co-hosting information
Property List
| Property | Type | Description |
|---|---|---|
| roomId | string |
Room ID |
| userId | string |
User ID |
| userName | string |
User name |
| avatarUrl | string |
User avatar URL |
| microphoneStatus | DeviceStatus |
Microphone status |
| cameraStatus | DeviceStatus |
Camera status |
| onSeatTimestamp | number |
Time when user took seat timestamp |
| networkQuality | NetworkQuality | undefined |
Network quality |
| customInfo | Record<string, any> |
Custom information |
AudienceInfo
Audience information
Property List
| Property | Type | Description |
|---|---|---|
| userId | string |
User ID |
| userName | string |
User name |
| avatarUrl | string |
User avatar URL |
| customInfo | Record<string, any> |
Custom information |
| userRole | TUIRole |
User role |
| isMessageDisabled | boolean |
Whether messaging is disabled |
LiveUserInfo
Live streaming user brief information
Property List
| Property | Type | Description |
|---|---|---|
| userId | string |
User ID |
| userName | string |
User name |
| avatarUrl | string |
User avatar URL |
NetworkInfo
Detailed network information
Property List
| Property | Type | Description |
|---|---|---|
| quality | NetworkQuality |
Network quality level |
| upLoss | number |
Uplink packet loss rate, unit (%) |
| downLoss | number |
Downlink packet loss rate, unit (%) |
| delay | number |
Network delay, unit ms |
SearchResult
Search result structure, supports generics
Property List
| Property | Type | Description |
|---|---|---|
| resultList | Array<T> |
Search result list |
| hasMore | boolean |
Whether there are more results |
| cursor | string |
Pagination cursor |
| totalCount | number |
Total result count |
| params | Record<string, any> |
Search parameters |
TUIRequest
Request structure
Property List
| Property | Type | Description |
|---|---|---|
| requestAction | TUIRequestAction |
Request type |
| timestamp | number |
Request initiation time |
| requestId | string |
Request ID |
| userId | string |
User ID who initiated the request |
| userName | string |
User name |
| nameCard | string |
In-room user name, supported since v2.5.0 |
| avatarUrl | string |
User avatar URL |
| content | string |
Other content |
TUIRequestCallback
Request callback structure
Property List
| Property | Type | Description |
|---|---|---|
| requestCallbackType | TUIRequestCallbackType |
Request callback type |
| requestId | string |
Request ID |
| userId | string |
User ID |
| code | number |
Request response code |
| message | string |
Request supplementary description |
TUIDeviceInfo
Device information structure
Property List
| Property | Type | Description |
|---|---|---|
| deviceId | string |
Device ID |
| deviceName | string |
Device name |
| deviceProperties | Record<string, any> |
Device properties object |
TUIConferenceInfo
Conference information structure
Property List
| Property | Type | Description |
|---|---|---|
| scheduleStartTime | number |
Scheduled conference start time. |
| scheduleEndTime | number |
Scheduled conference end time. |
| scheduleAttendees | string[] |
List of invited attendees. |
| reminderSecondsBeforeStart | number |
Reminder time before conference starts (seconds). |
| status | TUIConferenceStatus |
Room status (read-only). |
| basicRoomInfo | TUIRoomInfo |
Room information. |
TUIConferenceModifyInfo
Conference information modification structure
Property List
| Property | Type | Description |
|---|---|---|
| scheduleStartTime | number |
Scheduled conference start time |
| scheduleEndTime | number |
Scheduled conference end time |
| basicRoomInfo | object |
Basic room information |
| basicRoomInfo.roomId | string |
Room ID |
| basicRoomInfo.roomName | string |
Room name |
TUIInvitation
In-meeting invitation information structure
Property List
| Property | Type | Description |
|---|---|---|
| status | TUIInvitationStatus |
In-meeting invitation status |
| invitee | TUIUserInfo |
Invitee |
| inviter | TUIUserInfo |
Inviter |
TUILiveInfo
Live room information
Property List
| Property | Type | Description |
|---|---|---|
| basicRoomInfo | TUIRoomInfo |
Room information, read-only |
| isGiftEnabled | boolean |
Whether live room supports gifts |
| isLikeEnabled | boolean |
Whether live room supports likes |
| isPublicVisible | boolean |
Whether live room is public |
| activityStatus | number |
Live room activity status: user-defined marker |
| viewCount | number |
Cumulative view count, read-only |
| coverUrl | string |
Live room cover image HTTP URL address, maximum 200 bytes |
| backgroundUrl | string |
Live room background image HTTP URL address, maximum 200 bytes |
| categoryList | Array |
Live room category tags, maximum 3 tags per room |
TUILiveModifyInfo
Live room information modification structure
Property List
| Property | Type | Description |
|---|---|---|
| roomId | string |
Live room ID |
| isPublicVisible | boolean |
Optional, whether live room is public |
| activityStatus | number |
Optional, live room activity status: user-defined marker |
| coverUrl | string |
Optional, live room cover image HTTP URL address, maximum 200 bytes |
| backgroundUrl | string |
Optional, live room background image HTTP URL address, maximum 200 bytes |
| categoryList | Array |
Optional, live room category tags, maximum 3 tags per room |
TUILiveModifyFlag
Live room modification flag
Property List
| Property | Type | Description |
|---|---|---|
| kNone | number |
No modification |
| kActivityStatus | number |
Live room activity status, supports custom setting |
| kCoverUrl | number |
Live room cover |
| kCategory | number |
Live room category |
| kEnableGift | number |
Live room gift sending support marker |
| kEnableLike | number |
Live room like support marker |
| kPublic | number |
Live room public marker |
| kBackgroundUrl | number |
Live room background |