Conference

Web
- Run Sample Demo
- Integration
- UI Customization
- Conference Control
- In-Conference Chat
- On-Cloud Recording
- AI Noise Suppression
- Robot Streaming
- Virtual Background
- More Features
  - Floating Window
  - Text Watermark
- API Documentation
  - RoomKit API
  - RoomEngine API
    - API Overview
    - TUIRoomEngine
    - TUIRoomEvents
    - TUIRoomEngine Defines
- FAQs
iOS
- Run Sample Demo
- Integration
- UI Customization
- Conference Control
- In-Conference Chat
- On-Cloud Recording
- AI Noise Suppression
- Robot Streaming
- More Features
  - Floating Window
- API Documentation
  - RoomKit API
  - RoomEngine API
    - API Overview
    - TUIRoomEngine
    - TUIRoomObserver
    - Type Definition
- FAQs
Android
- Run Sample Demo
- Integration
- UI Customization
- Conference Control
- In-Conference Chat
- On-Cloud Recording
- AI Noise Suppression
- Robot Streaming
- More Features
  - Floating Window
- API Documentation
  - RoomKit API
  - RoomEngine API
    - API Overview
    - TUIRoomEngine
    - TUIRoomObserver
    - Type Definition
- FAQs
Electron
- Run Sample Demo
- Integration
- UI Customization
- Conference Control
- In-Conference Chat
- On-Cloud Recording
- AI Noise Suppression
- Robot Streaming
- More Features
  - Floating Window
  - Text Watermark
- API Documentation
  - RoomKit API
  - RoomEngine API
    - API Overview
    - TUIRoomEvent
    - TUIRoomEngine
    - TUIRoomEngine Defines
- FAQs
Flutter
- Run Sample Demo
- Integration
- UI Customization
- Conference Control
- In-Conference Chat
- On-Cloud Recording
- AI Noise Suppression
- Robot Streaming
- More Features
  - Floating Window
- API Documentation
  - RoomKit API
  - RoomEngine API
    - API Overview
    - TUIRoomEngine
    - TUIRoomObserver
    - Type Definition
- FAQs
Overview
- Overview

Activate the Service
Pricing
- Free Minutes
- Conference Monthly Packages
- Billing Explanation for Subscription Package Duration
- Pay-as-you-go
  - Billing of Audio and Video Duration
  - Billing of On-Cloud Recording and Recording Delivery
  - Billing of MixTranscoding and Relay to CDN
Server APIs
- REST API
  - RESTful API Overview
  - RESTful API List
  - Room Management
    - Create a Room
    - Destroy a Room
    - Update the Room Information
    - Get the Room Information
  - User Management
    - Get the Room Member List
    - Update the Room Member Information
    - Change the Room Ownership
    - Mark Room Members
    - Ban Room Members
    - Unban Room Members
    - Get the Banned Room Member List
    - Remove Room Member
  - Seat Management
    - Get the Seat List
    - Pick User on the Seat
    - Kick User off the Seat
    - Lock the Seat
- Third-Party Callback
  - Callback Overview
  - Callback Command List
  - Callback Configuration
    - Query Callback Configuration
    - Create Callback Configuration
    - Update Callback Configuration
    - Delete Callback Configuration
  - Room Related
    - After a Room Is Created
    - After a Room Is Destroyed
    - After the Room Information Is Updated
  - User Related
    - After a Room Is Entered
    - After a Room Is Left
  - Seat Connection Related
    - After the Seat List Is Changed
Error Code

Conference

TUIRoomObserver

TUIRoomEngine Event Callback
onError
Error Event Callback
void onError(TUICommonDefine.Error errorCode, String message)
Parameter
Type
Description
errorCode
TUICommonDefine.Error
Error Code
message
String
Error Message
onKickedOffLine
Other terminals login and get kicked off event.
void onKickedOffLine(String message)
Parameter
Type
Description
message
String
Kicked out description
onUserSigExpired
User credential timeout event.
void onUserSigExpired()
onRoomNameChanged
Room name change event.
void onRoomNameChanged(String roomId, String roomName)
Parameter
Type
Description
roomId
String
Room ID
roomName
String
Room Name
onAllUserMicrophoneDisableChanged
Inside the room, all users' mic is disabled event.
void onAllUserMicrophoneDisableChanged(String roomId, boolean isDisable)
Parameter
Type
Description
roomId
String
Room ID
isDisable
boolean
Whether it is disabled
onAllUserCameraDisableChanged
All users' Camera in the Room are disabled event.
void onAllUserCameraDisableChanged(String roomId, boolean isDisable)
Parameter
Type
Description
roomId
String
Room ID
isDisable
boolean
Whether it is disabled
onSendMessageForAllUserDisableChanged
Inside the room, all users' text message sending is disabled event.
void onSendMessageForAllUserDisableChanged(String roomId, boolean isDisable)
Parameter
Type
Description
roomId
String
Room ID
isDisable
boolean
Whether it is disabled
onRoomDismissed
Room dissolution event.
void onRoomDismissed(String roomId)
Parameter
Type
Description
roomId
String
Room ID
onKickedOutOfRoom
Kick out of the room event
void onKickedOutOfRoom(String roomId, String message)
Parameter
Type
Description
roomId
String
Room ID
message
String
Description of being kicked out
onRoomSpeechModeChanged
Mic control mode changes in the room.
void onRoomSpeechModeChanged(String roomId, TUIRoomDefine.SpeechMode speechMode)
Parameter
Type
Description
roomId
String
Room ID
speechMode
﻿TUIRoomDefine.SpeechMode﻿
Mic control mode
onRemoteUserEnterRoom
Remote user enters the room event.
void onRemoteUserEnterRoom(String roomId, TUIRoomDefine.UserInfo userInfo)
Parameter
Type
Description
roomId
String
Room ID
userInfo
﻿TUIRoomDefine.UserInfo﻿
User information
onRemoteUserLeaveRoom
Remote user leaves the room event.
void onRemoteUserLeaveRoom(String roomId, TUIRoomDefine.UserInfo userInfo)
Parameter
Type
Description
roomId
String
Room ID
userInfo
﻿TUIRoomDefine.UserInfo﻿
User information
onUserRoleChanged
User role changes event.
void onUserRoleChanged(String userId, TUIRoomDefine.Role role) 
Parameter
Type
Description
userId
String
User ID
role
﻿TUIRoomDefine.Role﻿
User Role
onUserVideoStateChanged
User Video status changes event.
void onUserVideoStateChanged(String userId, 
                             TUIRoomDefine.VideoStreamType streamType, 
                             boolean hasVideo, 
                             TUIRoomDefine.ChangeReason reason)
