Captured​Frame Captured​Frame Captured​Frame Class

Definition

Represents a captured video frame.

public sealed class CapturedFrame : IClosable, ICapturedFrame, ICapturedFrameWithSoftwareBitmap, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentTypepublic sealed class CapturedFrame : IDisposable, ICapturedFrame, ICapturedFrameWithSoftwareBitmap, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentTypePublic NotInheritable Class CapturedFrame Implements IDisposable, ICapturedFrame, ICapturedFrameWithSoftwareBitmap, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentType
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

CanRead CanRead CanRead

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

public bool CanRead { get; }public bool CanRead { get; }Public ReadOnly Property CanRead As bool
Value
bool bool bool

true if the captured frame can be read from; otherwise, false.

Attributes

CanWrite CanWrite CanWrite

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

public bool CanWrite { get; }public bool CanWrite { get; }Public ReadOnly Property CanWrite As bool
Value
bool bool bool

true if the captured frame can be written to; otherwise, false.

Attributes

ContentType ContentType ContentType

Gets the content type of the captured frame.

public string ContentType { get; }public string ContentType { get; }Public ReadOnly Property ContentType As string
Value
string string string

The content type of the captured frame.

Attributes

Height Height Height

Gets the height of the captured frame

public uint Height { get; }public uint Height { get; }Public ReadOnly Property Height As uint
Value
uint uint uint

The height of the frame.

Attributes

Position Position Position

Gets the position of the captured frame.

public ulong Position { get; }public ulong Position { get; }Public ReadOnly Property Position As ulong
Value
ulong ulong ulong

The position of the captured frame.

Attributes

Size Size Size

Gets the size of the captured frame in bytes.

public ulong Size { get; set; }public ulong Size { get; set; }Public ReadWrite Property Size As ulong
Value
ulong ulong ulong

The size of the captured frame in bytes.

Attributes

SoftwareBitmap SoftwareBitmap SoftwareBitmap

Gets a SoftwareBitmap object representing the captured frame.

public SoftwareBitmap SoftwareBitmap { get; }public SoftwareBitmap SoftwareBitmap { get; }Public ReadOnly Property SoftwareBitmap As SoftwareBitmap
Value
SoftwareBitmap SoftwareBitmap SoftwareBitmap

A SoftwareBitmap object representing the captured frame.

Attributes

Width Width Width

Gets the width of the captured frame.

public uint Width { get; }public uint Width { get; }Public ReadOnly Property Width As uint
Value
uint uint uint

The width of the captured frame.

Attributes

Methods

CloneStream() CloneStream() CloneStream()

Creates a copy of the stream.

public IRandomAccessStream CloneStream()public IRandomAccessStream CloneStream()Public Function CloneStream() As IRandomAccessStream
Returns
Attributes

Close() Close() Close()

Closes the captured framed object.

public void Close()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

Dispose() Dispose() Dispose()

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

This member is not implemented in C++void Dispose()Sub Dispose
Attributes

FlushAsync() FlushAsync() FlushAsync()

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

public IAsyncOperation<bool> FlushAsync()public IAsyncOperation<bool> FlushAsync()Public Function FlushAsync() As IAsyncOperation( Of bool )
Returns

When this method completes, a boolean value is returned which specifies true if the operation completed successfully; otherwise, false.

Attributes

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

Gets the input stream at the specified position.

public IInputStream GetInputStreamAt(UInt64 position)public IInputStream GetInputStreamAt(UInt64 position)Public Function GetInputStreamAt(position As UInt64) As IInputStream
Parameters
position
System.UInt64 System.UInt64 System.UInt64

The position in the input stream.

Returns
Attributes

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

Gets the output stream at the specified position.

public IOutputStream GetOutputStreamAt(UInt64 position)public IOutputStream GetOutputStreamAt(UInt64 position)Public Function GetOutputStreamAt(position As UInt64) As IOutputStream
Parameters
position
System.UInt64 System.UInt64 System.UInt64

The position in the output stream.

Returns
Attributes

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

Returns an asynchronous byte reader object.

public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)Public Function ReadAsync(buffer As IBuffer, count As UInt32, options As InputStreamOptions) As IAsyncOperationWithProgress( Of IBuffer, uint )
Parameters
buffer
IBuffer IBuffer IBuffer

The buffer into which the asynchronous read operation places the bytes that are read.

count
System.UInt32 System.UInt32 System.UInt32

The number of bytes to read that is less than or equal to the Capacity value.

options
InputStreamOptions InputStreamOptions InputStreamOptions

Specifies the type of the asynchronous read operation.

Returns

The asynchronous operation.

Attributes

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

Seeks the stream to the specified position.

public void Seek(UInt64 position)public void Seek(UInt64 position)Public Function Seek(position As UInt64) As void
Parameters
position
System.UInt64 System.UInt64 System.UInt64

The position in the stream to seek too.

Attributes

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

Asynchronously writes the specified data to the stream.

public IAsyncOperationWithProgress<uint, uint> WriteAsync(IBuffer buffer)public IAsyncOperationWithProgress<uint, uint> WriteAsync(IBuffer buffer)Public Function WriteAsync(buffer As IBuffer) As IAsyncOperationWithProgress( Of uint, uint )
Parameters
buffer
IBuffer IBuffer IBuffer

The data to write to the stream.

Returns

Represents an asynchronous operation that returns a result and reports progress.

Attributes