rtc_room_engine library

Platform interface for rtc_room_engine plugin

Classes

CallObserverExtraInfo
DeprecatedRoomEngineAPI
SeatFullInfo
SeatLayout
TUIActionCallback
TUIBattleConfig
TUIBattleInfo
TUIBattleRequestResult
TUIBattleUser
TUICallDefine
TUICallEngine
TUICallError
Indicates the error code during the calls.
TUICallObserver
The TUICallObserver class. TUICallObserver is used to observe TUICallEngine event that you are interested in.
TUICallParams
TUICallRecentCallsFilter
TUICallRecords
TUIConferenceInfo
Conference information
TUIConferenceInvitationManager
Abstract class for managing conference invitation operations.
TUIConferenceInvitationObserver
TUIConferenceListManager
Abstract class for managing conference list operations.
TUIConferenceListManagerObserver
TUIConnectionRequestResult
TUIConnectionUser
TUIEnterRoomOptions
4.9 Enter room options
TUIGiftCategory
TUIGiftCountRequestResult
TUIGiftInfo
TUIInvitation
Invitation information.
TUIInvitationListResult
Invitation list result.
TUIInviteUsersResult
Invite users result.
TUILiveBattleManager
TUILiveBattleObserver
TUILiveConnectionManager
TUILiveConnectionObserver
TUILiveGiftManager
TUILiveGiftObserver
TUILiveInfo
TUILiveLayoutManager
TUILiveLayoutObserver
TUILiveListManager
Abstract class for managing live list operations.
TUILiveListObserver
TUILiveListResult
TUILiveStatisticsData
TUILoginUserInfo
4.2 User Information in the Room
TUINetwork
1.4 Network Quality Information
TUINetworkQualityInfo
network quality info
TUIOfflinePushInfo
TUIPlayCallback
TUIRequest
4.7 Signaling Request
TUIRequestCallback
TUIRequestCompletion
TUIResult
Generic function return type
TUIRoomCustomMessage
4.11 Custom message in room
TUIRoomDeviceManager
TUIRoomEngine
TUIRoomId
Indicates the media room id of the calls.
TUIRoomInfo
////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 4.1 Room Information TUIRoomEngine supports only string room IDs.
TUIRoomObserver
TUIRoomEngine Event Callback Interface
TUIRoomTextMessage
4.10 Text message in room
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
TUIUserSearchParam
4.12 Search param
TUIUserSearchResult
5.2 TUIUserSearchResult Definition
TUIUserVoiceVolume
4.6 User Volume in the Room
TUIValueCallBack<T>
VideoEncoderParams
Video encoding parameters
VideoRenderParams
VideoView

Enums

CallEndReason
DeviceStatus
FillMode
Resolution
ResolutionMode
Rotation
SuspendStatus
TUIAudioPlaybackDevice
TUIAudioQuality
2.2 Audio Quality
TUIAudioRoute
TUIBattleCode
Battle Code.
TUIBattleStoppedReason
Battle Stopped Reason
TUICallIOSOfflinePushType
TUICallMediaType
Indicates the media type of the calls.
TUICallObserverType
Observer event type. Each enum value maps to the same string name.
TUICallResultType
TUICallRole
Indicates the role in the calls.
TUICallScene
Indicates the call scene, including 1v1 calls, group calls etc.
TUICallStatus
Indicates the calls status
TUICamera
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
TUIInvitationCode
Invitation code for invite users result.
TUIInvitationRejectedReason
Invitation rejected reason.
TUIInvitationStatus
Invitation status.
TUIKickedOutOfRoomReason
The reason why the user is kicked out of the room
TUILiveModifyFlag
TUILiveStatisticsModifyFlag
TUIMediaDevice
1.4 Types of media devices in the room
TUIMoveSeatPolicy
1.8 Policy for moving users between seats
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
TUISeatLockFlag
1.9 Seat lock flag bits.
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

CallEndReasonExt on CallEndReason
FillModeExt on FillMode
ResolutionExt on Resolution
ResolutionModeExt on ResolutionMode
RotationExt on Rotation
TUIAudioPlaybackDeviceExt on TUIAudioPlaybackDevice
TUIAudioQualityExt on TUIAudioQuality
TUIAudioRouteExt on TUIAudioRoute
TUIBattleCodeExt on TUIBattleCode
TUIBattleStoppedReasonExt on TUIBattleStoppedReason
TUICallIOSOfflinePushTypeExt on TUICallIOSOfflinePushType
TUICallMediaTypeExt on TUICallMediaType
TUICallObserverTypeX on TUICallObserverType
TUICallResultTypeExt on TUICallResultType
TUICallRoleExt on TUICallRole
TUICallSceneExt on TUICallScene
TUICallStatusExt on TUICallStatus
TUICameraExt on TUICamera
TUICaptureSourceTypeExt on TUIChangeReason
TUIChangeReasonExt on TUIChangeReason
TUIConferenceCancelReasonExt on TUIConferenceCancelReason
TUIConferenceModifyFlagExt on TUIConferenceModifyFlag
TUIConferenceStatusExt on TUIConferenceStatus
TUIConnectionCodeExt on TUIConnectionCode
TUIErrorExt on TUIError
TUIExtensionTypeExt on TUIExtensionType
TUIInvitationCodeExt on TUIInvitationCode
TUIInvitationRejectedReasonExt on TUIInvitationRejectedReason
TUIInvitationStatusExt on TUIInvitationStatus
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

