Share via


InfraredTorchMode Enum

Definition

Defines the Infrared torch modes.

public enum class InfraredTorchMode
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 524288)]
enum class InfraredTorchMode
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 524288)]
public enum InfraredTorchMode
var value = Windows.Media.Devices.InfraredTorchMode.off
Public Enum InfraredTorchMode
Inheritance
InfraredTorchMode
Attributes

Windows requirements

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

Fields

Name Value Description
Off 0

“Off” mode means that the infrared LED is constantly off

On 1

“On” mode means that the infrared LED is constantly on

AlternatingFrameIllumination 2

“AlternatingFrameIllumination” mode means that the infrared LED is on for every other frame.

Remarks

Set the current infrared torch mode with the InfraredTorchControl.CurrentMode

Not all modes may be available on all devices. Check the InfraredTorchControl.SupportedModes property to determine what modes are supported on the current device.

Applies to

See also