MediaFrameReaderAcquisitionMode Enum

Definition

Namespace:

Windows.Media.Capture.Frames

Specifies the way that the system should manage frames acquired from a MediaFrameReader or a MultiSourceMediaFrameReader when a new frame arrives before the app has finished processing the previous frame.

public enum class MediaFrameReaderAcquisitionMode

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
enum class MediaFrameReaderAcquisitionMode

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
public enum MediaFrameReaderAcquisitionMode

var value = Windows.Media.Capture.Frames.MediaFrameReaderAcquisitionMode.realtime

Public Enum MediaFrameReaderAcquisitionMode

Inheritance

Enum

MediaFrameReaderAcquisitionMode

Attributes

ContractVersionAttribute

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)

Fields

Name	Value	Description
Realtime	0	Frames that arrive while the app's FrameArrived event handler is executing are dropped. This mode works well for scenarios where processing the most current frame is prioritized, such as real-time computer vision applications.
Buffered	1	Frames that arrive while the app's FrameArrived event handler is executing are buffered in memory by the system. The FrameArrived event is raised for each buffered frame when the event handler for the previous frame has completed. This mode is intended for apps for which the sequence of frames is critical and for which dropped frames will break the scenario. Note that once the system's memory limit for buffered frames has been reached, no more frames will be acquired until the app processes buffered frames, freeing memory for the acquisition of additional frames.

Remarks

Use a value from this enumeration when setting the MediaFrameReader.AcquisitionMode property or the MultiSourceMediaFrameReader.AcquisitionMode property.