On = void Function(String key, String data)
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)
OnConferenceDidCancelled = void Function(TUIConferenceInfo conferenceInfo, TUIConferenceCancelReason reason, TUIUserInfo operateUser)
OnConferenceInfoChanged = void Function(TUIConferenceInfo conferenceInfo, List<TUIConferenceModifyFlag> modifyFlagList)
OnConferenceOwnerChanged = void Function(TUIConferenceInfo conferenceInfo, TUIUserInfo newOwner, TUIUserInfo oldOwner)
OnConferenceScheduled = void Function(TUIConferenceInfo conferenceInfo)
OnConferenceStatusChanged = void Function(String roomId, TUIConferenceStatus status)
OnConferenceStatusUpdated = void Function(TUIConferenceInfo conferenceInfo, 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)
OnGiftCountChanged = void Function(String roomId, int totalGiftsSent, int totalGiftCoins, int totalUniqueGiftSenders)
OnInvitationAccepted = void Function(TUIRoomInfo roomInfo, TUIInvitation invitation)
OnInvitationAdded = void Function(String roomId, TUIInvitation invitation)
OnInvitationCancelled = void Function(TUIRoomInfo roomInfo, TUIInvitation invitation)
OnInvitationHandledByOtherDevice = void Function(TUIRoomInfo roomInfo, bool accepted)
OnInvitationRejected = void Function(TUIRoomInfo roomInfo, TUIInvitation invitation, TUIInvitationRejectedReason reason)
OnInvitationRemoved = void Function(String roomId, TUIInvitation invitation)
OnInvitationRevokedByAdmin = void Function(TUIRoomInfo roomInfo, TUIInvitation invitation, TUIUserInfo admin)
OnInvitationStatusChanged = void Function(String roomId, TUIInvitation invitation)
OnInvitationTimeout = void Function(TUIRoomInfo roomInfo, TUIInvitation invitation)
OnKickedOffLine = void Function(String message)
OnKickedOffSeat = void Function(int seatIndex, TUIUserInfo operateUser)
OnKickedOffSeatEx = void Function(int seatIndex, TUIUserInfo operateUser, String extensionInfo)
OnKickedOutOfRoom = void Function(String roomId, TUIKickedOutOfRoomReason reason, String message)
OnLiveInfoChanged = void Function(TUILiveInfo liveInfo, List<TUILiveModifyFlag> modifyFlagList)
OnLiveStatisticsChanged = void Function(String roomId, TUILiveStatisticsData statisticsData, List<TUILiveStatisticsModifyFlag> modifyFlag)
OnLiveVideoLayoutChanged = void Function(String roomId, String layoutInfo)
OnLoading = void Function(String userId)
OnPlayError = void Function(String userId, TUIError code, String message)
OnPlaying = void Function(String userId)
OnReceiveCustomMessage = void Function(TUIRoomCustomMessage message)
OnReceiveGiftMessage = void Function(String roomId, TUIGiftInfo giftInfo, int count, TUIUserInfo sender)
OnReceiveInvitation = void Function(TUIRoomInfo roomInfo, TUIInvitation invitation, String extensionInfo)
OnReceiveLikesMessage = void Function(String roomId, int totalLikesReceived, TUIUserInfo sender)
OnReceiveTextMessage = void Function(TUIRoomTextMessage 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)
OnScheduleAttendeesUpdated = void Function(TUIConferenceInfo conferenceInfo, List<TUIUserInfo> leftUsers, List<TUIUserInfo> joinedUsers)
OnScreenShareForAllUserDisableChanged = void Function(String roomId, bool isDisable)
OnSeatLayoutChanged = void Function(String roomId, SeatLayout seatLayout)
OnSeatListChanged = void Function(List<TUISeatInfo> seatList, List<TUISeatInfo> seatedList, List<TUISeatInfo> leftList)
OnSeatListChangedEx = void Function(String roomId, List<SeatFullInfo> seatList, List<TUIUserInfo> newlySeatedUsers, List<TUIUserInfo> newlyLeftUsers)
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()
OnUserVideoSizeChanged = void Function(String roomId, String userId, TUIVideoStreamType streamType, int width, int height)
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)
SeatRequestOnAccepted = void Function(String requestId, TUIUserInfo userInfo, String extensionInfo)
SeatRequestOnCancelled = void Function(String requestId, TUIUserInfo userInfo)
SeatRequestOnError = void Function(String requestId, TUIUserInfo userInfo, TUIError error, String message)
SeatRequestOnRejected = void Function(String requestId, TUIUserInfo userInfo, String message, String extensionInfo)
SeatRequestOnTimeout = void Function(String requestId, TUIUserInfo userInfo)