TRTCLiveRoom APIs (iOS)

@property(nonatomic, weak)id<TRTCLiveRoomDelegate> delegate;

/// Log in to the component.
/// - Parameters:
///   - sdkAppID: You can view `SDKAppID` in **[Application Management](https://console.tencentcloud.com/trtc/app)** > **Application Info** of the TRTC console.
///   - userID: ID of the current user, which is a string that can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (\_)
///   - userSig: Tencent Cloud's proprietary security signature. For how to calculate and use it, see [FAQs > UserSig](https://intl.cloud.tencent.com/document/product/647/35166).
///   - config: global configuration information, which should be initialized during login and cannot be modified afterward. Use `isAttachedTUIKit` to specify whether to import TUIKit into your project.
///   - callback: Callback for login. The return code is `0` if login is successful.
/// - Note:
///   - We recommend setting the validity period of `userSig` to 7 days to avoid cases where message sending/receiving and co-anchoring fail due to expired `userSig`.
- (void)loginWithSdkAppID:(int)sdkAppID
                  userID:(NSString *)userID
                 userSig:(NSString *)userSig
                  config:(TRTCLiveRoomConfig *)config
                callback:(Callback _Nullable)callback
NS_SWIFT_NAME(login(sdkAppID:userID:userSig:config:callback:));

// Log out
/// - Parameter callback:  Callback for logout. The code is `0` if logout is successful.
- (void)logout:(Callback _Nullable)callback
NS_SWIFT_NAME(logout(_:));

/// Set user profiles. The information will be stored in Tencent Cloud Chat.
/// - Parameters:
///   - name: username
///   - avatarURL: profile picture URL
///   - callback: Callback for setting user profiles. The code is `0` if the operation is successful.
- (void)setSelfProfileWithName:(NSString *)name
                     avatarURL:(NSString * _Nullable)avatarURL
                      callback:(Callback _Nullable)callback
NS_SWIFT_NAME(setSelfProfile(name:avatarURL:callback:));

/// Create a room (called by anchor). If the room does not exist, the system will create the room automatically.
/// The process of creating a room and starting live streaming as an anchor is as follows:
/// 1. A user calls `startCameraPreview()` to enable camera preview and set beauty filters.
/// 2. The user calls `createRoom()` to create a room, the result of which is returned via a callback.
/// 3. The user calls `starPublish()` to push streams.
/// - Parameters:
///   - roomID: The room ID. You need to assign and manage the IDs in a centralized manner. Multiple `roomID` values can be aggregated into a live room list. Currently, Tencent Cloud does not provide list management services. Please manage your own room lists.
///   - roomParam: room information, such as room name and cover information. If both the room list and room information are managed by yourself, you can ignore this parameter.
///   - callback: Callback for room entry. The code is `0` if room entry is successful.
/// - Note:
///   - This API is called by an anchor to start live streaming. An anchor can create a room he or she created before.
- (void)createRoomWithRoomID:(UInt32)roomID
                   roomParam:(TRTCCreateRoomParam *)roomParam
                    callback:(Callback _Nullable)callback
NS_SWIFT_NAME(createRoom(roomID:roomParam:callback:));

/// Terminate a room (called by anchor)
/// After creating a room, an anchor can call this API to terminate it.
/// - parameter callback: callback for room termination. The code is `0` if the operation is successful.
/// - Note:
///   - After creating a room, an anchor can call this API to terminate it
- (void)destroyRoom:(Callback _Nullable)callback
NS_SWIFT_NAME(destroyRoom(callback:));

/// Enter a room (called by audience)
/// The process of entering a room and starting playback as an audience member is as follows:
/// 1. A user gets the latest room list from your server. The list may contain the `roomID` and other information of multiple rooms.
/// 2. The user selects a room and calls `enterRoom()` to enter the room.
/// 3. If the room list managed by your server contains the `userID` of the anchor of each room, after entering the room, the user can call `startPlay(userID)` to play the anchor’s video.
/// If the room list contains `roomID` only, upon room entry, the user will receive the `onAnchorEnter(userID)` callback from `TRTCLiveRoomDelegate`.
/// The user can then call `startPlay(userID)`, passing in the `userID` obtained from the callback, to play the anchor’s video.
/// - Parameters:
///   - roomID: The room ID.
///   - useCDNFirst: whether to play streams via CDNs whenever possible
///   - cdnDomain: CDN domain name
///   - callback: Callback for room entry. The code is `0` if room entry is successful.
/// - Note:
///   - This API is called by a user to enter a room.
///   - An anchor cannot use this API to enter a room he or she created, but must use createRoom instead.
- (void)enterRoomWithRoomID:(UInt32)roomID
                useCDNFirst:(BOOL)useCDNFirst
                  cdnDomain:(NSString * _Nullable)cdnDomain
                   callback:(Callback)callback
NS_SWIFT_NAME(enterRoom(roomID:useCDNFirst:cdnDomain:callback:));

