Merge pull request #62 from jcague/feature/archiving_outputmode

Added support to outputMode

Author: aoberoi

opentok/__init__.py

@@ -1,5 +1,5 @@
 from .opentok import OpenTok, Roles, MediaModes
 from .session import Session
-from .archives import Archive, ArchiveList
+from .archives import Archive, ArchiveList, OutputModes
 from .exceptions import OpenTokException
 from .version import __version__

opentok/archives.py

@@ -2,6 +2,7 @@
 from six import iteritems, PY2, PY3, u
 import json
 import pytz
+from enum import Enum
 if PY3:
     from datetime import timezone
 
@@ -10,6 +11,14 @@
 
 dthandler = lambda obj: obj.isoformat() if isinstance(obj, datetime)  or isinstance(obj, date) else None
 
+class OutputModes(Enum):
+    """List of valid settings for the outputMode parameter of the OpenTok.start_archive() method."""
+    composed = u('composed')
+    """The archive will produce a single MP4 file composed of all streams."""
+    individual = u('individual')
+    """The archive will generate a ZIP container with multiple individual WEBM files and a JSON metadata
+    file for video synchronization."""
+
 class Archive(object):
     """Represents an archive of an OpenTok session.
 
@@ -27,6 +36,12 @@ class Archive(object):
        Boolean value set to true when the archive contains a video track,
        and set to false otherwise.
 
+    :ivar outputMode:
+        The output mode to be generated for this archive:
+        The default value is composed (a single MP4 file composed of all streams).
+        Value individual will generate a ZIP container with multiple individual WEBM files
+        and a JSON metadata file for video synchronization.
+
     :ivar id:
        The archive ID.
 
@@ -80,8 +95,9 @@ def __init__(self, sdk, values):
             self.created_at = datetime.fromtimestamp(values.get('createdAt') // 1000, timezone.utc)
         self.size = values.get('size')
         self.duration = values.get('duration')
-        self.hasAudio = values.get('hasAudio')
-        self.hasVideo = values.get('hasVideo')
+        self.has_audio = values.get('hasAudio')
+        self.has_video = values.get('hasVideo')
+        self.output_mode = OutputModes[values.get('outputMode', 'composed')]
         self.url = values.get('url')
 
     def stop(self):

opentok/opentok.py

@@ -17,7 +17,7 @@
 
 from .version import __version__
 from .session import Session
-from .archives import Archive, ArchiveList
+from .archives import Archive, ArchiveList, OutputModes
 from .exceptions import OpenTokException, RequestError, AuthError, NotFoundError, ArchiveError
 
 class Roles(Enum):
@@ -264,7 +264,7 @@ def archive_url(self, archive_id=None):
             url = url + '/' + archive_id
         return url
 
-    def start_archive(self, session_id, hasAudio=True, hasVideo=True, name=None):
+    def start_archive(self, session_id, has_audio=True, has_video=True, name=None, output_mode=OutputModes.composed):
         """
         Starts archiving an OpenTok 2.0 session.
 
@@ -285,14 +285,22 @@ def start_archive(self, session_id, hasAudio=True, hasVideo=True, name=None):
           an error.
         :param Boolean hasVideo: if set to True, a video track will be inserted to the archive.
           hasVideo is an optional parameter that is set to True by default.
