BarcodeScannerProviderConnection.CreateFrameReaderAsync Method

Definition

Overloads

CreateFrameReaderAsync()

Creates a new BarcodeScannerFrameReader instance.

CreateFrameReaderAsync(BitmapPixelFormat)

Creates a new BarcodeScannerFrameReader instance that returns frames in the preferred format when possible.

CreateFrameReaderAsync(BitmapPixelFormat, BitmapSize)

Creates a new BarcodeScannerFrameReader instance that returns frames in the preferred format and size when possible.

CreateFrameReaderAsync()

Creates a new BarcodeScannerFrameReader instance.

public:
 virtual IAsyncOperation<BarcodeScannerFrameReader ^> ^ CreateFrameReaderAsync() = CreateFrameReaderAsync;
/// [Windows.Foundation.Metadata.Overload("CreateFrameReaderAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<BarcodeScannerFrameReader> CreateFrameReaderAsync();
[Windows.Foundation.Metadata.Overload("CreateFrameReaderAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<BarcodeScannerFrameReader> CreateFrameReaderAsync();
function createFrameReaderAsync()
Public Function CreateFrameReaderAsync () As IAsyncOperation(Of BarcodeScannerFrameReader)

Returns

A new BarcodeScannerFrameReader instance that reads frames from this BarcodeScannerProviderConnection.

Attributes

Windows requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)

Applies to

CreateFrameReaderAsync(BitmapPixelFormat)

Creates a new BarcodeScannerFrameReader instance that returns frames in the preferred format when possible.

public:
 virtual IAsyncOperation<BarcodeScannerFrameReader ^> ^ CreateFrameReaderAsync(BitmapPixelFormat preferredFormat) = CreateFrameReaderAsync;
/// [Windows.Foundation.Metadata.Overload("CreateFrameReaderWithFormatAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<BarcodeScannerFrameReader> CreateFrameReaderAsync(BitmapPixelFormat const& preferredFormat);
[Windows.Foundation.Metadata.Overload("CreateFrameReaderWithFormatAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<BarcodeScannerFrameReader> CreateFrameReaderAsync(BitmapPixelFormat preferredFormat);
function createFrameReaderAsync(preferredFormat)
Public Function CreateFrameReaderAsync (preferredFormat As BitmapPixelFormat) As IAsyncOperation(Of BarcodeScannerFrameReader)

Parameters

preferredFormat
BitmapPixelFormat

The preferred image format as a BitmapPixelFormat.

Returns

A new BarcodeScannerFrameReader instance that reads frames from this BarcodeScannerProviderConnection.

Attributes

Windows requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)

Remarks

If the requested format cannot be returned by the camera, frames will be returned using a default supported format. To ensure that the returned frames conform to a particular format, check the Format property on the returned BarcodeScannerVideoFrame objects.

Applies to

CreateFrameReaderAsync(BitmapPixelFormat, BitmapSize)

Creates a new BarcodeScannerFrameReader instance that returns frames in the preferred format and size when possible.

public:
 virtual IAsyncOperation<BarcodeScannerFrameReader ^> ^ CreateFrameReaderAsync(BitmapPixelFormat preferredFormat, BitmapSize preferredSize) = CreateFrameReaderAsync;
/// [Windows.Foundation.Metadata.Overload("CreateFrameReaderWithFormatAndSizeAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<BarcodeScannerFrameReader> CreateFrameReaderAsync(BitmapPixelFormat const& preferredFormat, BitmapSize const& preferredSize);
[Windows.Foundation.Metadata.Overload("CreateFrameReaderWithFormatAndSizeAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<BarcodeScannerFrameReader> CreateFrameReaderAsync(BitmapPixelFormat preferredFormat, BitmapSize preferredSize);
function createFrameReaderAsync(preferredFormat, preferredSize)
Public Function CreateFrameReaderAsync (preferredFormat As BitmapPixelFormat, preferredSize As BitmapSize) As IAsyncOperation(Of BarcodeScannerFrameReader)

Parameters

preferredFormat
BitmapPixelFormat

The preferred image format as a BitmapPixelFormat.

preferredSize
BitmapSize

The preferred frame size as a BitmapSize in pixels.

Returns

A new BarcodeScannerFrameReader instance that reads frames from this BarcodeScannerProviderConnection.

Attributes

Windows requirements

Device family
Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v7.0)

Remarks

If the requested format or size cannot be returned by the camera, frames will be returned using a default supported format and/or size. To ensure that the returned frames conform to a particular format or size, check the Format, Height and Width properties on the returned BarcodeScannerVideoFrame objects.

Applies to