Low​Lag​Photo​Sequence​Control Low​Lag​Photo​Sequence​Control Low​Lag​Photo​Sequence​Control Class

Definition

Provides functionality for managing the low shutter lag photo sequence mode on the capture device.

public : sealed class LowLagPhotoSequenceControl : ILowLagPhotoSequenceControlpublic sealed class LowLagPhotoSequenceControl : ILowLagPhotoSequenceControlPublic NotInheritable Class LowLagPhotoSequenceControl Implements ILowLagPhotoSequenceControl
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Photo sequence mode takes a rapid sequence of photos. A key scenario for photo sequence is getting photos in the past, that is prior to when the user takes a photo.

You can access the LowLagPhotoSequenceControl for the capture device through MediaCapture.VideoDeviceController.

You can find out if the device supports photo sequence mode by checking LowLagPhotoSequenceControl.Supported.

To initiate photo sequence mode, call MediaCapture.PrepareLowLagPhotoSequenceCaptureAsync. To start capturing photos, call StartAsync. To stop capturing photos, call StopAsync. The app will continue to receive photos from the device until the operation is stopped.

GetCurrentFrameRate specifies the frame rate at which the photos are taken.

PhotoCapturedEventArgs.CaptureTimeOffset can be used to tell whether a frame was in the future, greater than 0, or in the past, less than 0.

If the app wants to limit how many frames it gets per second, it can use LowLagPhotoSequence.PhotosPerSecondLimit. This can be useful in situations where the sensor on the device can handle 30fps, but the app only needs 4fps.

Thumbnails are supported for a low shutter lag single photos and photo sequences.

To enable thumbnails, set ThumbnailEnabled to true.

You can set the desired thumbnail size through DesiredThumbnailSize and set the thumbnail format through ThumbnailFormat.

The number of past photos cannot be more than MaxPastPhotos, which is the maximum number of past photos that is supported by the driver. The number of past photos returned will be the smaller of the following values: PastPhotoLimit, MaxPastPhotos, or the current number of available past photos.

Properties

DesiredThumbnailSize DesiredThumbnailSize DesiredThumbnailSize

Gets or sets the desired size for thumbnails, which is the largest length of the image, either width or height.

public : unsigned short DesiredThumbnailSize { get; set; }public uint DesiredThumbnailSize { get; set; }Public ReadWrite Property DesiredThumbnailSize As uint
Value
unsigned short uint uint

The desired thumbnail size.

Attributes
See Also

HardwareAcceleratedThumbnailSupported HardwareAcceleratedThumbnailSupported HardwareAcceleratedThumbnailSupported

Gets a value that specifies if hardware acceleration is supported for thumbnails in photo sequence mode.

public : unsigned short HardwareAcceleratedThumbnailSupported { get; }public uint HardwareAcceleratedThumbnailSupported { get; }Public ReadOnly Property HardwareAcceleratedThumbnailSupported As uint
Value
unsigned short uint uint

true if hardware acceleration is supported for thumbnails in photo sequence mode; otherwise, false.

Attributes
See Also

MaxPastPhotos MaxPastPhotos MaxPastPhotos

Gets the maximum number of past photos that can be stored.

public : unsigned short MaxPastPhotos { get; }public uint MaxPastPhotos { get; }Public ReadOnly Property MaxPastPhotos As uint
Value
unsigned short uint uint

The maximum number of past photos.

Attributes

Remarks

The PastPhotoLimit sets the actual number of past photos that are stored.

MaxPhotosPerSecond MaxPhotosPerSecond MaxPhotosPerSecond

Gets the maximum number of photos that can be taken per second.

public : float MaxPhotosPerSecond { get; }public float MaxPhotosPerSecond { get; }Public ReadOnly Property MaxPhotosPerSecond As float
Value
float float float

The maximum number of photos per second.

Attributes

Remarks

The PhotosPerSecondLimit sets the actual frame rate that photos are taken.

PastPhotoLimit PastPhotoLimit PastPhotoLimit

