Join Room

Create HMSSDK Instance

First, create an instance of HMSSDK class. Store this instance as a property. Ensure that the SDK object is alive in memory so that you can receive event callbacks from SDK. Simplest way to do this is as follows -

import HMSSDK

class MyMeetingClass {

    let hmsSDK: HMSSDK // store instance of HMSSDK as a property in your class

    init() {
        hmsSDK = HMSSDK.build() // initialize the SDK using the `build()` class function
    }
}

Optional: Join with Muted Audio / Video

You can optionally set the initial audio/video state at the time of joining like below (they are unmute by default):

class MyMeetingClass {

    let hmsSDK: HMSSDK // store instance of HMSSDK as a property in your class

    init() {
        // initialize the SDK using the `build()` class function
        hmsSDK = HMSSDK.build() { sdk in
            sdk.trackSettings = HMSTrackSettings.build { videoSettingsBuilder, audioSettingsBuilder in
                videoSettingsBuilder.initialMuteState = .mute
                audioSettingsBuilder.initialMuteState = .mute
            }
         }
     }
}

Create HMSConfig Instance

Next, create an object of HMSConfig class using the available joining configurations

let config = HMSConfig(userName: "John Doe",
                      authToken: "eyJH5c")

Optional: Set metadata for the user

Optionally, you can use metadata param that can be used to attach any additional data associated with this user. You can access this data on this peer later using peer's 'metadata' property.

let config = HMSConfig(userName: "John Doe",
                      authToken: "eyJH5c",
                      metadata: "{"avatar": "location/on/amazon/storage"}")

Call join

Now, we are primed to join the room. All you have to do is pass the config object to hmsSDK

hmsSDK.join(config: config, delegate: self)

Once on(join room: HMSRoom) callback is fired you have joined the room successfully. 🥳

class MyMeetingClass: HMSUpdateListener {
    func on(join room: HMSRoom) {
        ...
    }
}

Note: Make sure to wait for onJoin callback before calling any other SDK API (except leave) as they require an active connection and will fail with a “not connected” error.

Create HMSRoomModel Instance

First, create an instance of HMSRoomModel class. Store this instance as a property.

@ObservedObject var roomModel = HMSRoomModel(roomCode: "qdr-mik-seb")

import HMSRoomModels

struct MeetingView: View {
    
    @ObservedObject var roomModel = HMSRoomModel(roomCode: "qdr-mik-seb")
    
    var body: some View {
        ...
    }
}

Call joinSession

All you have to do is call joinSession. You can optionally pass username param.

try await roomModel.joinSession(userName: "iOS User")

import HMSRoomModels

struct MeetingView: View {
    
    @ObservedObject var roomModel = HMSRoomModel(roomCode: "qdr-mik-seb")
    
    var body: some View {
        
        switch roomModel.roomState {

        case .notJoined, .leftMeeting:
            // Button to join the room
            Button {
                Task {
                    try await roomModel.joinSession(userName: "iOS User")
                }
            } label: {
                Text("Join")
            }
        case .inMeeting:
            // Button to leave the room
            ...
        }
    }
}