Share via


VoipCallCoordinator Class

Definition

Allows an application to manage VoIP calls.

public ref class VoipCallCoordinator sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Calls.CallsVoipContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class VoipCallCoordinator final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Calls.CallsVoipContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class VoipCallCoordinator
Public NotInheritable Class VoipCallCoordinator
Inheritance
Object Platform::Object IInspectable VoipCallCoordinator
Attributes

Windows requirements

Device family
Windows Mobile Extension SDK (introduced in 10.0.10240.0)
Windows 10 (introduced in 10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced in v1.0)
App capabilities
phoneCallHistory phoneCallHistorySystem voipCall

Remarks

Version history

Windows version SDK version Value added
1709 16299 SetupNewAcceptedCall
1803 17134 RequestNewAppInitiatedCall
1803 17134 RequestNewIncomingCall(String,String,String,Uri,String,Uri,String,Uri,VoipPhoneCallMedia,TimeSpan,String)
1809 17763 ReserveCallResourcesAsync

Methods

CancelUpgrade(Guid)

Cancels the upgrade to a VoIP call.

GetDefault()

Retrieves the default instance of the VoipCallCoordinator class.

GetDeviceSelectorForCallControl()

Returns an Advanced Query Syntax (AQS) string that you can use to enumerate all valid call control capable devices. You can pass the returned string to DeviceInformation.FindAllAsync or DeviceInformation.CreateWatcher. Valid devices are those of a VoipCallControlDeviceKind that's supported for association, and that's currently connected.

IsCallControlDeviceKindSupportedForAssociation(VoipCallControlDeviceKind)

Determines whether or not a given device kind is supported for association with calls in the current version of the VoIP calling platform.

NotifyMuted()

Notifies the system that the user has muted the call using the VoIP app's UI.

NotifyUnmuted()

Notifies the system that the user has unmuted the call using the VoIP app's UI.

RequestIncomingUpgradeToVideoCall(String, String, String, Uri, String, Uri, String, Uri, TimeSpan)

Makes a request to the system for an incoming video call that will replace an existing call.

RequestNewAppInitiatedCall(String, String, String, String, VoipPhoneCallMedia)

Requests a new call object from the system. Call this method from your VoIP app to tell the system that there's a new incoming call, and that you want to host an incoming call notification for that new call.

RequestNewAppInitiatedCallWithOptions(AppInitiatedVoipPhoneCallOptions)

Requests a new call object from the system by using an AppInitiatedVoipPhoneCallOptions object. Call this method from your VoIP app to tell the system that there's a new incoming call, and that you want to host an incoming call notification for that new call.

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipPhoneCallMedia, TimeSpan, String)

Makes a request to the system for a new incoming call.

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipPhoneCallMedia, TimeSpan)

Makes a request to the system for a new incoming call.

RequestNewIncomingCallWithOptions(IncomingVoipPhoneCallOptions)

Requests a new call object from the system by using an IncomingVoipPhoneCallOptions object. Call this method from your VoIP app to tell the system that there's a new incoming call, and that you want to host an incoming call notification for that new call.

RequestNewOutgoingCall(String, String, String, VoipPhoneCallMedia)

Makes a request to the system for a new outgoing call.

RequestNewOutgoingCallWithOptions(OutgoingVoipPhoneCallOptions)

Requests a new call object from the system by using an OutgoingVoipCallOptions object. Call this method from your VoIP app to tell the system that there's a new outgoing call.

RequestOutgoingUpgradeToVideoCall(Guid, String, String, String)

Makes a request of the system to create an outgoing video call that will replace an existing cellular call.

ReserveCallResourcesAsync()

Important

The need to reserve the CPU and memory resources necessary for a VoIP call is unique to the Universal Windows Platform (UWP) environment. For a desktop app, resource management isn't necessary, so you can omit any call to ReserveCallResourcesAsync.

Reserves the CPU and memory resources necessary for a VoIP call. You should use this method only in a single-process application model.

ReserveCallResourcesAsync(String)

Important

The need to reserve the CPU and memory resources necessary for a VoIP call is unique to the Universal Windows Platform (UWP) environment. For a desktop app, resource management isn't necessary, so you can omit any call to ReserveCallResourcesAsync.

Reserves the CPU and memory resources necessary for a VoIP call. You should use this method only in a two-process application model.

SetupNewAcceptedCall(String, String, String, String, VoipPhoneCallMedia)

Sets up a newly accepted call.

SetupNewAcceptedCallWithOptions(AcceptedVoipPhoneCallOptions)

Sets up a newly accepted call by using an AcceptedVoipPhoneCallOptions object.

TerminateCellularCall(Guid)

Terminates a cellular call in order to upgrade to a VoIP call.

Events

MuteStateChanged

Raised when the mute status for the phone call changes.

Applies to