chrome.documentScan

Nội dung mô tả

Sử dụng API chrome.documentScan để khám phá và truy xuất hình ảnh từ trình quét tài liệu đính kèm.

Quyền

documentScan

Phạm vi cung cấp

Chrome 44 trở lên Chỉ dành cho ChromeOS

API Quét tài liệu

API Quét tài liệu được thiết kế nhằm cho phép các ứng dụng và tiện ích xem nội dung của tài liệu giấy trên một trình quét tài liệu đi kèm.

Loại

CancelScanResponse

Chrome 125 trở lên

Thuộc tính

  • việc làm

    string

    Cung cấp cùng một tên người dùng công việc đã được truyền đến cancelScan().

  • kết quả

    OperationResult

    Kết quả quét huỷ của phần phụ trợ. Nếu kết quả là OperationResult.SUCCESS hoặc OperationResult.CANCELLED, thì quá trình quét đã bị huỷ và máy quét sẵn sàng bắt đầu một lượt quét mới. Nếu kết quả là OperationResult.DEVICE_BUSY , thì tức là trình quét vẫn đang xử lý yêu cầu huỷ theo yêu cầu; phương thức gọi nên đợi trong một khoảng thời gian ngắn rồi thử lại yêu cầu. Các giá trị kết quả khác cho biết một lỗi vĩnh viễn và bạn không nên thử lại.

CloseScannerResponse

Chrome 125 trở lên

Thuộc tính

  • kết quả

    OperationResult

    Kết quả đóng trình quét. Ngay cả khi giá trị này không phải là SUCCESS, tên người dùng sẽ không hợp lệ và bạn không nên dùng nó cho bất kỳ thao tác nào khác.

  • scannerHandle

    string

    Tên người dùng của trình quét tương tự được truyền cho closeScanner.

Configurability

Chrome 125 trở lên

Cách thay đổi lựa chọn.

Liệt kê

"NOT_CONFIGURABLE"
Tuỳ chọn này ở chế độ chỉ có thể đọc.

"SOFTWARE_CONFIGURABLE"
Bạn có thể đặt tuỳ chọn này trong phần mềm.

"HARDWARE_CONFIGURABLE"
Người dùng có thể đặt lựa chọn này bằng cách bật/tắt một nút trên máy quét.

ConnectionType

Chrome 125 trở lên

Cho biết cách trình quét được kết nối với máy tính.

Liệt kê

"UNSPECIFIED"

"USB"

ConstraintType

Chrome 125 trở lên

Loại dữ liệu của quy tắc ràng buộc được biểu thị bằng OptionConstraint.

Liệt kê

"INT_RANGE"
Giới hạn trên một dải ô gồm các giá trị OptionType.INT. Các thuộc tính min, max và quant của OptionConstraint sẽ là long và cấp độ list của thuộc tính này sẽ không được thiết lập.

"FIXED_RANGE"
Giới hạn đối với một dải ô của OptionType.FIXED giá trị. Các thuộc tính min, max và quant của OptionConstraint sẽ là double và thuộc tính list của các thuộc tính đó sẽ bị huỷ thiết lập.

"INT_LIST"
Quy tắc ràng buộc trong một danh sách cụ thể gồm các giá trị OptionType.INT. Thuộc tính OptionConstraint.list sẽ chứa giá trị long và các thuộc tính khác sẽ bị huỷ thiết lập.

"FIXED_LIST"
Giới hạn đối với một danh sách giá trị OptionType.FIXED cụ thể. Thuộc tính OptionConstraint.list sẽ chứa giá trị double và các thuộc tính khác sẽ bị huỷ thiết lập.

"STRING_LIST"
Giới hạn đối với một danh sách cụ thể của các giá trị OptionType.STRING. Thuộc tính OptionConstraint.list sẽ chứa giá trị DOMString và các thuộc tính khác sẽ bị huỷ thiết lập.

DeviceFilter

Chrome 125 trở lên

Thuộc tính

  • local

    boolean không bắt buộc

    Chỉ trả lại máy quét được gắn trực tiếp vào máy tính.

  • bảo mật

    boolean không bắt buộc

    Chỉ trả về trình quét sử dụng một phương thức truyền tải an toàn, chẳng hạn như USB hoặc TLS.

