Session Management

The iOS SDK provides the following methods for managing video sessions:

• startRecord(): To start recording a session.
• stopRecord(): To stop recording a session.
• startLiveRecording(): To start live recording a session.
• stopLiveRecording(): To stop live recording s session.
• muteAllUser(): To hard-mute a room where all the participants are muted.
• unMuteAllUser(): To put the room off a hard-mute state.
• hardMuteAudio(): To hard-mute a participant's audio.
• hardMuteVideo(): To hard-mute a participant's video.
• hardMuteUserAudio(): To hard-mute a participant's audio.
• hardMuteUserVideo(): To hard-mute a participant's video.
• hardUnMuteAudio(): To hard-unmute a participant's audio.
• hardUnMuteVideo(): To hard-unmute a participant's audio.
• hardUnMuteUserAudio(): To hard-unmute a participant's audio.
• hardUnMuteUserVideo(): To hard-unmute a participant's video.
• lockRoom(): To lock a room.
• unlockRoom(): To unlock a room.
• approveAwaitedUser(): To approve a user's entry.
• denyAwaitedUser(): To decline a user's entry.
• dropUser(): To disconnect/force-drop one or more participants from a session.
• extendConferenceDuration(): To define the duration of a session.
• destroy(): To conclude an ongoing session.
• switchUserRole(): To promote a participant to act as a moderator in an ongoing session.
• startStreaming(): To forward live video sessions over an RTMP stream.
• stopStreaming(): To stop forwarding an RTMP stream.
• pinUsers(): To pin a user to the Active Talker list.
• unpinUsers(): To unpin a user.
• addSpotlightUsers(): To spotlight a user.
• removeSpotlightUsers(): To remove the spotlight from user's streams.
• switchRoomMode(): To switch the room mode.

Record a Session

You can record an RTC session as an individual stream and get it transcoded through a post-session service to create a single composite video file that can be retrieved and replayed using a video player. You can configure a room for automatic recording or invoke APIs to start recording when required. For more information, see How to Fetch Recordings?.

Ways to Record a Session

A session can be recorded in the following ways:

Auto-Recording a Session

You can configure a room with { settings: { auto_recording: true }} during Room Creation to automatically start recording the RTC session taking place in the room. The moderator of the room can stop the recording using the stopRecord() method.

Start Recording a Session

The EnxRoom.startRecord() method allows the moderator to start recording the session. You might need to provide this option on UI for the moderator to access it. There is no limit to the number of times a moderator can start recording.

Class: EnxRoom

Method: - (void)startRecord

Delegate Methods

Sample Code**

[room startRecord]; // To start recording

// To all participants that recording has started
-(void)roomRecordOn:(NSArray*)Data{
	/* Data is 
	[	{
			"msg":"Room Recording On",
			"result":"0"
		},
		"<null>"
	]
	*/
}

// To acknowledge the moderator that recording has started
-(void)startRecordingEvent:(NSArray *)response{
	/* response is 
	[	{
			"result":0,
			"msg":"Success"
		},
		"<null>"
	]
	*/
}

Error Codes and Exceptions

Note: In case of an error, <null> is received at the first index, and error info at the second index.

Stop Recording a Session

The EnxRoom.stopRecord() method is used to stop recording. You might need to provide this option on UI for the moderator to access it. There is no limit to the number of times a moderator can start recording.

Class: EnxRoom

Method: - (void)stopRecord

Delegate Methods

Sample Code

[room stopRecord]; // To stop recording

// To all participants that recording has stopped
 -(void)roomRecordOff:(NSArray*)Data{
	/*Data is 
	[	{
			"msg":"Room Recording Off",
			"result":"0"
		},
		"<null>"
	]
	*/
}

// To acknowledge the moderator that recording has stopped
-(void)stopRecordingEvent:(NSArray *)response{
	/* response is 
	[	{
			"result":0,
			"msg":"Success"
		},
		"<null>"
	]
	*/
}

Error Codes and Exceptions

