TUIRoomEngineImpl class

Implemented types

• TUIRoomEngine

Constructors

TUIRoomEngineImpl()

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addCategoryTagForUsers(int tag, List<String> userList) → Future<TUIActionCallback>

7.4 Add a tag for the user (only the room owner can call it)

override

addObserver(TUIRoomObserver observer) → void

1.6 Set Event Callback

override

applyToAdminToOpenLocalDevice(TUIMediaDevice device, int timeout, TUIRequestCallback? requestCallback) → TUIRequest

8.4 Request to Open Local Media Device (Available for regular users)

override

cancelRequest(String requestId) → Future<TUIActionCallback>

11.1 Cancel Request

override

changeUserNameCard(String userId, String nameCard) → Future<TUIActionCallback>

7.2 Change user nickname in the room (only support to change all user for administrators or room owner, user can only change by self). userId User ID to change. nameCard User nickname to set, maximum support is 32 bytes

override

changeUserRole(String userId, TUIRole role) → Future<TUIActionCallback>

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 7.1 Modify User Role

override

closeLocalCamera() → void

3.3 Close Local Camera

override

closeLocalMicrophone() → void

4.2 Close Local Microphone

override

closeRemoteDeviceByAdmin(String userId, TUIMediaDevice device) → Future<TUIActionCallback>

8.3 Close Remote User's Media Device

override

createRoom(TUIRoomInfo roomInfo) → Future<TUIActionCallback>

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 2.1 Create Room

override

destroyInstance() → void

destroyRoom() → Future<TUIActionCallback>

2.2 Dissolve Room

override

disableDeviceForAllUserByAdmin(TUIMediaDevice device, bool isDisable) → Future<TUIActionCallback>

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 8.1 Room-wide Media Device Management

override

disableSendingMessageByAdmin(String userId, bool isDisable) → Future<TUIActionCallback>

10.1 Disable Remote User's Text Message Sending Capability (Accessible only by administrators or group owners)

override

disableSendingMessageForAllUser(bool isDisable) → Future<TUIActionCallback>

10.2 Disable Text Message Sending Capability for All Users (Accessible only by administrators or group owners)

override

enableGravitySensor(bool enable) → void

3.7 enable gravity sensing mode

override

enterRoom(String roomId, {TUIRoomType roomType = TUIRoomType.conference, TUIEnterRoomOptions? options}) → Future<TUIValueCallBack<TUIRoomInfo>>

2.3 Enter Room

override

exitRoom(bool syncWaiting) → Future<TUIActionCallback>

2.4 Leave Room

override

fetchRoomInfo() → Future<TUIValueCallBack<TUIRoomInfo>>

2.5 Get Room Information

override

getExtension(TUIExtensionType extensionType) → dynamic

12.4 Get Extension

override

getMediaDeviceManager() → TUIRoomDeviceManager

12.5 Get media device manager

override

getSeatApplicationList() → Future<TUIValueCallBack<List<TUIRequest>>>

9.3 Get the request list of users in the room who applied for take seat

override

getSeatList() → Future<TUIValueCallBack<List<TUISeatInfo>>>

9.2 Get Seat List with a callback to notify the success or failure of the interface call. The successful callback will include a list of TUISeatInfo information.

override

getUserInfo(String userId) → Future<TUIValueCallBack<TUIUserInfo>>

6.2 Get Member Information

override

getUserList(int nextSequence) → Future<TUIValueCallBack<TUIUserListResult>>

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 6.1 Get Member List in the Room

override

getUserListByTag(int tag, int nextSequence) → Future<TUIValueCallBack<TUIUserListResult>>

7.6 Get user information in the room based on tags

override

kickRemoteUserOutOfRoom(String userId) → Future<TUIActionCallback>

7.3 Kick Remote User from the Room (Accessible only by administrators or room owner)

override

kickUserOffSeatByAdmin(int seatIndex, String userId) → Future<TUIActionCallback>

9.9 The host/administrator removes the user from the seat. The callback is used to notify the success or failure of the API call.

override

leaveSeat() → Future<TUIActionCallback>

9.6 Take off the local seat. The callback is used to notify the success or failure of the API call.

override

lockSeatByAdmin(int seatIndex, TUISeatLockParams lockParams) → Future<TUIActionCallback>

9.4 Lock Seat

override

moveToSeat(int targetSeatIndex) → Future<TUIActionCallback>

9.7 Move to other seat.

override

muteLocalAudio() → Future<TUIActionCallback>

4.4 Mute Local Audio

override

muteRemoteAudioStream(String userId, bool isMute) → void

5.4 Mute Remote User's Audio

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

openLocalCamera(bool isFront, TUIVideoQuality quality) → Future<TUIActionCallback>

