WhiteBalanceControl.SetPresetAsync(ColorTemperaturePreset) Method

Reference

Definition

Namespace:: Windows.Media.Devices

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Asynchronously sets the color temperature Preset.

public:
 virtual IAsyncAction ^ SetPresetAsync(ColorTemperaturePreset preset) = SetPresetAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction SetPresetAsync(ColorTemperaturePreset const& preset);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction SetPresetAsync(ColorTemperaturePreset preset);

function setPresetAsync(preset)

Public Function SetPresetAsync (preset As ColorTemperaturePreset) As IAsyncAction

Parameters

preset: ColorTemperaturePreset

The color temperate preset to set the Preset property to.

Returns

IAsyncAction

The object that is used to control the asynchronous operation.

Attributes: RemoteAsyncAttribute

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.

Applies to