Skip to main content
WhiteBalanceControl.SetPresetAsync | setPresetAsync method

Asynchronously sets the color temperature Preset.

Syntax


whiteBalanceControl.setPresetAsync(preset).done( /* Your success and error handlers */ );

public IAsyncAction SetPresetAsync(
  ColorTemperaturePreset preset
)

Public Function SetPresetAsync(
  preset As ColorTemperaturePreset 
) As IAsyncAction

public:
IAsyncAction^ SetPresetAsync(
  ColorTemperaturePreset preset
)

Parameters

preset

Type: ColorTemperaturePreset

The color temperate preset to set the Preset property to.

Return value

Type: IAsyncAction

The object that is used to control the asynchronous operation.

Remarks

Adjusting the white balance is only supported while the preview stream is running. Check to make sure that the preview stream is running before setting the white balance value or preset.

The ColorTemperaturePreset.Auto preset value instructs the system to automatically adjust the white balance level. For some scenarios, such as capturing a photo sequence where the white balance levels should be the same for each frame, you may want to lock the control to the current automatic value. To do this, call SetPresetAsync and specify the Manual preset and do not set a value on the control using SetValueAsync. This will cause the device to lock the current value. Do not attempt to read the current control value and then pass the returned value into SetValueAsync because this value is not guaranteed to be correct.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

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

Minimum supported server

Windows Server 2012 R2

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

WhiteBalanceControl