chrome.documentScan
- Description
Use the
chrome.documentScan
API to discover and retrieve images from attached paper document scanners. - Permissions
documentScan
Document Scan API #
The Document Scan API is designed to allow apps and extensions to view the content of paper documents on an attached document scanner.
Note: This API depends on OS features that may not be available depending on the underlying operating system. As of this writing only Chrome OS for certain USB-attached devices is known to successfully work.
Summary
- Types
- Methods
chrome.documentScan.scan(options: ScanOptions, callback: function)
Types
ScanOptions
Properties
- maxImagesnumber optional
The number of scanned images allowed (defaults to 1).
- mimeTypesstring[] optional
The MIME types that are accepted by the caller.
ScanResults
Properties
- dataUrlsstring[]
The data image URLs in a form that can be passed as the "src" value to an image tag.
- mimeTypestring
The MIME type of
dataUrls
.
Methods
scan
chrome.documentScan.scan(options: ScanOptions, callback: function)
Performs a document scan. On success, the PNG data will be sent to the callback.
Parameters
- options
Object containing scan parameters.
- callbackfunction
Called with the result and data from the scan.
The callback parameter should be a function that looks like this:
(result: ScanResults) => {...}
- result