Skip to content

Commit

Permalink
Update readme files and latest toolkit
Browse files Browse the repository at this point in the history
  • Loading branch information
jaykumarvcx committed Jun 30, 2020
1 parent 2600f1c commit a974443
Show file tree
Hide file tree
Showing 81 changed files with 3,336 additions and 2,401 deletions.
Binary file modified .DS_Store
Binary file not shown.
66 changes: 43 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ This App creates a virtual Room on the fly hosted on the Enablex platform using
#### 1.1.1 App Id and App Key

* Register with EnableX [https://www.enablex.io]
* Create your Application
* Login to the EnableX Portal
* Create your Application Key
* Get your App ID and App Key delivered to your Email


Expand All @@ -23,22 +24,33 @@ This App creates a virtual Room on the fly hosted on the Enablex platform using
* Clone or download this Repository [https://github.com/EnableX/Sample-iOS-Chat.git]


#### 1.1.3 Sample App Server
#### 1.1.3 Test Application Server

* Clone or download this Repository [https://github.com/EnableX/One-to-One-Video-Chat-Sample-Web-Application.git] & follow the steps further
* You need to use App ID and App Key to run this Service.
* Your iOS Client End Point needs to connect to this Service to create Virtual Room.
* Follow README file of this Repository to setup the Service.
You need to setup an Application Server to provision Web Service API for your iOS Application to communicate enabling Video Session.

To help you to try our iOS Application quickly, without having to setup 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 Duation to 10 minutes, and allows 1 moderator and note 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. More on this, read Point 2 later in the Document.


#### 1.1.4 Configure iOS Client

* Open the App
* Go to VCXConstant.swift and change the following:
```
let userName = "USERNAME" /* HTTP Basic Auth Username of App Server */
let password = "PASSWORD" /* HTTP Basic Auth Password of App Server */
let kBaseURL = "FQDN" /* FQDN of of App Server */
/* 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.
Expand All @@ -49,29 +61,34 @@ This App creates a virtual Room on the fly hosted on the Enablex platform using

* 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 a RTC Session.
* Once the Room Id is created, you can use it and share with others to connect to the Virtual Room to carry out a 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 may allow upto 5 Moderators.


## 2 Server API
## 2 Setup Your Own Application Server

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:
* https://developer.enablex.io/latest/server-api/rooms-route/#get-rooms - To get list of Rooms
* https://developer.enablex.io/latest/server-api/rooms-route/#get-room-info - To get information of the given Room
* https://developer.enablex.io/latest/server-api/rooms-route/#create-token - To create Token for the given Room
You may need to setup your own Application Server after you tried the Sample Application with EnableX hosted Server. We have differnt variant of Appliciation Server Sample Code, pick 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 End Point needs to connect to this Service to create Virtual Room and Create Token to join session.
* Application Server is created using EnableX Server API, a Rest API Service helps in provisioning, session access and pos-session reporting.

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


## 3 iOS Toolkit

iOS App to use iOS Toolkit to communicate with EnableX Servers to initiate and manage Real Time Communications.
iThis Sample Applcation uses EnableX iOS Toolkit to communicate with EnableX Servers to initiate and manage Real Time Communications. You might need to update your Application with latest version of EnableX iOS Toolkit time as and when a new release is avaialble.

* Documentation: https://developer.enablex.io/latest/client-api/ios-toolkit/
* Download: https://developer.enablex.io/resources/downloads/#ios-toolkit
* Download Toolkit: https://developer.enablex.io/resources/downloads/#ios-toolkit


## 4 Application Walk-through
Expand Down Expand Up @@ -140,6 +157,9 @@ To handle any chat recieve at room */

## 5 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.
EnableX provides hosted Vemo Application of different use-case for you to try out.

1. Try a quick Video Call: https://try.enablex.io
2. Try Apps on Demo Zone: https://portal.enablex.io/demo-zone/
3. Try Meeting & Webinar: https://www.enablex.io/ucaas/

You may also try our Video Meeting and Webinar solutions here: https://web.enablex.io/ucaas/covid-19/
2 changes: 1 addition & 1 deletion sampleiOS/Podfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ target 'sampleiOS' do
use_frameworks!

# Pods for sampleiOS
pod 'EnxRTCiOS', '1.5.3'
pod 'EnxRTCiOS'
pod 'Socket.IO-Client-Swift', '~> 15.0.0'
pod 'SVProgressHUD'
pod 'ReachabilitySwift'
Expand Down
16 changes: 8 additions & 8 deletions sampleiOS/Podfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ PODS:
- AMBubbleTableViewController (0.5.4)
- Crashlytics (3.14.0):
- Fabric (~> 1.10.2)
- EnxRTCiOS (1.5.3):
- GoogleWebRTC (= 1.1.29229)
- EnxRTCiOS (1.6.0):
- GoogleWebRTC (= 1.1.29400)
- Fabric (1.10.2)
- GoogleWebRTC (1.1.29229)
- GoogleWebRTC (1.1.29400)
- ReachabilitySwift (5.0.0)
- Socket.IO-Client-Swift (15.0.0):
- Starscream (~> 3.1)
Expand All @@ -15,7 +15,7 @@ PODS:
DEPENDENCIES:
- AMBubbleTableViewController
- Crashlytics
- EnxRTCiOS (= 1.5.3)
- EnxRTCiOS
- ReachabilitySwift
- Socket.IO-Client-Swift (~> 15.0.0)
- SVProgressHUD
Expand All @@ -35,14 +35,14 @@ SPEC REPOS:
SPEC CHECKSUMS:
AMBubbleTableViewController: f4426cd8d646fbe4ec5f0d821857cca62c2792b2
Crashlytics: 540b7e5f5da5a042647227a5e3ac51d85eed06df
EnxRTCiOS: f156a3106628eec03c33ab453ee2b02efd660a14
EnxRTCiOS: 3004e4cd586374ba6b6d6355288de54b75f7d2f6
Fabric: 706c8b8098fff96c33c0db69cbf81f9c551d0d74
GoogleWebRTC: ffbf2dca3bdef0fbeebcff497e0a659bd69761c8
GoogleWebRTC: cfb83bc346435a17fe06bb05f04ad826b858a7fb
ReachabilitySwift: 985039c6f7b23a1da463388634119492ff86c825
Socket.IO-Client-Swift: c039a808195d22a7192962841b8c035cb61ea49e
Starscream: 4bb2f9942274833f7b4d296a55504dcfc7edb7b0
SVProgressHUD: 1428aafac632c1f86f62aa4243ec12008d7a51d6

PODFILE CHECKSUM: adec52002305a5d73a822c7ab6c4f1c957467e14
PODFILE CHECKSUM: 71cc24b1815047ee1e121126d4f14aac368166c9

COCOAPODS: 1.8.4
COCOAPODS: 1.9.3
112 changes: 112 additions & 0 deletions sampleiOS/Pods/EnxRTCiOS/EnxRTCiOS.framework/EnxCustomEvent.txt

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions sampleiOS/Pods/EnxRTCiOS/EnxRTCiOS.framework/EnxEventFormate.txt

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified sampleiOS/Pods/EnxRTCiOS/EnxRTCiOS.framework/EnxRTCiOS
Binary file not shown.
Loading

0 comments on commit a974443

Please sign in to comment.