TUIRoom (iOS)
TUIRoom is based on Tencent Real-Time Communication (TRTC) and Tencent Cloud Chat. Its features include:
A host can create a room, and users can enter the room ID to join the room.
Participants can share their screens with each other.
All room members can send text chat messages and custom messages.
Note:
TUIRoom is an open-source class depending on two closed-source Tencent Cloud SDKs. For the specific implementation process, see Integrating TUIRoom (iOS).
The TRTC SDK is used as a low-latency audio/video room component.
The Chat SDK (iOS edition) is used to implement chat messages.
TUIRoom API Overview
TUIRoomCore basic APIs
API | Description |
Gets a singleton object. | |
Terminates a singleton object. | |
Sets event callbacks. |
Room APIs
API | Description |
Creates a room (called by host). | |
Closes the room (called by host). | |
Enters a room (called by participant) | |
Leaves a room (called by participant). | |
Gets the room information. | |
Gets the information of all users in the room. | |
Gets the information of a user. | |
Transfers the host permissions to another user (called by host). |
Local audio/video operation APIs
API | Description |
Enables the preview image of local video. | |
Stops local video capturing and preview. | |
Enables mic capturing. | |
Stops mic capturing. | |
Sets the mirror mode for local video preview. | |
Sets whether to play sound from the device’s speaker or receiver. |
Remote user APIs
API | Description |
Subscribes to and plays back the remote video image of a specified room member. | |
Unsubscribes from and stops the playback of a remote video image. |
Chat message sending APIs
API | Description |
Sends a chat message. | |
Sends a custom message. |
Room control APIs
API | Description |
Enables/Disables the mic of a specified user. | |
Enables/Disables the mics of all users and syncs the status to room information. | |
Enables/Disables the camera of a specified user. | |
Enables/Disables the cameras of all users and syncs the status to room information. | |
Disables/Enables chat messages (called by host). | |
Removes a specified user from the room (called by host). | |
Starts a roll call (called by host). | |
Stops a roll call (called by host). | |
Replies to a roll call (called by participant). | |
Sends a speech invitation to a participant (called by host). | |
Cancels a speech invitation sent to a participant (called by host). | |
Accepts/Rejects the speech invitation of the host (called by participant). | |
Sends a speech request (called by participant). | |
Approves/Rejects the speech request of a participant (called by host). | |
Disables requests to speak (called by host). | |
Stops the speech of a participant (called by host). | |
Stops the speech of all room members (called by host). | |
Exits the speaker mode (called by participant). |
Screen sharing APIs
API | Description |
Starts screen sharing. | |
Stops screen sharing. |
Beauty filter APIs
API | Description |
Settings APIs
API | Description |
Sets network QoS control parameters. |
SDK version APIs
API | Description |
Gets the SDK version. |
TUIRoomCoreDelegate API Overview
Callbacks for error events
API | Description |
Callback for error. |
Basic event callbacks
API | Description |
The room was closed. | |
The audio volume of a user. | |
The host changed. |
Remote user event callbacks
API | Description |
A remote user entered the room. | |
A remote user exited the room. | |
A remote user enabled/disabled their camera. | |
A remote user started/stopped screen sharing. | |
A remote user turned on/off their mic. | |
A remote user started speaking. | |
A remote user stopped speaking. |
Message event callbacks
API | Description |
A text chat message was received. |
Room control event callbacks
API | Description |
A participant received a speech invitation from the host. | |
The speech invitation sent to a participant was canceled by the host. | |
The host received a speech request from a participant. | |
A participant canceled a speech request. | |
The host disabled requests to speak. | |
A participant was asked to stop speaking. | |
The host started a roll call (received by participants) | |
The host stopped a roll call (received by participants). | |
A participant replied to the roll call (received by the host). | |
The host disabled/enabled chat messages. | |
The host disabled mic use. | |
The host disabled camera use. | |
The host removed a participant from the room (received by the participant). |
Callback of statistics on network quality and technical metrics
API | Description |
Statistics on technical metrics. | |
Network quality. |
Screen sharing event callbacks
API | Description |
Screen sharing started. | |
Screen sharing stopped. |
TUIRoomCore Basic APIs
getInstance
+ (instancetype)shareInstance;
destroyInstance
+ (void)destroyInstance;
setDelegate
This API is used to set the event callbacks of TUIRoomCore. You can use
TUIRoomCoreDelegate to get the callbacks.- (void)setDelegate:(id<TUIRoomCoreDelegate>)delegate;
The parameters are described below:
Parameter | Type | Description |
delegate | TUIRoomCoreDelegate | The event callback class. |
createRoom
This API is used to create a room (called by the host).
- (void)createRoom:(NSString *)roomIdspeechMode:(TUIRoomSpeechMode)speechModecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
roomId | NSString | The room ID. You need to assign and manage the IDs in a centralized manner. |
speechMode | TUIRoomSpeechMode | The speech mode. |
callback | TUIRoomActionCallback | The room creation result. |
Generally, a host may need to call the following APIs:
1. The host calls
createRoom() to create a room, the result of which is returned via TUIRoomActionCallback.2. The host calls
startCameraPreview() to enable camera capturing and preview.3. The host calls
startLocalAudio() to enable the local mic.destroyRoom
This API is used to close a room (called by the host).
- (void)destroyRoom:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomActionCallback | The room closing result. |
enterRoom
This API is used to enter a room (called by a participant).
- (void)enterRoom:(NSString *)roomIdcallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
roomId | NSString | The room ID. |
callback | TUIRoomActionCallback | The result. |
Generally, a participant joins a room in the following steps:
1. The participant calls
enterRoom (passing in roomId) to enter the room.2. The participant calls
startCameraPreview() to enable camera preview and calls startLocalAudio() to enable mic capturing.3. The participant receives the
onRemoteUserCameraAvailable callback and calls startRemoteView() to start playback.leaveRoom
This API is used to leave a room (called by a participant).
- (void)leaveRoom:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomActionCallback | The result. |
getRoomInfo
This API is used to get the room information.
- (nullable TUIRoomInfo *)getRoomInfo;
getRoomUsers
This API is used to get the information of all users in the room.
- (nullable NSArray<TUIRoomUserInfo *> *)getRoomUsers;
getUserInfo
This API is used to get the information of a specified room member.
- (void)getUserInfo:(NSString *)userIdcallback:(TUIRoomUserInfoCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
callback | TUIRoomUserInfoCallback | Room member details. |
setSelfProfile
This API is used to set the user profile.
- (void)setSelfProfile:(NSString *)userNameavatarURL:(NSString *)avatarURLcallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userName | NSString | The username. |
avatarURL | NSString | The URL of the user profile photo. |
callback | TUIRoomActionCallback | Whether the setting succeeded. |
transferRoomMaster
This API is used to transfer host permissions to another user.
- (void)transferRoomMaster:(NSString *)userIdcallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
callback | TUIRoomActionCallback | The result. |
Local Push APIs
startCameraPreview
This API is used to start the preview of the local camera.
- (void)startCameraPreview:(BOOL)isFrontview:(UIView *)view;
The parameters are described below:
Parameter | Type | Description |
isFront | BOOL | YES: Front camera; NO: Rear camera. |
view | UIView | Control that carries the video image. |
stopCameraPreview
This API is used to stop the preview of the local camera.
- (void)stopCameraPreview;
startLocalAudio
This API is used to start mic capturing.
- (void)startLocalAudio:(TRTCAudioQuality)quality;
The parameters are described below:
Parameter | Type | Description |
quality | TRTCAudioQuality | The sound quality. |
stopLocalAudio
This API is used to stop mic capturing.
- (void)stopLocalAudio;
setVideoMirror
This API is used to set the mirror mode for local video preview.
- (void)setVideoMirror:(TRTCVideoMirrorType)type;
The parameters are described below:
Parameter | Type | Description |
type | TRTCVideoMirrorType | The mirror mode. |
setSpeaker
This API is used to set whether to play sound from the device’s speaker or receiver.
- (void)setSpeaker:(BOOL)isUseSpeaker;
The parameters are described below:
Parameter | Type | Description |
isUseSpeaker | BOOL | YES: Speaker; NO: Receiver. |
Remote User APIs
startRemoteView
This API is used to subscribe to a remote user's video stream.
- (void)startRemoteView:(NSString *)userIdview:(UIView *)viewstreamType:(TUIRoomStreamType)streamTypecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The ID of the user whose video image is to be played back. |
view | UIView | The view that loads video images. |
streamType | TUIRoomStreamType | The stream type. |
callback | TUIRoomActionCallback | The result. |
stopRemoteView
This API is used to unsubscribe from and stop the playback of a remote video image.
- (void)stopRemoteView:(NSString *)userIdstreamType:(TUIRoomStreamType)streamTypecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The ID of the user whose video image is to be stopped. |
streamType | TUIRoomStreamType | The stream type. |
callback | TUIRoomActionCallback | The result. |
switchCamera
This API is used to switch between the front and rear cameras.
- (void)switchCamera:(BOOL)isFront;
The parameters are described below:
Parameter | Type | Description |
isFront | BOOL | YES: Front camera; NO: Rear camera. |
Message Sending APIs
sendChatMessage
This API is used to broadcast a text chat message in the room.
- (void)sendChatMessage:(NSString *)messagecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
message | NSString | The message content. |
callback | TUIRoomActionCallback | The result. |
Room Control APIs
muteUserMicrophone
This API is used to enable/disable the mic of the specified user.
- (void)muteUserMicrophone:(NSString *)userIdmute:(BOOL)mutecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
mute | BOOL | Whether to disable. |
callback | TUIRoomActionCallback | The result. |
muteAllUsersMicrophone
This API is used to enable/disable the mics of all users.
- (void)muteAllUsersMicrophone:(BOOL)mutecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
mute | BOOL | Whether to disable. |
callback | TUIRoomActionCallback | The result. |
muteUserCamera
This API is used to enable/disable the camera of the specified user.
- (void)muteUserCamera:(NSString *)userIdmute:(BOOL)mutecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
mute | BOOL | Whether to disable. |
callback | TUIRoomActionCallback | The result. |
muteAllUsersCamera
This API is used to enable/disable the cameras of all users.
- (void)muteAllUsersCamera:(BOOL)mutecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
mute | BOOL | Whether to disable. |
callback | TUIRoomActionCallback | The result. |
muteChatRoom
This API is used to disable/enable chat messages.
- (void)muteChatRoom:(BOOL)mutecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
mute | BOOL | Whether to disable. |
callback | TUIRoomActionCallback | The result. |
kickOffUser
This API is used by the host to remove a member from the room.
- (void)kickOffUser:(NSString *)userIdcallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
callback | TUIRoomActionCallback | The result. |
startCallingRoll
This API is used by the host to start a roll call.
- (void)startCallingRoll:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomActionCallback | The result. |
stopCallingRoll
This API is used by the host to stop a roll call.
- (void)stopCallingRoll:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomActionCallback | The result. |
replyCallingRoll
This API is used by a participant to reply to a roll call.
- (void)replyCallingRoll:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomActionCallback | The result. |
sendSpeechInvitation
This API is used by the host to invite a participant to speak.
- (void)sendSpeechInvitation:(NSString *)userIdcallback:(TUIRoomInviteeCallback)callback
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
callback | TUIRoomInviteeCallback | The result. |
cancelSpeechInvitation
This API is used by the host to cancel a speech invitation.
- (void)cancelSpeechInvitation:(NSString *)userIdcallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
callback | TUIRoomActionCallback | The result. |
replySpeechInvitation
This API is used by a participant to accept/reject the host’s invitation to speak.
- (void)replySpeechInvitation:(BOOL)agreecallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
agree | bool | Whether to approve. |
callback | TUIRoomActionCallback | The result. |
sendSpeechApplication
This API is used by a participant to send a request to speak.
- (void)sendSpeechApplication:(TUIRoomInviteeCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomInviteeCallback | The result. |
cancelSpeechApplication
This API is used by a participant to cancel the request to speak.
- (void)cancelSpeechApplication:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomActionCallback | The result. |
replySpeechApplication
This API is used by the host to approve/reject a participant’s speech request.
- (void)replySpeechApplication:(BOOL)agreeuserId:(NSString *)userIdcallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
agree | BOOL | Whether to approve. |
userId | NSString | The user ID. |
callback | TUIRoomActionCallback | The result. |
forbidSpeechApplication
This API is used by the host to disable requests to speak.
- (void)forbidSpeechApplication:(BOOL)forbidcallback:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
forbid | BOOL | Whether to disable. |
callback | TUIRoomActionCallback | The result. |
sendOffSpeaker
This API is used by the host to stop the speech of a participant.
- (void)sendOffSpeaker:(NSString *)userIdcallback:(TUIRoomInviteeCallback)callback;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
callback | TUIRoomInviteeCallback | The result. |
sendOffAllSpeakers
This API is used by the host to stop the speech of all room members.
- (void)sendOffAllSpeakers:(TUIRoomInviteeCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomInviteeCallback | The result. |
exitSpeechState
This API is used by a participant to exit the speaker mode.
- (void)exitSpeechState:(TUIRoomActionCallback)callback;
The parameters are described below:
Parameter | Type | Description |
callback | TUIRoomActionCallback | The result. |
Screen Sharing APIs
startScreenCapture
This API is used to start screen sharing.
- (void)startScreenCapture:(TRTCVideoEncParam *)encParam API_AVAILABLE(ios(11.0));
The parameters are described below:
Parameter | Type | Description |
encParams | TRTCVideoEncParam | Sets encoding parameters for screen sharing. |
Note:
stopScreenCapture
This API is used to stop screen capturing.
- (void)stopScreenCapture API_AVAILABLE(ios(11.0));
Beauty Filter APIs
getBeautyManager
- (TXBeautyManager *)getBeautyManager;
You can do the following using the beauty filter manger:
Set the beauty filter style and apply effects including skin brightening, rosy skin, eye enlarging, face slimming, chin slimming, chin lengthening/shortening, face shortening, nose narrowing, eye brightening, teeth whitening, eye bag removal, wrinkle removal, and smile line removal.
Adjust the hairline, eye spacing, eye corners, lip shape, nose wings, nose position, lip thickness, and face shape.
Apply animated effects such as face widgets (materials).
Add makeup effects.
Recognize gestures.
Settings APIs
setVideoQosPreference
This API is used to set network QoS control parameters.
- (void)setVideoQosPreference:(TRTCNetworkQosParam *)preference;
The parameters are described below:
Parameter | Type | Description |
preference | TRTCNetworkQosParam | The network QoS policy. |
setAudioQuality
This API is used to set audio quality.
- (void)setAudioQuality:(TRTCAudioQuality)quality;
The parameters are described below:
Parameter | Type | Description |
quality | TRTCAudioQuality |
setVideoResolution
This API is used to set the resolution.
- (void)setVideoResolution:(TRTCVideoResolution)resolution;
The parameters are described below:
Parameter | Type | Description |
resolution | TRTCVideoResolution |
setVideoFps
This API is used to set the frame rate.
- (void)setVideoFps:(int)fps;
The parameters are described below:
Parameter | Type | Description |
fps | int | The video capturing frame rate. |
Note:
Recommended value: 15 or 20 fps. Video will stutter severely if the frame rate is lower than 5 fps and slightly if it is lower than 10 fps. Setting the frame rate to higher than 20 fps would be a waste of resources (the frame rate of films is 24 fps).
setVideoBitrate
This API is used to set the bitrate.
- (void)setVideoBitrate:(int)bitrate;
The parameters are described below:
Parameter | Type | Description |
bitrate | int | The bitrate. The SDK encodes streams at the target video bitrate. However, it may reduce the bitrate if network conditions are poor. For more information, see TRTC SDK. |
Note:
Recommended value: See the recommended bitrate for each
TRTCVideoResolution value. For a better viewing experience, you can slightly increase the bitrate. For example, the recommended bitrate for TRTC_VIDEO_RESOLUTION_1280_720 is 1,200 Kbps. You can set the bitrate to 1,500 Kbps.enableAudioEvaluation
This API is used to enable the volume reminder.
- (void)enableAudioEvaluation:(BOOL)enable;
The parameters are described below:
Parameter | Type | Description |
bEnable | BOOL | YES: Enable. NO: Disable. |
Note:
After the volume reminder is enabled, the volumes measured by the SDK will be returned via the
onUserVolumeUpdate callback.setAudioPlayVolume
This API is used to set the playback volume.
- (void)setAudioPlayVolume:(NSInteger)volume;
The parameters are described below:
Parameter | Type | Description |
volume | int | The playback volume. Value range: 0-100. Default value: 100. |
setAudioCaptureVolume
This API is used to set the mic capturing volume.
- (void)setAudioCaptureVolume:(NSInteger)volume;
The parameters are described below:
Parameter | Type | Description |
volume | int | The capturing volume. Value range: 0-100. Default value: 100. |
startFileDumping
This API is used to start audio recording.
- (void)startFileDumping:(TRTCAudioRecordingParams *)params;
The parameters are described below:
Parameter | Type | Description |
params | TRTCAudioRecordingParams |
Note:
After this API is called, the SDK will record all audios of a call, including the local audio, remote audios, and background music, into a single file. This API works regardless of whether you are in the room or not. When
leaveRoom is called, audio recording will stop automatically.stopFileDumping
This API is used to stop audio recording.
- (void)stopFileDumping;
SDK Version APIs
getSdkVersion
This API is used to get the SDK version.
- (NSInteger)getSdkVersion;
Error Event Callbacks
onError
- (void)onError:(NSInteger)code message:(NSString *)message;
The parameters are described below:
Parameter | Type | Description |
code | NSInteger | The error code. |
message | NSString | The error message. |
Basic Event Callbacks
onDestroyRoom
The room was closed.
- (void)onDestroyRoom;
onUserVoiceVolume
The audio volume of a user.
- (void)onUserVoiceVolume:(NSString *)userId volume:(NSInteger)volume;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
volume | NSInteger | The volume. Value range: 0-100. |
onRoomMasterChanged
The host changed.
- (void)onRoomMasterChanged:(NSString *)previousUserIdcurrentUserId:(NSString *)currentUserId;
The parameters are described below:
Parameter | Type | Description |
previousUserId | NSString | The host’s user ID before the change. |
currentUserId | NSString | The host's user ID after the change. |
Remote User Callbacks
onRemoteUserEnter
A remote user entered the room.
- (void)onRemoteUserEnter:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
onRemoteUserLeave
A remote user exited the room.
- (void)onRemoteUserLeave:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
onRemoteUserCameraAvailable
A remote user enabled/disabled their camera.
- (void)onRemoteUserCameraAvailable:(NSString *)userIdavailable:(BOOL)available;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
available | BOOL | YES: Enabled; NO: Disabled. |
onRemoteUserScreenVideoAvailable
A member enabled/disabled video sharing.
- (void)onRemoteUserScreenVideoAvailable:(NSString *)userIdavailable:(BOOL)available;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
available | BOOL | Whether the user enabled/disabled screen sharing. |
onRemoteUserAudioAvailable
A remote user enabled/disabled their mic.
- (void)onRemoteUserAudioAvailable:(NSString *)userIdavailable:(BOOL)available;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | User ID. |
available | BOOL | Whether the user enabled/disabled their mic. |
onRemoteUserEnterSpeechState
A remote user started speaking.
- (void)onRemoteUserEnterSpeechState:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
onRemoteUserExitSpeechState
A remote user stopped speaking.
- (void)onRemoteUserExitSpeechState:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
Chat Message Event Callbacks
onReceiveChatMessage
A text chat message was received.
- (void)onReceiveChatMessage:(NSString *)userId message:(NSString *)message;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
message | NSString | The message content. |
Room Control Message Callbacks
onReceiveSpeechInvitation
The host sent a speech invitation (received by a participant).
- (void)onReceiveSpeechInvitation:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The host's user ID. |
onReceiveInvitationCancelled
The host canceled the speech invitation (received by a participant).
- (void)onReceiveInvitationCancelled:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The host's user ID. |
OnReceiveSpeechApplication
A participant sent a request to speak (received by the host).
void onReceiveSpeechApplication(String userId);
The parameters are described below:
Parameter | Type | Description |
userId | NSString | User ID. |
onSpeechApplicationCancelled
A participant canceled a speech request.
- (void)onSpeechApplicationCancelled:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
onSpeechApplicationForbidden
The host disabled requests to speak.
- (void)onSpeechApplicationForbidden:(BOOL)isForbidden userId:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
isForbidden | BOOL | Disabled or not. |
userId | NSString | User ID. |
onOrderedToExitSpeechState
A participant was asked to stop speaking.
- (void)onOrderedToExitSpeechState:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The host's user ID. |
onCallingRollStarted
The host started a roll call (received by participants).
- (void)onCallingRollStarted:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The host's user ID. |
onCallingRollStopped
The host stopped a roll call (received by participants).
- (void)onCallingRollStopped:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The host's user ID. |
onMemberReplyCallingRoll
A participant replied to the roll call (received by the host).
- (void)onMemberReplyCallingRoll:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID. |
onChatRoomMuted
The host disabled/enabled chat messages.
- (void)onChatRoomMuted:(BOOL)muted userId:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
muted | BOOL | Disabled or not. |
userId | NSString | The host's user ID. |
onMicrophoneMuted
The host disabled mic use.
- (void)onMicrophoneMuted:(BOOL)muted userId:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
muted | BOOL | Disabled or not. |
userId | NSString | The host's user ID. |
onCameraMuted
The host disabled camera use.
- (void)onCameraMuted:(BOOL)muted userId:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
muted | BOOL | Disabled or not. |
userId | NSString | The host's user ID. |
onReceiveKickedOff
The host removed a member from the room.
- (void)onReceiveKickedOff:(NSString *)userId;
The parameters are described below:
Parameter | Type | Description |
userId | NSString | The user ID of the host/admin. |
Callbacks of statistics on network quality and technical metrics
onStatistics
Callback of technical metric statistics.
- (void)onStatistics:(TRTCStatistics *)statistics;
The parameters are described below:
Parameter | Type | Description |
statis | TRTCStatistics | Statistics. |
onNetworkQuality
Network quality.
- (void)onNetworkQuality:(TRTCQualityInfo *)localQuality remoteQuality:(NSArray<TRTCQualityInfo *> *)remoteQuality;
The parameters are described below:
Parameter | Type | Description |
localQuality | TRTCQualityInfo | The upstream network quality. |
remoteQuality | NSArray<TRTCQualityInfo *> | The downstream network quality. |
Note:
Screen Sharing Event Callbacks
onScreenCaptureStarted
Screen sharing started.
- (void)onScreenCaptureStarted;
onScreenCaptureStopped
Screen sharing stopped.
- (void)onScreenCaptureStopped:(NSInteger)reason;
The parameters are described below:
Parameter | Type | Description |
reason | NSInteger | The reason. 0: The user stopped screen sharing; 1: Screen sharing was interrupted by another application. |
- TUIRoom API Overview
- TUIRoomCoreDelegate API Overview
- TUIRoomCore Basic APIs
- Local Push APIs
- Remote User APIs
- Message Sending APIs
- Room Control APIs
- muteUserMicrophone
- muteAllUsersMicrophone
- muteUserCamera
- muteAllUsersCamera
- muteChatRoom
- kickOffUser
- startCallingRoll
- stopCallingRoll
- replyCallingRoll
- sendSpeechInvitation
- cancelSpeechInvitation
- replySpeechInvitation
- sendSpeechApplication
- cancelSpeechApplication
- replySpeechApplication
- forbidSpeechApplication
- sendOffSpeaker
- sendOffAllSpeakers
- exitSpeechState
- Screen Sharing APIs
- Beauty Filter APIs
- Settings APIs
- SDK Version APIs
- Error Event Callbacks
- Basic Event Callbacks
- Remote User Callbacks
- Chat Message Event Callbacks
- Room Control Message Callbacks
- onReceiveSpeechInvitation
- onReceiveInvitationCancelled
- OnReceiveSpeechApplication
- onSpeechApplicationCancelled
- onSpeechApplicationForbidden
- onOrderedToExitSpeechState
- onCallingRollStarted
- onCallingRollStopped
- onMemberReplyCallingRoll
- onChatRoomMuted
- onMicrophoneMuted
- onCameraMuted
- onReceiveKickedOff
- Callbacks of statistics on network quality and technical metrics
- onStatistics
- onNetworkQuality
- Screen Sharing Event Callbacks