TUIRoomDefine
结构体类型
函数列表 | 描述 |
Room information. | |
User login information. | |
User information in the room. | |
Video encoding parameters. | |
Room seat information. | |
Lock seat parameters. | |
User volume in the room. | |
Request. | |
Enter a room parameters. |
枚举类型
枚举类型 | 描述 |
Room type. | |
Speech mode | |
Seat mode. | |
Types of media devices in the room. | |
Type of role in the room. | |
The reason of dismissing room. | |
Video quality. | |
Audio quality. | |
Video stream type. | |
Reasons for audio and video status changes. | |
Reasons for users being kicked out of the room. | |
Resolution mode. | |
Screen sharing capture source type. | |
Request type. |
TUIRoomType
TUIRoomType
Room type.
枚举 | 取值 | 描述 |
TUIRoomTypeConference | 1 | Conference room, suitable for conference and education scenarios. |
TUIRoomTypeLive | 2 | Live room, suitable for live scenarios. |
TUISpeechMode
TUISpeechMode
Speech mode
@deprecated Starting from v2.0, this function has been deprecated. It is recommended to use isSeatEnabled (whether to enable seat control) instead.
枚举 | 取值 | 描述 |
TUISpeechModeNone | 0 | Not set. |
TUISpeechModeFreeToSpeak | 1 | Free speech mode. |
TUISpeechModeApplyToSpeak | 2 | Apply to speech mode(Only available in conference room). |
TUISpeechModeApplySpeakAfterTakingSeat | 3 | On-stage speech mode. |
TUISeatMode
TUISeatMode
Seat mode.
枚举 | 取值 | 描述 |
TUISeatModeFreeToTake | 1 | Free to take seat mode. Members can take the seat freely without applying. |
TUISeatModeApplyToTake | 2 | Apply to take seat mode. Members can only take the seat after approval from the owner or administrator. |
TUIMediaDevice
TUIMediaDevice
Types of media devices in the room.
枚举 | 取值 | 描述 |
TUIMediaDeviceMicrophone | 1 | Microphone. |
TUIMediaDeviceCamera | 2 | Camera. |
TUIMediaDeviceScreenSharing | 3 | Screen sharing. |
TUIRole
TUIRole
Type of role in the room.
枚举 | 取值 | 描述 |
TUIRoleRoomOwner | 0 | Host, generally refers to the room creator. |
TUIRoleAdministrator | 1 | Administrator. |
TUIRoleGeneralUser | 2 | General user. |
TUIRoomDismissedReason
TUIRoomDismissedReason
The reason of dismissing room.
枚举 | 取值 | 描述 |
TUIRoomDismissedReasonByOwner | 1 | Dismissed by owner. |
TUIRoomDismissedReasonByServer | 2 | Dismissed by the server. |
TUIVideoQuality
TUIVideoQuality
Video quality.
枚举 | 取值 | 描述 |
TUIVideoQuality360P | 1 | Low-definition 360P. |
TUIVideoQuality540P | 2 | Standard definition 540P. |
TUIVideoQuality720P | 3 | High definition 720P. |
TUIVideoQuality1080P | 4 | Full high definition 1080P. |
TUIAudioQuality
TUIAudioQuality
Audio quality.
枚举 | 取值 | 描述 |
TUIAudioQualitySpeech | 0 | Speech mode. |
TUIAudioQualityDefault | 1 | Default mode. |
TUIAudioQualityMusic | 2 | Music mode. |
TUIVideoStreamType
TUIVideoStreamType
Video stream type.
枚举 | 取值 | 描述 |
TUIVideoStreamTypeCameraStream | 0 | HD camera video streaming. |
TUIVideoStreamTypeScreenStream | 1 | Screen sharing video streaming. |
TUIVideoStreamTypeCameraStreamLow | 2 | Low-definition camera video stream. |
TUIChangeReason
TUIChangeReason
Reasons for audio and video status changes.
枚举 | 取值 | 描述 |
TUIChangeReasonBySelf | 0 | Changed by self. |
TUIChangeReasonByAdmin | 1 | Changed by the owner and administrator. |
TUIKickedOutOfRoomReason
TUIKickedOutOfRoomReason
Reasons for users being kicked out of the room.
枚举 | 取值 | 描述 |
TUIKickedOutOfRoomReasonByAdmin | 0 | Kicked by owner or administrator. |
TUIKickedOutOfRoomReasonByLoggedOnOtherDevice | 1 | Kicked out when other devices enter the room. |
TUIKickedOutOfRoomReasonByServer | 2 | Kicked out by the server. |
TUIResolutionMode
TUIResolutionMode
Resolution mode.
枚举 | 取值 | 描述 |
TUIResolutionModeLandscape | 0 | Landscape. |
TUIResolutionModePortrait | 1 | Portrait. |
TUICaptureSourceType
TUICaptureSourceType
Screen sharing capture source type.
枚举 | 取值 | 描述 |
TUICaptureSourceTypeUnknown | -1 | Undefine. |
TUICaptureSourceTypeWindow | 0 | Window. |
TUICaptureSourceTypeScreen | 1 | Screen. |
TUIRequestAction
TUIRequestAction
Request type.
枚举 | 取值 | 描述 |
TUIRequestActionInvalidAction | 0 | Invalid request. |
TUIRequestActionOpenRemoteCamera | 1 | Request the remote user to open the camera. |
TUIRequestActionOpenRemoteMicrophone | 2 | Request the remote user to open the microphone. |
TUIRequestActionConnectOtherRoom | 3 | Request to connect to another room. |
TUIRequestActionTakeSeat | 4 | Request to take seat. |
TUIRequestActionRemoteUserOnSeat | 5 | Request the remote user to take seat. |
TUIRequestActionApplyToAdminToOpenLocalCamera | 6 | Request to open local camera by the administrator. |
TUIRequestActionApplyToAdminToOpenLocalMicrophone | 7 | Request to open local microphone by the administrator. |
TUIRequestActionApplyToAdminToOpenLocalScreenShare | 8 | Request to enable the screen sharing by the administrator. |
TUIRoomInfo
TUIRoomInfo
Room information.
枚举类型 | 描述 |
createTime | The room creation time (read-only). |
isCameraDisableForAllUser | Whether to prohibit opening the camera (optional parameter for creating a room), default value: NO. |
isMessageDisableForAllUser | Whether to prohibit sending messages (optional parameter for creating a room), default value: NO. |
isMicrophoneDisableForAllUser | Whether to prohibit opening the microphone (optional parameter for creating a room), default value: NO. |
isScreenShareDisableForAllUser | Whether to prohibit enabling the screen sharing (optional parameter for creating a room), default value: NO. |
isSeatEnabled | Whether to enable seat control. |
maxSeatCount | Maximum number of seat. |
memberCount | The count of members in the room (read-only). |
name | Room name (Optional parameter, default is room ID). |
ownerAvatarUrl | Room owner avatar URL: Defaults to the room creator's avatar URL (read-only). |
ownerId | Owner ID: Defaults to the room creator (read-only). |
ownerName | Room owner name: Defaults to the room creator's name (read-only). |
password | Room password. |
roomId | Room ID (String type, required parameter for creating room). |
roomType | |
seatMode | Seat mode (only available after isSeatEnabled is true). |
speechMode | Room speech mode (starting from v2.0, this function has been deprecated. It is recommended to use isSeatEnabled (whether to enable seat control) instead). |
TUILoginUserInfo
TUILoginUserInfo
User login information.
枚举类型 | 描述 |
avatarUrl | User avatar URL. |
customInfo | Custom information. |
userId | User ID. |
userName | User name. |
TUIUserInfo
TUIUserInfo
User information in the room.
枚举类型 | 描述 |
avatarUrl | Use avatar URL. |
hasAudioStream | The current user whether has audio stream, default value: NO. |
hasScreenStream | The current user whether has screen sharing stream, default value: NO. |
hasVideoStream | The current user whether has video stream, default value: NO. |
isMessageDisabled | Whether sending messages is disabled, default value: NO. |
roomCustomInfo | Room user custom information. |
userId | User ID. |
userName | User name. |
userRole |
TUIRoomVideoEncoderParams
TUIRoomVideoEncoderParams
Video encoding parameters.
枚举类型 | 描述 |
bitrate | Target video bitrate. |
fps | Video capture frame rate. |
resolutionMode | |
videoResolution |
TUISeatInfo
TUISeatInfo
Room seat information.
枚举类型 | 描述 |
avatarUrl | User avatar URL. |
index | Seat index. |
isAudioLocked | Whether the seat is prohibited from opening the microphone. Default value: NO. |
isLocked | Whether the seat is locked. Default value: NO. |
isVideoLocked | Whether the seat is prohibited from opening the camera. Default value: NO. |
userId | User ID. |
userName | User name. |
TUISeatLockParams
TUISeatLockParams
Lock seat parameters.
枚举类型 | 描述 |
lockAudio | Lock seat audio, default value: NO. |
lockSeat | Lock seat, default value: NO. |
lockVideo | Lock seat camera, default value: NO. |
TUIUserVoiceVolume
TUIUserVoiceVolume
User volume in the room.
枚举类型 | 描述 |
userId | User ID. |
volume | Volume: The volume of all users who are speaking, the value range is 0 - 100. |
TUIRequest
TUIRequest
Request.
枚举类型 | 描述 |
avatarUrl | User avatar URL. |
content | Request content. |
requestAction | |
requestId | Request ID. |
timestamp | Timestamp. |
userId | User ID. |
userName | User name. |
TUIEnterRoomOptions
TUIEnterRoomOptions
Enter a room parameters.
枚举类型 | 描述 |
password | Room password. |
