Merge pull request #220 from opentok/dev

Add append to user agent function, add audio/video only broadcasts

Author: maxkahan

README.rst

@@ -421,6 +421,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': [{
@@ -477,6 +479,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
@@ -640,6 +673,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)