Capture.Vision.Maui 1.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Capture.Vision.Maui --version 1.1.0
NuGet\Install-Package Capture.Vision.Maui -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Capture.Vision.Maui" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Capture.Vision.Maui --version 1.1.0
#r "nuget: Capture.Vision.Maui, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Capture.Vision.Maui as a Cake Addin
#addin nuget:?package=Capture.Vision.Maui&version=1.1.0

// Install Capture.Vision.Maui as a Cake Tool
#tool nuget:?package=Capture.Vision.Maui&version=1.1.0

.NET MAUI Camera View with Dynamsoft Vision SDKs

The project aims to help developers build .NET MAUI apps that feature a custom camera view, utilizing Dynamsoft Vision SDKs for barcode, MRZ, and document detection.

.NET MAUI Windows QR code scanner

Supported Platforms

  • Android
  • iOS
  • Windows

Features

  • Recognize 1D barcodes, QR codes, PDF417, DataMatrix, and more from camera frames.

Getting Started

  1. Enable the camera view in MauiProgram.cs:

    builder.UseNativeCameraView()
    
  2. Request a free trial license and replace LICENSE-KEY with your own license key in MainPage.xaml.cs:

    using Dynamsoft;
    
    namespace Capture.Vision.Maui.Example
    {
        public partial class MainPage : ContentPage
        {
            public MainPage()
            {
                InitializeComponent();
                InitService();
            }
    
            private async void InitService()
            {
                await Task.Run(() =>
                {
                    BarcodeQRCodeReader.InitLicense("LICENSE-KEY");
    
                    return Task.CompletedTask;
                });
            }
    
            async void OnTakeVideoButtonClicked(object sender, EventArgs e)
            {
                await Navigation.PushAsync(new CameraPage());
            }
        }
    }
    
  3. Create a content page to add the camera view:

    <?xml version="1.0" encoding="utf-8" ?>
    <ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
                xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
                xmlns:skia="clr-namespace:SkiaSharp.Views.Maui.Controls;assembly=SkiaSharp.Views.Maui.Controls"
                xmlns:cv="clr-namespace:Capture.Vision.Maui;assembly=Capture.Vision.Maui"
                x:Class="Capture.Vision.Maui.Example.CameraPage"
                Title="CameraPage">
        <ScrollView>
            <Grid>
                <cv:CameraView x:Name="cameraView" HorizontalOptions="FillAndExpand"
                VerticalOptions="FillAndExpand" EnableBarcode="True" 
                                    ResultReady="cameraView_ResultReady" FrameReady="cameraView_FrameReady"
                                />
                <skia:SKCanvasView x:Name="canvasView" 
                            Margin="0"
                            HorizontalOptions="FillAndExpand" VerticalOptions="FillAndExpand"
                            PaintSurface="OnCanvasViewPaintSurface" />
            </Grid>
        </ScrollView>
    </ContentPage>
    

    If you set EnableBarcode to True, the barcode result will be available in the cameraView_ResultReady event:

    private void cameraView_ResultReady(object sender, ResultReadyEventArgs e)
    {
        if (e.Result != null)
        {
            Result[] results = (Result[])e.Result;
            foreach (Result result in results)
            {
                System.Diagnostics.Debug.WriteLine(result.Text);
            }
        }
    }
    

    If you wish to obtain the camera frame for independent image processing, set EnableBarcode to False. The frame will then be accessible in the cameraView_FrameReady event.

    private void cameraView_FrameReady(object sender, FrameReadyEventArgs e)
    {
        // process image
    }
    

    The FrameReadyEventArgs contains the image data and the image format:

    public class FrameReadyEventArgs : EventArgs
    { 
        public enum PixelFormat
        {
            GRAYSCALE,
            RGB888,
            BGR888,
            RGBA8888,
            BGRA8888,
        }
        public FrameReadyEventArgs(byte[] buffer, int width, int height, int stride, PixelFormat pixelFormat)
        {
            Buffer = buffer;
            Width = width;
            Height = height;
            Stride = stride;
            Format = pixelFormat;
        }
    
        public byte[] Buffer { get; private set; }
        public int Width { get; private set; }
        public int Height { get; private set; }
        public int Stride { get; private set; }
        public PixelFormat Format { get; private set; }
    }
    

    Currently, the frame from Windows and Android devices is in the GRAYSCALE format, while the frame from iOS devices is in the BGRA8888 format.

  4. Specify barcode detection parameters according to the requirements of specific scenarios.

    public CameraPage()
    {
        InitializeComponent();
        ...
        // cameraView.BarcodeParameters = "{\"Version\":\"3.0\", \"ImageParameter\":{\"Name\":\"IP1\", \"BarcodeFormatIds\":[\"BF_QR_CODE\", \"BF_ONED\"], \"ExpectedBarcodesCount\":20}}";
    }
    

TODO

  • MRZ detection
  • Document detection

References

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-android33.0 is compatible.  net7.0-ios was computed.  net7.0-ios16.1 is compatible.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net7.0-windows10.0.19041 is compatible.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 219 3/6/2024
1.4.0 138 1/24/2024
1.3.0 83 1/23/2024
1.2.1 100 1/17/2024
1.2.0 89 1/17/2024
1.1.0 110 1/5/2024
1.0.0 308 6/19/2023

- Added barcode parameter settings.