GetOptionGroupsResponse

Chrome 125 trở lên

Thuộc tính

  • nhóm

    OptionGroup[] không bắt buộc

    Nếu result là SUCCESS, hãy cung cấp danh sách các nhóm tuỳ chọn theo thứ tự do trình điều khiển máy quét cung cấp.

  • kết quả

    OperationResult

    Kết quả của việc nhận được các nhóm lựa chọn. Nếu giá trị của thuộc tính này là SUCCESS, thì thuộc tính groups sẽ được điền.

  • scannerHandle

    string

    Tên người dùng của trình quét tương tự được truyền cho getOptionGroups.

GetScannerListResponse

Chrome 125 trở lên

Thuộc tính

  • kết quả

    OperationResult

    Kết quả liệt kê. Lưu ý rằng hệ thống có thể trả về một phần kết quả ngay cả khi chỉ ra lỗi.

  • máy quét

    ScannerInfo[]

    Danh sách trình quét có thể trống phù hợp với DeviceFilter được cung cấp.

OpenScannerResponse

Chrome 125 trở lên

Thuộc tính

  • tùy chọn

    đối tượng không bắt buộc

    Nếu result là SUCCESS, cung cấp mục ánh xạ khoá-giá trị, trong đó khoá là một tuỳ chọn dành riêng cho thiết bị và giá trị là một thực thể của ScannerOption.

  • kết quả

    OperationResult

    Kết quả khi mở trình quét. Nếu giá trị của thuộc tính này là SUCCESS, thì thuộc tính scannerHandle và options sẽ được điền.

  • scannerHandle

    chuỗi không bắt buộc

    Nếu result là SUCCESS, bạn có thể dùng một tên người dùng cho trình quét để thực hiện các thao tác khác.

  • scannerId

    string

    Mã máy quét được chuyển tới openScanner().

OperationResult

Chrome 125 trở lên

Một giá trị enum cho biết kết quả của từng toán tử.

Liệt kê

"UNKNOWN"
Đã xảy ra lỗi không xác định hoặc lỗi chung.

" THÀNH CÔNG"
Thao tác thành công.

"UNSUPPORTED"
Thao tác này không được hỗ trợ.

"CANCELLED"
Thao tác đã bị huỷ.

"DEVICE_BUSY"
Thiết bị đang bận.

"INVALID"
Dữ liệu hoặc đối số được truyền đến phương thức này không hợp lệ.

"WRONG_TYPE"
Giá trị đã cung cấp không đúng loại dữ liệu cho lựa chọn cơ bản.

"EOF"
Không có dữ liệu nào khác.

"ADF_JAMMED"
Bộ nạp tài liệu bị kẹt.

"ADF_EMPTY"
Nguồn cấp dữ liệu trống.

"COVER_OPEN"
Nắp bìa phẳng đang mở.

"IO_ERROR"
Đã xảy ra lỗi khi kết nối với thiết bị này.

"ACCESS_DENIED"
Thiết bị yêu cầu xác thực.

"NO_MEMORY"
Không có đủ bộ nhớ trên Chromebook để hoàn tất thao tác.

"UNREACHABLE"
Không kết nối được với thiết bị.

"Thiếu"
Thiết bị đã bị ngắt kết nối.

"Nội bộ_ERROR"
Đã xảy ra lỗi ở nơi không phải ứng dụng gọi.

OptionConstraint

Chrome 125 trở lên

Thuộc tính

  • danh sách

    string[]|number[] optional

  • tối đa

    số không bắt buộc

  • phút

    số không bắt buộc

  • lượng tử

    số không bắt buộc

OptionGroup

Chrome 125 trở lên

Thuộc tính

  • thành viên

    chuỗi[]

    Một mảng các tên lựa chọn theo thứ tự do người lái xe cung cấp.

  • title

    string

    Cung cấp tiêu đề có thể in, ví dụ: "Tuỳ chọn hình học".

OptionSetting

Chrome 125 trở lên