Gets or sets a value that specifies the number of past photos to store.

public : unsigned short PastPhotoLimit { get; set; }public uint PastPhotoLimit { get; set; }Public ReadWrite Property PastPhotoLimit As uint
Value
unsigned short uint uint

The number of past photos to store. To determine the maximum number of past photos that can be stored, check the MaxPastPhotos property.

Attributes

Remarks

To determine the maximum number of past photos that can be stored, check the MaxPastPhotos property.

The actual number of past photos cannot be more than MaxPastPhotos, which is the maximum number of past photos that is supported by the driver. The number of past photos returned will be the smaller of the following values: PastPhotoLimit, MaxPastPhotos, or the current number of available past photos.

PhotosPerSecondLimit PhotosPerSecondLimit PhotosPerSecondLimit

Gets or sets the number of photos that are taken per second.

public : float PhotosPerSecondLimit { get; set; }public float PhotosPerSecondLimit { get; set; }Public ReadWrite Property PhotosPerSecondLimit As float
Value
float float float

The number of photos taken per second.

Attributes

Remarks

To determine the maximum number photos per second supported by capture device, check the MaxPhotosPerSecond property.

Supported Supported Supported

Gets a value that specifies if the capture device supports low shutter lag photo sequence mode.

public : PlatForm::Boolean Supported { get; }public bool Supported { get; }Public ReadOnly Property Supported As bool
Value
PlatForm::Boolean bool bool

true if photo sequence mode is supported; otherwise, false.

Attributes

ThumbnailEnabled ThumbnailEnabled ThumbnailEnabled

Gets a value that enables and disables thumbnail support in photo sequence mode.

public : PlatForm::Boolean ThumbnailEnabled { get; set; }public bool ThumbnailEnabled { get; set; }Public ReadWrite Property ThumbnailEnabled As bool
Value
PlatForm::Boolean bool bool

true if thumbnails are enabled; otherwise, false.

Attributes

Remarks

Thumbnails are supported for a low shutter lag single photos and photo sequences.

To enable thumbnails, set ThumbnailEnabled to true.

You can set the desired thumbnail size through DesiredThumbnailSize and set the thumbnail format through ThumbnailFormat.

See Also

ThumbnailFormat ThumbnailFormat ThumbnailFormat

Gets or sets the media format for the thumbnails.

public : MediaThumbnailFormat ThumbnailFormat { get; set; }public MediaThumbnailFormat ThumbnailFormat { get; set; }Public ReadWrite Property ThumbnailFormat As MediaThumbnailFormat
Value
MediaThumbnailFormat MediaThumbnailFormat MediaThumbnailFormat

The media format for the thumbnails.

Attributes
See Also

Methods

GetCurrentFrameRate() GetCurrentFrameRate() GetCurrentFrameRate()

Gets the current frame rate at which pictures can be taken.

public : MediaRatio GetCurrentFrameRate()public MediaRatio GetCurrentFrameRate()Public Function GetCurrentFrameRate() As MediaRatio
Returns

The current frame rate.

Attributes

GetHighestConcurrentFrameRate(IMediaEncodingProperties) GetHighestConcurrentFrameRate(IMediaEncodingProperties) GetHighestConcurrentFrameRate(IMediaEncodingProperties)

Gets the highest frame rate supported when video and photos sequences are being captured concurrently.

public : MediaRatio GetHighestConcurrentFrameRate(IMediaEncodingProperties captureProperties)public MediaRatio GetHighestConcurrentFrameRate(IMediaEncodingProperties captureProperties)Public Function GetHighestConcurrentFrameRate(captureProperties As IMediaEncodingProperties) As MediaRatio
Parameters
captureProperties
IMediaEncodingProperties IMediaEncodingProperties IMediaEncodingProperties

The media encoding properties.

Returns

The highest concurrent frames per second.

Attributes

Remarks

The ConcurrentRecordAndPhotoSequenceSupported property on the MediaCapture class specifies if the capture device supports capturing videos and photo sequences at the same time.