Merge pull request #201 from opentok/dev

Version 3.2.0

Author: superchilled

.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

CHANGES.md

@@ -0,0 +1,158 @@
+# Release v3.2.0
+
+## Added
+
+- Mute all and mute stream functionality [#192](https://github.com/opentok/Opentok-Python-SDK/pull/192), [#197](https://github.com/opentok/Opentok-Python-SDK/pull/197), [#199](https://github.com/opentok/Opentok-Python-SDK/pull/199)
+- Added selective stream feature to `Archive` and `Broadcast` objects. [#196](https://github.com/opentok/Opentok-Python-SDK/pull/196)
+- Added PlayDTMF functionality to `SipCall` object [#194](https://github.com/opentok/Opentok-Python-SDK/pull/194)
+- Added SIP video outbound flag to `SipCall.dial` method [#194](https://github.com/opentok/Opentok-Python-SDK/pull/194)
+- Added the ObserveForceMute flag to `SipCall.dial` method [#193](https://github.com/opentok/Opentok-Python-SDK/pull/193)
+
+# 3.2.0b1
+
+## Added
+
+- Added mute/muteall functionality
+
+# Release v3.1.0
+
+## Added
+
+* #188 - Added support for archive layouts, as well as the new `screenshareType` option for screenshare layouts
+
+# Release v3.0.1
+
+# Changes
+
+- Fixed `readme.rst` not displaying properly on Pypi
+
+Thank you for your support and we are definitely excited to release even more exciting updates!! Stay tuned!!
+
+# Release v3.0.0
+
+# 🎉   Version 3.0 Changes
+
+- Verb to Noun format to make the SDK code more human-readable and maintain consistency with industry standard
+- Renamed the Opentok class to Client to ensure compliance with best practice and industry standards
+- Improved JWT generation
+- Improved error handling
+- Fixed Enum34 related issues
+
+# v2.11.0
+
+Fixing issues with Enum34.
+
+# Release v2.10.0
+
+- Add Broadcast APIs
+Thanks @normanargueta!
+
+# Release v2.9.0
+
+- Added SIP Dial API
+- Added Set Stream Class Lists API
+
+Thanks @normanargueta!
+
+# Release v2.8.0
+
+- List Archives filtration by sessionId (#137 )
+- Added Update Archive Layout functionality (#139)
+
+# Release v2.7.0
+
+Added `resolution` parameter for `start_archive`
+Added `signal` API
+Added `force_disconnect` API
+Added `get_stream` API
+Added `list_streams` API
+
+Thanks @normanargueta and @maikthomas
+
+# Release v2.6.0
+
+- Add timeout option to opentok constructor (#117, #57 Thanks @tylergould!)
+
+# Release v2.5.1
+
+Changes:
+
+- Exceptions now inherit from `Exception` instead of `BaseException` (#115, thanks @fernandogrd)
+
+As well as:
+
+- Update archive documentation (#80)
+- Document the `initial_layout_class_list` param for the `generate_token` function (#112)
+- Refactor sample app (#111)
+
+# Release v2.5.0
+
+This updates includes the following changes:
+
+- [Adds support for the `initial_layout_class_list` field in tokens](https://github.com/opentok/Opentok-Python-SDK/pull/77)
+- [Adds support for JWT `X-OPENTOK-AUTH` header, replacing the deprecated `X-TB-PARTNER-AUTH` header](https://github.com/opentok/Opentok-Python-SDK/pull/86)
+- [Updates the REST API endpoint URL to use `/project/` replacing the deprecated `/partner/`](https://github.com/opentok/Opentok-Python-SDK/pull/105)
+- [Only include connection data in generated token if it's been defined](https://github.com/opentok/Opentok-Python-SDK/pull/106)
+- [Ensure backwards compatibility with Python 2.6](https://github.com/opentok/Opentok-Python-SDK/pull/91)
+- [Removes Python 3.2 from supported version because it's not supported by our dependency](https://github.com/opentok/Opentok-Python-SDK/pull/105)
+
+As well as:
+
+- [Updates JS code in samples to use latest API and best practices](https://github.com/opentok/Opentok-Python-SDK/pull/108)
+- [Fix broken image paths in sample](https://github.com/opentok/Opentok-Python-SDK/pull/104)
+
+# Release v2.5.0b1
+
+This update adds support for the `initial_layout_class_list` field in tokens.
+
+# Release v2.4.1
+
+This update adds version information to the User-Agent string for analytics (#78)
+
+# Release v2.4.0
+
+This update adds proxy configuration as a feature of the OpenTok object. (thanks @juandebravo!)
+
+Here is an example of using proxy configuration:
+
+``` python
+from opentok import OpenTok
+
+opentok = OpenTok(api_key, api_secret)
+opentok.proxies = {
+  "http": "http://10.10.1.10:3128",
+  "https": "http://10.10.1.10:1080",
+}
+session = opentok.create_session()
+```
+
+The format for the proxy configuration is identical to the format used by the underlying [requests](http://docs.python-requests.org/en/latest/user/advanced/#proxies) library.
+
+# Release v2.3.0
+
+New archiving features:
+-  Automatically archived sessions -- See the `archive_mode` parameter of the `opentok.create_session()` method and the `ArchiveModes` class.
+-  Audio-only or video-only archives -- See the `has_audio` and `has_video` parameters of the `opentok.start_archive()` method.
+-  Individual archiving -- See the `output_mode` parameter of the `opentok.start_archive()` method and the `OutputModes` class.
+-  Paused archives -- When no clients are publishing to a session being archived, its status changes to "paused". See `archive.status`.
+
+Other improvements:
+-  Adds Python 3.4 support
+
+# Release v2.2.1
+
+The default setting for the `create_session()` method is to create a session with the media mode set
+to relayed. In previous versions of the SDK, the default setting was to use the OpenTok Media Router
+(media mode set to routed). In a relayed session, clients will attempt to send streams directly
+between each other (peer-to-peer); if clients cannot connect due to firewall restrictions, the
+session uses the OpenTok TURN server to relay audio-video streams.
+
+# Release v2.2.0
+
+This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
+work with OpenTok 1.0 archives.)
+
+The `OpenTok.create_session()` method now includes a `media_mode` parameter, instead of a `p2p` parameter.
+
+For details, see the reference documentation at
+http://www.tokbox.com/opentok/libraries/server/python/reference/index.html.

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.
@@ -34,7 +43,7 @@ class Archive(object):
        The time at which the archive was created, in milliseconds since the UNIX epoch.
 
     :ivar duration:
-       The duration of the archive, in milliseconds.
+       The duration of the archive, in seconds.
 
     :ivar has_audio:
        Boolean value set to true when the archive contains an audio track,
@@ -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

@@ -130,6 +130,7 @@ def get_broadcast_url(self, broadcast_id=None, stop=False, layout=False):
             url = url + "/stop"
         if layout:
             url = url + "/layout"
+            
         return url
 
     def get_mute_all_url(self, session_id):
@@ -142,4 +143,60 @@ def get_mute_all_url(self, session_id):
             + session_id
             + "/mute"
 
-        )
+        )
+
+        return url
+
+    def get_dtmf_all_url(self, session_id):
+        """ this method returns the url for Play DTMF to all clients in the session """
+        url = (
+            self.api_url
+            + "/v2/project/" 
+            + self.api_key
+            + "/session/"
+            + session_id
+            + "/play-dtmf"
+        )
+
+        return url
+
+    def get_dtmf_specific_url(self, session_id, connection_id):
+        """ this method returns the url for Play DTMF to a specific client connection"""
+        url = (
+            self.api_url
+            + "/v2/project/"
+            + self.api_key
+            + "/session/"
+            + session_id
+            + "/connection/"
+            + connection_id
+            + "/play-dtmf"
+        )
+
+        return url
+
+    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_key
+            + "archive/"
+            + archive_id
+            + "/streams"
+        )
+
+        return url
+
+    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"
+        )
+
+        return url

opentok/exceptions.py

@@ -88,3 +88,23 @@ class BroadcastError(OpenTokException):
     """
 
     pass
+
+class DTMFError(OpenTokException):
+    """
+    Indicates that one of the properties digits, session_id or connection_id is invalid
+    """
+
+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