refactor(iceserver): replace iceServers by iceServer (without s)

- This is to be consistent with webrtc-client parameter
- SourceController: use the
connectParams.iceServer if set

Author: thomasjammet

README.md

@@ -20,7 +20,7 @@ This plugin contains :
   - [Parameters](#parameters)
     - [**src**](#src)
     - [**type**](#type)
-    - [**iceservers**](#iceservers)
+    - [**iceserver**](#iceserver)
     - [**audiobutton**](#audiobutton)
     - [**data**](#data)
   - [Source Object](#source-object)
@@ -86,11 +86,13 @@ The following options can be set in the query:
 
 **It is important for the MIME-type to be empty to use the WebRTC source.**
 
-#### **iceservers**
+#### **iceserver**
 
-Ice-servers (STUN, TURN) structure in JSON string format to establish a WebRTC connection.
+[Ice-server](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection#iceservers) structure in JSON string format with TURN URL used to establish the WebRTC connection, mainly for TCP fallback.
 
-**Note:** Do not enclose the object in an array.
+> Do not enclose the object in an array.
+> If you have multiple TURN servers, you can add them in the `urls` array.
+> **If not set, the plugin will use the default TURN server of the Ceeblue Cloud.**
 
 **Example:**
 
@@ -130,7 +132,7 @@ Call the `player.src()` method with a WebRTC URL.
   const player = videojs('video-tag');
   player.src({
     src: 'wss://<ceeblue-host>/<streamId>',
-    iceservers: '{
+    iceserver: '{
       "urls": ["turn:<ceeblue-host>?transport=tcp", "turn:<ceeblue-host>:3478"],
       "username": "csc_demo",
       "credential": "UtrAFClFFO"
@@ -157,7 +159,7 @@ The WebRTC source can be set directly in the HTML Source tag.
 <div id="video_container">
     <video id=video-player width=960 height=540 class="video-js vjs-default-skin" controls>
         <source src="wss://<ceeblue-host>/webrtc/<streamId>" 
-            iceServers='{"urls": ["turn:<ceeblue-host>?transport=tcp", "turn:<ceeblue-host>:3478"], "username": "csc_demo", "credential": "UtrAFClFFO"}'>
+            iceserver='{"urls": ["turn:<ceeblue-host>?transport=tcp", "turn:<ceeblue-host>:3478"], "username": "csc_demo", "credential": "UtrAFClFFO"}'>
     </video>
 </div>
 <script>
@@ -208,13 +210,19 @@ To start the `SourceController` call the `start()` function with the following a
       streamName: '<streamId>'
       query: 'id=<accessToken>'
     }, 
-    [{
+    [
+      {
+        // A WebRTC source with custom options
         src: 'wss://<ceeblue-host>/<streamId>',
-        iceservers: '{"urls": ["turn:<ceeblue-host>?transport=tcp", "turn:<ceeblue-host>:3478"], "username": "csc_demo", "credential": "UtrAFClFFO"}',
-     },
+        iceserver: '{"urls": ["turn:<ceeblue-host>?transport=tcp", "turn:<ceeblue-host>:3478"], "username": "csc_demo", "credential": "UtrAFClFFO"}',
+      },
       'llhls',
-      'dash', 
-      'hls'
+      'dash',
+      {
+        // A fallback source with a custom type
+        src: 'http://vjs.zencdn.net/v/oceans.mp4',
+        type: 'video/mp4'
+      }
     ]);
 ```
 

examples/player.html

@@ -265,7 +265,7 @@ <h5>Timed Metadatas</h5>
 							source = {
 								src: Connect.buildURL(ConnectType.WEBRTC, connectParams, protocol).toString(),
 								// Ceeblue specific options
-								iceservers: {
+								iceserver: {
 									urls: ['turn:' + this.host.domain + ':3478?transport=tcp', 'turn:' + this.host.domain + ':3478'], 
 									username: 'csc_demo', 
 									credential: 'UtrAFClFFO'

src/controllers/SourceController.js

@@ -128,7 +128,7 @@ export class SourceController extends EventEmitter {
           source.sourceType = SourceType.DASH;
           break;
         default:
-          videojs.log.warning('Unknown source type ' + source.type + ' using the MIME type instead');
+          videojs.log.warn('Unknown source type ' + source.type + ' using the MIME type instead');
           source.sourceType = source.type;
           break;
         }
@@ -165,12 +165,15 @@ export class SourceController extends EventEmitter {
       const protocol = connectParams.host.startsWith('https://') ? 'https' : 'wss';
 
       result.src = Connect.buildURL(ConnectType.WEBRTC, connectParams, protocol).toString();
-      // Use the default ICE servers structure
-      result.iceServers = {
-        urls: ['turn:' + domain + ':3478?transport=tcp', 'turn:' + domain + ':3478'],
-        username: 'csc_demo',
-        credential: 'UtrAFClFFO'
-      };
+      result.iceserver = connectParams.iceServer;
+      if (!result.iceserver) {
+        // Use the default ICE servers structure
+        result.iceserver = {
+          urls: ['turn:' + domain + ':3478?transport=tcp', 'turn:' + domain + ':3478'],
+          username: 'csc_demo',
+          credential: 'UtrAFClFFO'
+        };
+      }
       break;
     default:
       videojs.log.error('Unknown source type ' + source);

src/sources/WebRTCSource.js

@@ -13,7 +13,7 @@ export class WebRTCSource extends Component {
    * Create a WebRTC source handler instance.
    *
    * @param  {Object} source Source object that is given in the DOM, includes the stream URL
-   *  and the source options : {iceservers: string|Object, audiobutton: true|false, data: true|false}
+   *  and the source options : {iceserver: string|Object, audiobutton: true|false, data: true|false}
    * @param  {Object} tech The videojs tech object
    * @param  {Object} options The videojs options object
    */
@@ -30,10 +30,10 @@ export class WebRTCSource extends Component {
       return;
     }
 
-    // Parse iceServers
+    // Parse iceServer
     try {
-      if (typeof source.iceservers === 'string') {
-        this.source.iceservers = JSON.parse(source.iceservers);
+      if (typeof source.iceserver === 'string') {
+        this.source.iceserver = JSON.parse(source.iceserver);
       }
     } catch (e) {
       videojs.log('Malformated JSON : ', e && e.message);
@@ -75,7 +75,7 @@ export class WebRTCSource extends Component {
     this.webRTCPlayer.on('log', log => {
       videojs.log('onLog', log);
     }, this._abortController);
-    this.webRTCPlayer.start({host: url.host, streamName, iceServer: this.source.iceservers, query: Util.objectFrom(url.searchParams)});
+    this.webRTCPlayer.start({host: url.host, streamName, iceServer: this.source.iceserver, query: Util.objectFrom(url.searchParams)});
 
     // Create the tracks controller
     this._tracksController = new WebRTCTracksController(this);