add max_bitrate field for archive api

Author: maxkahan

opentok/archives.py

@@ -12,10 +12,8 @@
 # compat
 from six.moves import map
 
-dthandler = (
-    lambda obj: obj.isoformat()
-    if isinstance(obj, datetime) or isinstance(obj, date)
-    else None
+dthandler = lambda obj: (
+    obj.isoformat() if isinstance(obj, datetime) or isinstance(obj, date) else None
 )
 
 
@@ -28,8 +26,9 @@ class OutputModes(Enum):
     individual = u("individual")
     """Each stream in the archive is recorded to an individual file."""
 
+
 class StreamModes(Enum):
-    """"List of valid settings for the stream_mode parameter of the OpenTok.start_archive()
+    """ "List of valid settings for the stream_mode parameter of the OpenTok.start_archive()
     method."""
 
     auto = u("auto")
@@ -38,6 +37,7 @@ class StreamModes(Enum):
     """Streams are included in the archive based on calls to the OpenTok.add_archive_stream()
     and OpenTok.remove_archive_stream() methods."""
 
+
 class Archive(object):
     """Represents an archive of an OpenTok session.
 
@@ -68,8 +68,8 @@ class Archive(object):
 
     :ivar streamMode:
         Whether streams included in the archive are selected automatically
-        ("auto", the default) or manually ("manual"). 
-    
+        ("auto", the default) or manually ("manual").
+
     :ivar streams:
         A list of streams currently being archived. This is only set for an archive with
         the status set to "started" and the stream_Mode set to "manual".
@@ -110,6 +110,8 @@ class Archive(object):
        "available"; for other archives, (including archives with the status "uploaded") this property is
        set to null. The download URL is obfuscated, and the file is only available from the URL for
        10 minutes. To generate a new URL, call the Archive.listArchives() or OpenTok.getArchive() method.
+
+    :ivar max_bitrate: The maximum video bitrate for the archive, in bits per second. The minimum value is 100,000 and the maximum is 6,000,000.
     """
 
     def __init__(self, sdk, values):
@@ -136,6 +138,7 @@ def __init__(self, sdk, values):
         self.streams = values.get("streams")
         self.url = values.get("url")
         self.resolution = values.get("resolution")
+        self.max_bitrate = values.get("maxBitrate")
 
     def stop(self):
         """

opentok/opentok.py

@@ -559,6 +559,7 @@ def start_archive(
         resolution=None,
         layout=None,
         multi_archive_tag=None,
+        max_bitrate=None,
     ):
         """
         Starts archiving an OpenTok session.
@@ -617,6 +618,8 @@ def start_archive(
         at a time for a given session.
         For more information, see simultaneous archives: https://tokbox.com/developer/guides/archiving/#simultaneous-archives.
 
+        :param String max_bitrate (Optional): The maximum video bitrate for the archive, in bits per second. The minimum value is 100,000 and the maximum is 6,000,000.
+
         :rtype: The Archive object, which includes properties defining the archive,
           including the archive ID.
         """
@@ -643,6 +646,7 @@ def start_archive(
             "resolution": resolution,
             "streamMode": stream_mode.value,
             "multiArchiveTag": multi_archive_tag,
+            "maxBitrate": max_bitrate,
         }
 
         if layout is not None:

tests/test_archive.py

@@ -38,6 +38,7 @@ def test_stop_archive(self):
                 u("hasVideo"): True,
                 u("outputMode"): OutputModes.composed.value,
                 u("url"): None,
+                u("maxBitrate"): 2000000,
             },
         )
         httpretty.register_uri(
@@ -61,7 +62,8 @@ def test_stop_archive(self):
                             "hasAudio": true,
                             "hasVideo": false,
                             "outputMode": "composed",
-                            "url" : null
+                            "url" : null,
+                            "maxBitrate": 2000000
                         }
                     """
                 )
@@ -98,6 +100,7 @@ def test_stop_archive(self):
         expect(archive).to(have_property(u("has_video"), False))
         expect(archive).to(have_property(u("output_mode"), OutputModes.composed))
         expect(archive).to(have_property(u("url"), None))
+        expect(archive).to(have_property(u("max_bitrate"), 2000000))
 
     @httpretty.activate
     def test_add_archive_stream(self):
@@ -144,6 +147,7 @@ def test_delete_archive(self):
                 u("hasVideo"): True,
                 u("outputMode"): OutputModes.composed.value,
                 u("url"): None,
+                u("maxBitrate"): 2000000,
             },
         )
         httpretty.register_uri(

tests/test_archive_api.py

@@ -51,7 +51,8 @@ def test_start_archive(self):
                             "hasAudio": true,
                             "hasVideo": true,
                             "outputMode": "composed",
-                            "url" : null
+                            "url" : null,
+                            "maxBitrate": 2000000
                         }
                     """
                 )
@@ -95,6 +96,7 @@ def test_start_archive(self):
         expect(archive).to(have_property(u("has_audio"), True))
         expect(archive).to(have_property(u("has_video"), True))
         expect(archive).to(have_property(u("url"), None))
+        expect(archive).to(have_property(u("max_bitrate"), 2000000))
 
     @httpretty.activate
     def test_start_archive_with_name(self):
@@ -468,7 +470,8 @@ def test_start_composed_archive(self):
                             "hasAudio": true,
                             "hasVideo": true,
                             "outputMode": "composed",
-                            "url" : null
+                            "url" : null,
+                            "maxBitrate": 2000000
                         }
                     """
                 )
@@ -516,6 +519,7 @@ def test_start_composed_archive(self):
         expect(archive).to(have_property(u("has_video"), True))
         expect(archive).to(have_property(u("output_mode"), OutputModes.composed))
         expect(archive).to(have_property(u("url"), None))
+        expect(archive).to(have_property(u("max_bitrate"), 2000000))
 
     @httpretty.activate
     def test_start_archive_with_layout(self):
@@ -1069,9 +1073,7 @@ def test_find_archives_with_offset_and_count(self):
             equal(u("application/json"))
         )
         expect(httpretty.last_request()).to(
-            have_property(
-                u("querystring"), {u("offset"): [u("2")], u("count"): [u("4")]}
-            )
+            have_property(u("querystring"), {u("offset"): [u("2")], u("count"): [u("4")]})
         )
         expect(archive_list).to(be_an(ArchiveList))
         expect(archive_list).to(have_property(u("count"), 6))