MiracastTransmitterAuthorizationStatus Enum

Reference

Definition

Namespace:: Windows.Media.Miracast

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.

Edit

Specifies the authorization status of a Miracast Transmitter.

public enum class MiracastTransmitterAuthorizationStatus

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 524288)]
enum class MiracastTransmitterAuthorizationStatus

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 524288)]
public enum MiracastTransmitterAuthorizationStatus

var value = Windows.Media.Miracast.MiracastTransmitterAuthorizationStatus.undecided

Public Enum MiracastTransmitterAuthorizationStatus

Inheritance: Enum
MiracastTransmitterAuthorizationStatus

Attributes: ContractVersionAttribute

Windows requirements

Device family	Windows 10, version 1903 (introduced in 10.0.18362.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v8.0)

Fields

Allowed	1	Connections from this transmitter are allowed.
AlwaysPrompt	2	Connections from this transmitter are allowed, but always ask the user to confirm a new connection.
Blocked	3	All connection attempts from this transmitter are automatically rejected.
Undecided	0	A decision has not yet been made about whether to allow or block this transmitter.

Remarks

When a new Miracast connection is received, MiracastReceiverAuthorizationMethod controls which type of authorization, if any, should be applied. (E.g., whether to display a PIN, or ask the user to approve the connection attempt.)

But the MiracastTransmitterAuthorizationStatus value can override the MiracastReceiverAuthorizationMethod. A value of MiracastTransmitterAuthorizationStatus.Blocked causes incoming connections from the specified Transmitter to be automatically rejected without prompting the user.

When the value is MiracastTransmitterAuthorizationStatus.Allowed, the effective MiracastReceiverAuthorizationMethod value becomes MiracastReceiverAuthorizationMethod.None, i.e., the user is not prompted and no PIN is displayed.

When the value is MiracastTransmitterAuthorizationStatus.AlwaysPrompt, the effective MiracastReceiverAuthorizationMethod value becomes MiracastReceiverAuthorizationMethod.ConfirmConnection, i.e., the user is prompted even if a PIN authorization is requested.

MiracastReceiverSettings.RequireAuthorizationFromKnownTransmitters overrides the above if the value has been set to true. In that case, values of MiracastTransmitterAuthorizationStatus.Allowed and MiracastTransmitterAuthorizationStatus.AlwaysPrompt are treated the same way as the value MiracastTransmitterAuthorizationStatus.Undecided, which means that the MiracastReceiverAuthorizationMethod value controls the authorization method.

Applies to