please select
Conference
  • Overview
  • 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
Docs Overview/
Conference/
iOS/
API Documentation/
RoomEngine API/
TUIRoomEngine/

TUIRoomEngine

TUIRoomEngine API Introduction

TUIRoomEngine API is a No UI Interface for Conference Component, you can use this API to custom encapsulate according to your business needs.

init

Create TUIRoomEngine instance
TUIRoomEngine *roomEngine = [[TUIRoomEngine alloc] init];

login

Login interface, you need to initialize user information before entering the room and perform a series of operations
Note: In v1.0.0, this interface is named setup, and in v1.0.1 and above, please use TUIRoomEnine.login to log in to TUIRoomEngine.
+ (void)loginWithSDKAppId:(NSInteger)sdkAppId 
                   userId:(NSString *)userId 
                  userSig:(NSString *)userSig 
                onSuccess:(TUISuccessBlock)onSuccess 
                  onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
sdkAppId
NSInteger
SDKAppID of Tencent Cloud communication application
userId
NSString *
User ID for Differentiate different users
userSig
NSString *
UserSig for Tencent Cloud flow authentication
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

logout

Logout interface, there will be actively leave the room operation, destroy resources
+ (void)logout:(TUISuccessBlock)onSuccess 
       onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

setSelfInfo

Set local user name and avatar.
+ (void)setSelfInfoWithUserName:(NSString *)userName
                      avatarUrl:(NSString *)avatarUrl
                      onSuccess:(TUISuccessBlock)onSuccess
                        onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
userName
NSString *
User name
avatarUrl
NSString *
User avatar URL address
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

getSelfInfo

Get the basic information of the local user login.
+ (TUILoginUserInfo *)getSelfInfo;
The parameters are as follows:
Parameter
Type
Meaning
selfInfo
The basic information of the local user login, the detailed definition can be referred to TUIRoomDefine.h in TUILoginUserInfo.

addObserver

Set event callback.
- (void)addObserver:(id<TUIRoomObserver>)observer;
The parameters are as follows:
Parameter
Type
Meaning
observer
TUIRoomObserver *
The pointer of the callback instance, you can get various event notifications (such as: error code, remote user entered room, audio and video status parameters, etc.) through TUIRoomObserver

removeObserver

Remove event callback.
- (void)removeObserver:(id<TUIRoomObserver>)observer;
The parameters are as follows:
Parameter
Type
Meaning
observer
TUIRoomObserver *
The pointer of the callback instance

createRoom

Create room.
- (void)createRoom:(TUIRoomInfo *)roomInfo
         onSuccess:(TUISuccessBlock)onSuccess
           onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
roomInfo
Room data, you can initialize some room settings
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

destroyRoom

close the room.
- (void)destroyRoom:(TUISuccessBlock)onSuccess onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

enterRoom

Entered room.
- (void)enterRoom:(NSString *)roomId
        onSuccess:(TUIRoomInfoBlock)onSuccess
          onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
roomId
NSString *
Room ID
onSuccess
TUIRoomInfoBlock
Successful callback
onError
TUIErrorBlock
Failed callback

exitRoom

Leave room.
- (void)exitRoom:(BOOL)syncWaiting
       onSuccess:(TUISuccessBlock)onSuccess
         onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
syncWaiting
BOOL
Whether to synchronize and wait for the interface to return
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

connectOtherRoom

