MediaCapture.CreateFrameReaderAsync MediaCapture.CreateFrameReaderAsync MediaCapture.CreateFrameReaderAsync MediaCapture.CreateFrameReaderAsync MediaCapture.CreateFrameReaderAsync Method

Definition

Namespace:
Windows.Media.Capture Windows.Media.Capture Windows.Media.Capture Windows.Media.Capture Windows.Media.Capture
Assemblies:
Windows.Media.Capture.dll, Windows.dll

Overloads

CreateFrameReaderAsync(MediaFrameSource) CreateFrameReaderAsync(MediaFrameSource) CreateFrameReaderAsync(MediaFrameSource) CreateFrameReaderAsync(MediaFrameSource) CreateFrameReaderAsync(MediaFrameSource)

Creates a MediaFrameReader that is used to acquire frames from a MediaFrameSource.
CreateFrameReaderAsync(MediaFrameSource, String) CreateFrameReaderAsync(MediaFrameSource, String) CreateFrameReaderAsync(MediaFrameSource, String) CreateFrameReaderAsync(MediaFrameSource, String) CreateFrameReaderAsync(MediaFrameSource, String)

Creates a MediaFrameReader that is used to acquire frames with the specified media encoding subtype from a MediaFrameSource.
CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize) CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize) CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize) CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize) CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)

Creates a MediaFrameReader that is used to acquire frames with the specified media encoding subtype and size from a MediaFrameSource.

CreateFrameReaderAsync(MediaFrameSource) CreateFrameReaderAsync(MediaFrameSource) CreateFrameReaderAsync(MediaFrameSource) CreateFrameReaderAsync(MediaFrameSource) CreateFrameReaderAsync(MediaFrameSource)

Edit

Creates a MediaFrameReader that is used to acquire frames from a MediaFrameSource.

public : IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource)
IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource) const;
public IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource)
Public Function CreateFrameReaderAsync(inputSource As MediaFrameSource) As IAsyncOperation(Of MediaFrameReader)
Windows.Media.Capture.MediaCapture.createFrameReaderAsync(inputSource).done( /* Your success and error handlers */ );
Parameters
inputSource
MediaFrameSource MediaFrameSource MediaFrameSource

The media frame source from which the reader will acquire frames.

Returns
IAsyncOperation<MediaFrameReader> IAsyncOperation<MediaFrameReader> IAsyncOperation<MediaFrameReader>

An asynchronous operation that returns a MediaFrameReader on completion.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
backgroundMediaRecording

Examples

A MediaFrameReader created with this overload of the CreateFrameReaderAsync method returns frames for which the data is stored in a constrained pool of memory. When this pool of memory has been filled, no more frames will be read until you manually free previously obtained frames by calling Close (or Dispose in C#). The other two overloads of this method, CreateFrameReaderAsync(Windows.Media.Capture.Frames.MediaFrameSource inputSource, System.String outputSubtype, Windows.Graphics.Imaging.BitmapSize outputSize) and CreateFrameReaderAsync(Windows.Media.Capture.Frames.MediaFrameSource inputSource, System.String outputSubtype), return copies of the original frame data and so they do not cause frame acquisition to halt when they are retained.

See Also
CreateFrameReaderAsync(MediaFrameSource, String)CreateFrameReaderAsync(MediaFrameSource, String)CreateFrameReaderAsync(MediaFrameSource, String)CreateFrameReaderAsync(MediaFrameSource, String)CreateFrameReaderAsync(MediaFrameSource, String)
CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)

CreateFrameReaderAsync(MediaFrameSource, String) CreateFrameReaderAsync(MediaFrameSource, String) CreateFrameReaderAsync(MediaFrameSource, String) CreateFrameReaderAsync(MediaFrameSource, String) CreateFrameReaderAsync(MediaFrameSource, String)

Edit

Creates a MediaFrameReader that is used to acquire frames with the specified media encoding subtype from a MediaFrameSource.

public : IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource, Platform::String outputSubtype)
IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource, winrt::hstring outputSubtype) const;
public IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource, String outputSubtype)
Public Function CreateFrameReaderAsync(inputSource As MediaFrameSource, outputSubtype As String) As IAsyncOperation(Of MediaFrameReader)
Windows.Media.Capture.MediaCapture.createFrameReaderAsync(inputSource, outputSubtype).done( /* Your success and error handlers */ );
Parameters
inputSource
MediaFrameSource MediaFrameSource MediaFrameSource

The media frame source from which the reader will acquire frames.

outputSubtype
String String String

A string specifying the requested media encoding subtype for the frames acquired by the frame reader. This value must be one of the strings defined by the properties of the MediaEncodingSubtypes class.

Returns
IAsyncOperation<MediaFrameReader> IAsyncOperation<MediaFrameReader> IAsyncOperation<MediaFrameReader>

An asynchronous operation that returns a MediaFrameReader on completion.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
backgroundMediaRecording
See Also
CreateFrameReaderAsync(MediaFrameSource)CreateFrameReaderAsync(MediaFrameSource)CreateFrameReaderAsync(MediaFrameSource)CreateFrameReaderAsync(MediaFrameSource)CreateFrameReaderAsync(MediaFrameSource)
CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)

CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize) CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize) CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize) CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize) CreateFrameReaderAsync(MediaFrameSource, String, BitmapSize)

Edit

Creates a MediaFrameReader that is used to acquire frames with the specified media encoding subtype and size from a MediaFrameSource.

public : IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource, Platform::String outputSubtype, BitmapSize outputSize)
IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource, winrt::hstring outputSubtype, BitmapSize outputSize) const;
public IAsyncOperation<MediaFrameReader> CreateFrameReaderAsync(MediaFrameSource inputSource, String outputSubtype, BitmapSize outputSize)
Public Function CreateFrameReaderAsync(inputSource As MediaFrameSource, outputSubtype As String, outputSize As BitmapSize) As IAsyncOperation(Of MediaFrameReader)
Windows.Media.Capture.MediaCapture.createFrameReaderAsync(inputSource, outputSubtype, outputSize).done( /* Your success and error handlers */ );
Parameters
inputSource
MediaFrameSource MediaFrameSource MediaFrameSource

The media frame source from which the reader will acquire frames.

outputSubtype
String String String

A string specifying the requested media encoding subtype for the frames acquired by the frame reader. This value must be one of the strings defined by the properties of the MediaEncodingSubtypes class.

outputSize
BitmapSize BitmapSize BitmapSize

An object specifying the requested size for the frames acquired by the frame reader.

Returns
IAsyncOperation<MediaFrameReader> IAsyncOperation<MediaFrameReader> IAsyncOperation<MediaFrameReader>

An asynchronous operation that returns a MediaFrameReader on completion.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)
Capabilities
backgroundMediaRecording
See Also
CreateFrameReaderAsync(MediaFrameSource)CreateFrameReaderAsync(MediaFrameSource)CreateFrameReaderAsync(MediaFrameSource)CreateFrameReaderAsync(MediaFrameSource)CreateFrameReaderAsync(MediaFrameSource)
CreateFrameReaderAsync(MediaFrameSource, String)CreateFrameReaderAsync(MediaFrameSource, String)CreateFrameReaderAsync(MediaFrameSource, String)CreateFrameReaderAsync(MediaFrameSource, String)CreateFrameReaderAsync(MediaFrameSource, String)