Share via

WhiteBalanceControl Class

  • Reference

Definition

Namespace:
Windows.Media.Devices
Edit

Provides functionality for controlling the white balance settings on a capture device.

public ref class WhiteBalanceControl sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class WhiteBalanceControl final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Standard)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
public sealed class WhiteBalanceControl
Public NotInheritable Class WhiteBalanceControl
Inheritance
Object Platform::Object IInspectable WhiteBalanceControl
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

The WhiteBalanceControl gives apps additional control over the white balance settings on a device. You can use one of the ColorTemperaturePreset values by calling SetPresetAsync. Or call SetValueAsync to set a specific Value between the Min and Max .

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

If the device does not support the WhiteBalanceControl, you can still use the WhiteBalance on the VideoCaptureDevice to set the value for the white balance color temperature.

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

White balance is specified as a color temperature in degrees Kelvin.

For how-to guidance for using the FocusControl, see Manual camera controls for photo and video capture.

Properties

Max

Gets the maximum white balance value.
Min

Gets the minimum white balance value.
Preset

Gets the color temperature preset.
Step

Gets the step value.
Supported

Gets a value that specifies if the capture device supports the white balance control.
Value

Gets the color temperature value.

Methods

SetPresetAsync(ColorTemperaturePreset)

Asynchronously sets the color temperature Preset.
SetValueAsync(UInt32)

Asynchronously sets the color temperature Value.

Applies to

See also