Note: In case of an error, <null> is received at the first index, and error info at the second index.

Live Recording with UI

Recording live refers to a new process of creating a transcoded file in a live session with a custom layout without recording individual streams. It provides the following advantages:

• You get a transcoded file within minutes post-session without waiting for long like the previous transcoding process.
• Unlike the previous transcoding processes created in a predefined layout, you can define your own layout for the live recording process.

This functionality is available in iOS SDK 2.1.2 and later versions.

Auto Live Recording

You can configure a room to automatically start live recording when the first person joins the room. To do this, add the following settings while creating a room:

"settings": { 
	"live_recording": {
		"auto_recording: true, 
		"url": "https://your-custom-view-url"
	}
}

For more information, go through the Room Creation Payload using our Server API and check How to Create Custom View for Live Recording. It is the same way as a view is created for live streaming.

A moderator can stop live recording in a room by using the stopRecord() method.

On-Demand Live Recording

Start Live Recording

The EnxRoom.startLiveRecording() method allows the moderator to start live recording a session.

Class: EnxRoom

Method: -(void)startLiveRecording:(NSDictionary *_Nonnull)streamingConfig;

Parameter: streamingConfig: JSONObject. Streaming configuration.

Callbacks

Sample Code

[enxRoom startLiveRecording: streamingConfig]; 


-(void)room:(EnxRoom* _Nullable)room didACKStartLiveRecording:(NSArray *_Nullable)data {
 // To the Moderator - Live Recording has started
}

-(void)room:(EnxRoom* _Nullable)room didRoomLiveRecordingOn:(NSArray *_Nullable)data {
 // To all the participants - Live Recording started
}

-(void)room:(EnxRoom* _Nullable)room didRoomliverecordingFailed:(NSArray*_Nullable)data {
 // To the executor of Method - Live Recording failed to start
}

-(void)room:(EnxRoom* _Nullable)room didRoomliverecordingUpdated:(NSArray*_Nullable)data {
 // To the executor of Method - Intermediate updates on the start recording progress
}

Error Codes and Exceptions

Stop Live Recording

The EnxRoom.stoptLiveRecording() method allows the moderator to start live recording the session.

Class: EnxRoom

Method:

• -(void)stopLiveRecording:(NSDictionary *_Nonnull)streamingConfig; This method is available in iOS SDK 2.1.2 and later versions.
• -(void)stopLiveRecording: This method is available in iOS SDK 2.1.3 and later versions.

Parameter: streamingConfig: Optional. Streaming configuration.

Callbacks

Sample Code

[enxRoom stopLiveRecording:streamingConfig];         // For v2.1.2
[enxRoom stopLiveRecording];                         // For v2.1.3+


-(void)room:(EnxRoom* _Nullable)room didACKStopLiveRecording:(NSArray *_Nullable)data {
 // To the Moderator - Live Recording has stopped
}

-(void)room:(EnxRoom* _Nullable)room didRoomliverecordingOff:(NSArray*_Nullable)data {
 // To all the participants - Live Recording stopped
}

Error Codes and Exceptions

Error Codes

Live Recording Waiting Queue

Play the Recording Files

The recored files on the EnableX server are password protected. EnableX has implemented HTTP Basic authentication to secure the storage of recorded files. Therefore, a video player must provide access credentials to pass through the authentication process to play the file from the EnableX server.

Sample Code

let headerString = "USERNAME:PASSWORD" 
let videoFileURL = "URL"

let data = headerString.data(using: .utf8)
let basicAuth = "Basic" + date!.base64EncodedString(
	options: NSData.Base64EncodingOptions(rawValue: 0))
let headers = {"Authorization" : basicAuth }

let asset = AVURLAsset(
	url: videoFileURL, 
	options: {
		"AVURLAssetHTTPHeaderFieldsKey" : headers
	}
)

let playerItem = AVPlayerItem(asset: asset)
player = AVPlayer(playerItem: item)

