Share via


VoipPhoneCall.SetAssociatedCallControlDevices(IIterable<String>) Method

Definition

Sets the list of call control device IDs that are associated with the call. In the scenario where control of a call is desired to be transferred from one device to another (such as due to a change in audio endpoint), this allows the change to be made in a single transaction, rather than with sequential add and remove calls.

public:
 virtual void SetAssociatedCallControlDevices(IIterable<Platform::String ^> ^ associatedDeviceIds) = SetAssociatedCallControlDevices;
void SetAssociatedCallControlDevices(IIterable<winrt::hstring> const& associatedDeviceIds);
/// [Windows.Foundation.Metadata.Experimental]
void SetAssociatedCallControlDevices(IIterable<winrt::hstring> const& associatedDeviceIds);
public void SetAssociatedCallControlDevices(IEnumerable<string> associatedDeviceIds);
[Windows.Foundation.Metadata.Experimental]
public void SetAssociatedCallControlDevices(IEnumerable<string> associatedDeviceIds);
function setAssociatedCallControlDevices(associatedDeviceIds)
Public Sub SetAssociatedCallControlDevices (associatedDeviceIds As IEnumerable(Of String))

Parameters

associatedDeviceIds

IIterable<String>

IEnumerable<String>

IIterable<Platform::String>

IIterable<winrt::hstring>

The new list of call control devices to associate with the call. This replaces any existing list of associated devices. Must be non-null, and contain no duplicate IDs (otherwise returns E_INVALIDARG).

Attributes

Windows requirements

Device family
Windows 11, version 24H2 (introduced in 10.0.26100.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced in v5.0)
App capabilities
voipCall

Remarks

If this is the first time that the list has been set (including if it is being set to empty), then the call's IsUsingAssociatedDevicesList will be set to true, and only the given devices will be used going forward.

Applies to