Make Simulcast API public (#861)

lynckia · Apr 19, 2017 · a07da5f · a07da5f
1 parent 7abd4f8
commit a07da5f
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/doc/client_api.md b/doc/client_api.md
@@ -391,9 +391,21 @@ room.publish(localStream, {maxVideoBW:300}, function(id, error){
   } else {
     console.log("Published stream", id);
   }
-});            
+});
+```
+
+### Publish Simulcast Streams
+
+You can enable Simulcast in the publisher by adding the next option:
+
+```
+room.publish(localStream, {simulcast: {numSpatialLayers: 2}});
 ```
 
+Being `numSpatialLayers` the max number of spatial layers the publisher will send.
+
+**Note:** Simulcast only works with Google Chrome and it's not compatible with Licode's recording yet.
+
 ## Subscribe to a remote stream
 
 It subscribes to a remote stream in the room.

diff --git a/erizo_controller/erizoClient/src/Room.js b/erizo_controller/erizoClient/src/Room.js
@@ -441,11 +441,10 @@ Erizo.Room = function (spec) {
             options.minVideoBW = spec.defaultVideoBW;
         }
 
-        // TODO(javier): remove dangling once Simulcast is stable
-        options._simulcast = options._simulcast || false;
+        options.simulcast = options.simulcast || options._simulcast || false;
 
         // 1- If the stream is not local or it is a failed stream we do nothing.
-        if (stream && stream.local && !stream.failed && 
+        if (stream && stream.local && !stream.failed &&
             that.localStreams[stream.getID()] === undefined) {
 
             // 2- Publish Media Stream to Erizo-Controller
@@ -575,7 +574,7 @@ Erizo.Room = function (spec) {
                                maxVideoBW: options.maxVideoBW,
                                limitMaxAudioBW: spec.maxAudioBW,
                                limitMaxVideoBW: spec.maxVideoBW,
-                               simulcast: options._simulcast,
+                               simulcast: options.simulcast,
                                audio: stream.hasAudio(),
                                video: stream.hasVideo()});
 

diff --git a/extras/basic_example/public/script.js b/extras/basic_example/public/script.js
@@ -105,7 +105,7 @@ window.onload = function () {
       room.addEventListener('room-connected', function (roomEvent) {
         var options = {metadata: {type: 'publisher'}};
         var enableSimulcast = getParameterByName('simulcast');
-        if (enableSimulcast) options._simulcast = {numSpatialLayers: 2};
+        if (enableSimulcast) options.simulcast = {numSpatialLayers: 2};
 
         var onlySubscribe = getParameterByName('onlySubscribe');
         if (!onlySubscribe) room.publish(localStream, options);