Notes:: As an alternate way, download the files from the EnableX server to your server and play the files with or without any security measures you may like to deploy. Files are deleted after 72 hours of creation from from the EnableX storage. So, playing the files directly from the EnableX server beyond 72 hours is not nguaranteed.

Hard Muting

Hard Mute a Room

The EnxRoom.muteAllUser() method allows moderators to hard-mute a room where all the participants are muted. A new participant joining a room in a hard-mute state is muted by default. The right to unmute a hard-mute room lies only with the moderator, and participants cannot unmute their local streams either.

Class: EnxRoom

Method: - (void)muteAllUser;

Delegate Methods

Sample Code

[room muteAllUser]; // To hard-mute room

- (void) didMutedAllUser:(NSArray *Data){
 // You hard-muted room
}

- (void)didHardMutedAll:(NSArray *Data){
 // Room is hard-muted - to all
}

Error Codes and Exceptions

Hard Unmute a Room

The EnxRoom.unMuteAllUser() method is used to put the room off the hard-mute state.

Class: EnxRoom

Method: - (void)unMuteAllUser;

Delegate Methods

Sample Code

[room unMuteAllUser]; // To hard-unmute room

- (void) didUnMutedAllUser:(NSArray *Data){
 // You hard-unuted room
}

- (void)didHardUnMuteAllUser:(NSArray *Data){
 // Room is hard-unmuted - to all
}

Error Codes and Exceptions

Hard Mute a Participant

The EnxStream.hardMuteAudio() and EnxStream.hardMuteVideo() methods allow moderators to hard-mute a participant's audio and video streams, respectively. The affected participants cannot unmute their audio or video streams.

Note: For iOS SDK 2.1.3 and later versions, click here for detailed information.

Class: EnxStream

Methods:

• - (void)hardMuteAudio:(NSString *)clientId
• - (void)hardMuteVideo:(NSString *)clientId

Parameter: clientId: The participant whose audio/video needs to be hard-muted.

Delegate Methods

Sample Code

[stream hardMuteAudio:@"clientId"];	// To hard-mute participant's audio

-(void)didReceiveHardMutedAudio:(NSArray *)Data{
	// Your audio is hard-muted
}
-(void)didHardMuteAudio:(NSArray *)Data{
	// You hard-muted the user's audio
}

// Video Hard-Mute will be used in the same way as audio.

Error Codes and Exceptions

Hard Mute a Participant (v2.1.3)

The EnxRoom.hardMuteUserAudio() and EnxRoom.hardMuteUserVideo() methods allows moderators to hard-mute a participant's audio and video streams, respectively. The affected participants cannot unmute their audio or video streams.

Class: EnxRoom

Method:

• -(void)hardMuteUserAudio:(NSString*_Nonnull)clientId
• -(void)hardMuteUserVideo(NSString*_Nonnull)clientId

These methods are available in iOS SDK 2.1.3 and later versions.

Parameter: clientId: The participant whose audio/video needs to be hard-muted.

Delegate Methods

Sample Code

[enxRoom hardMuteUserAudio:"clientID"]; 	// To hard-mute user's audio

-(void)didReceiveHardMutedAudio:(NSArray *)Data{
	// Your audio is hard-muted
}

-(void)didHardMuteAudio:(NSArray *)Data{
	// You hard-muted the user's audio
}

// Video Hard-Mute/Hard-Unmute will be used in the same way as audio.

Hard Unmute a Participant

A moderator can unmute a participant's audio or video streams using EnxStream.hardUnMuteAudio() and EnxStream.hardUnMuteVideo() methods respectively.

Note: For iOS SDK 2.1.3 and later, click here for detailed information.

Class: EnxStream

Method:

• - (void)hardMuteVideo:(NSString *)clientId
• - (void)hardUnMuteVideo:(NSString *)clientId

Parameters: clientId: The participant whose audio/video needs to be hard-unmuted.

Delegate Methods

Sample Code

[stream hardUnMuteAudio:@"clientId"];	// To hard-unmute participant's audio

