updating the comments

Vinothini Dharmaraj · Vinothini Dharmaraj · commit 55cb0768912e · 2024-06-18T09:34:37.000-07:00
diff --git a/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/__init__.py b/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/__init__.py
@@ -21,7 +21,9 @@
     RemoveParticipantResult,
     TransferCallResult,
     MediaStreamingOptions,
+    MediaStreamingSubscription,
     TranscriptionOptions,
+    TranscriptionSubscription,
     ChannelAffinity,
     MuteParticipantResult,
     SendDtmfTonesResult,
@@ -30,7 +32,11 @@
     ServerCallLocator,
     GroupCallLocator,
     AzureBlobContainerRecordingStorage,
-    AzureCommunicationsRecordingStorage
+    AzureCommunicationsRecordingStorage,
+    AudioMetadata,
+    AudioData,
+    TranscriptionMetadata,
+    TranscriptionData
 )
 from ._shared.models import (
     CommunicationIdentifier,
@@ -75,9 +81,15 @@
     "RecognitionChoice",
     "ChannelAffinity",
     "MediaStreamingOptions",
+    "MediaStreamingSubscription",
     "TranscriptionOptions",
-    'AzureBlobContainerRecordingStorage',
-    'AzureCommunicationsRecordingStorage',
+    "TranscriptionSubscription",
+    "AzureBlobContainerRecordingStorage",
+    "AzureCommunicationsRecordingStorage",
+    "AudioMetadata",
+    "AudioData",
+    "TranscriptionMetadata",
+    "TranscriptionData",
 
     # models for output
     "CallConnectionProperties",
diff --git a/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_call_connection_client.py b/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_call_connection_client.py
@@ -4,7 +4,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import TYPE_CHECKING, Optional, List, Union, Dict
+from typing import TYPE_CHECKING, Optional, List, Union, Dict, overload
 from urllib.parse import urlparse
 import warnings
 
@@ -411,7 +411,45 @@ def remove_participant(
 
         return RemoveParticipantResult._from_generated(response) # pylint:disable=protected-access
 
-    @distributed_trace
+    @overload
+    def play_media(
+        self,
+        play_source: Union[Union['FileSource', 'TextSource', 'SsmlSource'],
+                           List[Union['FileSource', 'TextSource', 'SsmlSource']]],
+        play_to: Union[Literal["all"], List['CommunicationIdentifier']] = 'all',
+        *,
+        loop: bool = False,
+        operation_context: Optional[str] = None,
+        operation_callback_url: Optional[str] = None,
+        **kwargs
+    ) -> None:
+        """Play media to specific participant(s) in this call.
+
+        :param play_source: A PlaySource representing the source to play.
+        :type play_source: ~azure.communication.callautomation.FileSource or
+         ~azure.communication.callautomation.TextSource or
+         ~azure.communication.callautomation.SsmlSource or
+         list[~azure.communication.callautomation.FileSource] or
+         list[~azure.communication.callautomation.TextSource] or
+         list[~azure.communication.callautomation.SsmlSource]
+        :param play_to: The targets to play media to. Default value is 'all', to play media
+         to all participants in the call.
+        :type play_to: list[~azure.communication.callautomation.CommunicationIdentifier]
+        :keyword loop: Whether the media should be repeated until cancelled.
+        :paramtype loop: bool
+        :keyword operation_context: Value that can be used to track this call and its associated events.
+        :paramtype operation_context: str or None
+        :keyword operation_callback_url: Set a callback URL that overrides the default callback URL set
+         by CreateCall/AnswerCall for this operation.
+         This setup is per-action. If this is not set, the default callback URL set by
+         CreateCall/AnswerCall will be used.
+        :paramtype operation_callback_url: str or None
+        :return: None
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
     def play_media(
         self,
         play_source: Union[Union['FileSource', 'TextSource', 'SsmlSource'],
@@ -452,13 +490,23 @@ def play_media(
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
         """
+
+    @distributed_trace
+    def play_media(
+        self,
+        play_source: Union[Union['FileSource', 'TextSource', 'SsmlSource'],
+                           List[Union['FileSource', 'TextSource', 'SsmlSource']]],
+        play_to: Union[Literal["all"], List['CommunicationIdentifier']] = 'all',
+        **kwargs
+    ) -> None:
+
         self._play_media(
             play_source=play_source,
             play_to=play_to,
-            loop=loop,
-            operation_context=operation_context,
-            operation_callback_url=operation_callback_url,
-            interrupt_call_media_operation=interrupt_call_media_operation,
+            loop=kwargs.pop("loop", False),
+            operation_context=kwargs.pop("operation_context", None),
+            operation_callback_url=kwargs.pop("operation_callback_url", None),
+            interrupt_call_media_operation=kwargs.pop("interrupt_call_media_operation", None),
             **kwargs
         )
 
@@ -1001,7 +1049,8 @@ def hold(
 
         hold_request=HoldRequest(
             target_participant=serialize_identifier(target_participant),
-            play_source_info=play_source_single._to_generated() if play_source_single else None,  # pylint:disable=protected-access
+            play_source_info=play_source_single._to_generated() # pylint:disable=protected-access
+            if play_source_single else None,
             operation_context=operation_context,
             operation_callback_uri=operation_callback_url,
             kwargs=kwargs
diff --git a/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/aio/_call_connection_client_async.py b/sdk/communication/azure-communication-callautomation/azure/communication/callautomation/aio/_call_connection_client_async.py
@@ -4,7 +4,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-from typing import TYPE_CHECKING, Optional, List, Union, Dict
+from typing import TYPE_CHECKING, Optional, List, Union, Dict, overload
 from urllib.parse import urlparse
 import warnings
 
@@ -416,7 +416,48 @@ async def remove_participant(
 
         return RemoveParticipantResult._from_generated(response) # pylint:disable=protected-access
 
-    @distributed_trace_async
+    @overload
+    async def play_media(
+        self,
+        play_source: Union[Union['FileSource', 'TextSource', 'SsmlSource'],
+                           List[Union['FileSource', 'TextSource', 'SsmlSource']]],
+        play_to: Union[Literal["all"], List['CommunicationIdentifier']] = 'all',
+        *,
+        loop: bool = False,
+        operation_context: Optional[str] = None,
+        operation_callback_url: Optional[str] = None,
+        **kwargs
+    ) -> None:
+        """Play media to specific participant(s) in this call.
+
+        :param play_source: A PlaySource representing the source to play.
+        :type play_source: ~azure.communication.callautomation.FileSource or
+         ~azure.communication.callautomation.TextSource or
+         ~azure.communication.callautomation.SsmlSource or
+         list[~azure.communication.callautomation.FileSource] or
+         list[~azure.communication.callautomation.TextSource] or
+         list[~azure.communication.callautomation.SsmlSource]
+        :param play_to: The targets to play media to. Default value is 'all', to play media
+         to all participants in the call.
+        :type play_to: list[~azure.communication.callautomation.CommunicationIdentifier]
+        :keyword loop: Whether the media should be repeated until cancelled.
+        :paramtype loop: bool
+        :keyword operation_context: Value that can be used to track this call and its associated events.
+        :paramtype operation_context: str or None
+        :keyword operation_callback_url: Set a callback URL that overrides the default callback URL set
+         by CreateCall/AnswerCall for this operation.
+         This setup is per-action. If this is not set, the default callback URL set by
+         CreateCall/AnswerCall will be used.
+        :paramtype operation_callback_url: str or None
+        :keyword interrupt_call_media_operation: If set play can barge into other existing
+         queued-up/currently-processing requests. This is applicable only when play_to set to all.
+        :paramtype interrupt_call_media_operation: bool
+        :return: None
+        :rtype: None
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+
+    @overload
     async def play_media(
         self,
         play_source: Union[Union['FileSource', 'TextSource', 'SsmlSource'],
@@ -457,13 +498,23 @@ async def play_media(
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
         """
+
+    @distributed_trace_async
+    async def play_media(
+        self,
+        play_source: Union[Union['FileSource', 'TextSource', 'SsmlSource'],
+                           List[Union['FileSource', 'TextSource', 'SsmlSource']]],
+        play_to: Union[Literal["all"], List['CommunicationIdentifier']] = 'all',
+        **kwargs
+    ) -> None:
+
         await self._play_media(
             play_source=play_source,
             play_to=play_to,
-            loop=loop,
-            operation_context=operation_context,
-            operation_callback_url=operation_callback_url,
-            interrupt_call_media_operation=interrupt_call_media_operation,
+            loop=kwargs.pop("loop", False),
+            operation_context=kwargs.pop("operation_context", None),
+            operation_callback_url=kwargs.pop("operation_callback_url", None),
+            interrupt_call_media_operation=kwargs.pop("interrupt_call_media_operation", None),
             **kwargs
         )
 
diff --git a/sdk/communication/azure-communication-callautomation/tests/test_call_media_client.py b/sdk/communication/azure-communication-callautomation/tests/test_call_media_client.py
@@ -121,6 +121,27 @@ def test_play_file_to_all_back_compat(self):
         self.assertEqual(expected_play_request.play_to, actual_play_request.play_to)
         self.assertEqual(expected_play_request.play_options, actual_play_request.play_options)
     
+    def test_play_file_back_compat_with_barge_in_play_media(self):
+        mock_play = Mock()
+        self.call_media_operations.play = mock_play
+        play_source = FileSource(url=self.url)
+
+        self.call_connection_client.play_media(play_source=play_source, interrupt_call_media_operation=True)
+
+        expected_play_request = PlayRequest(
+            play_sources=[play_source._to_generated()],
+            play_to=[],
+            play_options=PlayOptions(loop=False, interrupt_call_media_operation=True)
+        )
+        mock_play.assert_called_once()
+        actual_play_request = mock_play.call_args[0][1]
+
+        self.assertEqual(expected_play_request.play_sources[0].kind, actual_play_request.play_sources[0].kind)
+        self.assertEqual(expected_play_request.play_sources[0].file.uri, actual_play_request.play_sources[0].file.uri)
+        self.assertEqual(expected_play_request.play_sources[0].play_source_cache_id, actual_play_request.play_sources[0].play_source_cache_id)
+        self.assertEqual(expected_play_request.play_to, actual_play_request.play_to)
+        self.assertEqual(expected_play_request.play_options, actual_play_request.play_options)
+
     def test_play_file_to_all_back_compat_with_barge_in(self):
         mock_play = Mock()
         self.call_media_operations.play = mock_play