/// Leave a room (called by audience)
/// - Parameter callback: callback for room exit. The code is `0` if the operation is successful.
/// - Note:
///   - This API is called by an audience member to leave a room.
///   - An anchor cannot use this API to leave a room.

- (void)exitRoom:(Callback _Nullable)callback
NS_SWIFT_NAME(exitRoom(callback:));

/// Get room details
/// The information is provided by anchors via the `roomInfo` parameter when they call `createRoom()`. You don’t need this API if both the room list and room information are managed by yourself.
/// - Parameter roomIDs: The list of room IDs.
/// - Parameter callback: Callback of room details.
- (void)getRoomInfosWithRoomIDs:(NSArray<NSNumber *> *)roomIDs
                       callback:(RoomInfoCallback _Nullable)callback
NS_SWIFT_NAME(getRoomInfos(roomIDs:callback:));


/// Get the anchors and co-anchoring viewers in a room. This API takes effect only if it is called after `enterRoom()`.
/// - Parameter callback: Callback of user details.
- (void)getAnchorList:(UserListCallback _Nullable)callback
NS_SWIFT_NAME(getAnchorList(callback:));


/// Get the information of all audience members in a room. This API takes effect only if it is called after `enterRoom()`.
/// - Parameter callback: Callback of user details.
- (void)getAudienceList:(UserListCallback _Nullable)callback
NS_SWIFT_NAME(getAudienceList(callback:));


/// Enable local video preview
/// - Parameters:
///   - frontCamera: `true`: Front camera; `false`: Rear camera
///   - view: The control that loads video images.
///   - callback: Callback for the operation
- (void)startCameraPreviewWithFrontCamera:(BOOL)frontCamera
                                     view:(UIView *)view
                                 callback:(Callback _Nullable)callback
NS_SWIFT_NAME(startCameraPreview(frontCamera:view:callback:));


/// Stop local video capturing and preview
- (void)stopCameraPreview;


/// Start live streaming (push streams). This API can be called in the following scenarios:
/// 1. An anchor starts live streaming.
/// 2. An audience member starts co-anchoring.
/// - Parameters:
///   - streamID: the `streamID` used to bind live streaming CDNs. You need to set it to the `streamID` of the anchor if you want the audience to receive the anchor’s stream via CDNs.
///   - callback: Callback for the operation
- (void)startPublishWithStreamID:(NSString *)streamID
                        callback:(Callback _Nullable)callback
NS_SWIFT_NAME(startPublish(streamID:callback:));

/// Stop live streaming (pushing streams). This API can be called in the following scenarios:
/// 1. An anchor ends live streaming.
/// 2. An audience member ends co-anchoring.
/// - Parameter callback: Callback for the operation.
- (void)stopPublish:(Callback _Nullable)callback
NS_SWIFT_NAME(stopPublish(callback:));

/// Play a remote video. This API can be called in common playback and co-anchoring scenarios.
/// Common playback scenario
/// 1. If the room list managed by your server contains the `userID` of the anchor of each room, after entering a room, a user can call `startPlay(userID)` to play the anchor’s video.
/// 2. If the room list contains `roomID` only, upon room entry, a user will receive the `onAnchorEnter(userID)` callback from `TRTCLiveRoomDelegate`.
/// The user can then call `startPlay(userID)`, passing in the `userID` obtained from the callback, to play the anchor’s video.
/// Co-anchoring scenario
/// After co-anchoring starts, the anchor will receive the `onAnchorEnter(userID)` callback from `TRTCLiveRoomDelegate` and can call `startPlay(userID)`, passing in the `userID` obtained from the callback to play the co-anchoring user’s video.
/// - Parameters:
///   - userID: The ID of the user whose video is to be played.
///   - view: The control that loads video images.
///   - callback: Callback for the operation
- (void)startPlayWithUserID:(NSString *)userID
                       view:(UIView *)view
                   callback:(Callback _Nullable)callback
NS_SWIFT_NAME(startPlay(userID:view:callback:));

/// Stop rendering a remote video
/// - Parameters:
///   - userID: The ID of the remote user.
///   - callback: Callback for the operation
/// - Note:
///   - Call this API after receiving the `onAnchorExit` callback.
- (void)stopPlayWithUserID:(NSString *)userID
                  callback:(Callback _Nullable)callback
NS_SWIFT_NAME(stopPlay(userID:callback:));

/// Send a co-anchoring request
/// - Parameters:
///   - reason: reason for co-anchoring
///   - responseCallback: callback of the response
/// - Note: After an audience member sends a co-anchoring request, the anchor will receive the `onRequestJoinAnchor` callback.
- (void)requestJoinAnchor:(NSString *)reason
                  timeout:(double)timeout
         responseCallback:(ResponseCallback _Nullable)responseCallback
NS_SWIFT_NAME(requestJoinAnchor(reason:timeout:responseCallback:));