[stream hardUnMuteAudio:@"clientId"];	//To hard un-mute uparticipantser's audio
-(void)didReceivedHardUnmutedAudio:(NSArray *)Data{
	// Your audio is hard-unmuted
}

-(void)didHardUnMuteAudio:(NSArray *)Data{
	// You hard-unmuted user's audio
}

// Video Hard-Unmute will be used in the same way as audio.

Error Codes and Exceptions

Hard Unmute a Participant (v2.1.3)

A moderator can unmute the participant's audio or video streams using EnxRoom.hardUnMuteUserAudio() and EnxRoom.hardUnMuteUserVideo() methods respectively.

Class: EnxRoom

Method:

• -(void)hardUnmuteUserAudio:(NSString*_Nonnull)clientId
• -(void)hardUnmuteUserVideo:(NSString*_Nonnull)clientId

These methods are available in iOS SDK 2.1.3 and later versions.

Parameter: clientId: The participant whose audio/video needs to be hard-unmuted.

Delegate Methods

Sample Code

[enxRoom hardUnmuteUserAudio:"clientID"];	//To hard un-mute user's audio

-(void)didReceivedHardUnmutedAudio:(NSArray *)Data{
	// Your audio is hard-unmuted
}
-(void)didHardUnMuteUserAudio:(NSArray *)Data{
	// You hard-unmuted user's audio
}

// Video Hard-Mute/Hard-Unmute will be used in the same way as audio.

Room Entry Restriction

Lock a room

The EnxRoom.lockRoom() method allows the moderator to lock the room, which forbids new users from joining a session.

Class: EnxRoom

Method: - (void)lockRoom;

Delegate Methods

Sample Code

[room lockRoom];

// Moderator is acknowledged that room has been locked 
- (void)room:(EnxRoom *_Nullable)room didAckLockRoom:(NSArray *_Nullable)data;

// Participants are notified that room has been locked
- (void)room:(EnxRoom *_Nullable)room didLockRoom:(NSArray *_Nullable)data;

Error Codes and Exceptions

Unlock a Room

Moderator can unlock a room by using EnxRoom.unlockRoom() method to allow subsequent users to join the session.

Class: EnxRoom

Method: - (void)unlockRoom;

Delegate Methods

Sample Code

[room unlockRoom];

// Moderator is acknowledged that room has been unlocked 
- (void)room:(EnxRoom *_Nullable)room didAckUnlockRoom:(NSArray *_Nullable)data;

// Participants are notified that room has been unlocked
- (void)room:(EnxRoom *_Nullable)room didUnlockRoom:(NSArray *_Nullable)data;

Moderate Participant's Entry to a session

In a Knock-enabled Room, users need to wait until the moderator of the room grants them permission to join the session.

Approve a User's Entry

The EnxRoom.approveAwaitedUser() method allows moderators to approve a user's entry to a knock-enabled room.

Method: -approveAwaitedUser:clientID

Parameter: clientID: Client ID of the user awaiting moderator's approval.

Delegate Methods

Sample Code

// Moderator is notified about awaited user
-(void)room:(EnxRoom *_Nullable)room diduserAwaited:(NSArray *_Nullable)data  {
	// Awaited Client Info in the data, e.g.
	// [{"id","String", "name": "String"}] 
	
	[room approveAwaitedUser:id];  // To allow
	 
};

-(void)room:(EnxRoom *_Nullable)room didAckForApproveAwaitedUser:(NSArray *_Nullable)data; 
{	// User has been allowed entry	
}

Decline a User's Entry

The EnxRoom.denyAwaitedUser() method is used to decline a user's entry to a session.

Class: EnxRoom

Method: -denyAwaitedUser: clientID

Parameter: clientId: Client ID of the user awaiting moderator's approval.

Delegate Methods

Sample Code

