SWI-7428 Add mode attribute to StartStream

Author: ajrice6713

bandwidth/models/bxml/verbs/start_stream.py

@@ -9,21 +9,23 @@
 
 from ..nestable_verb import NestableVerb
 from ..verbs.stream_param import StreamParam
+from ...streaming_mode_enum import StreamingModeEnum
 
 
 class StartStream(NestableVerb):
 
     def __init__(
         self, destination: str, stream_params: List[StreamParam] = [],
-        name: str=None, tracks: str=None,
+        name: str=None, mode: StreamingModeEnum=None, tracks: str=None,
         stream_event_url: str=None,
         stream_event_method: str=None,
         username: str=None, password: str=None,
     ):
-        """Initialize a <Transfer> verb
+        """Initialize a <StartStream> verb
 
         Args:
             name (str, optional): A name to refer to this stream by. Used when sending <StopStream>. If not provided, it will default to the generated stream id as sent in the Media Stream Started webhook.
+            mode (str, optional): The mode to use for the stream. unidirectional or bidirectional. Specifies whether the audio being streamed over the WebSocket is bidirectional (the service can both read and write audio over the WebSocket) or unidirectional (one-way, read-only). Default is unidirectional.
             tracks (str, optional): The part of the call to send a stream from. inbound, outbound or both. Default is inbound.
             destination (str, optional): A websocket URI to send the stream to. The audio from the specified tracks will be sent via websocket to this URL as base64-encoded PCMU/G711 audio. See below for more details on the websocket packet format.
             stream_event_url (str, optional): URL to send the associated Webhook events to during this stream's lifetime. Does not accept BXML. May be a relative URL.
@@ -38,6 +40,7 @@ def __init__(
         self.destination = destination
         self.stream_params = stream_params
         self.name = name
+        self.mode = mode
         self.tracks = tracks
         self.stream_event_url = stream_event_url
         self.stream_event_method = stream_event_method
@@ -53,6 +56,7 @@ def _attributes(self):
         return {
             "destination": self.destination,
             "name": self.name,
+            "mode": self.mode.value if self.mode else None,
             "tracks": self.tracks,
             "streamEventUrl": self.stream_event_url,
             "streamEventMethod": self.stream_event_method,

bandwidth/models/streaming_mode_enum.py

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+"""
+    Bandwidth
+
+    Bandwidth's Communication APIs
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: [email protected]
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class StreamingModeEnum(str, Enum):
+    """
+    The Mode to use when streaming audio over the WebSocket. unidirectional or bidirectional.
+    """
+
+    """
+    allowed enum values
+    """
+    UNIDIRECTIONAL = 'unidirectional'
+    BIDIRECTIONAL = 'bidirectional'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of StreamingModeEnum from a JSON string"""
+        return cls(json.loads(json_str))

test/unit/models/bxml/test_start_stream.py

@@ -7,6 +7,7 @@
 """
 import unittest
 
+from bandwidth.models.streaming_mode_enum import StreamingModeEnum
 from bandwidth.models.bxml import StartStream, StreamParam, Verb, NestableVerb
 
 
@@ -47,3 +48,8 @@ def test_add_verb(self):
         expected = '<StartStream destination="testurl.com" name="stream1" tracks="inbound" streamEventUrl="eventurl.com" streamEventMethod="POST" username="user" password="pass"><StreamParam name="name1" value="value1" /><StreamParam name="name2" value="value2" /></StartStream>'
         self.start_stream.add_verb(self.stream_param2)
         assert expected == self.start_stream.to_bxml()
+
+    def test_bidirectional(self):
+        self.start_stream.mode = StreamingModeEnum.BIDIRECTIONAL
+        expected = '<StartStream destination="testurl.com" name="stream1" mode="bidirectional" tracks="inbound" streamEventUrl="eventurl.com" streamEventMethod="POST" username="user" password="pass"><StreamParam name="name1" value="value1" /></StartStream>'
+        assert expected == self.start_stream.to_bxml()