Merge pull request #196 from opentok/selective_stream

Adding selective stream

Author: pardel

.bumpversion.cfg

@@ -1,6 +1,6 @@
 [bumpversion]
-current_version = 3.1.0
+current_version = 3.2.0
 commit = True
 tag = False
 
-[bumpversion:file:opentok/version.py]
+[bumpversion:file:opentok/version.py]

.github/workflows/ot.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.5, 3.6, 3.7, 3.8.8, 3.9]
+        python-version: [3.6, 3.7, 3.8.8, 3.9]
 
     steps:
     - uses: actions/checkout@v2

opentok/__init__.py

@@ -1,6 +1,6 @@
 from .opentok import OpenTok, Client, Roles, MediaModes, ArchiveModes
 from .session import Session
-from .archives import Archive, ArchiveList, OutputModes
+from .archives import Archive, ArchiveList, OutputModes, StreamModes
 from .exceptions import (
     OpenTokException,
     AuthError,
@@ -13,4 +13,4 @@
 from .stream import Stream
 from .streamlist import StreamList
 from .sip_call import SipCall
-from .broadcast import Broadcast
+from .broadcast import Broadcast, BroadcastStreamModes

opentok/archives.py

@@ -26,6 +26,15 @@ 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()
+    method."""
+
+    auto = u("auto")
+    """Streams are automatically added to the archive."""
+    manual = u("manual")
+    """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.
@@ -55,6 +64,14 @@ class Archive(object):
         Whether all streams in the archive are recorded to a single file
         (OutputModes.composed) or to individual files (OutputModes.individual).
 
+    :ivar streamMode:
+        Whether streams included in the archive are selected automatically
+        ("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".
+
     :ivar partner_id:
        The API key associated with the archive.
 
@@ -113,6 +130,8 @@ def __init__(self, sdk, values):
         self.has_audio = values.get("hasAudio")
         self.has_video = values.get("hasVideo")
         self.output_mode = OutputModes[values.get("outputMode", "composed")]
+        self.stream_mode = values.get("streamMode", StreamModes.auto)
+        self.streams = values.get("streams")
         self.url = values.get("url")
         self.resolution = values.get("resolution")
 

opentok/broadcast.py

@@ -1,9 +1,19 @@
 import json
+from enum import Enum
+from six import iteritems, u
 
 
 class Broadcast(object):
     """
-    Represents a live streaming broadcast
+    Represents a live streaming broadcast.
+
+    :ivar streamMode:
+        Whether streams included in the broadcast are selected automatically
+        ("auto", the default) or manually ("manual"). 
+    
+    :ivar streams:
+        A list of streams currently being broadcast. This is only set for a broadcast with
+        the status set to "started" and the stream_Mode set to "manual".
     """
 
     def __init__(self, kwargs):
@@ -15,9 +25,21 @@ def __init__(self, kwargs):
         self.resolution = kwargs.get("resolution")
         self.status = kwargs.get("status")
         self.broadcastUrls = kwargs.get("broadcastUrls")
+        self.stream_mode = kwargs.get("streamMode", BroadcastStreamModes.auto)
+        self.streams = kwargs.get("streams")
 
     def json(self):
         """
         Returns a JSON representation of the broadcast
         """
         return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True, indent=4)
+
+class BroadcastStreamModes(Enum):
+    """"List of valid settings for the stream_mode parameter of the OpenTok.start_broadcast()
+    method."""
+
+    auto = u("auto")
+    """Streams are automatically added to the broadcast."""
+    manual = u("manual")
+    """Streams are included in the broadcast based on calls to the OpenTok.add_broadcast_stream()
+    and OpenTok.remove_broadcast_stream() methods."""

opentok/endpoints.py

@@ -132,14 +132,24 @@ def get_broadcast_url(self, broadcast_id=None, stop=False, layout=False):
             url = url + "/layout"
         return url
 
-    def get_mute_all_url(self, session_id):
-        """ this method returns the urls for muting every stream in a session """
+    def get_archive_stream(self, archive_id=None):
+        """ this method returns urls for working with streamModes in archives """
         url = (
-             self.api_url  
-            + "/v2/project/" 
+            self.api_url
+            + "/v2/project/"
             + self.api_key
-            + "/session/"
-            + session_id
-            + "/mute"
+            + "archive/"
+            + archive_id
+            + "/streams"
+        )
 
-        )
+    def get_broadcast_stream(self, broadcast_id=None):
+        """ this method returns urls for working with streamModes in broadcasts """
+        url = (
+            self.api_url
+            + "/v2/partner/"
+            + self.api_key
+            + "broadcast/"
+            + broadcast_id
+            + "/streams"
+        )

opentok/exceptions.py

@@ -88,3 +88,18 @@ class BroadcastError(OpenTokException):
     """
 
     pass
+
+class ArchiveStreamModeError(OpenTokException):
+    """
+    Indicates that the archive is configured with a streamMode that does not support stream manipulation.
+    """
+
+    pass
+
+
+class BroadcastStreamModeError(OpenTokException):
+    """
+    Indicates that the broadcast is configured with a streamMode that does not support stream manipulation.
+    """
+
+    pass