Room Connection

The iOS SDK provides methods to initialise a room, connect to it, publish streams, and disconnect — including built-in automatic reconnection when network conditions change.

Initiate a Room

RTC sessions run in a virtual room hosted on EnableX. Start by initialising an EnxRoom object. This is a purely local step — no network activity occurs until you call connect().

• Method: -(instancetype)init

EnxRoom *room = [[EnxRoom alloc] init];

Connect to a Room

The connect() method establishes a bi-directional web socket with the EnableX server and joins the room using the provided JWT token.

• Method: - (void)connect:(NSString *)token roomInfo:(NSDictionary *)roomInfo advanceOptions:(NSArray *)advanceOption

Parameters

roomInfo Keys

advanceOptions Keys

Pass advanceOptions as an NSArray of NSDictionary objects, each with an "id" key and an "enable" boolean.

Delegate Methods

NSString *token = @"YOUR_JWT_TOKEN";

NSDictionary *roomInfo = @{
    @"allow_reconnect"   : @YES,
    @"number_of_attempts": @3,
    @"timeout_interval"  : @10000,
    @"activeviews"       : @"list"
};

NSDictionary *batteryOption    = @{ @"id": @"battery_updates",               @"enable": @YES };
NSDictionary *resolutionOption = @{ @"id": @"notify-video-resolution-change", @"enable": @YES };
NSArray *advanceOptions = @[batteryOption, resolutionOption];

EnxRoom *room = [[EnxRoom alloc] init];
[room connect:token roomInfo:roomInfo advanceOptions:advanceOptions];

- (void)room:(EnxRoom *)room didConnect:(NSDictionary *)roomMetadata {
    // Connected — roomMetadata contains room details
}

- (void)room:(EnxRoom *)room didError:(NSString *)reason {
    // Connection failed — inspect reason
}

- (void)room:(EnxRoom *)room userDidJoined:(NSArray *)data {
    // A new user joined
}

- (void)room:(EnxRoom *)room didActiveTalkerList:(NSArray *)data {
    // Active talker list received after connecting
}

Error codes: 5086 — unable to connect.

Join a Room with a Stream (Quick Connect)

EnxRtc.joinRoom() is a convenience method that handles room initialisation, stream creation, and publishing in one call — removing the need to wire up each step manually.

• Class: EnxRtc
• Method: -(EnxStream *)joinRoom:(NSString *)token delegate:(id)delegate PublishStreamInfo:(NSDictionary *)publishStreamInfo
• Returns: EnxStream — the published local stream object.

Parameters

NSDictionary *streamInfo = @{
    @"video"     : @YES,
    @"audio"     : @YES,
    @"data"      : @YES,
    @"attributes": @{ @"name": @"User Name" }
};

EnxRtc *enxRtc = [[EnxRtc alloc] init];
EnxStream *localStream = [enxRtc joinRoom:@"YOUR_TOKEN"
                                 delegate:self
                        PublishStreamInfo:streamInfo];

- (void)room:(EnxRoom *)room didConnect:(NSDictionary *)roomMetadata {
    // Connected
}

- (void)room:(EnxRoom *)room didError:(NSString *)reason {
    // Connection failed
}

Disconnect from a Room

Call disconnect to close the session and release all media and signaling sockets. Other participants in the room receive a notification that you have left.

• Method: - (void)disconnect

Delegate Methods

[room disconnect];

- (void)room:(EnxRoom *)room didRoomDisconnect:(NSArray *)response {
    // You are disconnected
}

- (void)room:(EnxRoom *)room userDidDisconnected:(NSArray *)data {
    // A user disconnected — data contains their information
}

Error codes: 5031 — repeated disconnect in progress; 5032 — already disconnected.

Client endpoints connect over a secured web socket. If the network fails, EnableX can automatically attempt to reconnect.

Network Failure Events

Delegate Methods

- (void)room:(EnxRoom *)room didConnectionLost:(NSArray *)data {
    // Connection lost — update UI
}

- (void)room:(EnxRoom *)room didConnectionInterrupted:(NSArray *)data {
    // Connection interrupted — update UI
}

Reconnection Events

Enable auto-reconnection by passing allow_reconnect: YES in the roomInfo to connect().

Delegate Methods

- (void)room:(EnxRoom *)room didUserReconnectSuccess:(NSDictionary *)data {
    // Successfully reconnected
}

- (void)room:(EnxRoom *)room didReconnect:(NSString *)reason {
    // Reconnection attempt underway
}

Error codes: 5073 — switched to current network; 5074 — reconnection timed out; 5086 — method called on disconnected room; 5087 — reconnection failed.

Bandwidth Alert

EnableX includes Automatic Bandwidth Detection (ABWD) that monitors the client's available bandwidth. When bandwidth drops too low to support all received video streams, or recovers to support more, all affected endpoints are notified.

Delegate: -room:didRoomBandwidthAlert:

The notification is not triggered for every bandwidth fluctuation — only when the change affects the number of videos that can be received.

Payload Fields

- (void)room:(EnxRoom *)room didRoomBandwidthAlert:(NSArray *)data {
    // Respond by reducing active talkers or switching to audio-only mode
    // data: [{ "bandwidth": 240, "stream_bandwidth": 80, "number_of_videos": 2 }]
}