TRTC Flutter Core SDK

https://trtc.io/zh/document/67264?product=live&menulabel=core
Admin
TRTC Flutter Core SDK (TUIRoomEngine) is a real-time audio and video communication component for...
Tokens:2,865
Snippets:21
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Integrate TUIRoomEngine in Flutter Project

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

This snippet shows how to add the TUIRoomEngine SDK to your Flutter project's dependencies in the `pubspec.yaml` file and install it using the Flutter package manager.

```yaml
dependencies:
  rtc_room_engine: 最新版本
```

```bash
flutter pub get
```

--------------------------------

### TUIRoomEngine Remote Video Management API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

This API group handles the rendering and management of remote users' video streams. It includes setting up video views for remote participants, starting and stopping video playback, and muting remote audio streams. These functions are key for displaying and controlling incoming video feeds.

```dart
// Set remote user video rendering control
TUIRoomEngine.setRemoteVideoView(...);

// Start playing remote user video
TUIRoomEngine.startPlayRemoteVideo(...);

// Stop playing remote user video
TUIRoomEngine.stopPlayRemoteVideo(...);

// Mute remote user audio stream
TUIRoomEngine.muteRemoteAudioStream(...);
```

--------------------------------

### TUIRoomEngine Core Methods for Initialization and Management

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

This section details the core methods of the TUIRoomEngine API for initializing, logging in/out, managing user information, and setting up event observers. These methods are fundamental for establishing and maintaining a connection within the TRTC system.

```dart
// Create TUIRoomEngine instance
TUIRoomEngine.sharedInstance();

// Destroy TUIRoomEngine instance
TUIRoomEngine.destroyISharedinstance();

// Login interface
TUIRoomEngine.login(...);

// Logout interface
TUIRoomEngine.logout();

// Set local user name and avatar
TUIRoomEngine.setSelfInfo(...);

// Set login user information
TUIRoomEngine.setLoginUserInfo(...);

// Get local user login basic information
TUIRoomEngine.getSelfInfo();

// Set event callback
TUIRoomEngine.addObserver(...);

// Remove event callback
TUIRoomEngine.removeObserver(...);
```

--------------------------------

### TUIRoomObserver Callback Events

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

Callback events for TUIRoomEngine, allowing monitoring of various room-related events.

```APIDOC
## TUIRoomObserver Callback Events

### Description
Callback events for TUIRoomEngine, allowing monitoring of various room-related events.

### Error Callback

#### onError

##### Description
Error event callback.

### Login Status Event Callback

#### onKickedOffLine

##### Description
Other terminals logged in and were kicked offline.

#### onUserSigExpired

##### Description
User ticket expiration event.

### Room Events Callback

#### onRoomNameChanged

##### Description
Room name changed event.

#### onAllUserMicrophoneDisableChanged

##### Description
All users' microphones in the room were disabled event.

#### onAllUserCameraDisableChanged

##### Description
All users' cameras in the room were disabled event.

#### onScreenShareForAllUserDisableChanged

##### Description
All users' screen sharing in the room was disabled event.

#### onSendMessageForAllUserDisableChanged

##### Description
All users' ability to send text messages in the room was disabled event.

#### onKickedOutOfRoom

##### Description
Kicked out of the room event.

#### onRoomDismissed

##### Description
Room dismissed event.

#### onRoomSeatModeChanged

##### Description
Room seat mode changed event.

#### onRoomUserCountChanged

##### Description
Room user count changed event.

### Room User Events Callback

#### onRemoteUserEnterRoom

##### Description
Remote user entered room event.

#### onRemoteUserLeaveRoom

##### Description
Remote user left room event.

#### onUserRoleChanged

##### Description
User role changed event.

#### onUserVideoStateChanged

##### Description
User video state changed event.

#### onUserAudioStateChanged

##### Description
User audio state changed event.

#### onUserVoiceVolumeChanged

##### Description
User voice volume changed event.

#### onSendMessageForUserDisableChanged

##### Description
User text message sending capability changed event.

#### onUserNetworkQualityChanged

##### Description
User network quality changed event.

#### onUserScreenCaptureStopped

##### Description
Screen capture stopped event.

### Room Seat Events Callback

#### onRoomMaxSeatCountChanged

##### Description
Maximum seat count in the room changed event (only effective in meeting-type rooms).

#### onSeatListChanged

##### Description
Seat list changed event.

#### onKickedOffSeat

##### Description
Received event of user being removed from a seat.

### Request Signaling Event Callback

#### onRequestReceived

##### Description
Received request message event.

#### onRequestCancelled

##### Description
Received request cancellation event.

#### onRequestProcessed

##### Description
Received event of request being processed by another administrator/room owner.

```

