add channel affinity property to start recording (#30346)

* add channel affinity property to start recording

* update participant name to match other sdks

* resolve merge issues with main

* pr comments

* pr comments

* update comment var name

* change order of comments

Author: ikumarapeli-msft

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

@@ -17,7 +17,8 @@
     AddParticipantResult,
     RemoveParticipantResult,
     TransferCallResult,
-    MediaStreamingConfiguration
+    MediaStreamingConfiguration,
+    ChannelAffinity
 )
 from ._shared.models import (
     CommunicationIdentifier,
@@ -53,6 +54,7 @@
     "ServerCallLocator",
     "GroupCallLocator",
     "FileSource",
+    "ChannelAffinity",
 
     # models for output
     "CallConnectionProperties",

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

@@ -401,6 +401,7 @@ def start_recording(
         recording_format_type: Optional[Union[str, 'RecordingFormat']] = None,
         audio_channel_participant_ordering: Optional[List['CommunicationIdentifier']] = None,
         recording_storage_type: Optional[Union[str, 'RecordingStorage']] = None,
+        channel_affinity: Optional[List['ChannelAffinity']] = None,
         external_storage_location: Optional[str] = None,
         **kwargs
     ) -> RecordingProperties:
@@ -427,13 +428,25 @@ def start_recording(
         :keyword recording_storage_type: Recording storage mode.
          ``External`` enables bring your own storage.
         :paramtype recording_storage_type: str
+        :keyword channel_affinity: The channel affinity of call recording
+         When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified,
+         'channel' will be automatically assigned.
+         Channel-Participant mapping details can be found in the metadata of the recording.
+        :paramtype channel_affinity: list[~azure.communication.callautomation.ChannelAffinity]
         :keyword external_storage_location: The location where recording is stored,
          when RecordingStorageType is set to 'BlobStorage'.
         :paramtype external_storage_location: str or ~azure.communication.callautomation.RecordingStorage
         :return: RecordingProperties
         :rtype: ~azure.communication.callautomation.RecordingProperties
         :raises ~azure.core.exceptions.HttpResponseError:
         """
+        channel_affinity_internal = []
+
+        if channel_affinity:
+            for channel in channel_affinity:
+                channel_affinity_internal.append(channel._to_generated(# pylint:disable=protected-access
+                    ))
+
         start_recording_request = StartCallRecordingRequest(
             call_locator=call_locator._to_generated(# pylint:disable=protected-access
             ),
@@ -444,6 +457,7 @@ def start_recording(
             audio_channel_participant_ordering = audio_channel_participant_ordering,
             recording_storage_type = recording_storage_type,
             external_storage_location = external_storage_location,
+            channel_affinity = channel_affinity_internal,
             repeatability_first_sent=get_repeatability_timestamp(),
             repeatability_request_id=get_repeatability_guid()
         )

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

@@ -8,7 +8,8 @@
     CallLocator,
     MediaStreamingConfiguration as MediaStreamingConfigurationRest,
     FileSource as FileSourceInternal,
-    PlaySource as PlaySourceInternal
+    PlaySource as PlaySourceInternal,
+    ChannelAffinity as ChannelAffinityInternal
 )
 from ._shared.models import (
     CommunicationIdentifier,
@@ -21,7 +22,8 @@
 from ._utils import (
     deserialize_phone_identifier,
     deserialize_identifier,
-    deserialize_comm_user_identifier
+    deserialize_comm_user_identifier,
+    serialize_identifier
 )
 if TYPE_CHECKING:
     from ._generated.models._enums  import (
@@ -134,6 +136,41 @@ def _to_generated(self):
         return CallLocator(kind=self.kind,
                            group_call_id=self.id)
 
+class ChannelAffinity(object):
+    """Channel affinity for a participant.
+
+    All required parameters must be populated in order to send to Azure.
+
+    :ivar target_participant: The identifier for the participant whose bitstream will be written to the
+     channel
+     represented by the channel number. Required.
+    :vartype target_participant: ~azure.communication.callautomation.CommunicationIdentifier
+    :ivar channel: Channel number to which bitstream from a particular participant will be written.
+    :vartype channel: int
+    """
+
+    def __init__(
+        self,
+        target_participant: CommunicationIdentifier,
+        channel: int,
+        **kwargs
+    ):
+        """
+        :keyword target_participant: The identifier for the participant whose bitstream will be written to the
+         channel
+         represented by the channel number. Required.
+        :paramtype target_participant: ~azure.communication.callautomation.CommunicationIdentifier
+        :keyword channel: Channel number to which bitstream from a particular participant will be
+         written.
+        :paramtype channel: int
+        """
+        super().__init__(**kwargs)
+        self.target_participant = target_participant
+        self.channel = channel
+
+    def _to_generated(self):
+        return ChannelAffinityInternal(participant= serialize_identifier(self.target_participant), channel=self.channel)
+
 class FileSource(object):
     """Media file source of URL to be played in action such as Play media.
 

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

@@ -402,6 +402,7 @@ async def start_recording(
         recording_format_type: Optional[Union[str, 'RecordingFormat']] = None,
         audio_channel_participant_ordering: Optional[List['CommunicationIdentifier']] = None,
         recording_storage_type: Optional[Union[str, 'RecordingStorage']] = None,
+        channel_affinity: Optional[List['ChannelAffinity']] = None,
         external_storage_location: Optional[str] = None,
         **kwargs
     ) -> RecordingProperties:
@@ -428,13 +429,25 @@ async def start_recording(
         :keyword recording_storage_type: Recording storage mode.
          ``External`` enables bring your own storage.
         :paramtype recording_storage_type: str
+        :keyword channel_affinity: The channel affinity of call recording
+         When 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified,
+         'channel' will be automatically assigned.
+         Channel-Participant mapping details can be found in the metadata of the recording.
+        :paramtype channel_affinity: list[~azure.communication.callautomation.ChannelAffinity]
         :keyword external_storage_location: The location where recording is stored,
          when RecordingStorageType is set to 'BlobStorage'.
         :paramtype external_storage_location: str or ~azure.communication.callautomation.RecordingStorage
         :return: RecordingProperties
         :rtype: ~azure.communication.callautomation.RecordingProperties
         :raises ~azure.core.exceptions.HttpResponseError:
         """
+        channel_affinity_internal = []
+
+        if channel_affinity:
+            for channel in channel_affinity:
+                channel_affinity_internal.append(channel._to_generated(# pylint:disable=protected-access
+                    ))
+
         start_recording_request = StartCallRecordingRequest(
             call_locator=call_locator._to_generated(# pylint:disable=protected-access
             ),
@@ -445,6 +458,7 @@ async def start_recording(
             audio_channel_participant_ordering = audio_channel_participant_ordering,
             recording_storage_type = recording_storage_type,
             external_storage_location = external_storage_location,
+            channel_affinity = channel_affinity_internal,
             repeatability_first_sent=get_repeatability_timestamp(),
             repeatability_request_id=get_repeatability_guid()
         )

sdk/communication/azure-communication-callautomation/tests/test_call_recording_client.py

@@ -7,7 +7,7 @@
 
 from azure.core.credentials import AzureKeyCredential
 from azure.communication.callautomation import (
-    CallAutomationClient, ServerCallLocator
+    CallAutomationClient, ServerCallLocator, ChannelAffinity, CommunicationUserIdentifier
 )
 from unittest_helpers import mock_response
 from unittest.mock import Mock
@@ -27,9 +27,10 @@ def mock_send(*_, **__):
         callautomation_client = CallAutomationClient("https://endpoint", AzureKeyCredential("fakeCredential=="), transport=Mock(send=mock_send))
 
         call_locator = ServerCallLocator(server_call_id = "locatorId")
-
+        target_participant = CommunicationUserIdentifier("testId")
+        channel_affinity=ChannelAffinity(target_participant=target_participant, channel=0)
         try:
-            callautomation_client.start_recording(call_locator=call_locator)
+            callautomation_client.start_recording(call_locator=call_locator, channel_affinity=[channel_affinity])
         except:
             raised = True
             raise