1-to-1 RTC: A Sample Web App with EnableX Web Toolkit

The Sample Web App demonstrates the use of APIs for EnableX platform to carry out 1-to-1 RTC (Real Time Communication). The main motivation behind this application is to demonstrate usage of APIs and allow developers to ramp up on app by hosting on their own devices instead of directly using servers.

RTC Applications hosted on EnableX platform run natively on supported set of web browsers without any additional plugin downloads.

This basic 1-to-1 Video Chat Application is developed using HTML, CSS, Bootstrap v4.0.0-alpha.6, JAVA Script, jQuery, Node V8.9.1 and EnxRtc (The EnableX Web Toolkit).

The details of the supported set of web browsers can be found here: https://developer.enablex.io/release-notes/#cross-compatibility

1. Important!

When developing a Node Application with EnxRtc.js make sure to include the updated EnxRtc.js polyfills for RTCPeerConnection and getUserMedia otherwise your application will not work in web browsers.

2. Demo

Visit Demo Zone (https://portal.enablex.io/demo-zone/) to request a Guided Demo or Demo Access to different type of application available there.

You may also try our Video Meeting and Webinar solutions here: https://enablex.io/vcfree

3. Installation

3.1 Pre-Requisites

3.1.1 App Id and App Key

Register with EnableX https://portal.enablex.io/trial-sign-up/
Create your Application
Get your App ID and App Key delivered to your registered email
Clone or download this repository git clone https://github.com/EnableX/One-to-One-Video-Chat-Sample-Web-Application.git

3.1.2 SSL Certificates or Self-Signed Certificates

The Application needs to run on https. So, you need to use a valid SSL Certificate for your Domain and point your application to use them.

However you may use self-signed Certificate to run this application locally. There are many websites to get a self-signed certificate generated for you.

The following below can also be used to create a self-signed certificate.

cd One-to-One-Video-Chat-Sample-Web-Application

mkdir certs

sudo openssl req -x509 -newkey rsa:4096 -keyout ./certs/localhost.key -out ./certs/localhost.crt -days 10000 -nodes

sudo chmod 755 ./certs/localhost.*

3.1.3 Configure

Before you can run this application by hosting it locally you need to customize server/vcxconfig.js to meet your needs.

nano ./server/vcxconfig.js

vcxconfig.SERViCE = {
  name: "EnableX Sample Web App",     // Name of the Application [Change optional]
  version: "1.0.0",                   // Version [Change optional]
  path: "/v1",                        // Route [Default /v1]
  domain: "yourdomain.com",           // FQDN of  your hosting enviornment
  port  : "4443",                     // FQDN of  your hosting port. You need sudo permission if you want to use standard 443
  listen_ssl : true                   // SSL on/off key  [ Set always to "true" ]
};

vcxconfig.Certificate = {
    ssl_key: 	"../certs/localhost.key",            // Path to .key file or registered key
    ssl_cert: 	"../certs/localhost.crt"             // Path to .crt file or registered crt
// sslCaCerts :  ["../cert/yourdomain.ca-bundle"]    // Use the certificate CA[chain] [self signed or registered]
};

vcxconfig.SERVER_API_SERVER = {
  host: 'api.enablex.io',             // Hosted EnableX Server API Domain Name
};

vcxconfig.clientPath  = "../client";    // UI files location
vcxconfig.APP_ID      = "YOUR_APP_ID";  // Enter Your App ID you received from registered email
vcxconfig.APP_KEY     = "YOUR_APP_KEY"; // Enter Your App Key you have received from registered email

3.2 Build

Run npm install --save to build the project and the build artifacts will be stored in the ./node_modules directory.

3.2.1 Run Server

Run node server.js inside server folder to start your server.

cd server

node server.js Server started. Listening on Port 4443

3.2.2 Test Video Call

Open a browser and go to https://localhost:4443/. The browser should load the App. Go to -> Advanced -> Proceed to localhost
Don't have a Room ID? Create here (create a new RoomID)
Store the Room ID for future use or share
Enter a username (e.g. test0)
Join and allow access to camera and microphone when prompted to start your first webRTC call through EnableX
Open another browser tab and enter https://localhost:4443/
Enter the same roomID previously created and add a different username (test1) and click join
Now, you should see your own video in both the tabs!

4 Server API

EnableX Server API is a Rest API service meant to be called from Partners' Application Server to provision video enabled meeting rooms. API Access is given to each Application through the assigned App ID and App Key. So, the App ID and App Key are to be used as Username and Password respectively to pass as HTTP Basic Authentication header to access Server API.

For this application, the following Server API calls are used: