VariablePhotoSequenceCapture.UpdateSettingsAsync Method

Definition

Namespace:

Windows.Media.Capture.Core

Updates the frame control values of the variable photo sequence.

public:
 virtual IAsyncAction ^ UpdateSettingsAsync() = UpdateSettingsAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction UpdateSettingsAsync();

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction UpdateSettingsAsync();

function updateSettingsAsync()

Public Function UpdateSettingsAsync () As IAsyncAction

Returns

IAsyncAction

An asynchronous action.

Attributes

RemoteAsyncAttribute

Remarks

This method allows you to efficiently perform multiple variable photo sequence captures with different sets of frame controller values. An instance of VariablePhotoSequenceController is initially obtained with a call to MediaCapture.PrepareVariablePhotoSequenceCaptureAsync. Frame controller values for each frame are registered by appending a FrameController to the DesiredFrameControllers collection. After making an initial variable photo sequence capture, you can change the values of the properties of the frame controllers in the DesiredFrameControllers collection and then call UpdateSettingsAsync to have the system register the new frame controller values with the driver.

This method has the following restrictions:

• This method can't be called while a variable photo sequence capture is in progress. Attempting to call this method between a call to VariablePhotoSequence.StartAsync and the subsequent call to VariablePhotoSequence.StopAsync will result in an invalid request error.
• This method can't be called after the variable photo sequence capture has been deinitialized with a call to VariablePhotoSequence.FinishAsync. Doing so will result in an invalid request error. After calling FinishAsync, you must call PrepareVariablePhotoSequenceCaptureAsync again before calling UpdateSettingsAsync.
• The number of frame controllers must be the same for each variable photo sequence capture separated by calls to UpdateSettingsAsync. If you want to capture variable photo sequences with different numbers of frames, you must call FinishAsync and then call PrepareVariablePhotoSequenceCaptureAsync again to reinitialize the photo sequence capture.