AppBroadcastHeartbeatRequestedEventArgs Class

  • Reference

Definition

Namespace:
Windows.Media.Capture
Edit

Provides data for the AppBroadcastBackgroundService.HeartbeatRequested event which is raised by the system periodically to confirm that the broadcasting background task is currently active.

Note

This API requires the appBroadcast and appBroadcastSettings capability which is not available to all Windows apps. Unless your developer account is specially provisioned by Microsoft, calls to this API will fail at runtime.

public ref class AppBroadcastHeartbeatRequestedEventArgs sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Media.Capture.AppBroadcastContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AppBroadcastHeartbeatRequestedEventArgs final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Media.Capture.AppBroadcastContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AppBroadcastHeartbeatRequestedEventArgs
Public NotInheritable Class AppBroadcastHeartbeatRequestedEventArgs
Inheritance
Object Platform::Object IInspectable AppBroadcastHeartbeatRequestedEventArgs
Attributes
ContractVersionAttribute ThreadingAttribute

Windows requirements

Device family
Windows Desktop Extension SDK (introduced in 10.0.15063.0)
API contract
Windows.Media.Capture.AppBroadcastContract (introduced in v1.0)
App capabilities
appBroadcast appBroadcastSettings

Remarks

In the handler for the HeartbeatRequested event, set the Handled property to true to confirm that the broadcasting background task is currently active.

Properties

Handled

Gets or sets a value indicating whether the broadcasting background task is currently active.

Applies to