fixing merge conflict

Author: maxkahan

README.rst

@@ -438,6 +438,8 @@ The live streaming broadcast can target one HLS endpoint and up to five RTMP ser
       'stylesheet': 'the layout stylesheet (only used with type == custom)'
     },
     'maxDuration': 5400,
+    'hasAudio': True
+    'hasVideo': True
     'outputs': {
       'hls': {},
       'rtmp': [{
@@ -494,6 +496,37 @@ You can specify the following broadcast resolutions:
 To enable multiple simultaneous broadcasts on the same session, specify a unique value for the 
 ``multiBroadcastTag`` parameter in ``options`` when calling the ``opentok.start_broadcast`` method.
 
+You can broadcast only audio, or only video, for a stream by setting ``hasAudio`` or ``hasVideo``
+to ``False`` as required. These fields are ``True`` by default.
+
+.. code:: python
+
+  session_id = 'SESSIONID'
+  options = {
+    'layout': {
+      'type': 'custom',
+      'stylesheet': 'the layout stylesheet (only used with type == custom)'
+    },
+    'maxDuration': 5400,
+    'hasAudio': True
+    'hasVideo': False
+    'outputs': {
+      'hls': {},
+      'rtmp': [{
+        'id': 'foo',
+        'serverUrl': 'rtmp://myfooserver/myfooapp',
+        'streamName': 'myfoostream'
+      }, {
+        'id': 'bar',
+        'serverUrl': 'rtmp://mybarserver/mybarapp',
+        'streamName': 'mybarstream'
+      }]
+    },
+    'resolution': '640x480'
+  }
+
+  broadcast = opentok.start_broadcast(session_id, options)
+
 You can stop a started Broadcast using the ``opentok.stop_broadcast(broadcast_id)`` method.
 
 .. code:: python
@@ -657,6 +690,15 @@ to all clients connected to session or to a specific connection:
   # To a specific connection
   opentok.play_dtmf(session_id, connection_id, digits)
 
+Appending to the User Agent
+-------
+
+You can append a string to the user agent that is sent with requests:
+
+.. code:: python
+
+  opentok.append_to_user_agent('my-appended-string')
+
 Samples
 -------
 

opentok/broadcast.py

@@ -28,6 +28,12 @@ class Broadcast(object):
     :ivar status:
         The status of the broadcast.
 
+    :ivar hasAudio:
+        Whether the broadcast has audio.
+
+    :ivar hasVideo:
+        Whether the broadcast has video.
+
     :ivar broadcastUrls:
         An object containing details about the HLS and RTMP broadcasts.
         
@@ -63,6 +69,8 @@ def __init__(self, kwargs):
         self.projectId = kwargs.get("projectId")
         self.createdAt = kwargs.get("createdAt")
         self.updatedAt = kwargs.get("updatedAt")
+        self.hasAudio = kwargs.get("hasAudio")
+        self.hasVideo = kwargs.get("hasVideo")
         self.resolution = kwargs.get("resolution")
         self.status = kwargs.get("status")
         self.broadcastUrls = kwargs.get("broadcastUrls")
@@ -71,7 +79,7 @@ def __init__(self, kwargs):
 
     def json(self):
         """
-        Returns a JSON representation of the broadcast
+        Returns a JSON representation of the broadcast.
         """
         return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True, indent=4)
 

opentok/opentok.py

@@ -91,12 +91,12 @@ class ArchiveModes(Enum):
 
 
 valid_archive_resolutions = {
-    '640x480',
-    '480x640',
-    '1280x720',
-    '720x1280',
-    '1920x1080',
-    '1080x1920',
+    "640x480",
+    "480x640",
+    "1280x720",
+    "720x1280",
+    "1920x1080",
+    "1080x1920",
 }
 
 logger = logging.getLogger("opentok")
@@ -125,6 +125,9 @@ def __init__(
         self._proxies = None
         self.endpoints = Endpoints(api_url, self.api_key)
         self._app_version = __version__ if app_version == None else app_version
+        self._user_agent = (
+            f"OpenTok-Python-SDK/{self.app_version} python/{platform.python_version()}"
+        )
         # JWT custom claims - Default values
         self._jwt_livetime = 3  # In minutes
 
@@ -144,6 +147,13 @@ def app_version(self):
     def app_version(self, value):
         self._app_version = value
 
+    @property
+    def user_agent(self):
+        return self._user_agent
+
+    def append_to_user_agent(self, value):
+        self._user_agent = self._user_agent + value
+
     @property
     def jwt_livetime(self):
         return self._jwt_livetime
@@ -408,7 +418,7 @@ def create_session(
                     "A session with always archive mode must also have the routed media mode."
                 )
             )
-        
+
         if archive_name is not None:
             if archive_mode == ArchiveModes.manual:
                 raise OpenTokException(
@@ -418,7 +428,7 @@ def create_session(
                 raise OpenTokException(
                     "archive_name must be between 1 and 80 characters in length."
                 )
-        
+
         if archive_resolution is not None:
             if archive_mode == ArchiveModes.manual:
                 raise OpenTokException(
@@ -631,13 +641,13 @@ def start_archive(
         }
 
         if layout is not None:
-            payload['layout'] = layout
+            payload["layout"] = layout
 
         logger.debug(
             "POST to %r with params %r, headers %r, proxies %r",
             self.endpoints.archive_url(),
             json.dumps(payload),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -683,7 +693,7 @@ def stop_archive(self, archive_id):
         logger.debug(
             "POST to %r with headers %r, proxies %r",
             self.endpoints.archive_url(archive_id) + "/stop",
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -718,7 +728,7 @@ def delete_archive(self, archive_id):
         logger.debug(
             "DELETE to %r with headers %r, proxies %r",
             self.endpoints.archive_url(archive_id),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -748,7 +758,7 @@ def get_archive(self, archive_id):
         logger.debug(
             "GET to %r with headers %r, proxies %r",
             self.endpoints.archive_url(archive_id),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -794,7 +804,7 @@ def get_archives(self, offset=None, count=None, session_id=None):
         logger.debug(
             "GET to %r with headers %r, proxies %r",
             endpoint,
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -942,7 +952,7 @@ def send_signal(self, session_id, payload, connection_id=None):
             "POST to %r with params %r, headers %r, proxies %r",
             self.endpoints.signaling_url(session_id, connection_id),
             json.dumps(payload),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -997,7 +1007,7 @@ def get_stream(self, session_id, stream_id):
         logger.debug(
             "GET to %r with headers %r, proxies %r",
             endpoint,
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1034,7 +1044,7 @@ def list_streams(self, session_id):
         logger.debug(
             "GET to %r with headers %r, proxies %r",
             endpoint,
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1072,7 +1082,7 @@ def force_disconnect(self, session_id, connection_id):
         logger.debug(
             "DELETE to %r with headers %r, proxies %r",
             endpoint,
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1134,7 +1144,7 @@ def set_archive_layout(
             "PUT to %r with params %r, headers %r, proxies %r",
             endpoint,
             json.dumps(payload),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1263,7 +1273,7 @@ def dial(self, session_id, token, sip_uri, options=[]):
             "POST to %r with params %r, headers %r, proxies %r",
             endpoint,
             json.dumps(payload),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1317,7 +1327,7 @@ class names (Strings) to apply to the stream. For example:
             "PUT to %r with params %r, headers %r, proxies %r",
             endpoint,
             json.dumps(items_payload),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1354,6 +1364,10 @@ def start_broadcast(
 
         :param String session_id: The session ID of the OpenTok session you want to broadcast
 
+        :param Boolean optional hasAudio: Whether the stream is broadcast with audio.
+
+        :param Boolean optional hasVideo: Whether the stream is broadcast with video.
+
         :param Dictionary options, with the following properties:
 
             Dictionary 'layout' optional: Specify this to assign the initial layout type for the
@@ -1414,18 +1428,18 @@ def start_broadcast(
         BroadcastStreamModes.manual to explicitly select streams to include in the the broadcast, using the
         OpenTok.add_broadcast_stream() and OpenTok.remove_broadcast_stream() methods.
 
-        :rtype A Broadcast object, which contains information of the broadcast: id, sessionId
+        :rtype A Broadcast object, which contains information of the broadcast: id, sessionId,
         projectId, createdAt, updatedAt, resolution, status and broadcastUrls
         """
 
-        if 'hls' in options['outputs']:
+        if "hls" in options["outputs"]:
             if (
-                'lowLatency' in options['outputs']['hls']
-                and 'dvr' in options['outputs']['hls']
+                "lowLatency" in options["outputs"]["hls"]
+                and "dvr" in options["outputs"]["hls"]
             ):
                 if (
-                    options['outputs']['hls']['lowLatency'] == True
-                    and options['outputs']['hls']['dvr'] == True
+                    options["outputs"]["hls"]["lowLatency"] == True
+                    and options["outputs"]["hls"]["dvr"] == True
                 ):
                     raise BroadcastHLSOptionsError(
                         'HLS options "lowLatency" and "dvr" cannot both be set to "True".'
@@ -1441,7 +1455,7 @@ def start_broadcast(
             "POST to %r with params %r, headers %r, proxies %r",
             endpoint,
             json.dumps(payload),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1484,7 +1498,7 @@ def stop_broadcast(self, broadcast_id):
         logger.debug(
             "POST to %r with headers %r, proxies %r",
             endpoint,
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1621,7 +1635,7 @@ def get_broadcast(self, broadcast_id):
         logger.debug(
             "GET to %r with headers %r, proxies %r",
             endpoint,
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1680,7 +1694,7 @@ def set_broadcast_layout(
             "PUT to %r with params %r, headers %r, proxies %r",
             endpoint,
             json.dumps(payload),
-            self.json_headers(),
+            self.get_json_headers(),
             self.proxies,
         )
 
@@ -1929,10 +1943,10 @@ def connect_audio_to_websocket(
     def validate_websocket_options(self, options):
         if type(options) is not dict:
             raise InvalidWebSocketOptionsError(
-                'Must pass WebSocket options as a dictionary.'
+                "Must pass WebSocket options as a dictionary."
             )
-        if 'uri' not in options:
-            raise InvalidWebSocketOptionsError('Provide a WebSocket URI.')
+        if "uri" not in options:
+            raise InvalidWebSocketOptionsError("Provide a WebSocket URI.")
 
     def _sign_string(self, string, secret):
         return hmac.new(
@@ -1974,9 +1988,9 @@ def mute_all(
 
         try:
             if excludedStreamIds:
-                options = {'active': True, 'excludedStreams': excludedStreamIds}
+                options = {"active": True, "excludedStreams": excludedStreamIds}
             else:
-                options = {'active': True, 'excludedStreams': []}
+                options = {"active": True, "excludedStreams": []}
 
             response = requests.post(
                 url, headers=self.get_headers(), data=json.dumps(options)
@@ -2012,7 +2026,7 @@ def disable_force_mute(self, session_id: str) -> requests.Response:
         :param session_id The session ID.
         """
 
-        options = {'active': False}
+        options = {"active": False}
         url = self.endpoints.get_mute_all_url(session_id)
 
         response = requests.post(
@@ -2162,9 +2176,9 @@ def mute_all(
 
         try:
             if excludedStreamIds:
-                options = {'active': True, 'excludedStreams': excludedStreamIds}
+                options = {"active": True, "excludedStreams": excludedStreamIds}
             else:
-                options = {'active': True, 'excludedStreams': []}
+                options = {"active": True, "excludedStreams": []}
 
             response = requests.post(
                 url, headers=self.get_headers(), data=json.dumps(options)
@@ -2198,7 +2212,7 @@ def disable_force_mute(self, session_id: str) -> requests.Response:
         :param session_id The session ID.
         """
 
-        options = {'active': False}
+        options = {"active": False}
         url = self.endpoints.get_mute_all_url(session_id)
 
         response = requests.post(