// Moderator is notified about awaited user
-(void)room:(EnxRoom *_Nullable)room diduserAwaited:(NSArray *_Nullable)data  {
	// Awaited Client Info in the data, e.g.
	// [{"id","String", "name": "String"}] 

	[room denyAwaitedUser:id]; // To deny
	 
};

-(void)room:(EnxRoom *_Nullable)room didAckForDenyAwaitedUser:(NSArray *_Nullable)data {
	// User has been denied entry	
}

Manage Awaited Users When the moderator Joins Late

If a moderator joins a session after the participants have sent a request to join the session in a knock-enabled room, then the moderator can get a list of participants awaiting moderator's approval using the room.awaitedParticipants method. You can utilize this attribute to build the UI for moderator controls to handle pending approvals.

Sample Code

// e.g. room.awaitedParticipants

[
	{	"clientId": "String", 
		"name": "String" 
	}
]

Disconnect a User

The EnxRoom.dropUser() method allows moderators to disconnect/force-drop one or more participants from a session.

Method: -(void)dropUser:(NSArray *_Nonnull)clientIds;

Parameter: clientIds: Required. Array of Client IDs to be disconnected.

Delegate Methods

Error Codes and Exceptions

Session Extension and Closure

Extend a Session

The duration of a room is limited. It is specified in minutes and defined during the room creation. This time is counted as soon as the first user joins the session. The session is dropped when the session duration elapses.

For practical reasons, a session may need to get extended. The EnxRoom.extendConferenceDuration() allows you to extend the duration of a session beyond the configured value. The extension process is explained below. 1.An Extension window opens 10 minutes before the specified closure time of a session. All the connected users are notified of this event. 2. Users can trigger an extension of the session by calling extendConferenceDuration(). Once triggered, the Extension Window is closed, thus preventing subsequent extension requests. 3. If the extension is not triggered, the final Extension window opens 5 minutes before the scheduled closure of the session. All the connected users are notified of this event. 4. The session can be extended by 10 to 30 minutes. The extended period can vary as there is no restriction on the number of times a session is extended. 5. When a session is extended, the previous steps are repeated.

Method: -(void)extendConferenceDuration

Delegate Methods

Sample Code

//Extend Request
[enxRoon extendConferenceDuration]; 

// Notifies that session is scheduled to close in N Minutes
- (void)room:(EnxRoom *_Nullable)room didConferenceRemainingDuration:(NSArray *_Nullable)data;

// Notifies that session is extended
- (void)room:(EnxRoom *_Nullable)room didConferencessExtended:(NSArray *_Nullable)data;

Destroy a Session

The EnxRoom.destroy() method allows moderators to conclude an ongoing session.

Method: -(void)destroy;

Delegate Methods

Sample Code

[room destroy];

// Acknowledgement to moderator that the session is destroyed
 (void)room:(EnxRoom *_Nullable)room didAckDestroy:(NSArray *_Nullable)data;

Error Codes and Exceptions

Switch Participant Roles

The EnxRoom.switchUserRole() method allows moderators to promote a participant to act as a moderator in the ongoing session. This newly appointed moderator gets access to moderator controls, and the former moderator becomes a participant in the session. If desired, the new moderator can grant the moderator role to another participant.

Class: EnxRoom

Method: - (void)switchUserRole:(NSString *)clientId;

Parameter: clientId: String. Client ID of the participant who is designated as the moderator.

Delegate Methods

Sample Code

// Switching user with ClientId to Moderator Role
[_remoteRoom switchUserRole:@"clientId"];	

- (void)room:(EnxRoom *)room didSwitchUserRole:(NSArray *)data {
	// Moderator is acknowledged 
}

- (void)room:(EnxRoom *)room didUserRoleChanged:(NSArray *)data {
	// New Moderator is notified that 
	// his role is promoted to Moderator
}

Error Codes and Exceptions

RTMP Live Streaming

Forward live Video Sessions

The EnxRoom.startStreaming() method allows moderators to forward live video sessions over an RTMP stream to any live streaming CDNs supporting this protocol.

Class: EnxRoom