/// Respond to a co-anchoring request
/// - Parameters:
///   - user: user ID of the viewer
///   - agree: `true`: Accept; `false`: Reject
///   - reason: reason for accepting/rejecting the request
/// - Note: After the anchor responds to the request, the viewer will receive the `responseCallback` passed in to `requestJoinAnchor`.
- (void)responseJoinAnchor:(NSString *)userID
                     agree:(BOOL)agree
                    reason:(NSString *)reason
NS_SWIFT_NAME(responseJoinAnchor(userID:agree:reason:));

/// Remove a user from co-anchoring
/// - Parameters:
///   - userID: ID of the user to remove from co-anchoring
///   - callback: Callback for the operation
/// - Note: After the anchor calls this API to remove a user from co-anchoring, the user will receive the `trtcLiveRoomOnKickoutJoinAnchor()` callback.
- (void)kickoutJoinAnchor:(NSString *)userID
                 callback:(Callback _Nullable)callback
NS_SWIFT_NAME(kickoutJoinAnchor(userID:callback:));

/// Request cross-room communication
/// - Parameters:
///   - roomID: room ID of the anchor to invite
///   - userID: user ID of the anchor to invite
///   - responseCallback: callback of the response
/// - Note: After a cross-room communication request is sent, the invited anchor will receive the `onRequestRoomPK` callback.
- (void)requestRoomPKWithRoomID:(UInt32)roomID
                         userID:(NSString *)userID
               responseCallback:(ResponseCallback _Nullable)responseCallback
NS_SWIFT_NAME(requestRoomPK(roomID:userID:responseCallback:));

/// Respond to a cross-room communication request
/// Respond to a communication request from another anchor
/// - Parameters:
///   - user: user ID of the request sending anchor
///   - agree: `true`: Accept; `false`: Reject
///   - reason: reason for accepting/rejecting the request
/// - Note: After the anchor responds to the request, the anchor sending the request will receive the `responseCallback` passed in to `requestRoomPK`.
- (void)responseRoomPKWithUserID:(NSString *)userID
                           agree:(BOOL)agree
                          reason:(NSString *)reason
NS_SWIFT_NAME(responseRoomPK(userID:agree:reason:));

/// End cross-room communication 
/// - Parameter callback: Callback for ending cross-room communication 
// - Note: If either anchor ends cross-room communication, the other anchor will receive the `trtcLiveRoomOnQuitRoomPK` callback.
- (void)quitRoomPK:(Callback _Nullable)callback
NS_SWIFT_NAME(quitRoomPK(callback:));

/// Switch between the front and rear cameras
- (void)switchCamera;

/// Specify whether to mirror video
/// - Parameter isMirror: Enable/Disable mirroring
- (void)setMirror:(BOOL)isMirror
NS_SWIFT_NAME(setMirror(isMirror:));

/// Mute or unmute the local user
/// - Parameter isMuted: `true`: Mute; `false`: Unmute
- (void)muteLocalAudio:(BOOL)isMuted
NS_SWIFT_NAME(muteLocalAudio(isMuted:));

/// Mute or unmute a remote user
/// - Parameters:
///   - userID: ID of the remote user
///   - isMuted: `true`: Mute; `false`: Unmute
- (void)muteRemoteAudioWithUserID:(NSString *)userID isMuted:(BOOL)isMuted
NS_SWIFT_NAME(muteRemoteAudio(userID:isMuted:));

/// Mute or unmute all remote users
/// - Parameter isMuted: `true`: Mute; `false`: Unmute
- (void)muteAllRemoteAudio:(BOOL)isMuted
NS_SWIFT_NAME(muteAllRemoteAudio(_:));

/// Set audio quality. Valid values: `1` (low), `2` (average), `3` (high)
/// - Parameter quality: audio quality
- (void)setAudioQuality:(NSInteger)quality
NS_SWIFT_NAME(setAudioiQuality(quality:));

/// Get the audio effect management object
- (TXAudioEffectManager *)getAudioEffectManager;

/* Get the beauty filter management object TXBeautyManager
*
* You can do the following using TXBeautyManager:
* - 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.
*/
- (TXBeautyManager *)getBeautyManager;

/// Send a text chat message that can be seen by all users in a room
/// - Parameters:
///   - message: text chat message
///   - callback: Callback for message sending
- (void)sendRoomTextMsg:(NSString *)message callback:(Callback _Nullable)callback
NS_SWIFT_NAME(sendRoomTextMsg(message:callback:));

/// Send a custom message
/// - Parameters:
///   - command: custom command word used to distinguish between different message types
///   - message: text message
///   - callback: Callback for message sending
- (void)sendRoomCustomMsgWithCommand:(NSString *)command message:(NSString *)message callback:(Callback _Nullable)callback
NS_SWIFT_NAME(sendRoomCustomMsg(command:message:callback:));