rtc_room_engine library

Classes

DeprecatedRoomEngineAPI

TUIActionCallback

TUIBattleConfig

TUIBattleInfo

TUIBattleRequestResult

TUIBattleUser

TUIConferenceInfo

Conference information

TUIConferenceListManager

Abstract class for managing conference list operations.

TUIConferenceListManagerObserver

TUIConnectionRequestResult

TUIConnectionUser

TUIEnterRoomOptions

4.9 Enter room options

TUILiveBattleManager

TUILiveBattleObserver

TUILiveConnectionManager

TUILiveConnectionObserver

TUILiveInfo

TUILiveLayoutManager

TUILiveLayoutObserver

TUILiveListManager

Abstract class for managing live list operations.

TUILiveListObserver

TUILiveListResult

TUILoginUserInfo

4.2 User Information in the Room

TUINetwork

1.4 Network Quality Information

TUIPlayCallback

TUIRequest

4.7 Signaling Request

TUIRequestCallback

TUIRoomDeviceManager

TUIRoomEngine

TUIRoomInfo

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 4.1 Room Information TUIRoomEngine supports only string room IDs.

TUIRoomObserver

TUIRoomEngine Event Callback Interface

TUIRoomVideoEncoderParams

4.8 Video encoding parameters

TUIScheduledAttendeesResult

TUIScheduledAttendeesResult.

TUIScheduledConferenceListResult

TUIScheduledConferenceListResult.

TUISeatInfo

4.4 Seat Information in the Room

TUISeatLockParams

4.5 Lock Seat Operation Parameters

TUIUserInfo

4.3 User Information in the Room

TUIUserListResult

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 5.1 TUIUserListResult Definition

TUIUserVoiceVolume

4.6 User Volume in the Room

TUIValueCallBack<T>

VideoView

Enums

TUIAudioQuality

2.2 Audio Quality

TUIAudioRoute

TUIBattleCode

Battle Code.

TUIBattleStoppedReason

Battle Stopped Reason

TUICaptureSourceType

2.5 Screen Sharing Capture Source Types

TUIChangeReason