Thuộc tính

  • tên

    string

    Cho biết tên của tuỳ chọn cần đặt.

  • loại

    OptionType

    Cho biết loại dữ liệu của lựa chọn. Loại dữ liệu được yêu cầu phải khớp với loại dữ liệu thực của lựa chọn cơ bản.

  • value

    string|number|boolean|number[] optional

    Cho biết giá trị cần đặt. Hãy không đặt chính sách này để yêu cầu chế độ cài đặt tự động cho những chế độ đã bật autoSettable. Loại dữ liệu được cung cấp cho value phải khớp với type.

OptionType

Chrome 125 trở lên

Loại dữ liệu của một lựa chọn.

Liệt kê

"UNKNOWN"
Loại dữ liệu của lựa chọn chưa xác định. Thuộc tính value sẽ bị huỷ thiết lập.

"BOOL"
Thuộc tính value sẽ là một trong các giá trị truefalse.

"INT"
Một số nguyên 32 bit có dấu. Thuộc tính value sẽ dài hoặc dài[], tuỳ thuộc vào việc tuỳ chọn đó có nhận nhiều giá trị hay không.

"FIXED"
Giá trị gấp đôi trong dải ô -32768-32767.9999 với độ phân giải là 1/65535. Thuộc tính value sẽ tăng gấp đôi hoặc gấp đôi [] tuỳ thuộc vào việc lựa chọn đó có nhận nhiều giá trị hay không. Các giá trị kép không thể được biểu thị chính xác sẽ được làm tròn thành phạm vi và độ chính xác có sẵn.

"STRING"
Một chuỗi bất kỳ byte nào ngoại trừ NUL ('\0'). Thuộc tính value sẽ là một DOMString.

"NÚT"
Lựa chọn thuộc loại này không có giá trị. Thay vào đó, việc đặt một tuỳ chọn thuộc loại này sẽ gây ra hiệu ứng phụ dành riêng cho tuỳ chọn trong trình điều khiển máy quét. Ví dụ: Trình điều khiển máy quét có thể sử dụng chế độ nhập bằng nút để đưa ra phương thức chọn các giá trị mặc định hoặc yêu cầu bộ nạp tài liệu tự động chuyển sang trang giấy tiếp theo.

"GROUP"
Tùy chọn nhóm. Không có giá trị. API này được đưa vào để đảm bảo khả năng tương thích, nhưng thường sẽ không được trả về trong các giá trị ScannerOption. Sử dụng getOptionGroups() để truy xuất danh sách nhóm có tuỳ chọn thành viên.

OptionUnit

Chrome 125 trở lên

Cho biết loại dữ liệu của ScannerOption.unit.

Liệt kê

"UNITLESS"
Giá trị là một số không đơn vị. Ví dụ: đó có thể là một ngưỡng.

"PIXEL"
Giá trị là một số pixel, ví dụ: kích thước quét.

"BIT"
Giá trị là số bit, ví dụ: độ sâu màu.

"MM"
Giá trị được đo bằng milimét, ví dụ: kích thước quét.

"DPI"
Giá trị này được đo bằng số điểm trên mỗi inch, ví dụ như độ phân giải.

"PERCENT"
Giá trị là phần trăm, ví dụ: độ sáng.

"MICRO SECOND"
Giá trị được đo bằng micrô giây, ví dụ như thời gian phơi sáng.

ReadScanDataResponse

Chrome 125 trở lên

Thuộc tính

  • data

    ArrayBuffer không bắt buộc

    Nếu result là SUCCESS, chứa phần dữ liệu hình ảnh đã quét tiếp theo. Nếu result là EOF, thì chứa phần cuối của dữ liệu hình ảnh đã quét.

  • estimatedCompletion

    số không bắt buộc

    Nếu result là SUCCESS, ước tính lượng dữ liệu quét đã được gửi cho đến nay, trong phạm vi từ 0 đến 100.

  • việc làm

    string

    Cung cấp tên công việc được truyền đến readScanData().

  • kết quả

    OperationResult

    Kết quả của việc đọc dữ liệu. Nếu giá trị của lớp này là SUCCESS, thì data sẽ chứa phần tiếp theo (có thể là độ dài bằng 0) của dữ liệu hình ảnh đã sẵn sàng để đọc. Nếu giá trị của lớp này là EOF, thì data sẽ chứa phần cuối cùng của dữ liệu hình ảnh.

ScannerInfo

Chrome 125 trở lên