Method: -(void)startStreaming:(NSDictionary *_Nonnull)streamingConfig;

Delegate Methods

Sample Code

//Start Live Streaming
NSDictionary *StreamInfo = @{@"rtmpDetails":
	:@{@"rtmpUrl":@"rtmp://a.rtmp.youtube.com/live2/4rjb-hprf-7wf5-9923"},
	:@"urlDetails":@{@"url":@"https://meeting-qa.enablex.io/room/?token="}
}

[EnxRoom startStreaming: StreamInfo];


//All are notified that Streaming has started
- (void)room:(EnxRoom *_Nullable)room didStreamingStarted:(NSArray *_Nullable)data; 


//All are notified that Streaming has failed
- (void)room:(EnxRoom *_Nullable)room didStreamingFailed:(NSArray *_Nullable)data; 

//All are notified that Streaming process updates
- (void)room:(EnxRoom *_Nullable)room didStreamingUpdated:(NSArray *_Nullable)data;

Error Codes and Exceptions

Stop forwarding RTMP Stream

The EnxRoom.stopStreaming() method is used to stop forwarding an RTMP stream.

Class: EnxRoom

Method: -(void)stopStreaming:(NSDictionary *_Nonnull)streamingConfig;

Delegate Methods

Sample Code

// Stop Live Streaming
[EnxRoom stopStreaming: StreamInfo];
 
//All are notified that Streaming has stopped
- (void)room:(EnxRoom *_Nullable)room didStreamingStopped:(NSArray *_Nullable)data; 

//All are notified that Streaming process updates
- (void)room:(EnxRoom *_Nullable)room didStreamingUpdated:(NSArray *_Nullable)data;

Error Codes and Exceptions

HLS Streaming

HLS streaming helps you to reach a large number of audiences with your video session in real-time. It supports adaptive bitrate streaming to get the best quality video based on available network bandwidth at the receiving end.

HLS streaming helps scale up your reach to a larger audience with your real-time video session, meetings, and webinar. Audiences receive the best quality video streaming based on the available bandwidth at their end. A web-based video UI may be linked to define the view of your streaming which will be played across devices. In the background, the linked video UI automatically joins the video room and creates an HLS stream using the same view. As the stream is ready, endpoints receive an HLS stream URL from playing in the HLS Player.

HLS Service Subscription

HLS streaming Infrastructure is owned and managed by EnableX. Therefore, it is a subscription-based service. For subscription details, connect to the Sales/Account Manager.

If you look to live stream on YouTube, Vimeo, LinkedIn, and/or Facebook, you need to implement RTMP Live Streaming.

HLS View

HLS streaming experience for audiences can be achieved through the video UI. You can include a video UI or HLS View in either of the following ways:

• Use Default View: The simplest and quickest way is to use the default view for HLS streaming. You need not code for it. It is available with EnableX. However, it provides limited customization options.
• Develop Custom View: For a custom view, a web-based application must be developed, hosted over a publicly accessible "https" URL, and linked to the video room. For detailed information, click develop a custom view for your stream.

HLS Enabled Room

Even if the HLS service is subscribed, you must configure the following room-level "settings" to include HLS streaming in a video session.

For more information,

• How to define custom streaming View?
• How to create video room?.

Sample Code: Room Definition JSON Payload to enable HLS streaming.

{
  "name": "HLS Trial",
  "owner_ref": "XOXO",
  "settings": {
    "description": "HLS Trial",
    "mode": "group",
    "scheduled": false,
    "adhoc": false,
    "duration": 30,
    "moderators": "1",
    "participants": "2",
    "audiences": 6,
    "hls_view_url": "https://URL-DOMAIN/PATH/?token=",
    "send_audiences_stats": true,
    "auto_recording": false,
    "quality": "SD"
  }
}

Note: Room definition with HLS settings is not permitted if HLS is not subscribed.

Audience Token to Join