Connect to other rooms (used for streaming scenario to apply for cross-room streaming).
- (TUIRequest *)connectOtherRoom:(NSString *)roomId
                        userId:(NSString *)userId
                       timeout:(NSTimeInterval)timeout
                    onAccepted:(TUIRequestAcceptedBlock)onAccepted
                    onRejected:(TUIRequestRejectedBlock)onRejected      
                   onCancelled:(TUIRequestCancelledBlock)onCancelled
                     onTimeout:(TUIRequestTimeoutBlock)onTimeout
                      onError:(TUIRequestErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
roomId
NSString *
Room ID
userId
NSString *
User ID
timeout
NSTimeInterval
Timeout period (Unit seconds, if set to 0, SDK will not perform timeout detection and will not trigger timeout Callback)
onAccepted
TUIRequestAcceptedBlock
Invitation accepted Callback
onRejected
TUIRequestRejectedBlock
Invitation rejected Callback
onCancelled
TUIRequestCancelledBlock
Invitation canceled Callback
onTimeout
TUIRequestTimeoutBlock
Invitation timeout unprocessed Callback
onError
TUIRequestErrorBlock
Invitation error occurred Callback
Return value
Type
Meaning
request
TUIRequest
Request body

disconnectOtherRoom

Disconnect from other rooms (used for disconnecting cross-room streaming in live streaming scenarios).
- (void)disconnectOtherRoom:(TUISuccessBlock)onSuccess onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

fetchRoomInfo

Get Room data.
- (void)fetchRoomInfo:(TUIRoomInfoBlock)onSuccess onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
onSuccess
TUIRoomInfoBlock
Success Callback with TUIRoomInfo Room data
onError
TUIErrorBlock
Failed callback

updateRoomNameByAdmin

Update Room ID (Only Administrator or Group owner can call).
- (void)updateRoomNameByAdmin:(NSString *)roomName 
                    onSuccess:(TUISuccessBlock)onSuccess 
                      onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
roomName
NSString *
Room Name
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

updateRoomSpeechModeByAdmin

Set up the room's mic control mode (only administrators or group owners can call).
- (void)updateRoomSpeechModeByAdmin:(TUISpeechMode)mode 
                          onSuccess:(TUISuccessBlock)onSuccess 
                            onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
mode
Speech Mode, detailed Definition can be found in TUIRoomDefine.h file's TUISpeechMode.
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

setLocalVideoView

Set Local User Video Rendering Control.
- (void)setLocalVideoView:(TUIVideoStreamType)streamType view:(TUIVideoView *)view;
The parameters are as follows:
Parameter
Type
Meaning
streamType
Video streams Type, detailed Definition can be found in TUIRoomDefine.h file's TUIVideoStreamType.
view
TUIVideoView *
Video Rendering View

setRemoteVideoView

Set Remote User Video Rendering Control.
- (void)setRemoteVideoView:(NSString *)userId
                streamType:(TUIVideoStreamType)streamType
                      view:(TUIVideoView * __nullable)view;
The parameters are as follows:
Parameter
Type
Meaning
userId
NSString
Remote User ID
streamType
Video streams Type, detailed Definition can be found in TUIRoomDefine.h file's TUIVideoStreamType.
view
TUIVideoView *
Video Rendering View

openLocalCamera

Open Local Camera.
- (void)openLocalCamera:(BOOL)isFront  
                quality:(TUIVideoQuality)quality                 
              onSuccess:(TUISuccessBlock)onSuccess
                onError:(TUIErrorBlock)onError;
Parameter
Type
Meaning
isFront
BOOL
Front or not
quality
Video Quality, detailed Definition can be found in TUIRoomDefine.h file's TUIVideoQuality.
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

closeLocalCamera

Close Local Camera.
- (void)closeLocalCamera;

updateVideoQuality

Update Local Video Codec Quality Setting.
- (void)updateVideoQuality:(TUIVideoQuality)quality;
Parameter
Type
Meaning
quality
Video Quality

openLocalMicrophone

Open Local mic.
- (void)openLocalMicrophone:(TUIAudioQuality)quality
                  onSuccess:(TUISuccessBlock)onSuccess
                    onError:(TUIErrorBlock)onError;
Parameter
Type
Meaning
quality
Audio Quality, detailed Definition can be found in TUIRoomDefine.h file's TUIAudioQuality
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

closeLocalMicrophone

Close Local mic.
- (void)closeLocalMicrophone;

updateAudioQuality

Update Local Audio Codec Quality Setting.
- (void)updateAudioQuality:(TUIAudioQuality)quality;
Parameter
Type
Meaning
quality
Audio Quality

startScreenCapture

Start Screen Sharing (Only supports mobile iOS 11.0 and above systems)
This interface supports capturing the entire iOS system screen, similar to Tencent Meeting's full system-level Screen Sharing.
- (void)startScreenCaptureByReplaykit:(NSString *)appGroup API_AVAILABLE(ios(11.0));
The parameters are as follows:
Parameter
Type
Meaning
appGroup
NSString *
Specify the Application Group Identifier shared by your app and the Screen recording Process, you can set this parameter to nil, but it is recommended to set it according to the documentation for better Reliability.

startScreenCapture

Start Screen Sharing (This interface only supports desktop Mac OS systems)
This interface can capture the entire Mac OS system screen or the window content of a specified app and share it with other users in the same room.
- (void)startScreenCapture:(TUIVideoView *)view
                 onSuccess:(TUISuccessBlock)onSuccess
                   onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
view
TUIVideoView *
Parent Control of the Rendering Control, can be set to null, indicating no preview effect of Screen Sharing.
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

stopScreenCapture

End Screen Sharing.
- (void)stopScreenCapture;

getScreenCaptureSources

Enumerate available screens and windows for sharing (This interface only supports Mac OS systems)
When you integrate the desktop system's Screen Sharing function, you generally need to display a Target selection Interface so that users can use this Interface to choose whether to share the entire screen or a specific window.
Through this interface, you can query the ID, name, and thumbnail of the windows available for sharing in the current system. We provide a default Interface implementation in the Demo for your reference.
- (NSArray<TUIShareTarget *> *)getScreenCaptureSources;
Return Value
Type
Meaning
screenCaptureSources
NSArray<TUIShareTarget *> *
Window List including screens

selectScreenCaptureTarget

Select Screen Sharing Target.
- (void)selectScreenCaptureTarget:(NSString *)targetId;
The parameters are as follows:
Parameter
Type
Meaning
targetId
NSString *
Designated Sharing Source

startPushLocalVideo

Start Pushing Local Video.
- (void)startPushLocalVideo;

stopPushLocalVideo

Stop Pushing Local Video.
- (void)stopPushLocalVideo;

startPushLocalAudio

Start Pushing Local Audio.
- (void)startPushLocalAudio;

stopPushLocalAudio

Stop Pushing Local Audio.
- (void)stopPushLocalAudio;

startPlayRemoteVideo

Start Playback Remote User Video.
- (void)startPlayRemoteVideo:(NSString *)userId
                  streamType:(TUIVideoStreamType)streamType
                   onPlaying:(TUIPlayOnPlayingBlock)onPlaying
                   onLoading:(TUIPlayOnLoadingBlock)onLoading
                     onError:(TUIPlayOnErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
userId
NSString *
User ID
streamType
Type of Video streams. Detailed Definition can be found in TUIRoomDefine.h file's TUIVideoStreamType.
onPlaying
TUIPlayOnPlayingBlock
Playback Callback
onLoading
TUIPlayOnLoadingBlock
Load Callback
onError
TUIPlayOnErrorBlock
Error Callback

stopPlayRemoteVideo

Stop Playback Remote User Video.
- (void)stopPlayRemoteVideo:(NSString *)userId streamType:(TUIVideoStreamType)streamType;
The parameters are as follows:
Parameter
Type
Meaning
userId
NSString *
User ID
streamType
Type of Video streams. Detailed Definition can be found in TUIRoomDefine.h file's TUIVideoStreamType.

muteRemoteAudioStream

Mute Remote User
- (void)muteRemoteAudioStream:(NSString *)userId isMute:(BOOL)isMute;
Parameter
Type
Meaning
userId
NSString *
User ID
isMute
BOOL
Mute or not

getUserList

Get Member List in the Room.
- (void)getUserList:(NSInteger)nextSequence
          onSuccess:(TUIUserListResponseBlock)onSuccess
            onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
nextSequence
NSInteger
Pagination Fetch flag, fill in 0 for the first Fetch, if the Callback returns TUIUserListResult with next_sequence not equal to zero, Pagination is required, pass in again to Fetch until it is 0
onSuccess
TUIUserListResponseBlock
Success Callback. Detailed Definition can be found in TUIRoomDefine.h file's TUIUserListResponseBlock
onError
TUIErrorBlock
Failed callback

getUserInfo

Get Member data.
- (void)getUserInfo:(NSString *)userId
          onSuccess:(TUIUserInfoBlock)onSuccess
            onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
userId
NSString *
User ID
onSuccess
TUIUserInfoBlock
Success Callback. Detailed Definition can be found in TUIRoomDefine.h file's TUIUserInfoBlock
onError
TUIErrorBlock
Error callback

changeUserRole

Modify User Role (Only Administrator or Group owner can call).
- (void)changeUserRoleWithUserId:(NSString *)userId
                            role:(TUIRole)role
                       onSuccess:(TUISuccessBlock)onSuccess
                         onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
userId
NSString *
User ID
role
TUIRole
Role to switch to
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

kickRemoteUserOutOfRoom

- (void)kickRemoteUserOutOfRoom:(NSString *)userId 
                      onSuccess:(TUISuccessBlock)onSuccess 
                        onError:(TUIErrorBlock)onError;
Kick Remote User out of the Room (Only Administrator or Group Owner can call).
Parameter
Type
Meaning
userId
NSString *
User ID
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Failed callback

disableDeviceForAllUserByAdmin

Control the permission status of all users in the current room to open Audio and Video Capturing devices, such as: Disable all users from opening mic, Disable all users from opening Camera, Disable all users from opening Screen Sharing
(Currently only available in conference scenes, and only Administrator or Group Owner can call).

- (void)disableDeviceForAllUserByAdmin:(TUIMediaDevice)device 
                             isDisable:(BOOL)isDisable
                             onSuccess:(TUISuccessBlock)onSuccess 
                               onError:(TUIErrorBlock)onError;
Parameter
Type
Meaning
device
Device Type
isDisable
BOOL
Disable or Not
onSuccess
TUISuccessBlock
Operation Success Callback
onError
TUIErrorBlock
Operation Failure Callback

openRemoteDeviceByAdmin

Request Remote User to Open Media Device (Only Administrator or Group Owner can call).

- (TUIRequest *)openRemoteDeviceByAdmin:(NSString *)userId
                                 device:(TUIMediaDevice)device
                                timeout:(NSTimeInterval)timeout
                             onAccepted:(nullable TUIRequestAcceptedBlock)onAccepted
                             onRejected:(nullable TUIRequestRejectedBlock)onRejected
                            onCancelled:(nullable TUIRequestCancelledBlock)onCancelled
                              onTimeout:(nullable TUIRequestTimeoutBlock)onTimeout
                                onError:(nullable TUIRequestErrorBlock)onError;
Parameter
Type
Meaning
userId
NSString *
User ID
device
Media Device
timeout
NSTimeInterval
Timeout Duration, Unit Second, if set to 0, SDK will not perform timeout detection and will not trigger timeout callback
onAccepted
nullable TUIRequestAcceptedBlock
Invitation Accepted Callback
onRejected
nullable TUIRequestRejectedBlock
Invitation Rejected Callback
onCancelled
nullable TUIRequestCancelledBlock
Invitation Canceled Callback
onTimeout
nullable TUIRequestTimeoutBlock
Invitation Timeout Unhandled Callback
onError
nullable TUIRequestErrorBlock
Invitation Error Callback
Return Value
Type
Meaning
request
Request Body

closeRemoteDeviceByAdmin

Close Remote User's Media Device (Only Administrator or Group Owner can call).

- (void)closeRemoteDeviceByAdmin:(NSString *)userId 
                          device:(TUIMediaDevice)device 
                       onSuccess:(TUISuccessBlock)onSuccess 
                         onError:(TUIErrorBlock)onError;
Parameter
Type
Meaning
userId
NSString *
User ID
device
Media Device
onSuccess
TUISuccessBlock
Call Success Callback
onError
TUIErrorBlock
Call Failure Callback

applyToAdminToOpenLocalDevice

Request to Open Local Media Device (Available for ordinary users).

- (TUIRequest *)applyToAdminToOpenLocalDevice:(TUIMediaDevice)device
                                      timeout:(NSTimeInterval)timeout
                                   onAccepted:(nullable TUIRequestAcceptedBlock)onAccepted
                                   onRejected:(nullable TUIRequestRejectedBlock)onRejected
                                  onCancelled:(nullable TUIRequestCancelledBlock)onCancelled
                                    onTimeout:(nullable TUIRequestTimeoutBlock)onTimeout
                                      onError:(nullable TUIRequestErrorBlock)onError;
Parameter
Type
Meaning
device
Media Device
timeout
NSTimeInterval
Timeout Duration, Unit Second, if set to 0, SDK will not perform timeout detection and will not trigger timeout callback
onAccepted
nullable TUIRequestAcceptedBlock
Invitation Accepted Callback
onRejected
nullable TUIRequestRejectedBlock
Invitation Rejected Callback
onCancelled
nullable TUIRequestCancelledBlock
Invitation Canceled Callback
onTimeout
nullable TUIRequestTimeoutBlock
Invitation Timeout Unhandled Callback
onError
nullable TUIRequestErrorBlock
Invitation Error Callback
Return Value
Type
Meaning
request
Request Body

setMaxSeatCount

Set Maximum Seat Count (Only supported when entering the room and creating the room).
When roomType is TUIRoomTypeConference (Educational and Conference Scenes), maxSeatCount value is not limited;
When roomType is TUIRoomTypeLivingRoom (Live Streaming Scene), maxSeatCount is limited to 16;

- (void)setMaxSeatCount:(NSUInteger)maxSeatCount 
              onSuccess:(TUISuccessBlock)onSuccess 
                onError:(TUIErrorBlock)onError;
Parameter
Type
Meaning
maxSeatCount
NSUInteger
Maximum microphone positions
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

getSeatList

Get Seat List.
- (void)getSeatList:(TUISeatListResponseBlock)onSuccess
            onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
onSuccess
TUISeatListResponseBlock
Success Callback. For detailed definition, please refer to TUIRoomDefine.h for TUISeatListResponseBlock and TUISeatInfo definition
onError
TUIErrorBlock
Error callback

lockSeatByAdmin

Lock Seat (Only Administrator or Group Owner can call, including position lock, Audio status lock and Video status lock).
- (void)lockSeatByAdmin:(NSInteger)seatIndex 
               lockMode:(TUISeatLockParams *)lockParams 
              onSuccess:(TUISuccessBlock)onSuccess 
                onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
seatIndex
NSInteger
Seat Number
lockParams
Lock Seat Parameters, for detailed definition, please refer to TUIRoomDefine.h for TUISeatLockParams definition
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

takeSeat

Local User Go Live (In Free Speech Mode, no application is required, in Mic Control Mode, application to the host or administrator is required to allow Go Live, in Live Streaming Scene, users can Go Live freely, after Go Live, users can speak, in Conference Scene, no need to call this interface to speak).
- (TUIRequest *)takeSeat:(NSInteger)seatIndex
                 timeout:(NSTimeInterval)timeout
              onAccepted:(TUIRequestAcceptedBlock)onAccepted
              onRejected:(TUIRequestRejectedBlock)onRejected        
             onCancelled:(TUIRequestCancelledBlock)onCancelled
               onTimeout:(TUIRequestTimeoutBlock)onTimeout
                 onError:(TUIRequestErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
seatIndex
NSInteger
Seat Number
timeout
NSTimeInterval
Timeout Duration
onAccepted
TUIRequestAcceptedBlock
Signaling Accepted Callback
onRejected
TUIRequestRejectedBlock
Signaling Rejected Callback
onCancelled
TUIRequestCancelledBlock
Signaling Canceled Callback
onTimeout
TUIRequestTimeoutBlock
Signaling Timeout Callback
onError
TUIRequestErrorBlock
Error Callback
Return Value
Type
Meaning
request
Request Body

leaveSeat

Local User Get Off the Mic (In Free Speech Mode, no application is required).
- (void)leaveSeat:(TUISuccessBlock)onSuccess
          onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

takeUserOnSeatByAdmin

Host/Administrator Invite User to Go Live.
- (TUIRequest *)takeUserOnSeatByAdmin:(NSInteger)seatIndex
                               userId:(NSString *)userId
                              timeout:(NSTimeInterval)timeout
                           onAccepted:(TUIRequestAcceptedBlock)onAccepted
                           onRejected:(TUIRequestRejectedBlock)onRejected                         
                          onCancelled:(TUIRequestCancelledBlock)onCancelled
                            onTimeout:(TUIRequestTimeoutBlock)onTimeout
                              onError:(TUIRequestErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
seatIndex
NSInteger
Seat Number
userId
NSString *
User ID
timeout
NSTimeInterval
Timeout Duration (Unit Second, if set to 0, SDK will not perform timeout detection and will not trigger timeout callback)
onAccepted
TUIRequestAcceptedBlock
Invitation Accepted Callback
onRejected
TUIRequestRejectedBlock
Invitation Rejected Callback
onCancelled
TUIRequestCancelledBlock
Invitation Canceled Callback
onTimeout
TUIRequestTimeoutBlock
Invitation Timeout Unhandled Callback
onError
TUIRequestErrorBlock
Invitation Error Callback
Return Value
Type
Meaning
request
Request Body

kickUserOffSeatByAdmin

Host/Administrator Kick User Off the Mic.
- (void)kickUserOffSeatByAdmin:(NSInteger)seatIndex
                        userId:(NSString *)userId
                     onSuccess:(TUISuccessBlock)onSuccess
                       onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
seatIndex
NSInteger
Seat Number
userId
NSString *
User ID
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

cancelRequest

Cancel Request.
- (void)cancelRequest:(NSInteger)requestId
                  onSuccess:(TUISuccessBlock)onSuccess
                    onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
requestId
NSString *
Request ID. Returned by the sending request interface
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

responseRemoteRequest

Reply Request.
- (void)responseRemoteRequest:(NSString *)requestId
                        agree:(BOOL)agree
                    onSuccess:(TUISuccessBlock)onSuccess
                      onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
requestId
NSString *
Request ID. Returned by the sending request interface or OnRequestReceived event notification
agree
BOOL
Agree or not. YES: Agree, NO: Reject
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

sendTextMessage

Send Text Message.
- (void)sendTextMessage:(NSString *)message
              onSuccess:(TUISuccessBlock)onSuccess
                onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
message
NSString *
Message Content
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

sendCustomMessage

Send Custom Message.
- (void)sendCustomMessage:(NSString *)message
                onSuccess:(TUISuccessBlock)onSuccess
                  onError:(TUIErrorBlock)onError;
The parameters are as follows:
Parameter
Type
Meaning
message
NSString *
Message Content
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

disableSendingMessageByAdmin

Disable Remote User's Text Message Sending Ability (Only Administrator or Group Owner can call).
- (void)disableSendingMessageByAdmin:(NSString *)userId 
                           isDisable:(BOOL)isDisable 
                           onSuccess:(TUISuccessBlock)onSuccess 
                             onError:(TUIErrorBlock)onError;
Parameter
Type
Meaning
userId
NSString *
User ID
isDisable
BOOL
Disable or Not
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

disableSendingMessageForAllUser

Disable All Users' Text Message Sending Ability (Only Administrator or Group Owner can call).
- (void)disableSendingMessageForAllUser:(BOOL)isDisable 
                              onSuccess:(TUISuccessBlock)onSuccess 
                                onError:(TUIErrorBlock)onError;
Parameter
Type
Meaning
isDisable
BOOL
Disable or Not
onSuccess
TUISuccessBlock
Successful callback
onError
TUIErrorBlock
Error callback

getDeviceManager

Get Device Manager Object.
- (TXDeviceManager *)getDeviceManager;
Return Value
Type
Meaning
manager
TXDeviceManager *
TXDeviceManager Object

getBeautyManager

Get Sound Effect Manager Object.
- (TXBeautyManager *)getBeautyManager;
Return Value
Type
Meaning
manager
TXBeautyManager *
TXBeautyManager Object

getAudioEffectManager

Get Sound Effect Manager Object.
- (TXAudioEffectManager *)getAudioEffectManager;
Return Value
Type
Meaning
manager
TXAudioEffectManager *
TXAudioEffectManager Object

getTRTCCloud

Get TRTC Instance Object.
- (TRTCCloud *)getTRTCCloud;
Return Value
Type
Meaning
manager
TRTCCloud *
TRTCCloud Object