VariablePhotoSequenceCapture
VariablePhotoSequenceCapture
VariablePhotoSequenceCapture
VariablePhotoSequenceCapture
Class
Definition
Provides methods and events that enable the capture of variable photo sequences.
public : sealed class VariablePhotoSequenceCapture : IVariablePhotoSequenceCapture, IVariablePhotoSequenceCapture2public sealed class VariablePhotoSequenceCapture : IVariablePhotoSequenceCapture, IVariablePhotoSequenceCapture2Public NotInheritable Class VariablePhotoSequenceCapture Implements IVariablePhotoSequenceCapture, IVariablePhotoSequenceCapture2// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
Call the MediaCapture.PrepareVariablePhotoSequenceCaptureAsync method to obtain an instance of this class.
After starting a variable photo sequence capture, you must stop the variable photo sequence capture by calling StopAsync before your app attempts to record video with the MediaCapture object.
For how-to guidance for using VariablePhotoSequenceCapture, see Capture a photo sequence with VariablePhotoSequence.
Methods
FinishAsync() FinishAsync() FinishAsync() FinishAsync()
Asynchronously releases the VariablePhotoSequenceCapture object and resources used by the capture operation.
public : IAsyncAction FinishAsync()public IAsyncAction FinishAsync()Public Function FinishAsync() As IAsyncAction// You can use this method in JavaScript.
An asynchronous action.
StartAsync() StartAsync() StartAsync() StartAsync()
Starts the capturing of variable photo sequence frames.
public : IAsyncAction StartAsync()public IAsyncAction StartAsync()Public Function StartAsync() As IAsyncAction// You can use this method in JavaScript.
An asynchronous action.
StopAsync() StopAsync() StopAsync() StopAsync()
Stops the capturing of variable photo sequence frames.
public : IAsyncAction StopAsync()public IAsyncAction StopAsync()Public Function StopAsync() As IAsyncAction// You can use this method in JavaScript.
An asynchronous action.
UpdateSettingsAsync() UpdateSettingsAsync() UpdateSettingsAsync() UpdateSettingsAsync()
Updates the frame control values of the variable photo sequence.
public : IAsyncAction UpdateSettingsAsync()public IAsyncAction UpdateSettingsAsync()Public Function UpdateSettingsAsync() As IAsyncAction// You can use this method in JavaScript.
An asynchronous action.
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.
Events
PhotoCaptured PhotoCaptured PhotoCaptured PhotoCaptured
Occurs when a frame of a variable photo sequence is captured.
public : event TypedEventHandler PhotoCaptured<VariablePhotoSequenceCapture, VariablePhotoCapturedEventArgs>public event TypedEventHandler PhotoCaptured<VariablePhotoSequenceCapture, VariablePhotoCapturedEventArgs>Public Event PhotoCaptured<VariablePhotoSequenceCapture, VariablePhotoCapturedEventArgs>// You can use this event in JavaScript.
Stopped Stopped Stopped Stopped
Occurs when the VariablePhotoSequenceCapture object stops capturing frames for a variable photo sequence.
public : event TypedEventHandler Stopped<VariablePhotoSequenceCapture, object>public event TypedEventHandler Stopped<VariablePhotoSequenceCapture, object>Public Event Stopped<VariablePhotoSequenceCapture, object>// You can use this event in JavaScript.