A new role named audience, has been introduced for HLS audience to join a room. This role requires a token to join a session. When the first audience joins a video room, HLS streaming is automatically initiated. It is stopped when all audiences exit or disconnect from the video room. For more information to create a token, see How to create a Token?.

Sample Code: Create Token JSON Payload for audience role.

{
  "name": "John",
  "user_ref": "XOXO",
  "role": "audience"
}

Room Notifications

HLS streaming starts as soon as the first audience joins a video room and stops when the last audience exits/disconnects from the room. So, use the related delegate methods to handle UI and create the user experience.

Observer: public void setEnxHlsObserver(EnxHlsStreamObserver enxHlsObserver): Add this observer to start receiving HLS notifications.

Callbacks

Sample Code

// On HLS Start
- (void)room:(EnxRoom* _Nullable)room didHlsStarted:(NSArray *_Nonnull)data;
// data has hls_url key to play in HLS Player
 
// On HLS Stop
- (void)room:(EnxRoom* _Nullable)room didHlsStopped:(NSArray *_Nonnull)data;
 
// On HLS Waiting
- (void)room:(EnxRoom* _Nullable)room didHlsWaiting:(NSArray *_Nonnull)data; 

// On HLS Failure
- (void)room:(EnxRoom* _Nullable)room didHlsFailed:(NSArray *_Nonnull)data;

Error Codes

On HLS Start

On HLS Stop

On HLS Waiting

HLS Generic Error

HLS Player

The HLS stream URL received through the Video SDK needs to be played using an HLS player. Apple provides AVPlayerViewController to play HLS streams. The following code snippet provides details about using it:

AVPlayerItem *avPlayerItem =[[AVPlayerItem alloc]initWithAsset:avAsset];
AVPlayer *player = [AVPlayer playerWithPlayerItem:avPlayerItem];
AVPlayerViewController *vc = [[AVPlayerViewController alloc]init];
vc.player = player;
[self presentViewController:vc animated:true completion:^{
        [player play];
}];

Pin a User

The EnxRoom.pinUsers() method allows moderators to pin a user to the Active Talker list irrespective of the user's activity level. A pinned user's stream is always published in the room, even if the user is not talking. The inactive pinned users are placed in the Active Talker list after the actively talking users in a descending order based on their activity level, with the most active talker on top of the list. Based on the Room configuration, the total number of pinned users in a room is restricted to (max_active_talkers – 1).

On joining a room, a user is notified with Room Meta Information through the -room:didConnect: event. This event provides the list of pinned users as "pinnedUsers": [ /*client-ids*/ ].

Method: -(void)pinUsers:(NSArray *_Nonnull)clientIds

Parameter: clientIds: Array. Array of Client IDs of users whose streams need to be pinned.

Delegate Methods

Sample Code

[enxRoom pinUsers:[clientID1, clientID2]];	// Pin Users

-(void)room:(EnxRoom *_Nullable)channel didAckPinUsers:(NSArray *_Nullable)data{
	// Acknowledges that Users are pinned
}

-(void)room:(EnxRoom *_Nullable)channel didPinnedUsers:(NSArray *_Nullable)data{
	// Notifies with updated pinned user list
}

Error Codes and Exceptions

Unpin a User

The EnxRoom.unpinUsers() method is used to unpin users.

Method: -(void)unpinUsers:(NSArray *_Nonnull)clientIds

Parameter: clientIds: Array. Array of Client IDs of users whose streams need to be unpinned.

Delegate Methods

Sample Code

[enxRoom unpinUsers:[clientID1, clientID2]];// Unpin Users

-(void)room:(EnxRoom *_Nullable)channel didAckUnpinUsers:(NSArray *_Nullable)data{
	// Acknowledges that Users are unpinned
}

-(void)room:(EnxRoom *_Nullable)channel didPinnedUsers:(NSArray *_Nullable)data{
	// Notifies with updated pinned user list
}

Error Codes and Exceptions

Spotlight a User

