VoipCallCoordinator VoipCallCoordinator VoipCallCoordinator VoipCallCoordinator Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Allows an application to manage VoIP calls.

public : sealed class VoipCallCoordinator : IVoipCallCoordinatorpublic sealed class VoipCallCoordinator : IVoipCallCoordinatorPublic NotInheritable Class VoipCallCoordinator Implements IVoipCallCoordinator// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Methods

CancelUpgrade(Guid) CancelUpgrade(Guid) CancelUpgrade(Guid) CancelUpgrade(Guid)

Cancels the upgrade to a VoIP call.

public : void CancelUpgrade(PlatForm::Guid callUpgradeGuid)public void CancelUpgrade(Guid callUpgradeGuid)Public Function CancelUpgrade(callUpgradeGuid As Guid) As void// This API is not available in Javascript.
Parameters
callUpgradeGuid
PlatForm::Guid Guid Guid Guid

The GUID for the VoIP call.

Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

GetDefault() GetDefault() GetDefault() GetDefault()

Retrieves the default instance of the VoipCallCoordinator class.

public : static VoipCallCoordinator GetDefault()public static VoipCallCoordinator GetDefault()Public Static Function GetDefault() As VoipCallCoordinator// This API is not available in Javascript.
Returns
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Remarks

You can use this method to get the default instance of the VoipCallCoordinator class even if you do not define the required capability below. However, you will not be able to use the other methods of the VoipCallCoordinator object without defining the capability. The capability protects the service from running on the platform.

NotifyMuted() NotifyMuted() NotifyMuted() NotifyMuted()

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

public : void NotifyMuted()public void NotifyMuted()Public Function NotifyMuted() As void// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

NotifyUnmuted() NotifyUnmuted() NotifyUnmuted() NotifyUnmuted()

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

public : void NotifyUnmuted()public void NotifyUnmuted()Public Function NotifyUnmuted() As void// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

RequestIncomingUpgradeToVideoCall(String, String, String, Uri, String, Uri, String, Uri, TimeSpan) RequestIncomingUpgradeToVideoCall(String, String, String, Uri, String, Uri, String, Uri, TimeSpan) RequestIncomingUpgradeToVideoCall(String, String, String, Uri, String, Uri, String, Uri, TimeSpan) 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.

public : VoipPhoneCall RequestIncomingUpgradeToVideoCall(PlatForm::String context, PlatForm::String contactName, PlatForm::String contactNumber, Uri contactImage, PlatForm::String serviceName, Uri brandingImage, PlatForm::String callDetails, Uri ringtone, TimeSpan ringTimeout)public VoipPhoneCall RequestIncomingUpgradeToVideoCall(String context, String contactName, String contactNumber, Uri contactImage, String serviceName, Uri brandingImage, String callDetails, Uri ringtone, TimeSpan ringTimeout)Public Function RequestIncomingUpgradeToVideoCall(context As String, contactName As String, contactNumber As String, contactImage As Uri, serviceName As String, brandingImage As Uri, callDetails As String, ringtone As Uri, ringTimeout As TimeSpan) As VoipPhoneCall// This API is not available in Javascript.
Parameters
context
PlatForm::String String String String

A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file.

contactName
PlatForm::String String String String

The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters.

contactNumber
PlatForm::String String String String

The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters.

contactImage
Uri Uri Uri Uri

The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1 MB.

serviceName
PlatForm::String String String String

The name of the VoIP service or application. The maximum length is 128 characters.

brandingImage
Uri Uri Uri Uri

The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128 KB.

callDetails
PlatForm::String String String String

A string indicating who the call is on behalf of. The maximum length is 128 characters.

ringtone
Uri Uri Uri Uri

The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1 MB.

ringTimeout
TimeSpan TimeSpan TimeSpan TimeSpan

The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds.

Returns

The object representing the new incoming call.

Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

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

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

public : VoipPhoneCall RequestNewIncomingCall(PlatForm::String context, PlatForm::String contactName, PlatForm::String contactNumber, Uri contactImage, PlatForm::String serviceName, Uri brandingImage, PlatForm::String callDetails, Uri ringtone, VoipPhoneCallMedia media, TimeSpan ringTimeout)public VoipPhoneCall RequestNewIncomingCall(String context, String contactName, String contactNumber, Uri contactImage, String serviceName, Uri brandingImage, String callDetails, Uri ringtone, VoipPhoneCallMedia media, TimeSpan ringTimeout)Public Function RequestNewIncomingCall(context As String, contactName As String, contactNumber As String, contactImage As Uri, serviceName As String, brandingImage As Uri, callDetails As String, ringtone As Uri, media As VoipPhoneCallMedia, ringTimeout As TimeSpan) As VoipPhoneCall// This API is not available in Javascript.
Parameters
context
PlatForm::String String String String

A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null.

contactName
PlatForm::String String String String

The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters.

contactNumber
PlatForm::String String String String

The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters.

contactImage
Uri Uri Uri Uri

The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1MB.

serviceName
PlatForm::String String String String

The name of the VoIP service or application. The maximum length is 128 characters.

brandingImage
Uri Uri Uri Uri

The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128KB.

callDetails
PlatForm::String String String String

A string indicating who the call is on behalf of. The maximum length is 128 characters.

ringtone
Uri Uri Uri Uri

The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1MB.

media
VoipPhoneCallMedia VoipPhoneCallMedia VoipPhoneCallMedia VoipPhoneCallMedia

The media types of the new incoming call.

ringTimeout
TimeSpan TimeSpan TimeSpan TimeSpan

The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds.

Returns

The object representing the new incoming call.

Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

