Share via

AppBroadcastPlugInState Enum

  • Reference

Definition

Namespace:
Windows.Media.Capture
Edit

Specifies the current state of the broadcast background task.

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 enum class AppBroadcastPlugInState
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Media.Capture.AppBroadcastContract, 65536)]
enum class AppBroadcastPlugInState
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Media.Capture.AppBroadcastContract), 65536)]
public enum AppBroadcastPlugInState
var value = Windows.Media.Capture.AppBroadcastPlugInState.unknown
Public Enum AppBroadcastPlugInState
Inheritance
Enum
AppBroadcastPlugInState
Attributes
ContractVersionAttribute

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

Fields

Name Value Description
Unknown 0

The current state is unknown.
Initialized 1

The broadcast background task is initialized.
MicrosoftSignInRequired 2

The current user needs to be authenticated with the Microsoft service.
OAuthSignInRequired 3

The current user needs to be authenticated with the broadcast provider service.
ProviderSignInRequired 4

The broadcast background task needs to authenticate the current user with the broadcast provider service.
InBandwidthTest 5

The broadcast background task is in the process of testing the bandwidth of the device's connection to the broadcasting service provider. Once this test is complete, the system will set the AppBroadcastBackgroundServiceStreamInfo.BandwidthTestBitrate property to indicate the result of the bandwidth test.
ReadyToBroadcast 6

The broadcast background task is ready to broadcast.

Applies to