--------------------------------

### TUIRoomEngine Room Management API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

This set of APIs allows for the creation, destruction, entry, and exit of audio/video rooms. It also includes functionalities for connecting to and disconnecting from other rooms, fetching room information, and administrative actions like updating room names and management modes.

```dart
// Create a room
TUIRoomEngine.createRoom(...);

// Destroy a room
TUIRoomEngine.destroyRoom(...);

// Enter a room
TUIRoomEngine.enterRoom(...);

// Exit a room
TUIRoomEngine.exitRoom();

// Connect to another room
TUIRoomEngine.connectOtherRoom(...);

// Disconnect from another room
TUIRoomEngine.disconnectOtherRoom();

// Fetch room information
TUIRoomEngine.fetchRoomInfo(...);

// Update room name by admin
TUIRoomEngine.updateRoomNameByAdmin(...);

// Set room management mode by admin
TUIRoomEngine.updateRoomSeatModeByAdmin(...);
```

--------------------------------

### Room User Speaking Management API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

APIs for controlling user media device permissions and requests.

```APIDOC
## Room User Speaking Management API

### Description
APIs for controlling user media device permissions and requests.

### disableDeviceForAllUserByAdmin

#### Description
Controls whether all users in the current room can enable audio or video streams. For example, globally disable microphones, cameras, or screen sharing. Currently only available in meeting scenarios, and only administrators or room owners can call this.

### openRemoteDeviceByAdmin

#### Description
Requests a remote user to open their media device. Only administrators or room owners can call this.

### closeRemoteDeviceByAdmin

#### Description
Closes a remote user's media device. Only administrators or room owners can call this.

### applyToAdminToOpenLocalDevice

#### Description
Requests to open the local media device. Available for regular users.

```

--------------------------------

### Room User Management API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

APIs for managing user roles, names, and tags within a room.

```APIDOC
## Room User Management API

### Description
APIs for managing user roles, names, and tags within a room.

### changeUserRole

#### Description
Modifies the user role. Only administrators or room owners can call this.

### changeUserNameCard

#### Description
Modifies the user's nickname.

### kickRemoteUserOutOfRoom

#### Description
Removes a remote user from the room. Only administrators or room owners can call this.

### addCategoryTagForUsers

#### Description
Adds a tag for users. Only room owners can call this.

### removeCategoryTagForUsers

#### Description
Removes a tag for users. Only room owners can call this.

### getUserListByTag

#### Description
Retrieves room user information based on tags.

### setCustomInfoForUser

#### Description
Sets custom information for room members.

```

--------------------------------

### Debugging API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

API for calling experimental interfaces.

```APIDOC
## Debugging API

### Description
API for calling experimental interfaces.

### callExperimentalAPI

#### Description
Calls an experimental interface.

```

--------------------------------

### Room User Information API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

APIs for retrieving information about users within a room.

```APIDOC
## Room User Information API

### Description
APIs for retrieving information about users within a room.

### getUserList

#### Description
Gets the list of members in the room.

### getUserInfo

#### Description
Gets member information.

```

--------------------------------

### TUIRoomEngine Local Video Management API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

This API group focuses on managing the local user's video feed. It includes setting up video rendering, controlling the camera, adjusting video quality, and initiating/stopping screen sharing. These functions are essential for user-initiated video and screen sharing.

