このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

TUIRoomDefine

TUIRoomDefine
StructType
FuncList
DESC
RoomInfo
Room information.
LoginUserInfo
User login information.
UserInfo
User information in the room.
RoomVideoEncoderParams
Video encoding parameters.
SeatInfo
Room seat information.
SeatLockParams
Lock seat parameters.
UserVoiceVolume
User volume in the room.
Request
Request.
EnterRoomOptions
Enter a room parameters.
RoomTextMessage
Room text message
RoomCustomMessage
Room custom message
EnumType
EnumType
DESC
RoomType
Room type.
SeatMode
Seat mode.
MediaDevice
Types of media devices in the room.
Role
Type of user role in the room.
RoomDismissedReason
The reason of dismissing room.
VideoQuality
Video quality.
AudioQuality
Audio quality.
VideoStreamType
Video stream type.
ChangeReason
Reasons for audio and video status changed.
KickedOutOfRoomReason
Reasons for users being kicked off from the room.
ResolutionMode
Resolution mode.
RequestAction
Request type.
UserInfoModifyFlag
The TUIUserInfo modifiable parameter key.
TUIRoomType
TUIRoomType
Room type.Enum
Value
DESC
CONFERENCE
1
Conference room, suitable for conference and education scenarios.
LIVE
2
Live room, suitable for live scenarios.
TUISeatMode
TUISeatMode
Seat mode.Enum
Value
DESC
FREE_TO_TAKE
1
Free to take seat mode. Users can take the seat freely without applying.
APPLY_TO_TAKE
2
Apply to take seat mode. Users can take the seat after the owner or administrator approve.
TUIMediaDevice
TUIMediaDevice
Types of media devices in the room.Enum
Value
DESC
MICROPHONE
1
Microphone.
CAMERA
2
Camera.
SCREEN_SHARING
3
Screen sharing.
TUIRole
TUIRole
Type of user role in the room.Enum
Value
DESC
ROOM_OWNER
0
Owner, generally refers to the room creator.
MANAGER
1
Administrator.
GENERAL_USER
2
General user.
TUIRoomDismissedReason
TUIRoomDismissedReason
The reason of dismissing room.Enum
Value
DESC
BY_OWNER
1
Dismissed by owner.
BY_SERVER
2
Dismissed by the room server.
TUIVideoQuality
TUIVideoQuality
Video quality.Enum
Value
DESC
Q_360P
1
Low-definition 360P.
Q_540P
2
Standard definition 540P.
Q_720P
3
High definition 720P.
Q_1080P
4
Full high definition 1080P.
TUIAudioQuality
TUIAudioQuality
Audio quality.Enum
Value
DESC
SPEECH
0
Speech mode.
DEFAULT
1
Default mode.
MUSIC
2
Music mode.
TUIVideoStreamType
TUIVideoStreamType
Video stream type.Enum
Value
DESC
CAMERA_STREAM
0
HD camera video stream.
SCREEN_STREAM
1
Screen sharing video stream.
CAMERA_STREAM_LOW
2
Low-definition camera video stream.
TUIChangeReason
TUIChangeReason
Reasons for audio and video status changed.Enum
Value
DESC
BY_SELF
0
Changed by self.
BY_ADMIN
1
Changed by the owner and administrator.
TUIKickedOutOfRoomReason
TUIKickedOutOfRoomReason
Reasons for users being kicked off from the room.Enum
Value
DESC
BY_ADMIN
0
Kicked off by owner or administrator.
BY_LOGGED_ON_OTHER_DEVICE
1
Kicked off when other devices enter the room.
BY_SERVER
2
Kicked off by the server.
NETWORK_DISCONNECTED
3
Kicked off due to nework disconnected
JOIN_ROOM_STATUS_INVALID_DURING_OFFLINE
4
Kicked off due to joined room status change while offline(kicked out by administrator or the room destroyed by administrator)
COUNT_OF_JOINED_ROOMS_EXCEED_LIMIT
5
Exceeded the maximum concurrent rooms per device limit, resulting in kicked out of the earliest joined room
TUIResolutionMode
TUIResolutionMode
Resolution mode.Enum
Value
DESC
LANDSCAPE
0
Landscape.
PORTRAIT
1
Portrait.
TUIRequestAction
TUIRequestAction
Request type.Enum
Value
DESC
INVALID_ACTION
0
Invalid request.
REQUEST_TO_OPEN_REMOTE_CAMERA
1
Request the remote user to open the camera.
REQUEST_TO_OPEN_REMOTE_MICROPHONE
2
Request the remote user to open the microphone.
REQUEST_TO_TAKE_SEAT
4
Request to take seat.
REQUEST_REMOTE_USER_ON_SEAT
5
Request the remote user to take seat.
REQUEST_APPLY_TO_ADMIN_TO_OPEN_LOCAL_CAMERA
6
Request to open local camera by the administrator.
REQUEST_APPLY_TO_ADMIN_TO_OPEN_LOCAL_MICROPHONE
7
Request to open local microphone by the administrator.
REQUEST_APPLY_TO_ADMIN_TO_OPEN_LOCAL_SCREEN_SHARE
8
Request to enable the screen sharing by the administrator.
TUIUserInfoModifyFlag
TUIUserInfoModifyFlag
The TUIUserInfo modifiable parameter key.Enum
Value
DESC
USER_ROLE
0x01
userRole changed.
NAME_CARD
0x02
nameCard changed.
TUIRoomInfo
TUIRoomInfo
Room information.EnumType
DESC
createTime
The room creation time (read-only).
isCameraDisableForAllUser
The status of disabling for all user to open the camera in room (optional parameter for creating a room), default value: ﻿false﻿.
isMessageDisableForAllUser
The status of disabling for all user to send message in room (optional parameter for creating a room), default value: ﻿false﻿.
isMicrophoneDisableForAllUser
The status of disabling for all user to open the microphone in room (optional parameter for creating a room), default value: ﻿false﻿.
isScreenShareDisableForAllUser
The status of disabling for all user to start the screen sharing in room (optional parameter for creating a room), default value: ﻿false﻿.
isSeatEnabled
The status of enabling seat.
keepOwnerOnSeat
Keep owner on seat after taking seat。
maxSeatCount
Maximum number of seat.
memberCount
The count of members in the room (read-only).
name
Room name (Optional parameter, default is room ID, maximum support is 100 bytes).
ownerAvatarUrl
Room owner avatar URL: Default is the room creator's avatar URL (read-only).
ownerId
Owner ID: Default is the room creator (read-only).
ownerName
Room owner name: Default is the room creator's name (read-only).
password
Room password.
roomId
Room ID (String type, required parameter for creating room, maximum support is 48 bytes).
roomType
Room type (Optional parameter). More details, see: ﻿RoomType﻿.
seatMode
Seat mode (only available after isSeatEnabled is true).
TUILoginUserInfo
TUILoginUserInfo
User login information.EnumType
DESC
avatarUrl
User avatar URL.
customInfo
Custom information.
userId
User ID.
userName
User name.
TUIUserInfo
TUIUserInfo
User information in the room.EnumType
DESC
avatarUrl
Use avatar URL.
hasAudioStream
The status of the user has audio stream, default value: ﻿false﻿.
hasScreenStream
The status of the user has screen sharing stream, default value: ﻿false﻿.
hasVideoStream
The status of the user has video stream, default value: ﻿false﻿.
isMessageDisabled
The status of disabling the user to send message, default value: ﻿false﻿.
nameCard
User nickname in the room, maximum support is 32 bytes.
roomCustomInfo
Room user custom information.
userId
User ID.
userName
User name.
userRole
User role type. Conference room roles only exist within the room. Once checked out and re-entered, the role becomes a general user. Live room can be set before entering the room, and as long as the room is not disbanded, the role still exists. More details, see: ﻿Role﻿.
TUIRoomVideoEncoderParams
TUIRoomVideoEncoderParams
Video encoding parameters.EnumType
DESC
bitrate
Target video bitrate.
fps
Video capture frame rate.
resolutionMode
Resolution mode. More details, see: ﻿ResolutionMode﻿.
videoResolution
Video quality. More details, see: ﻿VideoQuality﻿.
TUISeatInfo
TUISeatInfo
Room seat information.EnumType
DESC
avatarUrl
User avatar URL.
index
Seat index.
isAudioLocked
The status of audio-locked for the seat. Default value: ﻿false﻿.
isLocked
The status of locked for the seat. Default value: ﻿false﻿.
isVideoLocked
The status of video-locked for the seat. Default value: ﻿false﻿.
nameCard
User nickname in the room.
userId
User ID.
userName
User name.
TUISeatLockParams
TUISeatLockParams
Lock seat parameters.EnumType
DESC
lockAudio
Lock seat audio, default value: ﻿false﻿.
lockSeat
Lock seat, default value: ﻿false﻿.
lockVideo
Lock seat camera, default value: ﻿false﻿.
TUIUserVoiceVolume
TUIUserVoiceVolume
User volume in the room.EnumType
DESC
userId
User ID.
volume
Volume: The volume of all users who are speaking, the value range is 0 - 100.
TUIRequest
TUIRequest
Request.EnumType
DESC
avatarUrl
User avatar URL.
content
Request content.
nameCard
User nickname in the room.
requestAction
Request type. More details, see ﻿TUIRequestAction﻿.
requestId
Request ID.
timestamp
Timestamp.
userId
User ID.
userName
User name.
TUIEnterRoomOptions
TUIEnterRoomOptions
Enter a room parameters.EnumType
DESC
password
Room password.
TUIRoomTextMessage
TUIRoomTextMessage
Room text messageEnumType
DESC
extensionInfo
Message extension information
roomId
Room ID（read-only）
sender
Message sender（read-only）
sequence
Message sequence number（read-only）
textContent
Text message content
timestampInSecond
Message sent time（read-only）
TUIRoomCustomMessage
TUIRoomCustomMessage
Room custom messageEnumType
DESC
businessId
Business ID
data
Business data
roomId
Room ID(read-only)
sender
Message sender(read-only)
sequence
Message sequence number(read-only)
timestampInSecond
Message sent time(read-only)

