WhiteBalanceControl WhiteBalanceControl WhiteBalanceControl WhiteBalanceControl WhiteBalanceControl Class

Definition

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

public : sealed class WhiteBalanceControl : IWhiteBalanceControl
struct winrt::Windows::Media::Devices::WhiteBalanceControl : IWhiteBalanceControl
public sealed class WhiteBalanceControl : IWhiteBalanceControl
Public NotInheritable Class WhiteBalanceControl Implements IWhiteBalanceControl
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 Max Max Max Max

Gets the maximum white balance value.

Min Min Min Min Min

Gets the minimum white balance value.

Preset Preset Preset Preset Preset

Gets the color temperature preset.

Step Step Step Step Step

Gets the step value.

Supported Supported Supported Supported Supported

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

Value Value Value Value Value

Gets the color temperature value.

Methods

SetPresetAsync(ColorTemperaturePreset) SetPresetAsync(ColorTemperaturePreset) SetPresetAsync(ColorTemperaturePreset) SetPresetAsync(ColorTemperaturePreset) SetPresetAsync(ColorTemperaturePreset)

Asynchronously sets the color temperature Preset.

SetValueAsync(UInt32) SetValueAsync(UInt32) SetValueAsync(UInt32) SetValueAsync(UInt32) SetValueAsync(UInt32)

Asynchronously sets the color temperature Value.

See Also