```dart
// Set local user video rendering control
TUIRoomEngine.setLocalVideoView(...);

// Open local camera
TUIRoomEngine.openLocalCamera();

// Close local camera
TUIRoomEngine.closeLocalCamera();

// Update local video encoding quality settings
TUIRoomEngine.updateVideoQuality(...);

// Set video encoder parameters
TUIRoomEngine.updateVideoQualityEx(...);

// Set video encoder resolution mode
TUIRoomEngine.setVideoResolutionMode(...);

// Enable gravity sensor mode
TUIRoomEngine.enableGravitySensor();

// Start pushing local video
TUIRoomEngine.startPushLocalVideo();

// Stop pushing local video
TUIRoomEngine.stopPushLocalVideo();

// Start screen sharing
TUIRoomEngine.startScreenSharing();

// End screen sharing
TUIRoomEngine.stopScreenSharing();
```

--------------------------------

### TUIRoomEngine Local Audio Management API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

This set of APIs allows for the control of the local user's audio stream. It includes opening and closing the microphone, updating audio quality settings, and muting/unmuting the local audio feed. These are critical for managing user audio participation.

```dart
// Open local microphone
TUIRoomEngine.openLocalMicrophone();

// Close local microphone
TUIRoomEngine.closeLocalMicrophone();

// Update local audio encoding quality settings
TUIRoomEngine.updateAudioQuality(...);

// Mute local audio stream
TUIRoomEngine.muteLocalAudio();

// Unmute local audio stream
TUIRoomEngine.unMuteLocalAudio();
```

--------------------------------

### Send Message API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

APIs for controlling message sending capabilities for users in a room.

```APIDOC
## Send Message API

### Description
APIs for controlling message sending capabilities for users in a room.

### disableSendingMessageByAdmin

#### Description
Disables a remote user's ability to send text messages. Only administrators or room owners can call this.

### disableSendingMessageForAllUser

#### Description
Disables all users' ability to send text messages. Only administrators or room owners can call this.

```

--------------------------------

### Advanced Features API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

APIs for advanced features like beauty effects and device management.

```APIDOC
## Advanced Features API

### Description
APIs for advanced features like beauty effects and device management.

### setBeautyLevel

#### Description
Sets the beauty level.

### setWhitenessLevel

#### Description
Sets the whiteness level.

### getExtension

#### Description
Gets the plugin.

### getMediaDeviceManager

#### Description
Gets the device management class.

```

--------------------------------

### Room Seat Management API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

APIs for managing seating arrangements and applications within a room.

```APIDOC
## Room Seat Management API

### Description
APIs for managing seating arrangements and applications within a room.

### setMaxSeatCount

#### Description
Sets the maximum number of seats. Only settable before entering the room or during room creation.

### getSeatList

#### Description
Retrieves the list of seats.

### getSeatApplicationList

#### Description
Host/Administrator retrieves the request list of users applying to be on a seat.

### lockSeatByAdmin

#### Description
Locks a seat. Only administrators or room owners can call this, including position locking, audio status locking, and video status locking.

### takeSeat

#### Description
Applies to be on a seat. No application needed in free speaking mode.

### leaveSeat

#### Description
Applies to leave a seat. No application needed in free speaking mode.

### moveToSeat

#### Description
Moves a user to a different seat.

### takeUserOnSeatByAdmin

#### Description
Host/Administrator invites a user to take a seat.

### kickUserOffSeatByAdmin

#### Description
Host/Administrator removes a user from a seat.

```

--------------------------------

### Signaling Management API

Source: https://trtc.io/zh/document/67264?product=live&menulabel=core/index_menulabel=core+sdk&platform=flutter&product=live

APIs for managing signaling requests and responses.

```APIDOC
## Signaling Management API

### Description
APIs for managing signaling requests and responses.

### cancelRequest

#### Description
Cancels a request.

### responseRemoteRequest

#### Description
Responds to a remote request.

```
Tokens:
Raw