Thuộc tính

  • connectionType

    ConnectionType

    Cho biết cách trình quét được kết nối với máy tính.

  • deviceUuid

    string

    Để so khớp với các mục nhập ScannerInfo khác trỏ đến cùng một thiết bị thực.

  • imageFormats

    chuỗi[]

    Một mảng các loại MIME có thể được yêu cầu cho các lần quét được trả về.

  • nhà sản xuất

    string

    Nhà sản xuất máy quét.

  • model

    string

    Kiểu máy quét (nếu có) hoặc nội dung mô tả chung.

  • tên

    string

    Tên mà con người có thể đọc được để hiển thị trình quét trong giao diện người dùng.

  • protocolType

    string

    Nội dung mô tả mà con người có thể đọc được về giao thức hoặc trình điều khiển dùng để truy cập vào máy quét, chẳng hạn như Mopria, WSD hoặc epsonds. Việc này chủ yếu hữu ích khi cho phép người dùng chọn giữa các giao thức nếu thiết bị hỗ trợ nhiều giao thức.

  • scannerId

    string

    Mã của một trình quét cụ thể.

  • bảo mật

    boolean

    Nếu đúng, quá trình truyền tải kết nối của máy quét sẽ không bị trình nghe thụ động chặn, chẳng hạn như TLS hoặc USB.

ScannerOption

Chrome 125 trở lên

Thuộc tính

  • khả năng định cấu hình

    Khả năng định cấu hình

    Cho biết liệu có thể thay đổi lựa chọn này hay không và cách thay đổi.

  • quy tắc ràng buộc

    OptionConstraint không bắt buộc

    Xác định OptionConstraint trên tuỳ chọn trình quét hiện tại.

  • description

    string

    Nội dung mô tả dài hơn về lựa chọn này.

  • isActive

    boolean

    Cho biết tuỳ chọn đang hoạt động và có thể được thiết lập hoặc truy xuất. Nếu giá trị là false, thuộc tính value sẽ không được đặt.

  • isAdvanced

    boolean

    Cho biết rằng giao diện người dùng sẽ không hiển thị tuỳ chọn này theo mặc định.

  • isAutoSettable

    boolean

    Trình điều khiển máy quét có thể tự động thiết lập.

  • isDetectable

    boolean

    Cho biết rằng lựa chọn này có thể được phát hiện qua phần mềm.

  • isEmulated

    boolean

    Trình điều khiển máy quét mô phỏng nếu đúng.

  • tên

    string

    Tên lựa chọn sử dụng chữ cái ASCII viết thường, chữ số và dấu gạch ngang. Không được phép sử dụng dấu phụ.

  • title

    string

    Tiêu đề dài một dòng, in được.

  • loại

    OptionType

    Loại dữ liệu có trong thuộc tính value cần thiết để đặt tuỳ chọn này.

  • đơn vị

    OptionUnit

    Đơn vị đo lường cho lựa chọn này.

  • value

    string|number|boolean|number[] optional

    Giá trị hiện tại của tuỳ chọn, nếu có liên quan. Lưu ý rằng loại dữ liệu của thuộc tính này phải khớp với loại dữ liệu được chỉ định trong type.

ScanOptions

Thuộc tính

  • maxImages

    số không bắt buộc

    Số lượng hình ảnh đã quét được cho phép. Giá trị mặc định là 1.

  • mimeTypes

    string[] không bắt buộc

    Loại MIME được phương thức gọi chấp nhận.

ScanResults

Thuộc tính

  • dataUrls

    chuỗi[]

    Một mảng gồm các URL hình ảnh dữ liệu dưới dạng có thể được truyền dưới dạng giá trị "src" vào thẻ hình ảnh.

  • mimeType

    string

    Loại MIME của dataUrls.

SetOptionResult

Chrome 125 trở lên

Thuộc tính

  • tên

    string

    Cho biết tên của lựa chọn đã được đặt.

  • kết quả

    OperationResult

    Cho biết kết quả của việc đặt lựa chọn này.

SetOptionsResponse

Chrome 125 trở lên