The EnxRoom.addSpotlightUsers() method allows the moderator to spotlight a user, pushing the user's stream to the top of the Active Talker list irrespective of the user's activity level. Spotlighting publishes the chosen user's stream in the room even if the user is not talking. The moderator can spotlight as many users as max_active_talkers defined in the Room Configuration.

On joining a room, a user is notified with Room Meta Information through the onRoomConnected event. This event provides the list of spotlightUsers.

Subsequent active talkers list (JSON) received with the didActiveTalkersUpdated callback includes a "spotlight" key with a boolean value. This key is set to true for spotlighted users.

Class: EnxRoom

Method: -(void)addSpotlightUsers:(NSArray *_Nonnull)clientIds

Parameter: clientIds: Array. Array of Client IDs of users whose streams are spotlighted.

Delegate Methods

Sample Code

[enxRoom addSpotlightUsers:[clientID1, clientID2]];	// To add Spotlight

-(void)room:(EnxRoom *_Nullable)channel didAckAddSpotlightUsers:(NSArray *_Nullable)data {
	// Moderator who adds users to Spotlight is acknowledged
	// data { "result": 0,  clients: [] }
}

- (void)room:(EnxRoom *_Nullable)channel didUpdatedSpotlightUsers:(NSArray *_Nullable)data {
	// Everyone is notified wtih updated Spotlight list
	// data { "moderator_id": "String",  clients: [] }
}

Remove the Spotlight from a User

The EnxRoom.removeSpotlightUsers() method removes the spotlight from user streams.

Class: EnxRoom

Method: -(void)removeSpotlightUsers:(NSArray *_Nonnull)clientIds

Parameter: clientIds: Array of Client IDs of users whose streams are removed from the spotlight.

Delegate Method

Sample Code

[enxRoom removeSpotlightUsers:[clientID1, clientID2]];	// To remove from Spotlight

-(void)room:(EnxRoom *_Nullable)channel didAckRemoveSpotlightUsers:(NSArray *_Nullable)data {
	// Moderator who removes users from Spotlight is acknowledged 
	// data { "result": 0,  clients: [] }
};

- (void)room:(EnxRoom *_Nullable)channel didUpdatedSpotlightUsers:(NSArray *_Nullable)data {
	// Everyone is notified wtih updated Spotlight list
	// data { "moderator_id": "String",  clients: [] }
};

Room Mode Switch

A room defined with either group or lecture mode may be switched to the other mode at runtime during an ongoing session. The EnxRoom.switchRoomMode() method is executed by the moderator to switch to another mode instantly.

When a room is switched from group or lecture mode:

• The audio/video streams of all the participants are dropped from the room with a notification to each participant.
• All the features of Lecture mode, such as Floor Access Control are activated.
• All active breakout rooms are terminated.

On the other hand, when a room is switched from group or lecture mode:

• A notification is sent to each participant, allowing the participants to publish their audio/video streams into the room.
• Due to privacy concerns, SDK does not automatically start publishing audio/video streams in such cases, but application developers must decide whether to publish them automatically or to prompt the participants to publish them.

Class: EnxRoom

Method: -(void)switchRoomMode:(NSString *_Nonnull)roomMode

Parameter: roomMode: String. Enumerated values lecture, group. Use the mode that you want to switch to.

Delegate Methods

Sample Code

[enxRoom switchRoomMode:@" lecture"]; 	// To switch to group mode

// Moderator is acknowledged
- (void)room:(enxRoom *_Nullable)room didAckSwitchedRoom:(NSArray *_Nullable)data { 

	/* data example: 
	{
	  "result": 1715,
	  "moderator": "String",
	  "msg": "Room switched to lecture mode",
	  "mode": "lecture"
	}
	*/
}

// Everyone is notified
-(void)room:(enxRoom *_Nullable)room didRoomModeSwitched:(NSArray *_Nullable)data { 
	/* data example: 
	{
	  "result": 1715,
	  "moderator": "String",
	  "msg": "Room switched to lecture mode",
	  "mode": "lecture"
	}
	*/
}

Error Codes and Exceptions