VoipPhoneCall VoipPhoneCall VoipPhoneCall VoipPhoneCall Class

Definition

Represents a VoIP phone call.

public : sealed class VoipPhoneCall
struct winrt::Windows::ApplicationModel::Calls::VoipPhoneCall
public sealed class VoipPhoneCall
Public NotInheritable Class VoipPhoneCall
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
phoneCallHistorySystem voipCall phoneCallHistory

Remarks

Call the VoipCallCoordinator.RequestNewAppInitiatedCall method to create a new VoipPhoneCall object. You can then use the VoipPhoneCall object to set up a new in-app call notification, and to handle events that the VoipPhoneCall raises.

If the user accepts the call, then your application should call NotifyCallAccepted. If the call is rejected or unanswered, then call NotifyCallEnded. Alternatively, the system itself can raise the AnswerRequested or RejectRequested events, and your VoIP application can handle those events in order to determine whether the user has accepted or rejected the incoming call via the HID device.

Version history

Windows version SDK version Value added
1709 16299 TryShowAppUI
1803 17134 NotifyCallAccepted

Properties

CallMedia CallMedia CallMedia CallMedia

Gets the media types used by the call.

ContactName ContactName ContactName ContactName

Gets or sets contact name associated with the VoIP call.

StartTime StartTime StartTime StartTime

Gets or sets the start time associated with the VoIP call.

Methods

NotifyCallAccepted(VoipPhoneCallMedia) NotifyCallAccepted(VoipPhoneCallMedia) NotifyCallAccepted(VoipPhoneCallMedia) NotifyCallAccepted(VoipPhoneCallMedia)

Notifies the system that the VoIP call has been accepted.

NotifyCallActive() NotifyCallActive() NotifyCallActive() NotifyCallActive()

Notifies the system that the VoIP call is active.

NotifyCallEnded() NotifyCallEnded() NotifyCallEnded() NotifyCallEnded()

Notifies the system that the call has ended.

NotifyCallHeld() NotifyCallHeld() NotifyCallHeld() NotifyCallHeld()

Notifies the system that the call is currently on hold.

NotifyCallReady() NotifyCallReady() NotifyCallReady() NotifyCallReady()

When upgrading a call from cellular to video, notifies the system that the app is done setting up the audio and video streams for the video call so that the system can end the existing cellular call.

TryShowAppUI() TryShowAppUI() TryShowAppUI() TryShowAppUI()

Brings the VOIP app's user interface into the foreground after accepting a call.

Events

AnswerRequested AnswerRequested AnswerRequested AnswerRequested

Raised when the user answers an incoming call.

EndRequested EndRequested EndRequested EndRequested

Raised to alert the VoIP app that the call should be ended.

HoldRequested HoldRequested HoldRequested HoldRequested

Raised to alert the VoIP app that the call should be placed on hold.

RejectRequested RejectRequested RejectRequested RejectRequested

Raised when a call has been rejected.

ResumeRequested ResumeRequested ResumeRequested ResumeRequested

Raised to indicate that a previously held VoIP call should be made active.