RequestNewOutgoingCall(String, String, String, VoipPhoneCallMedia) RequestNewOutgoingCall(String, String, String, VoipPhoneCallMedia) RequestNewOutgoingCall(String, String, String, VoipPhoneCallMedia) RequestNewOutgoingCall(String, String, String, VoipPhoneCallMedia)

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

public : VoipPhoneCall RequestNewOutgoingCall(PlatForm::String context, PlatForm::String contactName, PlatForm::String serviceName, VoipPhoneCallMedia media)public VoipPhoneCall RequestNewOutgoingCall(String context, String contactName, String serviceName, VoipPhoneCallMedia media)Public Function RequestNewOutgoingCall(context As String, contactName As String, serviceName As String, media As VoipPhoneCallMedia) As VoipPhoneCall// This API is not available in Javascript.
Parameters
context
PlatForm::String String String String

A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null.

contactName
PlatForm::String String String String

The name or ID of the caller which is displayed in the phone's minimized call UI. The maximum length is 128 characters.

serviceName
PlatForm::String String String String

The name of the VoIP service which is displayed in the phone's minimized call UI. The maximum length is 128 characters.

media
VoipPhoneCallMedia VoipPhoneCallMedia VoipPhoneCallMedia VoipPhoneCallMedia

The object representing the new outgoing call.

Returns

The object representing the new incoming call.

Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

RequestOutgoingUpgradeToVideoCall(Guid, String, String, String) RequestOutgoingUpgradeToVideoCall(Guid, String, String, String) RequestOutgoingUpgradeToVideoCall(Guid, String, String, String) RequestOutgoingUpgradeToVideoCall(Guid, String, String, String)

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

public : VoipPhoneCall RequestOutgoingUpgradeToVideoCall(PlatForm::Guid callUpgradeGuid, PlatForm::String context, PlatForm::String contactName, PlatForm::String serviceName)public VoipPhoneCall RequestOutgoingUpgradeToVideoCall(Guid callUpgradeGuid, String context, String contactName, String serviceName)Public Function RequestOutgoingUpgradeToVideoCall(callUpgradeGuid As Guid, context As String, contactName As String, serviceName As String) As VoipPhoneCall// This API is not available in Javascript.
Parameters
callUpgradeGuid
PlatForm::Guid Guid Guid Guid

The GUID of the call.

context
PlatForm::String String String String

A string that is passed to the associated foreground app as a deep link. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file.

contactName
PlatForm::String String String String

The name or ID of the caller which is displayed in the phone's minimized call UI. The maximum length is 128 characters.

serviceName
PlatForm::String String String String

The name of the VoIP service which is displayed in the phone's minimized call UI. The maximum length is 128 characters.

Returns

The object representing the new outgoing call.

Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

ReserveCallResourcesAsync(String) ReserveCallResourcesAsync(String) ReserveCallResourcesAsync(String) ReserveCallResourcesAsync(String)

Reserves the resources necessary for a VoIP call.

public : IAsyncOperation<VoipPhoneCallResourceReservationStatus> ReserveCallResourcesAsync(PlatForm::String taskEntryPoint)public IAsyncOperation<VoipPhoneCallResourceReservationStatus> ReserveCallResourcesAsync(String taskEntryPoint)Public Function ReserveCallResourcesAsync(taskEntryPoint As String) As IAsyncOperation( Of VoipPhoneCallResourceReservationStatus )// This API is not available in Javascript.
Parameters
taskEntryPoint
PlatForm::String String String String

The name of an application-defined class that performs the work of a background task. For more information, see TaskEntryPoint.

Returns
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

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

Prerelease. Sets up a newly accepted call.

public : VoipPhoneCall SetupNewAcceptedCall(PlatForm::String context, PlatForm::String contactName, PlatForm::String contactNumber, PlatForm::String serviceName, VoipPhoneCallMedia media)public VoipPhoneCall SetupNewAcceptedCall(String context, String contactName, String contactNumber, String serviceName, VoipPhoneCallMedia media)Public Function SetupNewAcceptedCall(context As String, contactName As String, contactNumber As String, serviceName As String, media As VoipPhoneCallMedia) As VoipPhoneCall// This API is not available in Javascript.
Parameters
context
PlatForm::String String String String

Information that is passed to the VOIP app's foreground UI process. This might be the contact name, or other data that helps the UI display more quickly.

contactName
PlatForm::String String String String

The name or ID of the caller.

contactNumber
PlatForm::String String String String

The phone number (if applicable) of the caller.

serviceName
PlatForm::String String String String

The name of the service or application.

media
VoipPhoneCallMedia VoipPhoneCallMedia VoipPhoneCallMedia VoipPhoneCallMedia

The type of call (audio/video or audio only).

Returns

Returns the call as a VoipPhoneCall object.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v2)
Capabilities
voipCall

Remarks

All string parameters have a maximum allowed length of 128 characters (including the terminator).

TerminateCellularCall(Guid) TerminateCellularCall(Guid) TerminateCellularCall(Guid) TerminateCellularCall(Guid)

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

public : void TerminateCellularCall(PlatForm::Guid callUpgradeGuid)public void TerminateCellularCall(Guid callUpgradeGuid)Public Function TerminateCellularCall(callUpgradeGuid As Guid) As void// This API is not available in Javascript.
Parameters
callUpgradeGuid
PlatForm::Guid Guid Guid Guid

The GUID for the VoIP call.

Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Events

MuteStateChanged MuteStateChanged MuteStateChanged MuteStateChanged

Raised when the mute status for the phone call changes.

public : event TypedEventHandler MuteStateChanged<VoipCallCoordinator,  MuteChangeEventArgs>public event TypedEventHandler MuteStateChanged<VoipCallCoordinator,  MuteChangeEventArgs>Public Event MuteStateChanged<VoipCallCoordinator,  MuteChangeEventArgs>// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall