Share via


HumanPresenceSettings Class

Definition

Represents the various human presence system settings.

public ref class HumanPresenceSettings sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 983040)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class HumanPresenceSettings final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 983040)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class HumanPresenceSettings
Public NotInheritable Class HumanPresenceSettings
Inheritance
Object Platform::Object IInspectable HumanPresenceSettings
Attributes

Windows requirements

Device family
Windows 11 Insider Preview (introduced in 10.0.23504.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v15.0)

Properties

DimmingOptions

Gets the adaptive dimming options for the human presence sensor.

IsAdaptiveDimmingEnabled

Gets or sets whether adaptive dimming is enabled.

IsAttentionAwareDimmingEnabled

This property is obsolete. For more information, see Remarks.

Gets or sets whether the human presence sensor can dim the screen of the PC when user interaction is not detected for a period of time.

IsLockOnLeaveEnabled

Gets or sets whether the human presence sensor can lock the PC if it detects the user has left it unattended.

IsWakeOnApproachEnabled

Gets or sets whether the human presence sensor can wake the PC if it detects the user is approaching.

LockOnLeaveDistanceInMillimeters

Gets or sets the distance a user must be from the human presence sensor for the PC to be considered unattended and automatically lock.

LockOnLeaveTimeout

Gets or sets the time interval a user must go undetected by the human presence sensor before the PC is considered unattended and automatically locked.

LockOptions

Gets the lock on leave options (whether a user is no longer detected by the human presence sensor) for the human presence sensor.

SensorId

Gets or sets the unique ID of the human presence sensor.

WakeOnApproachDistanceInMillimeters

Gets or sets the distance a user must be from the human presence sensor for the PC to automatically unlock.

WakeOptions

Gets the wake options (whether a user is detected by the human presence sensor) for the human presence sensor.

Methods

GetCurrentSettings()

Retrieves the current system settings for human presence detection.

GetCurrentSettingsAsync()

Asynchronously retrieves the current system settings for human presence detection.

GetSupportedFeaturesForSensorId(String)

Retrieves the features supported by the specified human presence sensor.

GetSupportedFeaturesForSensorIdAsync(String)

Asynchronously retrieves the features supported by the specified human presence sensor.

GetSupportedLockOnLeaveTimeouts()

Retrieves the collection of intervals (from the system settings) used to specify how much time should pass before locking the PC after a user is no longer detected.

UpdateSettings(HumanPresenceSettings)

Bulk updates various human presence system settings with the provided values.

UpdateSettingsAsync(HumanPresenceSettings)

Asynchronously updates various human presence system settings with the provided values.

Events

SettingsChanged

Occurs when a user changes any human presence setting.

Applies to

See also