VariablePhotoSequenceCapture VariablePhotoSequenceCapture VariablePhotoSequenceCapture VariablePhotoSequenceCapture VariablePhotoSequenceCapture Class

Definition

Provides methods and events that enable the capture of variable photo sequences.

public : sealed class VariablePhotoSequenceCapture : IVariablePhotoSequenceCapture, IVariablePhotoSequenceCapture2
struct winrt::Windows::Media::Capture::Core::VariablePhotoSequenceCapture : IVariablePhotoSequenceCapture, IVariablePhotoSequenceCapture2
public sealed class VariablePhotoSequenceCapture : IVariablePhotoSequenceCapture, IVariablePhotoSequenceCapture2
Public NotInheritable Class VariablePhotoSequenceCapture Implements IVariablePhotoSequenceCapture, IVariablePhotoSequenceCapture2
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
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() FinishAsync()

Asynchronously releases the VariablePhotoSequenceCapture object and resources used by the capture operation.

public : IAsyncAction FinishAsync()
IAsyncAction FinishAsync() const;
public IAsyncAction FinishAsync()
Public Function FinishAsync() As IAsyncAction
Windows.Media.Capture.Core.VariablePhotoSequenceCapture.finishAsync().done( /* Your success and error handlers */ );
Returns

An asynchronous action.

StartAsync() StartAsync() StartAsync() StartAsync() StartAsync()

Starts the capturing of variable photo sequence frames.

public : IAsyncAction StartAsync()
IAsyncAction StartAsync() const;
public IAsyncAction StartAsync()
Public Function StartAsync() As IAsyncAction
Windows.Media.Capture.Core.VariablePhotoSequenceCapture.startAsync().done( /* Your success and error handlers */ );
Returns

An asynchronous action.

StopAsync() StopAsync() StopAsync() StopAsync() StopAsync()

Stops the capturing of variable photo sequence frames.

public : IAsyncAction StopAsync()
IAsyncAction StopAsync() const;
public IAsyncAction StopAsync()
Public Function StopAsync() As IAsyncAction
Windows.Media.Capture.Core.VariablePhotoSequenceCapture.stopAsync().done( /* Your success and error handlers */ );
Returns

An asynchronous action.

UpdateSettingsAsync() UpdateSettingsAsync() UpdateSettingsAsync() UpdateSettingsAsync() UpdateSettingsAsync()

Updates the frame control values of the variable photo sequence.

public : IAsyncAction UpdateSettingsAsync()
IAsyncAction UpdateSettingsAsync() const;
public IAsyncAction UpdateSettingsAsync()
Public Function UpdateSettingsAsync() As IAsyncAction
Windows.Media.Capture.Core.VariablePhotoSequenceCapture.updateSettingsAsync().done( /* Your success and error handlers */ );
Returns

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:

Events

PhotoCaptured PhotoCaptured PhotoCaptured PhotoCaptured PhotoCaptured

Occurs when a frame of a variable photo sequence is captured.

public : event TypedEventHandler PhotoCaptured<VariablePhotoSequenceCapture, VariablePhotoCapturedEventArgs>
// Register
event_token PhotoCaptured(TypedEventHandler<VariablePhotoSequenceCapture, VariablePhotoCapturedEventArgs> const& handler) const;

// Revoke with event_token
void PhotoCaptured(event_token const& cookie) const;

// Revoke with event_revoker
PhotoCaptured_revoker PhotoCaptured(auto_revoker_t, TypedEventHandler<VariablePhotoSequenceCapture, VariablePhotoCapturedEventArgs> const& handler) const;
public event TypedEventHandler PhotoCaptured<VariablePhotoSequenceCapture, VariablePhotoCapturedEventArgs>
Public Event TypedEventHandler PhotoCaptured( Of ( Of VariablePhotoSequenceCapture ), ( Of VariablePhotoCapturedEventArgs ))
function onPhotoCaptured(eventArgs){/* Your code */}


variablePhotoSequenceCapture.addEventListener("photoCaptured", onPhotoCaptured);
variablePhotoSequenceCapture.removeEventListener("photoCaptured", onPhotoCaptured);

Stopped Stopped Stopped Stopped Stopped

Occurs when the VariablePhotoSequenceCapture object stops capturing frames for a variable photo sequence.

public : event TypedEventHandler Stopped<VariablePhotoSequenceCapture, object>
// Register
event_token Stopped(TypedEventHandler<VariablePhotoSequenceCapture, object> const& handler) const;

// Revoke with event_token
void Stopped(event_token const& cookie) const;

// Revoke with event_revoker
Stopped_revoker Stopped(auto_revoker_t, TypedEventHandler<VariablePhotoSequenceCapture, object> const& handler) const;
public event TypedEventHandler Stopped<VariablePhotoSequenceCapture, object>
Public Event TypedEventHandler Stopped( Of ( Of VariablePhotoSequenceCapture ), ( Of object ))
function onStopped(eventArgs){/* Your code */}


variablePhotoSequenceCapture.addEventListener("stopped", onStopped);
variablePhotoSequenceCapture.removeEventListener("stopped", onStopped);

See Also