LowLagPhotoSequenceControl LowLagPhotoSequenceControl LowLagPhotoSequenceControl LowLagPhotoSequenceControl Class

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

Syntax

Declaration

public sealed class LowLagPhotoSequenceControlpublic sealed class LowLagPhotoSequenceControlPublic NotInheritable Class LowLagPhotoSequenceControl

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 VideoDeviceController.

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

To initiate photo sequence mode, call PrepareLowLagPhotoSequenceCaptureAsync(Windows.Media.MediaProperties.ImageEncodingProperties). 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.

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 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 summary

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

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

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

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

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

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

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

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

Gets or sets the media format for the thumbnails.

Methods summary

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

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

Properties

  • DesiredThumbnailSize
    DesiredThumbnailSize
    DesiredThumbnailSize
    DesiredThumbnailSize

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

    public uint DesiredThumbnailSize { get; set; }public uint DesiredThumbnailSize { get; set; }Public ReadWrite Property DesiredThumbnailSize As uint

    Property Value

    • uint
      uint
      uint
      uint

      The desired thumbnail size.

  • HardwareAcceleratedThumbnailSupported
    HardwareAcceleratedThumbnailSupported
    HardwareAcceleratedThumbnailSupported
    HardwareAcceleratedThumbnailSupported

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

    public uint HardwareAcceleratedThumbnailSupported { get; }public uint HardwareAcceleratedThumbnailSupported { get; }Public ReadOnly Property HardwareAcceleratedThumbnailSupported As uint

    Property Value

    • uint
      uint
      uint
      uint

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

  • MaxPastPhotos
    MaxPastPhotos
    MaxPastPhotos
    MaxPastPhotos

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

    public uint MaxPastPhotos { get; }public uint MaxPastPhotos { get; }Public ReadOnly Property MaxPastPhotos As uint

    Property Value

    • uint
      uint
      uint
      uint

      The maximum number of past photos.

    Remarks

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

  • MaxPhotosPerSecond
    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

    Property Value

    • float
      float
      float
      float

      The maximum number of photos per second.

    Remarks

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

  • PastPhotoLimit
    PastPhotoLimit
    PastPhotoLimit
    PastPhotoLimit

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

    public uint PastPhotoLimit { get; set; }public uint PastPhotoLimit { get; set; }Public ReadWrite Property PastPhotoLimit As uint

    Property Value

    • uint
      uint
      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.

    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
    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

    Property Value

    • float
      float
      float
      float

      The number of photos taken per second.

    Remarks

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

  • Supported
    Supported
    Supported
    Supported

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

    public bool Supported { get; }public bool Supported { get; }Public ReadOnly Property Supported As bool

    Property Value

    • bool
      bool
      bool
      bool

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

  • ThumbnailEnabled
    ThumbnailEnabled
    ThumbnailEnabled
    ThumbnailEnabled

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

    public bool ThumbnailEnabled { get; set; }public bool ThumbnailEnabled { get; set; }Public ReadWrite Property ThumbnailEnabled As bool

    Property Value

    • bool
      bool
      bool
      bool

      true if thumbnails are enabled; otherwise, false.

    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.

  • ThumbnailFormat
    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

    Property Value

Methods

  • GetCurrentFrameRate()
    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

  • GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties)
    GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties)
    GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties)
    GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties)

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

    public MediaRatio GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties captureProperties)public MediaRatio GetHighestConcurrentFrameRate(Windows.Media.MediaProperties.IMediaEncodingProperties captureProperties)Public Function GetHighestConcurrentFrameRate(captureProperties As Windows.Media.MediaProperties.IMediaEncodingProperties) As MediaRatio

    Parameters

    Returns

    Remarks

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

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.Media.Devices.dll