Session Extension & Closure: iOS SDK – Video API

Table of Contents

• Extend Session
• Destroy Session

Extend Session

Each Room is defined with duration value in minutes. This duration defines total length of single session and it’s counted from the time first user joins the session. EnableX drops the session when the session duration elapses.

For practical reasons, a session may need to get extended. Therefore, EnableX allows users to extend a session duration at run-time. Follow explanation given below:

1. An “Extension Window” opens 10 minutes prior to the end of scheduled closure of the Session. All connected users are notified with an Event.
2. Any user can trigger extension of the Session by calling a Method. If any user trigger extension, the Extension Window is closed. This prevents EnableX to process further Extension Request within the same Extension Window.
3. If extension is not triggered by any user, another “Extension Window” opens 5 minutes prior to the end of scheduled closure of the Session. This is the final Extension Window. All connected users are notified with an Event.
4. EnableX processes extension request and extends the session by 10 to 30 minutes. So, the extended period may vary.
5. There is no cap on number of times you may extend your Session. Once extended, Step 1-4 will get repeated.

Method: -(void)extendConferenceDuration – No parameter required

Delegate Methods:

• -room:didConferenceRemainingDuration – This delegate method is called when an Extension Window is open. It bring a JSON to show how many minutes is left to scheduled session closure.
• -room:didConferencessExtended – This delegate method is called when Session is extended.

//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 Session

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

Method: -(void)destroy; – No Parameter required.

Delegate Methods:

• -room:didAckDestroy: – Acknowledgment to the Moderator when the session is destroyed.
• -room:didRoomDisconnected: – Notification to all users in the Room when the session is destroyed.

[room destroy];

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

Error Codes / Exceptions

Code	Description
5116	Unauthorized Access. When a user with participant role invokes destroy().

---