BarcodeScannerProviderConnection BarcodeScannerProviderConnection BarcodeScannerProviderConnection BarcodeScannerProviderConnection BarcodeScannerProviderConnection Class

Definition

Represents a connection to a barcode scanner provider client.

public : sealed class BarcodeScannerProviderConnection : IClosable
struct winrt::Windows::Devices::PointOfService::Provider::BarcodeScannerProviderConnection : IClosable
public sealed class BarcodeScannerProviderConnection : IDisposable
Public NotInheritable Class BarcodeScannerProviderConnection Implements IDisposable
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10, version 1803 (introduced v10.0.17134.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v6)

Remarks

Use the instance of this class provided by the Connection property of the BarcodeScannerProviderTriggerDetails object passed to your background task on activation.

Version history

Windows version SDK version Value added
1809 17763 CreateFrameReaderAsync
1809 17763 CreateFrameReaderAsync(BitmapPixelFormat)
1809 17763 CreateFrameReaderAsync(BitmapPixelFormat,BitmapSize)

Properties

CompanyName CompanyName CompanyName CompanyName CompanyName

Gets or sets the company name of the barcode scanner provider.

Id Id Id Id Id

Gets the ID of the barcode scanner provider connection.

Name Name Name Name Name

Gets or sets the name of the barcode scanner provider.

SupportedSymbologies SupportedSymbologies SupportedSymbologies SupportedSymbologies SupportedSymbologies

Gets the supported symbologies of the barcode scanner provider.

Version Version Version Version Version

Gets or sets the version of the barcode scanner provider.

VideoDeviceId VideoDeviceId VideoDeviceId VideoDeviceId VideoDeviceId

Gets the video device ID that represents the camera lens associated with the barcode scanner.

Methods

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

Closes the barcode scanner provider connection session.

CreateFrameReaderAsync() CreateFrameReaderAsync() CreateFrameReaderAsync() CreateFrameReaderAsync() CreateFrameReaderAsync()

Creates a new BarcodeScannerFrameReader instance.

CreateFrameReaderAsync(BitmapPixelFormat) CreateFrameReaderAsync(BitmapPixelFormat) CreateFrameReaderAsync(BitmapPixelFormat) CreateFrameReaderAsync(BitmapPixelFormat) CreateFrameReaderAsync(BitmapPixelFormat)

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

CreateFrameReaderAsync(BitmapPixelFormat, BitmapSize) CreateFrameReaderAsync(BitmapPixelFormat, BitmapSize) CreateFrameReaderAsync(BitmapPixelFormat, BitmapSize) CreateFrameReaderAsync(BitmapPixelFormat, BitmapSize) CreateFrameReaderAsync(BitmapPixelFormat, BitmapSize)

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

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

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

ReportErrorAsync(UnifiedPosErrorData) ReportErrorAsync(UnifiedPosErrorData) ReportErrorAsync(UnifiedPosErrorData) ReportErrorAsync(UnifiedPosErrorData) ReportErrorAsync(UnifiedPosErrorData)

Sends an error report to the client app.

ReportErrorAsync(UnifiedPosErrorData, Boolean, BarcodeScannerReport) ReportErrorAsync(UnifiedPosErrorData, Boolean, BarcodeScannerReport) ReportErrorAsync(UnifiedPosErrorData, Boolean, BarcodeScannerReport) ReportErrorAsync(UnifiedPosErrorData, Boolean, BarcodeScannerReport) ReportErrorAsync(UnifiedPosErrorData, Boolean, BarcodeScannerReport)

Sends an error report to the client app.

ReportScannedDataAsync(BarcodeScannerReport) ReportScannedDataAsync(BarcodeScannerReport) ReportScannedDataAsync(BarcodeScannerReport) ReportScannedDataAsync(BarcodeScannerReport) ReportScannedDataAsync(BarcodeScannerReport)

Sends a barcode scanner data report to the client app.

ReportTriggerStateAsync(BarcodeScannerTriggerState) ReportTriggerStateAsync(BarcodeScannerTriggerState) ReportTriggerStateAsync(BarcodeScannerTriggerState) ReportTriggerStateAsync(BarcodeScannerTriggerState) ReportTriggerStateAsync(BarcodeScannerTriggerState)

Sends a barcode scanner trigger state update to the client app during a scanning operation.

Start() Start() Start() Start() Start()

Starts the connection for data transfer.

Events

DisableScannerRequested DisableScannerRequested DisableScannerRequested DisableScannerRequested DisableScannerRequested

Raised when the client app attempts to disable the barcode scanner.

EnableScannerRequested EnableScannerRequested EnableScannerRequested EnableScannerRequested EnableScannerRequested

Raised when the client app attempts to enable the barcode scanner.

GetBarcodeSymbologyAttributesRequested GetBarcodeSymbologyAttributesRequested GetBarcodeSymbologyAttributesRequested GetBarcodeSymbologyAttributesRequested GetBarcodeSymbologyAttributesRequested

Raised when the client app attempts to get the attributes of a barcode symbology.

HideVideoPreviewRequested HideVideoPreviewRequested HideVideoPreviewRequested HideVideoPreviewRequested HideVideoPreviewRequested

Raised when the client app attempts to hide a video preview window.

SetActiveSymbologiesRequested SetActiveSymbologiesRequested SetActiveSymbologiesRequested SetActiveSymbologiesRequested SetActiveSymbologiesRequested

Raised when the client app attempts to set the barcode symbologies for the device to use.

SetBarcodeSymbologyAttributesRequested SetBarcodeSymbologyAttributesRequested SetBarcodeSymbologyAttributesRequested SetBarcodeSymbologyAttributesRequested SetBarcodeSymbologyAttributesRequested

Raised when the client app attempts to set the attributes of a barcode symbology.

StartSoftwareTriggerRequested StartSoftwareTriggerRequested StartSoftwareTriggerRequested StartSoftwareTriggerRequested StartSoftwareTriggerRequested

Raised when the client app attempts to signal the barcode scanner to start scanning.

StopSoftwareTriggerRequested StopSoftwareTriggerRequested StopSoftwareTriggerRequested StopSoftwareTriggerRequested StopSoftwareTriggerRequested

Raised when the client app attempts to signal the barcode scanner to stop scanning.