+        :param OutputModes outputMode: if set to composed, a single MP4 file composed of all streams
+          will be generated. If you set it to individual it will create a ZIP container with multiple
+          individual WEBM files and a JSON metadata file for video synchronization.
+          outputMode is an optional parameter that is set to composed by default.
 
         :rtype: The Archive object, which includes properties defining the archive,
           including the archive ID.
         """
+        if not isinstance(output_mode, OutputModes):
+            raise OpenTokException(u('Cannot start archive, {0} is not a valid output mode').format(output_mode))
+
         payload = {'name': name,
                    'sessionId': session_id,
-                   'hasAudio': hasAudio,
-                   'hasVideo': hasVideo
+                   'hasAudio': has_audio,
+                   'hasVideo': has_video,
+                   'outputMode': output_mode.value
         }
 
         response = requests.post(self.archive_url(), data=json.dumps(payload), headers=self.archive_headers())

sample/Archiving/archiving.py

@@ -1,5 +1,5 @@
 from flask import Flask, render_template, request, redirect, url_for
-from opentok import OpenTok, MediaModes
+from opentok import OpenTok, MediaModes, OutputModes
 from email.utils import formatdate
 import os, time
 
@@ -52,9 +52,13 @@ def download(archive_id):
     archive = opentok.get_archive(archive_id)
     return redirect(archive.url)
 
-@app.route("/start")
+@app.route("/start", methods=['POST'])
 def start():
-    archive = opentok.start_archive(session.session_id, name="Python Archiving Sample App")
+    has_audio = 'hasAudio' in request.form.keys()
+    has_video = 'hasVideo' in request.form.keys()
+    output_mode = OutputModes[request.form.get('outputMode')]
+    archive = opentok.start_archive(session.session_id, name="Python Archiving Sample App",
+                                    has_audio=has_audio, has_video=has_video, output_mode=output_mode)
     return archive.json()
 
 @app.route("/stop/<archive_id>")

sample/Archiving/static/js/host.js

@@ -18,20 +18,33 @@ session.on('archiveStarted', function(event) {
   console.log("ARCHIVE STARTED");
   $(".start").hide();
   $(".stop").show();
+  disableForm();
 });
 
 session.on('archiveStopped', function(event) {
   archiveID = null;
   console.log("ARCHIVE STOPPED");
   $(".start").show();
   $(".stop").hide();
+  enableForm();
 });
 
 $(document).ready(function() {
-  $(".start").click(function(event){
-    $.get("start");
+  $(".start").click(function (event) {
+    var options = $(".archive-options").serialize();
+    disableForm();
+    $.post("/start", options).fail(enableForm);
   }).show();
   $(".stop").click(function(event){
     $.get("stop/" + archiveID);
   }).hide();
 });
+
+
+function disableForm() {
+  $(".archive-options-fields").attr('disabled', 'disabled');
+}
+
+function enableForm() {
+  $(".archive-options-fields").removeAttr('disabled');
+}

sample/Archiving/templates/host.html

@@ -15,6 +15,29 @@ <h3 class="panel-title">Host</h3>
           <div id="subscribers"><div id="publisher"></div></div>
         </div>
         <div class="panel-footer">
+          <form class="archive-options">
+              <fieldset class="archive-options-fields">
+                  <div class="form-group">
+                      <p class="help-block">Archive Options:</p>
+                      <label class="checkbox-inline">
+                          <input type="checkbox" name="hasAudio" checked> Audio
+                      </label>
+                      <label class="checkbox-inline">
+                          <input type="checkbox" name="hasVideo" checked> Video
+                      </label>
+                  </div>
+
+                  <div class="form-group">
+                      <p class="help-block">Output Mode:</p>
+                      <label class="radio-inline">
+                          <input type="radio" name="outputMode" value="composed" checked> Composed
+                      </label>
+                      <label class="radio-inline">
+                          <input type="radio" name="outputMode" value="individual"> Individual
+                      </label>
+                  </div>
+              </fieldset>
+          </form>
           <button class="btn btn-danger start">Start archiving</button>
           <button class="btn btn-success stop">Stop archiving</button>
         </div>

tests/test_archive.py

@@ -8,7 +8,7 @@
 import datetime
 import pytz
 
-from opentok import OpenTok, Archive, __version__
+from opentok import OpenTok, Archive, __version__, OutputModes
 
 class OpenTokArchiveTest(unittest.TestCase):
     def setUp(self):
@@ -31,6 +31,7 @@ def test_stop_archive(self):
             u('status'): u('started'),
             u('hasAudio'): True,
             u('hasVideo'): True,
+            u('outputMode'): OutputModes.composed.value,
             u('url'): None,
         })
         httpretty.register_uri(httpretty.POST, u('https://api.opentok.com/v2/partner/{0}/archive/{1}/stop').format(self.api_key, archive_id),
@@ -47,6 +48,7 @@ def test_stop_archive(self):
                                           "status" : "stopped",
                                           "hasAudio": true,
                                           "hasVideo": false,
+                                          "outputMode": "composed",
                                           "url" : null
                                         }""")),
                                status=200,
@@ -70,8 +72,9 @@ def test_stop_archive(self):
         expect(archive).to.have.property(u('created_at')).being.equal(created_at)
         expect(archive).to.have.property(u('size')).being.equal(0)
         expect(archive).to.have.property(u('duration')).being.equal(0)
-        expect(archive).to.have.property(u('hasAudio')).being.equal(True)
-        expect(archive).to.have.property(u('hasVideo')).being.equal(False)
+        expect(archive).to.have.property(u('has_audio')).being.equal(True)
+        expect(archive).to.have.property(u('has_video')).being.equal(False)
+        expect(archive).to.have.property(u('output_mode')).being.equal(OutputModes.composed)
         expect(archive).to.have.property(u('url')).being.equal(None)
 
     @httpretty.activate
@@ -89,6 +92,7 @@ def test_delete_archive(self):
             u('status'): u('available'),
             u('hasAudio'): True,
             u('hasVideo'): True,            
+            u('outputMode'): OutputModes.composed.value,
             u('url'): None,
         })
         httpretty.register_uri(httpretty.DELETE, u('https://api.opentok.com/v2/partner/{0}/archive/{1}').format(self.api_key, archive_id),