Building a 1-to-1 Real-Time Communication iOS App with EnableX iOS Toolkit: A Comprehensive Guide

1-to-1 RTC: A Hands-On Guide to RTC Development Using EnableX iOS Toolkit This Sample iOS App demonstrates the power and efficiency of EnableX platform Video APIs and iOS Toolkit. It allows developers to ramp up on app development by hosting on their own devices.

Key Features Virtual Room Creation: Seamlessly set up virtual rooms on the EnableX platform using REST calls. Room Credentials: Take control of your RTC session by using Room IDs to connect as either a Moderator or Participant. Flexibility: The app provides a unique "try" mode to use EnableX's hosted Application Server, allowing for quick testing without setting up your own server.

EnableX Developer Center: https://developer.enablex.io/

1. How to get started

1.1 Prerequisites

1.1.1 App Id and App Key

• Register with EnableX [https://portal.enablex.io/cpaas/trial-sign-up/]
• Create your Application
• Get your App ID and App Key delivered to your email

1.1.2 Sample iOS Client

• Clone or download this Repository [https://github.com/EnableX/One-to-One-Video-Chat-Webrtc-Application-Sample-for-IOS.git]

1.1.3 Test Application Server

You need to set up an Application Server to provision Web Service API for your iOS Application to enable Video Session.

To help you to try our iOS Application quickly, without having to set up Applciation Server, this Application is shipped pre-configured to work in a "try" mode with EnableX hosted Application Server i.e. https://demo.enablex.io.

Our Application Server restricts a single Session Duations to 10 minutes, and allows 1 moderator and not more than 1 Participant in a Session.

Once you tried EnableX iOS Sample Application, you may need to set up your own Application Server and verify your Application to work with your Application Server. Refer to point 2 for more details on this.

1.1.4 Configure IOS Client

• Open the App
• Go to VCXConstant.swift, it's reads-

/* To try the App with Enablex Hosted Service you need to set the kTry = true
When you setup your own Application Service, set kTry = false */
let kTry = true

/* Your Web Service Host URL. Keet the defined host when kTry = true */
let kBasedURL = "https://demo.enablex.io/"
    
/* Your Application Credential required to try with EnableX Hosted Service
When you setup your own Application Service, remove these */
let kAppId    = ""
let kAppkey   = ""

1.2 Test

1.2.1 Open the App

• Open the App in your Device. You get a form to enter Credentials i.e. Name & Room Id.
• You need to create a Room by clicking the "Create Room" button.
• Once the Room Id is created, you can use it and share with others to connect to the Virtual Room to carry out an RTC Session either as a Moderator or a Participant (Choose applicable Role in the Form).

Note: Only one user with Moderator Role allowed to connect to a Virtual Room while trying with EnableX Hosted Service. Your Own Application Server can allow upto 5 Moderators.

Note:- In case of emulator/simulator your local stream will not create. It will create only on real device.

2. Set up Your Own Application Server

You can set up your own Application Server after you tried the Sample Application with EnableX hosted Server. We have differnt variants of Appliciation Server Sample Code. Pick the one in your preferred language and follow instructions given in respective README.md file.

• NodeJS: [https://github.com/EnableX/Video-Conferencing-Open-Source-Web-Application-Sample.git]
  
• PHP: [https://github.com/EnableX/Group-Video-Call-Conferencing-Sample-Application-in-PHP]

Note the following:

• You need to use App ID and App Key to run this Service.
• Your iOS Client EndPoint needs to connect to this Service to create Virtual Room and Create Token to join the session.
• Application Server is created using EnableX Server API while Rest API Service helps in provisioning, session access and post-session reporting.

To know more about Server API, go to: https://www.enablex.io/developer/video-api/server-api

3. IOS Toolkit

This Sample Application uses EnableX iOS Toolkit to communicate with EnableX Servers to initiate and manage Real-Time Communications. Please update your Application with latest version of EnableX IOS Toolkit as and when a new release is available.

• Documentation: https://www.enablex.io/developer/video-api/client-api/ios-toolkit/
• Download Toolkit: https://www.enablex.io/developer/video-api/client-api/ios-toolkit/

4. Trial

Sign up for a free trial https://portal.enablex.io/cpaas/trial-sign-up/ or try our multiparty video chat https://try.enablex.io/