FuncList | DESC |
Create a TUIRoomEngine instance (singleton pattern). | |
Destroy the TUIRoomEngine instance (singleton pattern). | |
After creating a TUIRoomEngine instance, you should login with sdkAppId, userId and userSig then you can call TUIRoomEngine instance and other function. | |
Log out of your account. If you are in the room, there will be active leaving room and destroying resource operations. | |
Update user name and avatar for logged-in user. | |
Return the basic information of the logged-in user, including nickname and avatar. | |
Update user basic information for logged-in user. | |
Set event observer. | |
Remove event observer. | |
Create a room. | |
Dismiss the room. | |
Enter a room. | |
Enter a room. | |
Enter a room. | |
Exit the room. | |
Fetch room information. | |
Fetch Specified Room Information. | |
Update room name (only support for administrators or room owner). | |
Update room seat mode (only support for administrators or room owner). | |
Update room password (only support for administrators or room owner). | |
Get room metadata. | |
Set room metadata, if the key already exists, update its value, if not, add the key. | |
Set the local camera to preview the render view. | |
Open the local camera. | |
Close the local camera. | |
Start publishing local video stream, default enabled. | |
Stop publishing local video stream. | |
Update video encoding quality. | |
Set the video encoding parameters. | |
Set the video resolution mode (horizontal resolution or vertical resolution). | |
Set the substitute image for local video during pause. | |
Turn on gravity sensing mode. (only availble on mobile OS and the camera capture scene inside the SDK). | |
Start screen sharing (only available on mobile OS). | |
Start screen sharing (only available on Mac OS). | |
Stop screen sharing. | |
Get the sharable screen and windows (only available on Mac OS) | |
Select the screen or windows to share (only available on Mac OS) | |
Open local microphone. | |
Close the local microphone. | |
Update audio encoding quality. | |
Pause publishing the local audio stream. | |
Resume publishing the local audio stream. | |
Enable system audio sharing | |
Set the render view for remote user. | |
Start playing the remote user's video stream. | |
Stop playing the remote user's video stream. | |
Mute the remote user's audio stream. | |
Get the list of user in the room. | |
Get user information. | |
Change user role (only support for administrators or room owner). | |
Change user nickname in the room (only support to change all user for administrators or room owner, user can only change by self). | |
Kick the remote user out of the room (only support for administrators or room owner). | |
Add a tag for the user (only support for administrators or room owner). | |
Remove tag for user (only support for room owner). | |
Get user information in the room based on the tag. | |
Set custom information for room users. | |
The owner or administrator control that all users whether can open device. For example: all users are prohibited from opening the microphone(only available in the conference scenario). | |
Request the remote user to open the media device (only support for administrators or room owner). | |
Close remote user media devices (only support for administrators or room owner). | |
Apply to open the local media device (available to general users). | |
Get seat list. | |
Lock the seat (only support for administrators or room owner). | |
Take the seat. | |
Leave the seat. | |
Move to seat. | |
Invite user to take the seat (only support for administrators or room owner). | |
Kick off the user from seat (only support for administrators or room owner). | |
Get the request list of users who want to take the seat in the room (only support for administrators or room owner). | |
Disable the ability of remote users to send messages (only support for administrators or room owner). | |
Disable the ability of all users to send messages (only support for administrators or room owner). | |
Send text message | |
Send custom message | |
Cancel request. | |
Response request. | |
Get the TRTC instance object. | |
Set the beauty level. | |
Set whitening level. | |
Get the extension. | |
Get device management class. | |
Get live-connection management class. | |
Get live-battle management class. | |
Call experimental APIs. |
// Objective-C Usage example:TUIRoomEngine *engine = [TUIRoomEngine sharedInstance];// Swift Usage example:let engine = TUIRoomEngine.sharedInstance()
// Objective-C Usage example:[TUIRoomEngine destroySharedInstance];// Swift Usage example:TUIRoomEngine.destroySharedInstance()
+ (void)loginWithSDKAppId: | (NSInteger)sdkAppId |
userId: | (NSString *)userId |
userSig: | (NSString *)userSig |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[TUIRoomEngine loginWithSDKAppId:1400000001userId:@"user123"userSig:@"xxxxxx"onSuccess:^{// Login success handling}onError:^(int code, NSString *message) {// Login failure handling}];// Swift Usage example:TUIRoomEngine.login(sdkAppId: 1400000001,userId: "user123",userSig: "xxxxxx",onSuccess: {// Login success handling},onError: { code, message in// Login failure handling})
Param | DESC |
sdkAppId | |
userId | User ID, it is the unique identifier used by Tencent Cloud to distinguish users. |
userSig | The user signature designed by Tencent Cloud based on the UserId, which is used to access Tencent Cloud services. More details, see UserSig. |
+ (void)logout: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[TUIRoomEngine logout:^{// Handle logout success} onError:^(int code, NSString *message) {// Handle logout failure}];// Swift Usage example:TUIRoomEngine.logout {// Handle logout success} onError: { code, message in// Handle logout failure}
Param | DESC |
onError | Callback for failed logout, including error code and message. |
onSuccess | Callback for successful logout. |
+ (void)setSelfInfoWithUserName: | (NSString *)userName |
avatarUrl: | (NSString *)avatarURL |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[TUIRoomEngine setSelfInfoWithUserName:@"John"avatarUrl:@"https://avatar.url"onSuccess:^{// Handle success}onError:^(int code, NSString *message) {// Handle failure}];// Swift Usage example:TUIRoomEngine.setSelfInfo(userName: "John",avatarUrl: "https://avatar.url",onSuccess: {// Handle success},onError: { code, message in// Handle failure})
Param | DESC |
avatarURL | User avatar URL address. |
onError | Callback for failed operation, including error code and message. |
onSuccess | Callback for successful operation. |
userName | User nickname. |
// Objective-C Usage example:TUILoginUserInfo *userInfo = [TUIRoomEngine getSelfInfo];// Swift Usage example:let userInfo = TUIRoomEngine.getSelfInfo()
+ (void)setSelfInfo: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:TUILoginUserInfo *userInfo = [[TUILoginUserInfo alloc] init];userInfo.userId = @"user123";userInfo.userName = @"John";userInfo.avatarUrl = @"https://avatar.url";[TUIRoomEngine setSelfInfo:userInfoonSuccess:^{// Handle success}onError:^(int code, NSString *message) {// Handle failure}];// Swift Usage example:let userInfo = TUILoginUserInfo()userInfo.userId = "user123"userInfo.userName = "John"userInfo.avatarUrl = "https://avatar.url"TUIRoomEngine.setSelfInfo(userInfo: userInfo,onSuccess: {// Handle success},onError: { code, message in// Handle failure})
Param | DESC |
callback | Interface callback to notify success or failure of the operation. |
userInfo |
- (void)addObserver: |
// Objective-C Usage example:TUIRoomEngine *engine = [TUIRoomEngine sharedInstance];[engine addObserver:self];// Swift Usage example:let engine = TUIRoomEngine.sharedInstance()engine.addObserver(self)
Param | DESC |
observer | Object instance conforming to TUIRoomObserver protocol. |
- (void)removeObserver: |
// Objective-C Usage example:TUIRoomEngine *engine = [TUIRoomEngine sharedInstance];[engine removeObserver:self];// Swift Usage example:let engine = TUIRoomEngine.sharedInstance()engine.removeObserver(self)
Param | DESC |
observer | The observer callback instance to be removed. |
- (void)createRoom: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:TUIRoomInfo *roomInfo = [[TUIRoomInfo alloc] init];roomInfo.roomId = @"room123";roomInfo.roomType = TUIRoomTypeConference;roomInfo.name = @"Conference Room";[[TUIRoomEngine sharedInstance] createRoom:roomInfoonSuccess:^{NSLog(@"Room created");}onError:^(TUIError code, NSString * _Nonnull message) {NSLog(@"Create failed: %@", message);}];// Swift Usage example:let roomInfo = TUIRoomInfo()roomInfo.roomId = "room123"roomInfo.roomType = .conferenceroomInfo.name = "Conference Room"TUIRoomEngine.sharedInstance().createRoom(roomInfo, onSuccess: {print("Room created")}, onError: { code, message inprint("Create failed: \\(message)")})
Param | DESC |
callback | (Android/Win) Interface callback to notify success or failure of the call, failure callback contains error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
roomInfo | Room information object used to initialize room settings. |
- (void)destroyRoom: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] destroyRoom:^{NSLog(@"Room dismissed successfully");} onError:^(TUIError code, NSString * _Nonnull message) {NSLog(@"Failed to dismiss room: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().destroyRoom {print("Room dismissed successfully")} onError: { code, message inprint("Failed to dismiss room: \\(message)")}
Param | DESC |
callback | (Android/Win) Interface callback to notify success or failure of the call, failure callback contains error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
- (void)enterRoom: | (NSString *)roomId |
onSuccess: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
2.4 enterRoom(String roomId, TUIRoomDefine.RoomType roomType or 2.5 enterRoom(String roomId, TUIRoomDefine.RoomType roomType, TUIRoomDefine.EnterRoomOptions interface.// Objective-C Usage example:[[TUIRoomEngine sharedInstance] enterRoom:@"roomId123" onSuccess:^(TUIRoomInfo * _Nullable roomInfo) {NSLog(@"Enter room successfully");} onError:^(TUIError code, NSString * _Nonnull message) {NSLog(@"Failed to enter room: %@", message);}];// Swift ExampleTUIRoomEngine.sharedInstance().enterRoom("roomId123") { roomInfo inprint("Enter room successfully")} onError: { code, message inprint("Failed to enter room: \\(message)")}
Param | DESC |
callback | (Android/Win) Interface callback to notify success or failure of the call, failure callback contains error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
roomId | Room ID. |
- (void)enterRoom: | (NSString *)roomId |
roomType: | |
onSuccess: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] enterRoom:@"roomId123"roomType:TUIRoomTypeConferenceonSuccess:^(TUIRoomInfo * _Nullable roomInfo) {NSLog(@"Enter room successfully");} onError:^(TUIError code, NSString * _Nonnull message) {NSLog(@"Failed to enter room: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().enterRoom("roomId123", roomType: .conference) { roomInfo inprint("Enter room successfully")} onError: { code, message inprint("Failed to enter room: \\(message)")}
Param | DESC |
callback | (Android/Win) Interface callback to notify success or failure of the call, failure callback contains error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
roomId | Room ID, must be unique. |
roomType | Room type (conference/live). |
- (void)enterRoom: | (NSString *)roomId |
roomType: | |
options: | |
onSuccess: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:TUIEnterRoomOptions *options = [[TUIEnterRoomOptions alloc] init];options.password = @"***";[[TUIRoomEngine sharedInstance] enterRoom:@"roomId123"roomType:TUIRoomTypeConferenceoptions:optionsonSuccess:^(TUIRoomInfo * _Nullable roomInfo) {NSLog(@"Enter room successfully");} onError:^(TUIError code, NSString * _Nonnull message) {NSLog(@"Failed to enter room: %@", message);}];// Swift Usage example:let options = TUIEnterRoomOptions()options.password = "***"TUIRoomEngine.sharedInstance().enterRoom("roomId123",roomType: .conference,options: options) { roomInfo inprint("Enter room successfully")} onError: { code, message inprint("Failed to enter room: \\(message)")}
Param | DESC |
callback | (Android/Win) Interface callback to notify success or failure of the call, failure callback contains error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
options | |
roomId | Room ID. |
roomType | Room type. |
- (void)exitRoom: | (BOOL)syncWaiting |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] exitRoom:YES onSuccess:^{NSLog(@"Exit room successfully");} onError:^(TUIError code, NSString * _Nonnull message) {NSLog(@"Failed to exit room: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().exitRoom(syncWaiting: true) {print("Exit room successfully")} onError: { code, message inprint("Failed to exit room: \\(message)")}
Param | DESC |
callback | (Android/Win) Interface callback to notify success or failure of the call, failure callback contains error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
syncWaiting | Whether to wait synchronously for the interface to return. |
- (void)fetchRoomInfo: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] fetchRoomInfo:^(TUIRoomInfo * _Nullable roomInfo) {NSLog(@"Get room info successfully: %@", roomInfo);} onError:^(TUIError code, NSString * _Nonnull message) {NSLog(@"Failed to get room info: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().fetchRoomInfo { roomInfo inprint("Get room info successfully: \\(roomInfo)")} onError: { code, message inprint("Failed to get room info: \\(message)")}
- (void)fetchRoomInfo: | (NSString*)roomId |
roomType: | |
onSuccess: | (TUIRoomInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] fetchRoomInfo:@"room123"roomType:TUIRoomTypeConferenceonSuccess:^(TUIRoomInfo *roomInfo) {NSLog(@"Room info fetched successfully: %@", roomInfo);} onError:^(TUIError code, NSString *message) {NSLog(@"Failed to fetch room info: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().fetchRoomInfo(roomId: "room123", roomType: .conference) { roomInfo inprint("Room info fetched successfully: \\(roomInfo)")} onError: { code, message inprint("Failed to fetch room info: \\(message)")}
Param | DESC |
callback | (Android) Interface callback to notify success or failure of the call, success returns $TUIRoomInfo room info, failure returns error code and message. |
onError | (iOS) Failure callback, includes error code and message. |
onSuccess | (iOS) Success callback, returns room information object. |
roomId | Room ID to query. |
roomType | Room type (conference/live). |
- (void)updateRoomNameByAdmin: | (NSString *)roomName |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] updateRoomNameByAdmin:@"New Room" onSuccess:^{NSLog(@"Room name updated successfully");} onError:^(TUIError code, NSString *message) {NSLog(@"Failed to update room name: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().updateRoomNameByAdmin("New Room") {print("Room name updated successfully")} onError: { code, message inprint("Failed to update room name: \\(message)")}
Param | DESC |
callback | (Android/Win) Interface callback to notify success or failure of the call, failure returns error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
roomName | New room name. |
- (void)updateRoomSeatModeByAdmin: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] updateRoomSeatModeByAdmin:TUISeatModeApplyToTakeonSuccess:^{NSLog(@"Room seat mode updated successfully");} onError:^(TUIError code, NSString *message) {NSLog(@"Failed to update room seat mode: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().updateRoomSeatModeByAdmin(.applyToTake) {print("Room seat mode updated successfully")} onError: { code, message inprint("Failed to update room seat mode: \\(message)")}
Param | DESC |
callback | (Android/Win) Interface callback to notify success or failure of the call, failure returns error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
seatMode |
- (void)updateRoomPasswordByAdmin: | (NSString *)password |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] updateRoomPasswordByAdmin:@"NewPassword" onSuccess:^{NSLog(@"Room password updated successfully");} onError:^(TUIError code, NSString *message) {NSLog(@"Failed to update room password: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().updateRoomPasswordByAdmin("NewPassword") {print("Room password updated successfully")} onError: { code, message inprint("Failed to update room password: \\(message)")}
Param | DESC |
callback | (Android) Interface callback to notify success or failure of the call, failure returns error code and message. |
onError | (iOS) Failure callback (contains error code and message). |
onSuccess | (iOS) Success callback. |
password | New room password, recommended length 8-16 characters, can include letters, numbers and special characters. |
- (void)getRoomMetadata: | (NSArray<NSString *> *)keys |
onSuccess: | (TUIRoomMetadataResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
// Objective-C Usage example:[[TUIRoomEngine sharedInstance] getRoomMetadata:@[@"key1", @"key2"] onSuccess:^(NSDictionary<NSString *,NSString *> *metadata) {NSLog(@"Room metadata fetched successfully: %@", metadata);} onError:^(TUIError code, NSString *message) {NSLog(@"Failed to fetch room metadata: %@", message);}];// Swift Usage example:TUIRoomEngine.sharedInstance().getRoomMetadata(["key1", "key2"]) { metadata inprint("Room metadata fetched successfully: \\(metadata)")} onError: { code, message inprint("Failed to fetch room metadata: \\(message)")}
Param | DESC |
callback | (Android) Interface callback to notify success or failure of the call, failure returns error code and message. Interface callback to notify success or failure of the call, failure callback contains error code and message. |
keys | List of metadata keys to query. Pass empty list to retrieve all metadata. |
onError | (iOS) Failure callback, includes error code and message. |
onSuccess | (iOS) Success callback, returns metadata dictionary. |
// Objective-C Usage example:NSDictionary *metadata = @{@"key1": @"value1", @"key2": @"value2"};[[TUIRoomEngine sharedInstance] setRoomMetadataByAdmin:metadata onSuccess:^{NSLog(@"Room metadata updated successfully");} onError:^(TUIError code, NSString *message) {NSLog(@"Failed to update room metadata: %@", message);}];// Swift Usage example:let metadata = ["key1": "value1", "key2": "value2"]TUIRoomEngine.sharedInstance().setRoomMetadataByAdmin(metadata) {print("Room metadata updated successfully")} onError: { code, message inprint("Failed to update room metadata: \\(message)")}
Param | DESC |
callback | (Android) Interface callback to notify success or failure of the call, failure callback contains error code and message. |
metadata | Custom metadata key-value pairs to set, both keys and values must be strings |
onError | (iOS) Failure callback (contains error code and message) |
onSuccess | (iOS) Success callback |
- (void)setLocalVideoView: | (TUIVideoView *__nullable)view |
Param | DESC |
view | Render view. |
- (void)openLocalCamera: | (BOOL)isFront |
quality: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
isFront | YES: front NO: rear (only available on mobile OS). |
- (void)updateVideoQuality: |
- (void)updateVideoQualityEx: | |
params: |
Param | DESC |
params | |
streamType |
- (void)setVideoResolutionMode: | |
resolutionMode: |
Param | DESC |
resolutionMode | |
streamType |
- (void)setLocalVideoMuteImage: | (nullable TUIImage *)image |
- (void)enableGravitySensor: | (BOOL)enable |
Param | DESC |
enable | YES: Open NO: Close. |
- (void)startScreenCaptureByReplaykit: | (NSString *)appGroup |
- (void)startScreenCapture: | (TUIVideoView *)view |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
view | The render view can be set a null value, it means not displaying the preview screen locally. |
- (void)selectScreenCaptureTarget: | (NSString *)targetId |
Param | DESC |
targetId | Selected sharing source. |
- (void)openLocalMicrophone: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
quality | Audio quality. |
- (void)updateAudioQuality: |
- (void)unmuteLocalAudio: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)enableSystemAudioSharing: | (BOOL)enable |
- (void)setRemoteVideoView: | (NSString *)userId |
streamType: | |
view: | (TUIVideoView *__nullable)view |
Param | DESC |
streamType | |
userId | Remote user ID. |
view | Render view. |
- (void)startPlayRemoteVideo: | (NSString *)userId |
streamType: | |
onPlaying: | (TUIPlayOnPlayingBlock)onPlaying |
onLoading: | (TUIPlayOnLoadingBlock)onLoading |
onError: | (TUIPlayOnErrorBlock)onError |
Param | DESC |
streamType | |
userId | User ID. |
- (void)stopPlayRemoteVideo: | (NSString *)userId |
streamType: |
Param | DESC |
streamType | |
userId | User ID. |
- (void)muteRemoteAudioStream: | (NSString *)userId |
isMute: | (BOOL)isMute |
Param | DESC |
isMute | true: pause pulling remote user's audio stream, false: resume pulling remote user's audio stream. |
userId | User ID. |
- (void)getUserList: | (NSInteger)nextSequence |
onSuccess: | (TUIUserListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
nextSequence | Filling in 0 for the first request, if the returned data of the callback is not zero, paging is required, continue the operation until it is 0. |
- (void)getUserInfo: | (NSString *)userId |
onSuccess: | (TUIUserInfoBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
userId | User ID. |
- (void)changeUserRole: | (NSString *)userId |
role: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
role | |
userId | User ID. |
- (void)changeUserNameCard: | (NSString *)userId |
nameCard: | (NSString *)nameCard |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
nameCard | User nickname to set, maximum support is 32 bytes |
userId | User ID to change. |
- (void)kickRemoteUserOutOfRoom: | (NSString *)userId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
userId | User ID. |
- (void)addCategoryTagForUsers: | (NSInteger)tag |
userList: | (NSArray<NSString *> *)userList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
tag | Integer type, it is recommended that this value must be greater than or equal to 1000, you can customize it. |
userList | User list. |
- (void)removeCategoryTagForUsers: | (NSInteger)tag |
userList: | (NSArray<NSString *> *)userList |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
tag | Integer type, it is recommended that this value must be greater than or equal to 1000, you can customize it. |
userList | User list. |
- (void)getUserListByTag: | (NSInteger)tag |
nextSequence: | (NSInteger)nextSequence |
onSuccess: | (TUIUserListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
nextSequence | Filling in 0 for the first request, if the returned data of the callback is not zero, paging is required, continue the operation until it is 0. |
tag | Integer type, it is recommended that this value must be greater than or equal to 1000, you can customize it. |
- (void)setCustomInfoForUser: | (NSString *)userId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
customInfo | Custom information. |
userId | User userId. |
- (void)disableDeviceForAllUserByAdmin: | |
isDisable: | (BOOL)isDisable |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
device | |
isDisable | true: disable user to open device, false: enable user to open device. |
- (TUIRequest *)openRemoteDeviceByAdmin: | (NSString *)userId |
device: | |
timeout: | (NSTimeInterval)timeout |
onAccepted: | (nullable TUIRequestAcceptedBlock)onAccepted |
onRejected: | (nullable TUIRequestRejectedBlock)onRejected |
onCancelled: | (nullable TUIRequestCancelledBlock)onCancelled |
onTimeout: | (nullable TUIRequestTimeoutBlock)onTimeout |
onError: | (nullable TUIRequestErrorBlock)onError |
Param | DESC |
device | |
timeout | Timeout time, in seconds. If it is set to 0, the SDK will not execute timeout detection and will not trigger a timeout callback. |
userId | User ID. |
- (void)closeRemoteDeviceByAdmin: | (NSString *)userId |
device: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
device | |
userId | User ID. |
- (TUIRequest *)applyToAdminToOpenLocalDevice: | |
timeout: | (NSTimeInterval)timeout |
onAccepted: | (nullable TUIRequestAcceptedBlock)onAccepted |
onRejected: | (nullable TUIRequestRejectedBlock)onRejected |
onCancelled: | (nullable TUIRequestCancelledBlock)onCancelled |
onTimeout: | (nullable TUIRequestTimeoutBlock)onTimeout |
onError: | (nullable TUIRequestErrorBlock)onError |
Param | DESC |
device | |
timeout | Timeout time, in seconds. If it is set to 0, the SDK will not execute timeout detection and will not trigger a timeout callback. |
- (void)getSeatList: | (TUISeatListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)lockSeatByAdmin: | (NSInteger)seatIndex |
lockMode: | |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
lockParams | Seat lock parameter. More details, see: $TUISeatLockParam$. |
seatIndex | Seat index. |
- (TUIRequest *)takeSeat: | (NSInteger)seatIndex |
timeout: | (NSTimeInterval)timeout |
onAccepted: | (TUIRequestAcceptedBlock)onAccepted |
onRejected: | (TUIRequestRejectedBlock)onRejected |
onCancelled: | (TUIRequestCancelledBlock)onCancelled |
onTimeout: | (TUIRequestTimeoutBlock)onTimeout |
onError: | (TUIRequestErrorBlock)onError |
Param | DESC |
seatIndex | Seat index. If the seat is not enabled or the sequence of seats is not concerned, just fill in -1. |
timeout | Timeout time, in seconds. If it is set to 0, the SDK will not execute timeout detection and will not trigger a timeout callback. |
- (void)leaveSeat: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)moveToSeat: | (NSInteger)targetSeatIndex |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (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 |
Param | DESC |
seatIndex | Seat index. |
timeout | Timeout time, in seconds. If it is set to 0, the SDK will not execute timeout detection and will not trigger a timeout callback. |
userId | User ID. |
- (void)kickUserOffSeatByAdmin: | (NSInteger)seatIndex |
userId: | (NSString *)userId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
seatIndex | Seat index. If the seat is not enabled and the sequence of seats is not concerned, just fill in -1. |
userId | User ID. |
- (void)getSeatApplicationList: | (TUIRequestListResponseBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
- (void)disableSendingMessageByAdmin: | (NSString *)userId |
isDisable: | (BOOL)isDisable |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
isDisable | true: disable user to send message, false: enable user to send message. |
userId | User ID. |
- (void)disableSendingMessageForAllUser: | (BOOL)isDisable |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
isDisable | true: disable all users to send message, false: enable all users to send message. |
- (void)sendTextMessage: | |
onSuccess: | (TUISendTextMessageBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
onError | Error callback. |
onSuccess | Success callback. |
textMessage | Message object. |
- (void)sendCustomMessage: | |
onSuccess: | (TUISendCustomMessageBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
customMessage | Message object. |
onError | Error callback. |
onSuccess | Success callback. |
- (void)cancelRequest: | (NSString *)requestId |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
requestId | Request ID (get from the sent request). |
- (void)responseRemoteRequest: | (NSString *)requestId |
agree: | (BOOL)agree |
onSuccess: | (TUISuccessBlock)onSuccess |
onError: | (TUIErrorBlock)onError |
Param | DESC |
agree | YES: Agree the request, NO: Reject the request. |
requestId | Request ID (get from the sent request or notification of the OnRequestReceived event). |
- (void)setBeautyLevel: | (NSInteger)beautyStyle |
beautyLevel: | (float)beautyLevel |
Param | DESC |
beautyLevel | Beauty level, the value range is 0 - 9; 0 indicates to disable the filter, and 9 indicates the most obvious effect. |
beautyStyle | Beauty style, the values are as follows: 0: Smooth, the skin smoothing effect is more obvious; 1: Natural, the skin smoothing effect is more natural, and more facial details are retained; 2: Excellent, the skin smoothing effect is between smooth and natural, retaining more skin details than smooth, and the skin smoothing degree is higher than natural. |
- (void)setWhitenessLevel: | (float)whitenessLevel |
Param | DESC |
whitenessLevel | Whitening level, ranging from 0 - 9; 0 indicates to disable the filter, and 9 indicates the most obvious effect. |
- (id) getExtension: |
Param | DESC |
extensionType |
- (id)callExperimentalAPI: | (NSString *)jsonStr |
callback: | (TUIExperimentalAPIResponseBlock)callback |
Feedback