Thuộc tính

  • tùy chọn

    đối tượng không bắt buộc

    Ánh xạ khoá-giá trị được cập nhật từ tên tuỳ chọn đến giá trị ScannerOption có chứa cấu hình mới sau khi thử đặt tất cả các tuỳ chọn đã cung cấp. Thuộc tính này có cấu trúc giống như thuộc tính options trong OpenScannerResponse.

    Thuộc tính này sẽ được thiết lập ngay cả khi một số tuỳ chọn không được thiết lập thành công, nhưng sẽ không được đặt nếu không truy xuất được cấu hình đã cập nhật (ví dụ: nếu máy quét bị ngắt kết nối khi đang quét).

  • kết quả

    SetOptionResult[]

    Một mảng kết quả, mỗi mảng cho một OptionSetting được truyền vào.

  • scannerHandle

    string

    Cung cấp tay điều khiển trình quét được truyền đến setOptions().

StartScanOptions

Chrome 125 trở lên

Thuộc tính

  • định dạng

    string

    Chỉ định loại MIME để trả về dữ liệu đã quét.

  • maxReadSize

    số không bắt buộc

    Nếu bạn chỉ định một giá trị khác 0, hãy giới hạn số byte quét tối đa được trả về trong một phản hồi readScanData duy nhất cho giá trị đó. Giá trị nhỏ nhất được phép là 32768 (32 KB). Nếu thuộc tính này không được chỉ định, thì kích thước của phần được trả về có thể lớn bằng toàn bộ hình ảnh được quét.

StartScanResponse

Chrome 125 trở lên

Thuộc tính

  • việc làm

    chuỗi không bắt buộc

    Nếu result là SUCCESS, hãy cung cấp một tên người dùng có thể dùng để đọc dữ liệu quét hoặc huỷ công việc.

  • kết quả

    OperationResult

    Kết quả của việc bắt đầu quét. Nếu giá trị của thuộc tính này là SUCCESS, thì thuộc tính job sẽ được điền.

  • scannerHandle

    string

    Cung cấp cùng một tay điều khiển trình quét đã được truyền đến startScan().

Phương thức

cancelScan()

Cam kết Chrome 125 trở lên 
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
)

Huỷ quá trình quét đã bắt đầu và trả về một Promise phân giải bằng đối tượng CancelScanResponse. Nếu lệnh gọi lại được sử dụng, đối tượng sẽ được truyền đến đối tượng đó.

Thông số

  • việc làm

    string

    Xử lý một công việc quét đang hoạt động trước đó được trả về từ lệnh gọi đến startScan.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (response: CancelScanResponse)=>void

Giá trị trả về

  • Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

closeScanner()

Cam kết Chrome 125 trở lên 
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
)

Đóng trình quét có tay điều khiển được truyền và trả về một Promise phân giải bằng đối tượng CloseScannerResponse. Nếu lệnh gọi lại được sử dụng, đối tượng sẽ được truyền đến đối tượng đó. Ngay cả khi phản hồi không thành công, tên người dùng đã cung cấp sẽ trở thành không hợp lệ và không nên được dùng cho các thao tác tiếp theo.

Thông số

  • scannerHandle

    string

    Chỉ định tên người dùng của một trình quét đang mở trước đó được trả về từ lệnh gọi đến openScanner.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (response: CloseScannerResponse)=>void

Giá trị trả về

  • Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getOptionGroups()

Cam kết Chrome 125 trở lên 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
)

Lấy tên nhóm và tuỳ chọn thành viên từ trình quét mà openScanner đã mở trước đó. Phương thức này trả về một Promise sẽ phân giải bằng đối tượng GetOptionGroupsResponse. Nếu lệnh gọi lại được truyền đến hàm này, thì dữ liệu trả về sẽ được truyền vào hàm đó.

Thông số

  • scannerHandle

    string

    Tên người dùng của một trình quét đang mở được trả về từ lệnh gọi đến openScanner.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (response: GetOptionGroupsResponse)=>void

Giá trị trả về

  • Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getScannerList()

Cam kết Chrome 125 trở lên 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
)

Lấy danh sách các trình quét có sẵn và trả về một Promise phân giải bằng đối tượng GetScannerListResponse. Nếu lệnh gọi lại được truyền đến hàm này, thì dữ liệu trả về sẽ được truyền vào hàm đó.

Thông số

Giá trị trả về

  • Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

openScanner()

