Welcome What's new in Chrome extensions Getting started API Reference Samples
Welcome What's new in Chrome extensions Getting started API Reference Samples

chrome.documentScan

Important: This API works only on ChromeOS
  • Description

    Use the chrome.documentScan API to discover and retrieve images from attached paper document scanners.

  • Permissions
    documentScan
  • Availability
    Chrome 44+ ChromeOS only

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 ChromeOS for certain USB-attached devices is known to successfully work.

Summary

Types

ScanOptions

Properties

  • maxImages

    number optional

    The number of scanned images allowed (defaults to 1).

  • mimeTypes

    string[] optional

    The MIME types that are accepted by the caller.

ScanResults

Properties

  • dataUrls

    string[]

    The data image URLs in a form that can be passed as the "src" value to an image tag.

  • mimeType

    string

    The MIME type of dataUrls.

Methods

scan

chrome.documentScan.scan(
  options: ScanOptions,
  callback?: function,
)
Promise

Performs a document scan. On success, the PNG data will be sent to the callback.

Parameters

Returns

  • Promise<ScanResults>

    Pending

    This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

We serve cookies on this site to analyze traffic, remember your preferences, and optimize your experience.