tencent_live_uikit library

Classes

AbstractTUIExtension
AbstractTUIService
Barrage
BarrageDisplayController
BarrageDisplayWidget
BarrageInputPanelWidget
BarrageItemWidget
BarrageLocalizations
Callers can lookup localized strings with an instance of BarrageLocalizations returned by BarrageLocalizations.of(context).
BarrageSendController
BarrageSendWidget
BarrageState
BarrageStore
BarrageUser
CustomBarrageBuilder
Data
DeprecatedRoomEngineAPI
GiftDisplayController
GiftDisplayWidget
GiftJson
GiftLocalizations
Callers can lookup localized strings with an instance of GiftLocalizations returned by GiftLocalizations.of(context).
GiftMessage
GiftModel
GiftPanelWidget
GiftPanelWidgetState
GiftSendController
GiftSendWidget
GiftState
GiftStore
GiftUser
ITUINotification
LikeJson
LikeSendController
LikeSendWidget
LiveIdentityGenerator
LiveKitLocalizations
Callers can lookup localized strings with an instance of LiveKitLocalizations returned by LiveKitLocalizations.of(context).
LiveListWidget
PageWidget
PageWidgetState
RoomParams
TUIActionCallback
TUIBattleConfig
TUIBattleInfo
TUIBattleRequestResult
TUIBattleUser
TUICallback
TUIConferenceInfo
Conference information
TUIConferenceListManager
Abstract class for managing conference list operations.
TUIConferenceListManagerObserver
TUIConnectionRequestResult
TUIConnectionUser
TUICore
TUIEnterRoomOptions
4.9 Enter room options
TUILiveBattleManager
TUILiveBattleObserver
TUILiveConnectionManager
TUILiveConnectionObserver
TUILiveInfo
TUILiveKitNavigatorObserver
TUILiveLayoutManager
TUILiveLayoutObserver
TUILiveListManager
Abstract class for managing live list operations.
TUILiveListObserver
TUILiveListResult
TUILiveRoomAnchorWidget
TUILiveRoomAnchorWidgetState
TUILiveRoomAudienceWidget
TUILiveRoomAudienceWidgetState
TUILogin
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
TUIToast
TUIUserInfo
4.3 User Information in the Room
TUIUserListResult
////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 5.1 TUIUserListResult Definition
TUIUserVoiceVolume
4.6 User Volume in the Room
TUIValueCallBack<T>
TUIVoiceRoomWidget
VideoView

Enums

RoomBehavior
RoomType
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.
TUIDuration
TUIError
1.1 Error Code Enumeration Definition
TUIExtensionID
TUIExtensionProtocol
TUIExtensionType
1.3 Extension Type
TUIGravity
Toast
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

Constants

GROUP_ID → const String
imSDKInitSuccessEvent → const String
loginSuccessEvent → const String
logoutSuccessEvent → const String
maxConnectedViewersCount → const int
METHOD_NAME_CALL → const String
uikit call method name and param keys
METHOD_NAME_ENABLE_FLOAT_WINDOW → const String
uikit enable float window method name and param keys
PARAM_NAME_ENABLE_FLOAT_WINDOW → const String
PARAM_NAME_GROUPID → const String
PARAM_NAME_TYPE → const String
PARAM_NAME_USERIDS → const String
TUICALLKIT_SERVICE_NAME → const String
TYPE_AUDIO → const String
TYPE_VIDEO → const String

Typedefs

ITUINotificationCallback = void Function(dynamic arg)
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)
OnReceiveGiftCallback = void Function(GiftMessage message)
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)
OnSendGiftCallback = void Function(GiftMessage message)
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)