Integration Overview

pod install

<key>NSCameraUsageDescription</key>
<string>TUIRoomKit needs access to your camera</string>
<key>NSMicrophoneUsageDescription</key>
<string>TUIRoomKit needs access to your microphone</string>

import UIKit
import AtomicXCore

// RoomMainViewController represents the main view controller of the room
class RoomMainViewController: UIViewController {
    
    // Initialize the view controller and automatically create and join the room
    public init(roomID: String, roomType: RoomType) {
        super.init(nibName: nil, bundle: nil)
        createAndJoinRoom(roomID: roomID, roomType: roomType)
    }
    
    required init?(coder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }
    
    // Call this method to create and join the room
    private func createAndJoinRoom(roomID: String, roomType: RoomType) {
        // 1. Configure room initialization parameters
        // CreateRoomOptions defines the basic attributes and initial permission controls of the room
        var options = CreateRoomOptions()
        options.roomName = "My Discussion"        // Set the room display name
        options.password = ""                // Set the room entry password (leave blank if not required)
        
        // 2. Set room permissions: control all-member permissions at creation (typically for formal meetings)
        options.isAllCameraDisabled = false      // Enable/disable cameras for all members
        options.isAllMessageDisabled = false     // Enable/disable chat for all members
        options.isAllMicrophoneDisabled = false  // Enable/disable microphones for all members
        options.isAllScreenShareDisabled = false // Enable/disable screen sharing for all members
        
        // 3. Create and join room
        // If the room does not exist, it will be created first, then joined automatically
        RoomStore.shared.createAndJoinRoom(roomID: roomID, roomType: roomType, options: options) { [weak self] result in
            guard let self = self else { return }
            switch result {
            case .success():
                print("Room created and joined successfully")
            case .failure(let error):
                print("Failed to create and join room [Error code: \(error.code)]: \(error.message)")
            }
        }
    }
}

import UIKit
import AtomicXCore

// RoomMainViewController represents the main view controller of the room
class RoomMainViewController: UIViewController {
    private let roomID: String
    public init(roomID: String) {
        self.roomID = roomID
        super.init(nibName: nil, bundle: nil)
        openDevices()
    }
    
    required init?(coder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }
    
    // Enable devices
    private func openDevices() {
        // 1. Enable front camera
        DeviceStore.shared.openLocalCamera(isFront: true, completion: nil)
        // 2. Enable microphone
        DeviceStore.shared.openLocalMicrophone(completion: nil)
    }
}

import UIKit
import AtomicXCore

// RoomMainViewController represents the main view controller of the room
class RoomMainViewController: UIViewController {
    private let roomID: String

    public init(roomID: String) {
        self.roomID = roomID
        super.init(nibName: nil, bundle: nil)
        endRoom()
    }
    
    required init?(coder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }
    
    // End the room
    private func endRoom() { 
        // endRoom API permanently ends the current room.
        // Note: Typically, only the host (owner) can perform this operation. After execution, all members are removed from the room and audio/video capture is forcibly stopped.
        RoomStore.shared.endRoom { [weak self] result in
            guard let self = self else { return }
            switch result {
            case .success():
                print("Room ended successfully")
            case .failure(let error):
                print("Failed to end room [Error code: \(error.code)]: \(error.message)")
            }
        }
    }
}

import UIKit
import AtomicXCore

// RoomMainViewController represents the main view controller of the room
class RoomMainViewController: UIViewController {
    
    public init(roomID: String, roomType: RoomType) {
        super.init(nibName: nil, bundle: nil)
        joinRoom(roomID: roomID, roomType: roomType)
    }
    
    required init?(coder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }
    
    // Join an existing room
    private func joinRoom(roomID: String, roomType: RoomType) {
        // 1. Prepare join parameters
        // joinRoom is used for joining a known and ongoing room
        let targetRoomID = roomID    // Target room ID
        let roomPassword = ""        // Room password, pass empty string or nil if not set
        
        // 2. Call RoomStore joinRoom API
        // This operation verifies if the room exists, if the user is banned, and if the password is correct
        RoomStore.shared.joinRoom(roomID: targetRoomID, roomType: roomType, password: roomPassword) { [weak self] result in
            guard let self = self else { return }
            switch result {
            case .success():
                print("Joined room successfully")
            case .failure(let error):
                print("Failed to join room [Error code: \(error.code)]: \(error.message)")
            }
        }
    }
}

import UIKit
import AtomicXCore

// RoomMainViewController represents the main view controller of the room
class RoomMainViewController: UIViewController {
    private let roomID: String
    
    public init(roomID: String) {
        self.roomID = roomID
        super.init(nibName: nil, bundle: nil)
        leaveRoom()
    }
    
    required init?(coder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }
    
    // Leave the current room
    private func leaveRoom() {
        // 1. Business logic
        // leaveRoom API is used for regular members or host to leave the room.
        // Unlike endRoom, when the host calls leaveRoom, only they leave; the room remains.
        
        // 2. Call RoomStore leaveRoom API
        // This operation stops audio/video streaming and notifies the server to remove the current user from the room
        RoomStore.shared.leaveRoom { [weak self] result in
            guard let self = self else { return }
            switch result {
            case .success():
                print("Left room successfully")
            case .failure(let error):
                print("Failed to leave room [Error code: \(error.code)]: \(error.message)")
            }
        }
    }
}