Added interrupt hold audio flag for play media. (Azure#39552)

* Added interrupt hold audio flag for play media.

* added async changes.

* fixing the plint error

* fixing unit test failure and logic update

* fixing the test failures

---------

Co-authored-by: Vinothini Dharmaraj <[email protected]>

Author: v-pivamshi

sdk/communication/azure-communication-callautomation/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/communication/azure-communication-callautomation",
-  "Tag": "python/communication/azure-communication-callautomation_9df9dd8efa"
+  "Tag": "python/communication/azure-communication-callautomation_1f3ca63ba1"
 }

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_call_connection_client.py

@@ -384,6 +384,7 @@ def play_media(
         loop: bool = False,
         operation_context: Optional[str] = None,
         operation_callback_url: Optional[str] = None,
+        interrupt_hold_audio : bool = False,
         **kwargs
     ) -> None:
         """Play media to specific participant(s) in this call.
@@ -407,6 +408,9 @@ def play_media(
          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_hold_audio: If set, hold audio will be interrupted, then this request will be
+         played, and then the hold audio will be resumed.
+        :paramtype interrupt_hold_audio: bool
         :return: None
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -510,6 +514,7 @@ def _play_media(
         operation_context: Optional[str] = None,
         operation_callback_url: Optional[str] = None,
         interrupt_call_media_operation: Optional[bool] = False,
+        interrupt_hold_audio : bool = False,
         **kwargs
     ) -> None:
         """Play media to specific participant(s) in this call.
