WhiteBalanceControl class

Applies to Windows and Windows Phone

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

Syntax


var whiteBalanceControl = VideoDeviceController.whiteBalanceControl;

Attributes

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

Members

The WhiteBalanceControl class has these types of members:

Methods

The WhiteBalanceControl class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
SetPresetAsync Asynchronously sets the color temperature Preset.
SetValueAsync Asynchronously sets the color temperature Value.

 

Properties

The WhiteBalanceControl class has these properties.

PropertyAccess typeDescription

Max

Read-onlyGets the maximum white balance value.

Min

Read-onlyGets the minimum white balance value.

Preset

Read-onlyGets the color temperature preset.

Step

Read-onlyGets the step value.

Supported

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

Value

Read-onlyGets the color temperature value.

 

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.

Requirements

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

See also

Object
MediaCapture.VideoDeviceController

 

 

Show:
© 2014 Microsoft