VoipPhoneCall Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a VoIP phone call.
public ref class VoipPhoneCall sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.ApplicationModel.Calls.CallsVoipContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class VoipPhoneCall final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.ApplicationModel.Calls.CallsVoipContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class VoipPhoneCall
Public NotInheritable Class VoipPhoneCall
- Inheritance
- 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
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 |
Gets the media types used by the call. |
ContactName |
Gets or sets contact name associated with the VoIP call. |
StartTime |
Gets or sets the start time associated with the VoIP call. |
Methods
NotifyCallAccepted(VoipPhoneCallMedia) |
Notifies the system that the VoIP call has been accepted. |
NotifyCallActive() |
Notifies the system that the VoIP call is active. |
NotifyCallEnded() |
Notifies the system that the call has ended. |
NotifyCallHeld() |
Notifies the system that the call is currently on hold. |
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() |
Brings the VOIP app's user interface into the foreground after accepting a call. |
Events
AnswerRequested |
Raised when the user answers an incoming call. |
EndRequested |
Raised to alert the VoIP app that the call should be ended. |
HoldRequested |
Raised to alert the VoIP app that the call should be placed on hold. |
RejectRequested |
Raised when a call has been rejected. |
ResumeRequested |
Raised to indicate that a previously held VoIP call should be made active. |