@@ -536,6 +541,9 @@ def _play_media(
         :keyword interrupt_call_media_operation: If set play can barge into other existing
          queued-up/currently-processing requests.
         :paramtype interrupt_call_media_operation: bool
+        :keyword interrupt_hold_audio: If set, hold audio will be interrupted, then this request will be
+         played, and then the hold audio will be resumed.
+        :paramtype interrupt_hold_audio: bool
         :return: None
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -550,11 +558,13 @@ def _play_media(
 
         audience = [] if play_to == "all" else [serialize_identifier(i) for i in play_to]
         interrupt_call_media_operation = interrupt_call_media_operation if play_to == "all" else False
+        interrupt_hold_audio = interrupt_hold_audio if play_to != "all" else False
         play_request = PlayRequest(
             play_sources=[play_source_single._to_generated()] if play_source_single else # pylint:disable=protected-access
             [source._to_generated() for source in play_sources] if play_sources else None,  # pylint:disable=protected-access
             play_to=audience,
-            play_options=PlayOptions(loop=loop,interrupt_call_media_operation=interrupt_call_media_operation),
+            play_options=PlayOptions(loop=loop,interrupt_call_media_operation=interrupt_call_media_operation,
+                                     interrupt_hold_audio=interrupt_hold_audio),
             operation_context=operation_context,
             operation_callback_uri=operation_callback_url,
             **kwargs,

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/aio/_call_connection_client_async.py

@@ -390,6 +390,7 @@ async def play_media(
         loop: bool = False,
         operation_context: Optional[str] = None,
         operation_callback_url: Optional[str] = None,
+        interrupt_hold_audio : bool = False,
         **kwargs
     ) -> None:
         """Play media to specific participant(s) in this call.
@@ -413,6 +414,9 @@ async def play_media(
          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_hold_audio: If set, hold audio will be interrupted, then this request will be
+         played, and then the hold audio will be resumed.
+        :paramtype interrupt_hold_audio: bool
         :return: None
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -503,6 +507,8 @@ async def play_media(
             loop=loop,
             operation_context=operation_context,
             operation_callback_url=operation_callback_url,
+            interrupt_call_media_operation=kwargs.get("interrupt_call_media_operation", False),
+            interrupt_hold_audio=kwargs.get("interrupt_hold_audio", False),
             **kwargs,
         )
 
@@ -517,6 +523,7 @@ async def _play_media(
         operation_context: Optional[str] = None,
         operation_callback_url: Optional[str] = None,
         interrupt_call_media_operation: Optional[bool] = None,
+        interrupt_hold_audio : bool = False,
         **kwargs,
     ) -> None:
         """Play media to specific participant(s) in this call.
@@ -543,6 +550,9 @@ async def _play_media(
         :keyword interrupt_call_media_operation: If set play can barge into other existing
          queued-up/currently-processing requests.
         :paramtype interrupt_call_media_operation: bool
+        :keyword interrupt_hold_audio: If set, hold audio will be interrupted, then this request will be
+         played, and then the hold audio will be resumed.
+        :paramtype interrupt_hold_audio: bool
         :return: None
         :rtype: None
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -557,11 +567,13 @@ async def _play_media(
 
         audience = [] if play_to == "all" else [serialize_identifier(i) for i in play_to]
         interrupt_call_media_operation = interrupt_call_media_operation if play_to == "all" else False
+        interrupt_hold_audio = interrupt_hold_audio if play_to != "all" else False
         play_request = PlayRequest(
             play_sources=[play_source_single._to_generated()] if play_source_single else # pylint:disable=protected-access
             [source._to_generated() for source in play_sources] if play_sources else None, # pylint:disable=protected-access
             play_to=audience,
-            play_options=PlayOptions(loop=loop, interrupt_call_media_operation=interrupt_call_media_operation),
+            play_options=PlayOptions(loop=loop, interrupt_call_media_operation=interrupt_call_media_operation,
+                                     interrupt_hold_audio=interrupt_hold_audio),
             operation_context=operation_context,
             operation_callback_uri=operation_callback_url,
             **kwargs,

sdk/communication/azure-communication-callautomation/swagger/SWAGGER.md

@@ -17,7 +17,7 @@ autorest SWAGGER.md
 
 ```yaml
 tag: package-2024-09-01-preview
-require: https://github.com/Azure/azure-rest-api-specs/blob/d1bedfa9c084a2e3f9cbeb075c532d691c3c0095/specification/communication/data-plane/CallAutomation/readme.md
+require: https://github.com/Azure/azure-rest-api-specs/blob/c8d14e82887409318f471cb17d2fa03844e8187f/specification/communication/data-plane/CallAutomation/readme.md
 output-folder: ../azure/communication/callautomation/_generated
 models-mode: msrest
 namespace: azure.communication.callautomation

sdk/communication/azure-communication-callautomation/tests/events/test_e2e_media_client.pyTestMediaAutomatedLiveTesttest_play_combined_file_and_text_sources_with_play_media.event.json

@@ -1 +1 @@
-{"IncomingCall": {"to": {"kind": "communicationUser", "rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-471b-21c8-e3c7-593a0d004196", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-471b-21c8-e3c7-593a0d004196"}}, "from": {"kind": "communicationUser", "rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-471b-20b3-ec8d-084822007116", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-471b-20b3-ec8d-084822007116"}}, "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwd2UtMDQtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi80elFwU2I5bUtrMlB6YldkRXEyVWZBP2k9MTAtNjAtMjAtMTQ4JmU9NjM4NzMzNDkyMzI3OTE0NTI1", "callerDisplayName": "REDACTED", "incomingCallContext": "REDACTED", "correlationId": "961e08cb-0692-4f9b-b888-81e5747bdcef"}, "ParticipantsUpdated": {"id": "8478a9fd-0d38-4b1c-8500-9aa922dd9a2b", "source": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87", "type": "Microsoft.Communication.ParticipantsUpdated", "data": {"participants": [{"identifier": {"rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-471b-20b3-ec8d-084822007116", "kind": "communicationUser", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-471b-20b3-ec8d-084822007116"}}, "isMuted": false, "isOnHold": false}, {"identifier": {"rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-471b-21c8-e3c7-593a0d004196", "kind": "communicationUser", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-471b-21c8-e3c7-593a0d004196"}}, "isMuted": false, "isOnHold": false}], "sequenceNumber": 5, "resultInformation": {"code": 200, "subCode": 0, "message": ""}, "version": "2024-09-01-preview", "callConnectionId": "05002580-af5f-48e5-9285-7869d1a95f87", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwd2UtMDQtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi80elFwU2I5bUtrMlB6YldkRXEyVWZBP2k9MTAtNjAtMjAtMTQ4JmU9NjM4NzMzNDkyMzI3OTE0NTI1", "correlationId": "961e08cb-0692-4f9b-b888-81e5747bdcef", "publicEventType": "Microsoft.Communication.ParticipantsUpdated"}, "time": "2025-01-27T10:06:10.1040753+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87"}, "CallConnected": {"id": "0d5ed915-5899-4559-8a06-6076e462e884", "source": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87", "type": "Microsoft.Communication.CallConnected", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 0, "message": ""}, "callConnectionId": "05002580-af5f-48e5-9285-7869d1a95f87", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwd2UtMDQtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi80elFwU2I5bUtrMlB6YldkRXEyVWZBP2k9MTAtNjAtMjAtMTQ4JmU9NjM4NzMzNDkyMzI3OTE0NTI1", "correlationId": "961e08cb-0692-4f9b-b888-81e5747bdcef", "publicEventType": "Microsoft.Communication.CallConnected"}, "time": "2025-01-27T10:05:59.5077041+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87"}, "PlayStarted": {"id": "5fad8636-b696-4fd9-be58-b0ad1175a4c5", "source": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87", "type": "Microsoft.Communication.PlayStarted", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 0, "message": "Action completed successfully."}, "callConnectionId": "05002580-af5f-48e5-9285-7869d1a95f87", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwd2UtMDQtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi80elFwU2I5bUtrMlB6YldkRXEyVWZBP2k9MTAtNjAtMjAtMTQ4JmU9NjM4NzMzNDkyMzI3OTE0NTI1", "correlationId": "961e08cb-0692-4f9b-b888-81e5747bdcef", "publicEventType": "Microsoft.Communication.PlayStarted"}, "time": "2025-01-27T10:06:03.780036+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87"}, "PlayCompleted": {"id": "e5f6e543-aa48-4a00-a5cf-783543d085b1", "source": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87", "type": "Microsoft.Communication.PlayCompleted", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 0, "message": "Action completed successfully."}, "callConnectionId": "05002580-af5f-48e5-9285-7869d1a95f87", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwd2UtMDQtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi80elFwU2I5bUtrMlB6YldkRXEyVWZBP2k9MTAtNjAtMjAtMTQ4JmU9NjM4NzMzNDkyMzI3OTE0NTI1", "correlationId": "961e08cb-0692-4f9b-b888-81e5747bdcef", "publicEventType": "Microsoft.Communication.PlayCompleted"}, "time": "2025-01-27T10:06:10.0835274+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87"}, "CallDisconnected": {"id": "f27b971c-7041-403e-9864-1efa1ff60a28", "source": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87", "type": "Microsoft.Communication.CallDisconnected", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 7000, "message": "The conversation has ended. DiagCode: 0#7000.@"}, "callConnectionId": "05002580-af5f-48e5-9285-7869d1a95f87", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwd2UtMDQtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi80elFwU2I5bUtrMlB6YldkRXEyVWZBP2k9MTAtNjAtMjAtMTQ4JmU9NjM4NzMzNDkyMzI3OTE0NTI1", "correlationId": "961e08cb-0692-4f9b-b888-81e5747bdcef", "publicEventType": "Microsoft.Communication.CallDisconnected"}, "time": "2025-01-27T10:06:11.6916704+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/05002580-af5f-48e5-9285-7869d1a95f87"}}
+{"IncomingCall": {"to": {"kind": "communicationUser", "rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-c9b0-24a8-99c6-593a0d009650", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-c9b0-24a8-99c6-593a0d009650"}}, "from": {"kind": "communicationUser", "rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-c9b0-243d-99c6-593a0d00964f", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-c9b0-243d-99c6-593a0d00964f"}}, "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzd2UtMDItcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9QczZ5SHJ5eHVVZVVFUkxpSm11MWlBP2k9MTAtNjAtNDQtMyZlPTYzODc1NTk4MTcwMDU1NzMxNw==", "callerDisplayName": "REDACTED", "incomingCallContext": "REDACTED", "correlationId": "29f2c302-d6e8-4f3f-9142-5d4fde2ca49e"}, "CallConnected": {"id": "647f8ad9-f8f8-4fc7-ba7b-011d233097e0", "source": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f", "type": "Microsoft.Communication.CallConnected", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 0, "message": ""}, "callConnectionId": "30002180-1462-4655-87d2-7f9e9608160f", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzd2UtMDItcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9QczZ5SHJ5eHVVZVVFUkxpSm11MWlBP2k9MTAtNjAtNDQtMyZlPTYzODc1NTk4MTcwMDU1NzMxNw==", "correlationId": "29f2c302-d6e8-4f3f-9142-5d4fde2ca49e", "publicEventType": "Microsoft.Communication.CallConnected"}, "time": "2025-02-21T18:39:23.6000425+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f"}, "ParticipantsUpdated": {"id": "6d03af99-5086-4f79-9e26-fec4e7192052", "source": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f", "type": "Microsoft.Communication.ParticipantsUpdated", "data": {"participants": [{"identifier": {"rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-c9b0-24a8-99c6-593a0d009650", "kind": "communicationUser", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-c9b0-24a8-99c6-593a0d009650"}}, "isMuted": false, "isOnHold": false}, {"identifier": {"rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-c9b0-243d-99c6-593a0d00964f", "kind": "communicationUser", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000025-c9b0-243d-99c6-593a0d00964f"}}, "isMuted": false, "isOnHold": false}], "sequenceNumber": 5, "resultInformation": {"code": 200, "subCode": 0, "message": ""}, "version": "2024-09-01-preview", "callConnectionId": "30002180-1462-4655-87d2-7f9e9608160f", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzd2UtMDItcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9QczZ5SHJ5eHVVZVVFUkxpSm11MWlBP2k9MTAtNjAtNDQtMyZlPTYzODc1NTk4MTcwMDU1NzMxNw==", "correlationId": "29f2c302-d6e8-4f3f-9142-5d4fde2ca49e", "publicEventType": "Microsoft.Communication.ParticipantsUpdated"}, "time": "2025-02-21T18:39:35.6435412+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f"}, "PlayStarted": {"id": "23384caf-60a7-490a-a7f6-79e42e835aad", "source": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f", "type": "Microsoft.Communication.PlayStarted", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 0, "message": "Action completed successfully."}, "callConnectionId": "30002180-1462-4655-87d2-7f9e9608160f", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzd2UtMDItcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9QczZ5SHJ5eHVVZVVFUkxpSm11MWlBP2k9MTAtNjAtNDQtMyZlPTYzODc1NTk4MTcwMDU1NzMxNw==", "correlationId": "29f2c302-d6e8-4f3f-9142-5d4fde2ca49e", "publicEventType": "Microsoft.Communication.PlayStarted"}, "time": "2025-02-21T18:39:29.2339624+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f"}, "PlayCompleted": {"id": "36b4d44a-02bf-4fa6-b13a-60d3e1ba2a20", "source": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f", "type": "Microsoft.Communication.PlayCompleted", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 0, "message": "Action completed successfully."}, "callConnectionId": "30002180-1462-4655-87d2-7f9e9608160f", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzd2UtMDItcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9QczZ5SHJ5eHVVZVVFUkxpSm11MWlBP2k9MTAtNjAtNDQtMyZlPTYzODc1NTk4MTcwMDU1NzMxNw==", "correlationId": "29f2c302-d6e8-4f3f-9142-5d4fde2ca49e", "publicEventType": "Microsoft.Communication.PlayCompleted"}, "time": "2025-02-21T18:39:35.6127383+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f"}, "CallDisconnected": {"id": "737018a6-a829-4480-8966-b906cc148be6", "source": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f", "type": "Microsoft.Communication.CallDisconnected", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 7000, "message": "The conversation has ended. DiagCode: 0#7000.@"}, "callConnectionId": "30002180-1462-4655-87d2-7f9e9608160f", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzd2UtMDItcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9QczZ5SHJ5eHVVZVVFUkxpSm11MWlBP2k9MTAtNjAtNDQtMyZlPTYzODc1NTk4MTcwMDU1NzMxNw==", "correlationId": "29f2c302-d6e8-4f3f-9142-5d4fde2ca49e", "publicEventType": "Microsoft.Communication.CallDisconnected"}, "time": "2025-02-21T18:39:36.2131072+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/30002180-1462-4655-87d2-7f9e9608160f"}}