CapturedFrame CapturedFrame CapturedFrame CapturedFrame CapturedFrame Class

Definition

Represents a captured video frame.

public : sealed class CapturedFrame : IClosable, ICapturedFrame, ICapturedFrameWithSoftwareBitmap, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentType
struct winrt::Windows::Media::Capture::CapturedFrame : IClosable, ICapturedFrame, ICapturedFrameWithSoftwareBitmap, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentType
public sealed class CapturedFrame : IDisposable, ICapturedFrame, ICapturedFrameWithSoftwareBitmap, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentType
Public NotInheritable Class CapturedFrame Implements IDisposable, ICapturedFrame, ICapturedFrameWithSoftwareBitmap, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentType
// 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

There are several different techniques for capturing photos using the MediaCapture class, including AdvancedPhotoCapture, LowLagPhotoCapture, LowLagPhotoSequenceCapture, and VariablePhotoSequenceCapture. Though the sets of APIs used for each of these techniques vary, ultimately they all return the captured photo to you in the form of a CapturedFrame object.

Properties

BitmapProperties BitmapProperties BitmapProperties BitmapProperties BitmapProperties

Gets an object containing bitmap properties for the CapturedFrame. These properties convey image metadata such as EXIF data.

CanRead CanRead CanRead CanRead CanRead

Gets a value that indicates if the captured frame can be read from.

CanWrite CanWrite CanWrite CanWrite CanWrite

Gets a value that indicates if the captured frame can be written to.

ContentType ContentType ContentType ContentType ContentType

Gets the content type of the captured frame.

ControlValues ControlValues ControlValues ControlValues ControlValues

Gets an object containing capture control metadata for the CapturedFrame. Capture controls adjust capture settings such as ISO and exposure.

Height Height Height Height Height

Gets the height of the captured frame

Position Position Position Position Position

Gets the position of the captured frame.

Size Size Size Size Size

Gets the size of the captured frame in bytes.

SoftwareBitmap SoftwareBitmap SoftwareBitmap SoftwareBitmap SoftwareBitmap

Gets a SoftwareBitmap object representing the captured frame.

Width Width Width Width Width

Gets the width of the captured frame.

Methods

CloneStream() CloneStream() CloneStream() CloneStream() CloneStream()

Creates a copy of the stream.

Close() Close() Close() Close() Close()

Closes the captured framed object.

Dispose() Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

FlushAsync() FlushAsync() FlushAsync() FlushAsync() FlushAsync()

Asynchronously commits and flushes all of the data of the CapturedFrame.

GetInputStreamAt(UInt64) GetInputStreamAt(UInt64) GetInputStreamAt(UInt64) GetInputStreamAt(UInt64) GetInputStreamAt(UInt64)

Gets the input stream at the specified position.

GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64)

Gets the output stream at the specified position.

ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions)

Returns an asynchronous byte reader object.

Seek(UInt64) Seek(UInt64) Seek(UInt64) Seek(UInt64) Seek(UInt64)

Seeks the stream to the specified position.

WriteAsync(IBuffer) WriteAsync(IBuffer) WriteAsync(IBuffer) WriteAsync(IBuffer) WriteAsync(IBuffer)

Asynchronously writes the specified data to the stream.

See Also