The sample iOS App demonstrates the use of EnableX platform Video APIs and iOS Toolkit to build 1-to-1 RTC (Real-Time Communication) Application. It allows developers to ramp up on app development by hosting on their own devices.
Key Features
Virtual Room Creation: Get up and running with REST calls that generate virtual rooms hosted on the EnableX platform. Room Credentials: Utilize room IDs to connect to your virtual space as either a Moderator or Participant using a mobile client. The same Room credentials can be shared with others to join the same virtual Room to carry out an RTC (Real-Time Communication) session.
Interactive Canvas: Experiment with real-time canvas functionalities to enhance your application's user experience.
EnableX Developer Center: https://developer.enablex.io/
- 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
- Clone or download this Repository [https://github.com/EnableX/One-to-One-Video-Chat-With-Canvas-Webrtc-Application-Sample-for-iOS.git]
You need to setup 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 Application 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 setup your own Application Server and verify your Application to work with your Application Server. Refer to point 2 for more details on this.
- Open the App
- Go to VCXConstant.swift and change the following:
/* 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 = ""
Note: The distributable comes with demo username and password for the Service.
- 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.
You may need to setup 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
This Sample Application uses EnableX iOS Toolkit to communicate with EnableX Server 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/
We create a Token for a Room Id to get connected to EnableX Platform to connect to the Virtual Room to carry out an RTC Session.
To create Token, we make use of Server API. Refer following documentation: https://www.enablex.io/developer/video-api/server-api/rooms-route/#create-token
We use the Token to get connected to the Virtual Room. Once connected, we intiate local stream and publish into the room. Refer following documentation for this process: https://www.enablex.io/developer/video-api/client-api/ios-toolkit/room-connection/#connect-room
We play the Stream into EnxPlayerView Object.
let streamView = EnxPlayerView(frame: CGRect)
self.view.addSubview(streamView)
localStream.attachRenderer(streamView)
More on Player: https://www.enablex.io/developer/video-api/client-api/ios-toolkit/play-stream/
EnableX Platform will emit back many events related to the ongoing RTC Session as and when they occur implicitly or explicitly as a result of user interaction. We use delegates to handle all such events.
/* Example of Delegates */
/* Delegate: didConnect
Handles successful connection to the Virtual Room */
func room(_ room: EnxRoom?, didConnect roomMetadata: [AnyHashable : Any]?) {
/* You may initiate and publish your stream here */
}
/* Delegate: didError
Error handler when room connection fails */
func room(_ room: EnxRoom?, didError reason: String?) {
}
/* Delegate: didAddedStream
To handle any new stream added to the Virtual Room */
func room(_ room: EnxRoom?, didAddedStream stream: EnxStream?) {
/* Subscribe Remote Stream */
}
/* Delegate: activeTalkerList
To handle any time Active Talker list is updated */
func room(_ room: EnxRoom?, activeTalkerList Data: [Any]?) {
/* Handle Stream Players */
}
Enablex Platform provide api to start/stop canvas.
To initiate canvas customer must have canvas subscription enable in their room.
Note:- Right now only one user can share his canvas at any given time in the room. The canvas stream can be edited in real time
only by the person who started the canvas. Exm:- If in room their are 2 participants 'A' and 'B', If participant 'A' start the canvas then participant 'B' can only view and vice varsa.
Method:
```
Start Canvas
-(void)startCanvas:(UIView*_Nonnull)view;
/*
Here user needs to pass the view, which he/she wants to publish as another stream into the room over the canvas channel.
*/
Stop Canvas
-(void)stopCanvas;
```
Delegates:
```
/*
Owner of start/Stop canvas (The person startting/Stoping canvas) will receive acknowledgement delegates as below */
//Start Canvas
-(void)room:(EnxRoom *_Nullable)room didStartCanvasACK:(NSArray *_Nullable)Data;
//Stop Canvas
-(void)room:(EnxRoom *_Nullable)room didStoppedCanvasACK:(NSArray *_Nullable)Data;
/*
Other participants in same room will receive delegates as Below */
//Once Canvas start
-(void)room:(EnxRoom*)room canvasStarted:(NSArray * _Nullable)Data;
//Once Canvas Stopen
-(void)room:(EnxRoom*)room canvasStopped:(NSArray * _Nullable)Data;
```
Join Screen :- On this screen user creates the roomID, and share this roomID to other end user who has to join this room.
Here in this screen 2nd participant joins into the same room. On Top of the screen, option button is available to start the canvas.
Once user clicks start canvas, a white page will open, where user can draw, add interactive buttons or play a video etc. In this example we will change the canvas color and its name on "Change color button tap"
Changed color from white to Red.
Changed color from Red to Blue.
As you can see once any user starts the canvas, users in same room views the activity on the canvas, based on the interactive actions initiated from canvas owner.
EnableX provides hosted Demo Application Server of different use-case for you to try out.
- Try a quick Video Call: https://try.enablex.io
- Sign up for a free trial https://portal.enablex.io/cpaas/trial-sign-up/