FuncList	DESC
RoomInfo	Room information.
LoginUserInfo	User login information.
UserInfo	User information in the room.
RoomVideoEncoderParams	Video encoding parameters.
SeatInfo	Room seat information.
SeatLockParams	Lock seat parameters.
UserVoiceVolume	User volume in the room.
Request	Request.
EnterRoomOptions	Enter a room parameters.
RoomTextMessage	Room text message
RoomCustomMessage	Room custom message

EnumType	DESC
RoomType	Room type.
SeatMode	Seat mode.
MediaDevice	Types of media devices in the room.
Role	Type of user role in the room.
RoomDismissedReason	The reason of dismissing room.
VideoQuality	Video quality.
AudioQuality	Audio quality.
VideoStreamType	Video stream type.
ChangeReason	Reasons for audio and video status changed.
KickedOutOfRoomReason	Reasons for users being kicked off from the room.
ResolutionMode	Resolution mode.
RequestAction	Request type.
UserInfoModifyFlag	The TUIUserInfo modifiable parameter key.

Enum	Value	DESC
CONFERENCE	1	Conference room, suitable for conference and education scenarios.
LIVE	2	Live room, suitable for live scenarios.

EnumType	DESC
createTime	The room creation time (read-only).
isCameraDisableForAllUser	The status of disabling for all user to open the camera in room (optional parameter for creating a room), default value: false.
isMessageDisableForAllUser	The status of disabling for all user to send message in room (optional parameter for creating a room), default value: false.
isMicrophoneDisableForAllUser	The status of disabling for all user to open the microphone in room (optional parameter for creating a room), default value: false.
isScreenShareDisableForAllUser	The status of disabling for all user to start the screen sharing in room (optional parameter for creating a room), default value: false.
isSeatEnabled	The status of enabling seat.
keepOwnerOnSeat	Keep owner on seat after taking seat。
maxSeatCount	Maximum number of seat.
memberCount	The count of members in the room (read-only).
name	Room name (Optional parameter, default is room ID, maximum support is 100 bytes).
ownerAvatarUrl	Room owner avatar URL: Default is the room creator's avatar URL (read-only).
ownerId	Owner ID: Default is the room creator (read-only).
ownerName	Room owner name: Default is the room creator's name (read-only).
password	Room password.
roomId	Room ID (String type, required parameter for creating room, maximum support is 48 bytes).
roomType	Room type (Optional parameter). More details, see: RoomType.
seatMode	Seat mode (only available after isSeatEnabled is true).

EnumType	DESC
avatarUrl	User avatar URL.
customInfo	Custom information.
userId	User ID.
userName	User name.

EnumType	DESC
bitrate	Target video bitrate.
fps	Video capture frame rate.
resolutionMode	Resolution mode. More details, see: ResolutionMode.
videoResolution	Video quality. More details, see: VideoQuality.

EnumType	DESC
lockAudio	Lock seat audio, default value: false.
lockSeat	Lock seat, default value: false.
lockVideo	Lock seat camera, default value: false.

EnumType	DESC
extensionInfo	Message extension information
roomId	Room ID（read-only）
sender	Message sender（read-only）
sequence	Message sequence number（read-only）
textContent	Text message content
timestampInSecond	Message sent time（read-only）

EnumType	DESC
businessId	Business ID
data	Business data
roomId	Room ID(read-only)
sender	Message sender(read-only)
sequence	Message sequence number(read-only)
timestampInSecond	Message sent time(read-only)