Skip to main content

Windows Dev Center

TorchControl class

Provides functionality for controlling the torch LED settings on a capture device.

Syntax


var torchControl = VideoDeviceController.torchControl;

public sealed class TorchControl

Public NotInheritable Class TorchControl

public ref class TorchControl sealed 

Members

The TorchControl class has these types of members:

Methods

The TorchControl class inherits methods from the Object class (C#/VB/C++).

Properties

The TorchControl class has these properties.

PropertyAccess typeDescription

Enabled

Read/writeGets or sets a value that enables and disables the torch LED on the device.

PowerPercent

Read/writeGets or sets the intensity of the torch LED.

PowerSupported

Read-onlyGets a value that specifics if the device allows the torch LED power settings to be changed.

Supported

Read-onlyGets a value that specifies if the capture device supports the torch control.

 

Remarks

The TorchControl enables apps to manage the torch LED on a device. This can used in capture apps or in non-capture app to do things like brighten a room.

You can find out if a device supports this control by checking TorchControl.Supported.

You can access the TorchControl for the capture device through MediaCapture.VideoDeviceController.

Requirements (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Media.Devices
Windows::Media::Devices [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8.1 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Media.Devices
Windows::Media::Devices [C++]

Metadata

Windows.winmd

Attributes

[ DualApiPartition()]
[ MarshalingBehavior(Standard)]
[ Threading(MTA)]
[ Version(0x06030000)]

See also

Object
MediaCapture.VideoDeviceController