3.2 Open Local Camera

override

openLocalMicrophone(TUIAudioQuality quality) → Future<TUIActionCallback>

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 4.1 Open Local Microphone

override

openRemoteDeviceByAdmin(String userId, TUIMediaDevice device, int timeout, TUIRequestCallback? requestCallback) → TUIRequest

8.2 Request Remote User to Open Media Device

override

removeCategoryTagForUsers(int tag, List<String> userList) → Future<TUIActionCallback>

7.5 Remove tag for user (only the room owner can call it)

override

removeObserver(TUIRoomObserver observer) → void

1.7 Remove Event Callback

override

responseRemoteRequest(String requestId, bool agree) → Future<TUIActionCallback>

11.2 Respond to Request

override

setBeautyLevel(int beautyStyle, int beautyLevel) → void

12.2 Set beauty level

override

setCustomInfoForUser(String userId, Map<String, String> customInfo) → Future<TUIActionCallback>

7.7 Set custom info for user in the room

override

setLocalVideoView(int viewId) → void

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 3.1 Set the View Control for Local User Video Rendering

override

setMaxSeatCount(int maxSeatCount) → Future<TUIActionCallback>

9.1 Set Maximum Number of Seats with a callback to notify the success or failure of the interface call

override

setRemoteVideoView(String userId, TUIVideoStreamType streamType, int view) → void

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// 5.1 Set the View Control for Remote User Video Rendering

override

setVideoResolutionMode(TUIVideoStreamType streamType, TUIResolutionMode resolutionMode) → void

3.6 Set video encoder resolution mode (horizontal screen resolution or vertical screen resolution)

override

setWhitenessLevel(int whitenessLevel) → void

12.3 Set whitening level

override

startPlayRemoteVideo(String userId, TUIVideoStreamType streamType, TUIPlayCallback? playCallback) → void

5.2 Start Playing Remote User Video

override

startPushLocalAudio() → void

////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////// Start Pushing Local Audio

override

startPushLocalVideo() → void

3.8 Start Pushing Local Video. Enabled by default.

override

startScreenSharing({String appGroup = ''}) → Future<void>

3.10 Start screen sharing

override

stopPlayRemoteVideo(String userId, TUIVideoStreamType streamType) → void

5.3 Stop Playing Remote User Video

override

stopPushLocalAudio() → void

Stop Pushing Local Audio

override

stopPushLocalVideo() → void

3.9 Stop Pushing Local Video

override

stopScreenSharing() → Future<void>

3.11 Stop screen sharing

override

switchCamera(bool isFrontCamera) → Future<int?>

Switch front or rear camera

override

takeSeat(int seatIndex, int timeout, TUIRequestCallback? requestCallback) → TUIRequest

9.5 The user takes a seat locally

override

takeUserOnSeatByAdmin(int seatIndex, String userId, int timeout, TUIRequestCallback? requestCallback) → TUIRequest

9.8 The host/administrator invites a user to take a seat.

override

toString() → String

A string representation of this object.

inherited

unMuteLocalAudio() → Future<TUIActionCallback>

4.5 UnMute Local Audio

override

updateAudioQuality(TUIAudioQuality quality) → void

4.3 Update Local Audio Encoding Quality Settings

override

updateRoomNameByAdmin(String roomName) → Future<TUIActionCallback>

2.6 Update Room Information

override

updateRoomPasswordByAdmin(String password) → Future<TUIActionCallback>

2.8 Update Room password

override

updateRoomSeatModeByAdmin(TUISeatMode seatMode) → Future<TUIActionCallback>

2.7 Update Room Seat Mode

override

updateVideoQuality(TUIVideoQuality quality) → void

3.4 Update Local Video Encoding Quality Settings

override

updateVideoQualityEx(TUIVideoStreamType streamType, TUIRoomVideoEncoderParams params) → void

3.5 Set the encoding parameters of the video encoder

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

callExperimentalAPI(String jsonStr) → void

12.1 Call experimental interface

override

destroySharedInstance() → void

Destroy TUIRoomEngine destroySharedInstance

override

getSelfInfo() → TUILoginUserInfo

1.5 Get Local User Basic Information

override

login(int sdkAppId, String userId, String userSig) → Future<TUIActionCallback>

1.1 Login Interface - You need to initialize user information before entering the room and performing a series of operations.

override

logout() → Future<TUIActionCallback>

1.2 Logout Interface - It includes actively leaving the room and destroying resources.

override

setLoginUserInfo(TUILoginUserInfo userInfo) → Future<TUIActionCallback>

1.4 Set Loaded User's User Information

override

setSelfInfo(String userName, String avatarURL) → Future<TUIActionCallback>

1.3 Set Local User Name and Avatar

override