Cam kết Chrome 125 trở lên 
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
)

Mở một trình quét để có quyền truy cập độc quyền và trả về một Lời hứa giải quyết được bằng đối tượng OpenScannerResponse. Nếu lệnh gọi lại được truyền đến hàm này, thì dữ liệu trả về sẽ được truyền vào hàm đó.

Thông số

  • scannerId

    string

    Mã của máy quét sắp mở. Giá trị này được trả về từ lệnh gọi trước đó đến getScannerList.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (response: OpenScannerResponse)=>void

Giá trị trả về

  • Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

readScanData()

Cam kết Chrome 125 trở lên 
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
)

Đọc phần dữ liệu hình ảnh có sẵn tiếp theo từ vị trí công việc đang hoạt động và trả về một Lời hứa giải quyết bằng đối tượng ReadScanDataResponse. Nếu lệnh gọi lại được sử dụng, đối tượng sẽ được truyền đến đối tượng đó.

**Lưu ý:**Kết quả phản hồi là SUCCESS với thành phần data có độ dài bằng 0 là hợp lệ. Điều này có nghĩa là trình quét vẫn đang hoạt động nhưng chưa có thêm dữ liệu sẵn sàng. Phương thức gọi nên đợi một thời gian ngắn rồi thử lại.

Khi lệnh quét hoàn tất, phản hồi sẽ có giá trị kết quả là EOF. Phản hồi này có thể chứa một thành phần data cuối cùng khác 0.

Thông số

  • việc làm

    string

    Tên công việc đang hoạt động được trả về trước đó từ startScan.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (response: ReadScanDataResponse)=>void

Giá trị trả về

  • Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

scan()

Cam kết 
chrome.documentScan.scan(
  options: ScanOptions,
  callback?: function,
)

Thực hiện quét tài liệu và trả về một Promise có thể phân giải bằng đối tượng ScanResults. Nếu lệnh gọi lại được truyền đến hàm này, thì dữ liệu trả về sẽ được truyền vào hàm đó.

Thông số

  • tùy chọn

    ScanOptions

    Đối tượng chứa các thông số quét.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (result: ScanResults)=>void

Giá trị trả về

  • Promise<ScanResults>

    Chrome 96 trở lên

    Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setOptions()

Cam kết Chrome 125 trở lên 
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
)

Đặt các tuỳ chọn trên trình quét được chỉ định và trả về một Promise giúp phân giải bằng đối tượng SetOptionsResponse chứa kết quả của việc cố gắng đặt mọi giá trị theo thứ tự của đối tượng OptionSetting được truyền vào. Nếu lệnh gọi lại được sử dụng, đối tượng sẽ được truyền đến đối tượng đó.

Thông số

  • scannerHandle

    string

    Tay cầm của máy quét để đặt các tuỳ chọn. Đây phải là một giá trị trước đó được trả về từ lệnh gọi đến openScanner.

  • tùy chọn

    OptionSetting[]

    Danh sách các đối tượng OptionSetting sẽ được áp dụng cho trình quét.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (response: SetOptionsResponse)=>void

Giá trị trả về

  • Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

startScan()

Cam kết Chrome 125 trở lên 
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
)

Bắt đầu quét trên máy quét đã chỉ định và trả về một Hứa hẹn giải quyết bằng StartScanResponse. Nếu lệnh gọi lại được sử dụng, đối tượng sẽ được truyền đến đối tượng đó. Nếu lệnh gọi thành công, phản hồi sẽ bao gồm tên công việc có thể dùng trong các lệnh gọi tiếp theo để đọc dữ liệu quét hoặc huỷ quá trình quét.

Thông số

  • scannerHandle

    string

    Tay cầm của một trình quét đang mở. Đây phải là một giá trị trước đó được trả về từ lệnh gọi đến openScanner.

  • tùy chọn

    StartScanOptions

    Một đối tượng StartScanOptions cho biết các tuỳ chọn quét. Thuộc tính StartScanOptions.format phải khớp với một trong các mục nhập được trả về trong ScannerInfo của trình quét.

  • số gọi lại

    hàm không bắt buộc

    Tham số callback sẽ có dạng như sau: 

    (response: StartScanResponse)=>void

Giá trị trả về

  • Lời hứa chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.