Parameter
Type
Description
userId
String
User ID
streamType
﻿TUIRoomDefine.VideoStreamType﻿
Streams type
hasVideo
boolean
Whether there are streams
reason
﻿TUIRoomDefine.ChangeReason﻿
Reason for streams change
onUserAudioStateChanged
User Audio status changes event.
void onUserAudioStateChanged(String userId, boolean hasAudio, TUIRoomDefine.ChangeReason reason)
Parameter
Type
Description
userId
String
User ID
hasAudio
boolean
Whether there are Audio streams
reason
﻿TUIRoomDefine.ChangeReason﻿
Reason for Audio streams change
onUserVoiceVolumeChanged
User volume change event.
void onUserVoiceVolumeChanged(Map<String, Integer> volumeMap) 
Parameter
Type
Description
volumeMap
Map
User Volume Map
key: userId
value: Used for carrying the volume size of all speaking users, Value range 0 - 100
onSendMessageForUserDisableChanged
User text message sending ability changes event.
void onSendMessageForUserDisableChanged(String roomId, String userId, boolean isDisable)
Parameter
Type
Description
roomId
String
Room ID
userId
String
User ID
isDisable
boolean
Whether it is prohibited to send text messages.
onUserNetworkQualityChanged
User network status change event.
void onUserNetworkQualityChanged(Map<String, TUICommonDefine.NetworkInfo> networkMap)
Parameter
Type
Description
networkMap
Map
 User Network Status Map
key: userId
value: Network Condition
onUserScreenCaptureStopped
Screen Sharing stopped Callback event.
void onUserScreenCaptureStopped(int reason)
Parameter
Type
Description
reason
int
Stop reason:
0: User actively stops
1: Screen window closing causes the stop
2: Screen Sharing display screen status change (such as interface being unplugged, Projection mode change, etc.)
onRoomMaxSeatCountChanged
Maximum number of mic slots changes event in the room (only effective in meeting type rooms).
void onRoomMaxSeatCountChanged(String roomId, int maxSeatCount)
Parameter
Type
Description
roomId
String
Room ID
maxSeatCount
int
Maximum number of mic slots in the room
onSeatListChanged
Mic slot list changes event.
void onSeatListChanged(List<TUIRoomDefine.SeatInfo> seatList, 
                       List<TUIRoomDefine.SeatInfo> seatedList,
                       List<TUIRoomDefine.SeatInfo> leftList)
Parameter
Type
Description
seatList
List<TUIRoomDefine.SeatInfo>
The latest user list on the mic, including newly on mic users
seatedList
List<TUIRoomDefine.SeatInfo>
Newly on mic user list
leftList
List<TUIRoomDefine.SeatInfo>
Newly off mic user list
onKickedOffSeat
Received the event of user being kicked off mic.
void onKickedOffSeat(String userId)
Parameter
Type
Description
userId
String
Operate Kick-out of the (Host/Administrator) User ID
onRequestReceived
Received request message event.
void onRequestReceived(TUIRoomDefine.Request request)
Parameter
Type
Description
request
﻿TUIRoomDefine.Request﻿
Request content
onRequestCancelled
Received request cancellation event.
void onRequestCancelled(String requestId, String userId)
Parameter
Type
Description
requestId
String
Request ID
userId
String
Cancel signaling user ID
onReceiveTextMessage
Received ordinary text message event.
void onReceiveTextMessage(String roomId, TUICommonDefine.Message message)
Parameter
Type
Description
roomId
String
Room ID
message
﻿TUICommonDefine.Message﻿
Message content
onReceiveCustomMessage
Received custom message event.
void onReceiveCustomMessage(String roomId, TUICommonDefine.Message message)
Parameter
Type
Description
roomId
String
Room ID
message
﻿TUICommonDefine.Message﻿
Message content
﻿

Parameter	Type	Description
errorCode	TUICommonDefine.Error	Error Code
message	String	Error Message