{"id":15998288,"url":"https://github.com/yushulx/flutter_document_scan_sdk","last_synced_at":"2025-10-04T20:27:12.539Z","repository":{"id":63994086,"uuid":"570036325","full_name":"yushulx/flutter_document_scan_sdk","owner":"yushulx","description":"A Flutter Document Detection SDK built with Dynamsoft Document Normalizer","archived":true,"fork":false,"pushed_at":"2024-10-09T08:38:10.000Z","size":33620,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-06T06:46:39.416Z","etag":null,"topics":["dart","document-detection","document-rectification","flutter"],"latest_commit_sha":null,"homepage":"https://pub.dev/packages/flutter_document_scan_sdk","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yushulx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-24T07:34:42.000Z","updated_at":"2025-01-16T13:45:19.000Z","dependencies_parsed_at":"2023-01-24T06:30:54.098Z","dependency_job_id":"407d7862-f18d-4f4f-b9a3-cdbb2220d566","html_url":"https://github.com/yushulx/flutter_document_scan_sdk","commit_stats":{"total_commits":40,"total_committers":1,"mean_commits":40.0,"dds":0.0,"last_synced_commit":"9d6a126e0db31093b3087ad65d37c1069af40995"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yushulx%2Fflutter_document_scan_sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yushulx%2Fflutter_document_scan_sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yushulx%2Fflutter_document_scan_sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yushulx%2Fflutter_document_scan_sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yushulx","download_url":"https://codeload.github.com/yushulx/flutter_document_scan_sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245826918,"owners_count":20678877,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dart","document-detection","document-rectification","flutter"],"created_at":"2024-10-08T08:08:24.794Z","updated_at":"2025-10-04T20:27:12.528Z","avatar_url":"https://github.com/yushulx.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flutter Document Scan SDK\nA Flutter wrapper for the **Dynamsoft Capture Vision SDK**, featuring document detection and normalization.\n\n![Flutter document scanner for Windows](https://www.dynamsoft.com/codepool/img/2025/05/flutter-document-scanner-windows.png)\n\n![Flutter document scanner normalization for Windows](https://www.dynamsoft.com/codepool/img/2025/05/flutter-document-scanner-normalization-windows.png)\n    \n## Demo Video\n- iOS\n\n  https://github.com/user-attachments/assets/d6f44994-ea37-4f72-8079-6492f52547d2\n\n- Windows\n\n  https://github.com/user-attachments/assets/89113ad1-7699-49a7-ade0-81949cc8ced6\n\n- Web\n\n  https://github.com/user-attachments/assets/3e51915b-c7ad-4406-8ef1-e5cb12fee806\n\n## Supported Platforms\n- ✅ Windows\n- ✅ Linux\n- ✅ Android\n- ✅ iOS\n    \n    - Add camera and microphone usage descriptions to `ios/Runner/Info.plist`:\n    \n        ```xml\n        \u003ckey\u003eNSCameraUsageDescription\u003c/key\u003e\n        \u003cstring\u003eCan I use the camera please?\u003c/string\u003e\n        \u003ckey\u003eNSMicrophoneUsageDescription\u003c/key\u003e\n        \u003cstring\u003eCan I use the mic please?\u003c/string\u003e\n        ```\n\n    - Minimum deployment target: iOS 13.0 or later\n\n- ✅ Web\n        \n    In `index.html`, include:\n\n    ```html\n    \u003cscript src=\"https://cdn.jsdelivr.net/npm/dynamsoft-capture-vision-bundle@3.0.3001/dist/dcv.bundle.min.js\"\u003e\u003c/script\u003e\n    ```\n\n\n## Prerequisites\n- A valid [Dynamsoft Capture Vision license key](https://www.dynamsoft.com/customer/license/trialLicense/?product=dcv\u0026package=cross-platform)\n\n## Getting Started\n1. Set the license key in `example/lib/global.dart`:\n\n    ```dart\n    Future\u003cint\u003e initDocumentSDK() async {\n      int? ret = await docScanner.init(\n          \"LICENSE-KEY\");\n      ...\n    }\n    ```\n2. Run the example project on your desired platform:\n\n    ```bash\n    cd example\n    flutter run -d chrome    # Run on Web\n    flutter run -d linux     # Run on Linux\n    flutter run -d windows   # Run on Windows\n    flutter run              # Run on default connected device (e.g., Android)\n    ```\n\n## API Reference\n\n| Method | Description | Parameters | Return Type |\n|--------|-------------|------------|-------------|\n| `Future\u003cint?\u003e init(String key)` | Initializes the SDK with a license key. | `key`: License string | `Future\u003cint?\u003e` |\n| `Future\u003cNormalizedImage?\u003e normalizeFile(String file, List\u003cOffset\u003e points, ColorMode color)` | Normalizes a document image from a file. | `file`: Path to the image file \u003cbr\u003e `points`: Document corner points \u003cbr\u003e `color`: output image color | `Future\u003cNormalizedImage?\u003e` |\n| `Future\u003cNormalizedImage?\u003e normalizeBuffer(Uint8List bytes, int width, int height, int stride, int format, List\u003cOffset\u003e points, int rotation, ColorMode color)` | Normalizes a document image from a raw image buffer. | `bytes`: Image buffer \u003cbr\u003e `width`, `height`: Image dimensions \u003cbr\u003e `stride`: Row stride in bytes \u003cbr\u003e `format`: Image pixel format index \u003cbr\u003e `points`: Document corner points \u003cbr\u003e `rotation`: 0/90/180/270 \u003cbr\u003e `color`: output image color | `Future\u003cNormalizedImage?\u003e` |\n| `Future\u003cList\u003cDocumentResult\u003e?\u003e detectFile(String file)` | Detects documents in an image file. | `file`: Path to the image file | `Future\u003cList\u003cDocumentResult\u003e?\u003e` |\n| `Future\u003cList\u003cDocumentResult\u003e?\u003e detectBuffer(Uint8List bytes, int width, int height, int stride, int format, int rotation)` | Detects documents from a raw image buffer. | `bytes`: Image buffer \u003cbr\u003e `width`, `height`: Image dimensions \u003cbr\u003e `stride`: Row stride in bytes \u003cbr\u003e `format`: Image pixel format index \u003cbr\u003e `rotation`: 0/90/180/270 | `Future\u003cList\u003cDocumentResult\u003e?\u003e` |\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyushulx%2Fflutter_document_scan_sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyushulx%2Fflutter_document_scan_sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyushulx%2Fflutter_document_scan_sdk/lists"}