2.4 Reason for Modification (Reason for user's audio-video status change: Self-initiated modification or Modified by the host or administrator)

TUIConferenceCancelReason

Conference cancel reason.

TUIConferenceModifyFlag

Scheduled conference information modify flag.

TUIConferenceStatus

Conference status.

TUIConnectionCode

Connection Code.

TUIError

1.1 Error Code Enumeration Definition

TUIExtensionType

1.3 Extension Type

TUIKickedOutOfRoomReason

The reason why the user is kicked out of the room

TUILiveModifyFlag

TUIMediaDevice

1.4 Types of media devices in the room

TUINetworkQuality

1.2 Network Quality

TUIRequestAction

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 3.1 Request Types

TUIResolutionMode

2.6 Resolution mode

TUIRole

1.5 Types of roles in the room

TUIRoomDismissedReason

1.6 Types of room dismissed reason

TUIRoomType

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 1.1 Room Types

TUISeatMode

1.2 Take Seat Modes

TUIUserInfoModifyFlag

1.7 Types of userInfo modify flag

TUIVideoQuality

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 2.1 Video Quality

TUIVideoStreamType

2.3 Video Stream Types

Extensions

TUIAudioQualityExt on TUIAudioQuality

TUIAudioRouteExt on TUIAudioRoute

TUIBattleCodeExt on TUIBattleCode

TUIBattleStoppedReasonExt on TUIBattleStoppedReason

TUICaptureSourceTypeExt on TUIChangeReason

TUIChangeReasonExt on TUIChangeReason

TUIConferenceCancelReasonExt on TUIConferenceCancelReason

TUIConferenceModifyFlagExt on TUIConferenceModifyFlag

TUIConferenceStatusExt on TUIConferenceStatus

TUIConnectionCodeExt on TUIConnectionCode

TUIErrorExt on TUIError

TUIExtensionTypeExt on TUIExtensionType

TUIKickedOutOfRoomReasonExt on TUIKickedOutOfRoomReason

TUILiveModifyFlagExt on TUILiveModifyFlag

TUIMediaDeviceExt on TUIMediaDevice

TUINetworkQualityExt on TUINetworkQuality

TUIRequestActionExt on TUIRequestAction

TUIResolutionModeExt on TUIResolutionMode

TUIRoleExt on TUIRole

TUIRoomDismissedReasonExt on TUIRoomDismissedReason

TUIRoomTypeExt on TUIRoomType

TUISeatModeExt on TUISeatMode

TUIUserInfoModifyFlagExt on TUIUserInfoModifyFlag

TUIVideoQualityExt on TUIVideoQuality

TUIVideoStreamTypeExt on TUIVideoStreamType

Typedefs

OnAllUserCameraDisableChanged = void Function(String roomId, bool isDisable)

OnAllUserMicrophoneDisableChanged = void Function(String roomId, bool isDisable)

OnBattleEnded = void Function(TUIBattleInfo battleInfo, TUIBattleStoppedReason reason)

OnBattleRequestAccept = void Function(TUIBattleInfo battleInfo, TUIBattleUser inviter, TUIBattleUser invitee)

OnBattleRequestCancelled = void Function(TUIBattleInfo battleInfo, TUIBattleUser inviter, TUIBattleUser invitee)

OnBattleRequestReceived = void Function(TUIBattleInfo battleInfo, TUIBattleUser inviter, TUIBattleUser invitee)

OnBattleRequestReject = void Function(TUIBattleInfo battleInfo, TUIBattleUser inviter, TUIBattleUser invitee)

OnBattleRequestTimeout = void Function(TUIBattleInfo battleInfo, TUIBattleUser inviter, TUIBattleUser invitee)

OnBattleScoreChanged = void Function(String battleId, List<TUIBattleUser> battleUserList)

OnBattleStarted = void Function(TUIBattleInfo battleInfo)

OnConferenceCancelled = void Function(String roomId, TUIConferenceCancelReason reason, TUIUserInfo operateUser)

OnConferenceInfoChanged = void Function(TUIConferenceInfo conferenceInfo, List<TUIConferenceModifyFlag> modifyFlagList)

OnConferenceScheduled = void Function(TUIConferenceInfo conferenceInfo)

OnConferenceStatusChanged = void Function(String roomId, TUIConferenceStatus status)

OnConferenceWillStart = void Function(TUIConferenceInfo conferenceInfo)

OnConnectionRequestAccept = void Function(TUIConnectionUser invitee)

OnConnectionRequestCancelled = void Function(TUIConnectionUser inviter)

OnConnectionRequestReceived = void Function(TUIConnectionUser inviter, List<TUIConnectionUser> inviteeList, String extensionInfo)

OnConnectionRequestReject = void Function(TUIConnectionUser invitee)

OnConnectionRequestTimeout = void Function(TUIConnectionUser inviter, TUIConnectionUser invitee)

OnConnectionUserListChanged = void Function(List<TUIConnectionUser> connectedList, List<TUIConnectionUser> joinedList, List<TUIConnectionUser> leavedList)

OnError = void Function(TUIError errorCode, String message)

OnKickedOffLine = void Function(String message)

OnKickedOffSeat = void Function(int seatIndex, TUIUserInfo operateUser)

OnKickedOutOfRoom = void Function(String roomId, TUIKickedOutOfRoomReason reason, String message)

OnLiveInfoChanged = void Function(TUILiveInfo liveInfo, List<TUILiveModifyFlag> modifyFlagList)

OnLiveVideoLayoutChanged = void Function(String roomId, String layoutInfo)

Copyright (c) 2025 Tencent. All rights reserved. Module: TUILiveLayoutManager @ TUIKitEngine Function: LiveLayout APIS.

OnLoading = void Function(String userId)

OnPlayError = void Function(String userId, TUIError code, String message)

OnPlaying = void Function(String userId)

OnRemoteUserEnterRoom = void Function(String roomId, TUIUserInfo userInfo)

OnRemoteUserLeaveRoom = void Function(String roomId, TUIUserInfo userInfo)

OnRequestCancelled = void Function(TUIRequest request, TUIUserInfo operateUser)

OnRequestProcessed = void Function(TUIRequest request, TUIUserInfo operateUser)

OnRequestReceived = void Function(TUIRequest request)

OnRoomDismissed = void Function(String roomId, TUIRoomDismissedReason reason)

OnRoomMaxSeatCountChanged = void Function(String roomId, int maxSeatCount)

OnRoomMetadataChanged = void Function(String key, String value)

OnRoomNameChanged = void Function(String roomId, String roomName)

OnRoomSeatModeChanged = void Function(String roomId, TUISeatMode seatMode)

OnRoomUserCountChanged = void Function(String roomId, int userCount)

OnScheduleAttendeesChanged = void Function(String roomId, List<TUIUserInfo> leftUsers, List<TUIUserInfo> joinedUsers)

OnScreenShareForAllUserDisableChanged = void Function(String roomId, bool isDisable)

OnSeatListChanged = void Function(List<TUISeatInfo> seatList, List<TUISeatInfo> seatedList, List<TUISeatInfo> leftList)

OnSendMessageForAllUserDisableChanged = void Function(String roomId, bool isDisable)

OnSendMessageForUserDisableChanged = void Function(String roomId, String userId, bool isDisable)

OnUserAudioStateChanged = void Function(String userId, bool hasAudio, TUIChangeReason reason)

OnUserExitBattle = void Function(String battleId, TUIBattleUser battleUser)

OnUserInfoChanged = void Function(TUIUserInfo userInfo, List<TUIUserInfoModifyFlag> modifyFlagList)

OnUserJoinBattle = void Function(String battleId, TUIBattleUser battleUser)

OnUserNetworkQualityChanged = void Function(Map<String, TUINetwork> networkMap)

OnUserScreenCaptureStopped = void Function(int reason)

OnUserSigExpired = void Function()

OnUserVideoStateChanged = void Function(String userId, TUIVideoStreamType streamType, bool hasVideo, TUIChangeReason reason)

OnUserVoiceVolumeChanged = void Function(Map<String, int> volumeMap)

RequestOnAccepted = void Function(String requestId, String userId)

RequestOnCancelled = void Function(String requestId, String userId)

RequestOnError = void Function(String requestId, String userId, TUIError error, String message)

RequestOnRejected = void Function(String requestId, String userId, String message)

RequestOnTimeout = void Function(String requestId, String userId)