Merge pull request #48 from eauge/develop

Added hasAudio and hasVideo feature to archiving

Author: aoberoi

opentok/archives.py

@@ -52,6 +52,14 @@ class Archive(object):
          Amazon S3 bucket or Windows Azure container that you set at the
          `OpenTok dashboard <https://dashboard.tokbox.com>`_.
 
+    :ivar hasAudio:
+       Boolean value set to true when the archive contains an audio track,
+       and set to false otherwise.
+
+    :ivar hasVideo:
+       Boolean value set to true when the archive contains a video track,
+       and set to false otherwise.
+
     :ivar url:
        The download URL of the available MP4 file. This is only set for an archive with the status set to
        "available"; for other archives, (including archives with the status "uploaded") this property is
@@ -72,6 +80,8 @@ 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.url = values.get('url')
 
     def stop(self):

opentok/opentok.py

@@ -263,7 +263,7 @@ def archive_url(self, archive_id=None):
             url = url + '/' + archive_id
         return url
 
-    def start_archive(self, session_id, **kwargs):
+    def start_archive(self, session_id, hasAudio=True, hasVideo=True, name=None):
         """
         Starts archiving an OpenTok 2.0 session.
 
@@ -278,11 +278,17 @@ def start_archive(self, session_id, **kwargs):
         :param String name: This is the name of the archive. You can use this name
           to identify the archive. It is a property of the Archive object, and it is a property
           of archive-related events in the OpenTok.js library.
+        :param Boolean hasAudio: if set to true, an audio track will be inserted to the archive. hasAudio is an optional parameter that is set to true by default.
+        :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.
 
         :rtype: The Archive object, which includes properties defining the archive,
           including the archive ID.
         """
-        payload = {'name': kwargs.get('name'), 'sessionId': session_id}
+        payload = {'name': name,
+                   'sessionId': session_id,
+                   'hasAudio': hasAudio,
+                   'hasVideo': hasVideo
+        }
 
         response = requests.post(self.archive_url(), data=json.dumps(payload), headers=self.archive_headers())
 

tests/test_archive.py

@@ -29,6 +29,8 @@ def test_stop_archive(self):
             u('sessionId'): u('SESSIONID'),
             u('size'): 0,
             u('status'): u('started'),
+            u('hasAudio'): True,
+            u('hasVideo'): True,
             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),
@@ -43,6 +45,8 @@ def test_stop_archive(self):
                                           "sessionId" : "SESSIONID",
                                           "size" : 0,
                                           "status" : "stopped",
+                                          "hasAudio": true,
+                                          "hasVideo": false,
                                           "url" : null
                                         }""")),
                                status=200,
@@ -66,6 +70,8 @@ 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('url')).being.equal(None)
 
     @httpretty.activate
@@ -81,6 +87,8 @@ def test_delete_archive(self):
             u('sessionId'): u('SESSIONID'),
             u('size'): 0,
             u('status'): u('available'),
+            u('hasAudio'): True,
+            u('hasVideo'): True,            
             u('url'): None,
         })
         httpretty.register_uri(httpretty.DELETE, u('https://api.opentok.com/v2/partner/{0}/archive/{1}').format(self.api_key, archive_id),