chrome.documentScan

Deskripsi

Gunakan chrome.documentScan API untuk menemukan dan mengambil gambar dari pemindai dokumen yang terlampir.

Izin

documentScan

Ketersediaan

Chrome 44 dan yang lebih baru Khusus ChromeOS

API Pemindaian Dokumen

Document Scan API didesain untuk memungkinkan aplikasi dan ekstensi melihat isi dokumen kertas pada pemindai dokumen yang dilampirkan.

Jenis

CancelScanResponse

Chrome 125 dan yang lebih baru

Properti

  • tugas

    string

    Memberikan handle tugas yang sama yang diteruskan ke cancelScan().

  • Hasil pemindaian pembatalan backend. Jika hasilnya adalah OperationResult.SUCCESS atau OperationResult.CANCELLED, pemindaian telah dibatalkan dan pemindai siap memulai pemindaian baru. Jika hasilnya adalah OperationResult.DEVICE_BUSY , pemindai masih memproses pembatalan yang diminta; pemanggil harus menunggu beberapa saat dan mencoba permintaan lagi. Nilai hasil lainnya menunjukkan error permanen yang tidak boleh dicoba lagi.

CloseScannerResponse

Chrome 125 dan yang lebih baru

Properti

  • Hasil dari penutupan pemindai. Meskipun nilai ini bukan SUCCESS, handle tidak akan valid dan tidak boleh digunakan untuk operasi lebih lanjut.

  • scannerHandle

    string

    Tuas pemindai yang sama seperti yang diteruskan ke closeScanner.

Configurability

Chrome 125 dan yang lebih baru

Cara mengubah opsi.

Enum

"NOT_CONFIGURABLE"
Opsi ini bersifat hanya baca.

"SOFTWARE_CONFIGURABLE"
Opsi ini dapat disetel di software.

"HARDWARE_CONFIGURABLE"
Opsi ini dapat disetel oleh pengguna yang mengalihkan atau menekan tombol di pemindai.

ConnectionType

Chrome 125 dan yang lebih baru

Menunjukkan cara pemindai terhubung ke komputer.

Enum

"UNSPECIFIED"

"USB"

"JARINGAN"

ConstraintType

Chrome 125 dan yang lebih baru

Jenis data batasan yang diwakili oleh OptionConstraint.

Enum

"INT_RANGE"
Batasan pada rentang nilai OptionType.INT. Properti min, max, dan quant dari OptionConstraint akan menjadi long, dan properti list-nya akan dibatalkan penetapannya.

"FIXED_RANGE"
Batasan pada rentang nilai OptionType.FIXED. Properti min, max, dan quant dari OptionConstraint akan menjadi double, dan properti list-nya akan dibatalkan penetapannya.

"INT_LIST"
Batasan pada daftar nilai OptionType.INT tertentu. Properti OptionConstraint.list akan berisi nilai long, dan properti lainnya akan dibatalkan penetapannya.

"FIXED_LIST"
Batasan pada daftar nilai OptionType.FIXED tertentu. Properti OptionConstraint.list akan berisi nilai double, dan properti lainnya akan dibatalkan penetapannya.

"STRING_LIST"
Batasan pada daftar nilai OptionType.STRING tertentu. Properti OptionConstraint.list akan berisi nilai DOMString, dan properti lainnya akan dibatalkan penetapannya.

DeviceFilter

Chrome 125 dan yang lebih baru

Properti

  • lokal

    boolean opsional

    Hanya kembalikan pemindai yang terpasang langsung ke komputer.

  • aman

    boolean opsional

    Hanya tampilkan pemindai yang menggunakan transport aman, seperti USB atau TLS.

GetOptionGroupsResponse

Chrome 125 dan yang lebih baru

Properti

  • yang dilacak

    OptionGroup[] opsional

    Jika result adalah SUCCESS, daftar ini akan memberikan daftar grup opsi dalam urutan yang disediakan oleh driver pemindai.

  • Hasil dari mendapatkan grup opsi. Jika nilai ini adalah SUCCESS, properti groups akan diisi.

  • scannerHandle

    string

    Tuas pemindai yang sama seperti yang diteruskan ke getOptionGroups.

GetScannerListResponse

Chrome 125 dan yang lebih baru

Properti

  • Hasil enumerasi. Perhatikan bahwa hasil parsial dapat dikembalikan meskipun ini mengindikasikan adanya error.

  • pemindai

    ScannerInfo[]

    Daftar pemindai yang mungkin kosong dan cocok dengan DeviceFilter yang diberikan.

OpenScannerResponse

Chrome 125 dan yang lebih baru

Properti

  • opsi

    objek opsional

    Jika result adalah SUCCESS, memberikan pemetaan nilai kunci dengan kuncinya adalah opsi khusus perangkat dan nilainya adalah instance ScannerOption.

  • Hasil membuka pemindai. Jika nilai ini adalah SUCCESS, properti scannerHandle dan options akan diisi.

  • scannerHandle

    string opsional

    Jika result adalah SUCCESS, tuas ke pemindai yang dapat digunakan untuk operasi lebih lanjut.

  • scannerId

    string

    ID pemindai diteruskan ke openScanner().

OperationResult

Chrome 125 dan yang lebih baru

Enum yang menunjukkan hasil dari setiap operasi.

Enum

"UNKNOWN"
Terjadi error yang tidak diketahui atau umum.

"SUCCESS"
Operasi berhasil.

"UNSUPPORTED"
Operasi tidak didukung.

"CANCELLED"
Operasi dibatalkan.

"DEVICE_BUSY"
Perangkat sedang sibuk.

"INVALID"
Data atau argumen yang diteruskan ke metode tidak valid.

"WRONG_TYPE"
Nilai yang diberikan adalah jenis data yang salah untuk opsi pokok.

"EOF"
Tidak ada data lagi yang tersedia.

"ADF_JAMMED"
Pengumpan dokumen macet.

"ADF_EMPTY"
Pengumpan dokumen kosong.

"COVER_OPEN"
Penutup kasur datar terbuka.

"IO_ERROR"
Terjadi error saat berkomunikasi dengan perangkat.

"ACCESS_DENIED"
Perangkat memerlukan autentikasi.

"NO_MEMORY"
Memori tidak cukup di Chromebook untuk menyelesaikan operasi.

"UNREACHABLE"
Perangkat tidak dapat dijangkau.

"MISSING"
Perangkat terputus.

"INTERNAL_ERROR"
Terjadi error selain di aplikasi panggilan.

OptionConstraint

Chrome 125 dan yang lebih baru

Properti

  • list

    string[] | number[] opsional

  • maks

    angka opsional

  • mnt

    angka opsional

  • kuantitas

    angka opsional

OptionGroup

Chrome 125 dan yang lebih baru

Properti

  • anggota

    {i>string<i}[]

    Array nama opsi dalam urutan yang diberikan oleh driver.

  • judul

    string

    Memberikan judul yang dapat dicetak, misalnya "Opsi geometri".

OptionSetting

Chrome 125 dan yang lebih baru

Properti

  • nama

    string

    Menunjukkan nama opsi yang akan ditetapkan.

  • jenis

    OptionType

    Menunjukkan jenis data opsi. Jenis data yang diminta harus cocok dengan jenis data sebenarnya dari opsi pokok.

  • nilai

    string | angka | boolean | number[] opsional

    Menunjukkan nilai yang akan ditetapkan. Jangan disetel untuk meminta setelan otomatis bagi opsi yang mengaktifkan autoSettable. Jenis data yang diberikan untuk value harus cocok dengan type.

OptionType

Chrome 125 dan yang lebih baru

Jenis data opsi.

Enum

"UNKNOWN"
Jenis data opsi tidak diketahui. Penetapan properti value akan dibatalkan.

"BOOL"
Properti value akan berupa salah satu dari truefalse.

"INT"
Bilangan bulat 32-bit yang ditandatangani. Properti value akan panjang atau panjang[], bergantung pada apakah opsi tersebut memerlukan lebih dari satu nilai.

"FIXED"
Dua dalam rentang -32768-32767,9999 dengan resolusi 1/65535. Properti value akan menjadi double atau double[] bergantung pada apakah opsi tersebut memerlukan lebih dari satu nilai. Nilai ganda yang tidak dapat direpresentasikan secara tepat akan dibulatkan ke rentang dan presisi yang tersedia.

"STRING"
Urutan byte apa pun kecuali NUL ('\0'). Properti value akan menjadi DOMString.

"BUTTON"
Opsi jenis ini tidak memiliki nilai. Sebaliknya, menyetel opsi jenis ini akan menyebabkan efek samping khusus opsi di driver pemindai. Misalnya, opsi jenis tombol dapat digunakan oleh driver pemindai untuk menyediakan cara guna memilih nilai default atau memberi tahu pengumpan dokumen otomatis untuk melanjutkan ke lembar kertas berikutnya.

"GROUP"
Opsi pengelompokan. Tidak ada nilai. Ini disertakan untuk kompatibilitas, tetapi biasanya tidak akan ditampilkan dalam nilai ScannerOption. Gunakan getOptionGroups() untuk mengambil daftar grup dengan opsi anggotanya.

OptionUnit

Chrome 125 dan yang lebih baru

Menunjukkan jenis data untuk ScannerOption.unit.

Enum

"UNITLESS"
Nilainya adalah angka tanpa unit. Misalnya, nilai minimum dapat berupa nilai minimum.

"PIXEL"
Nilainya adalah jumlah piksel, misalnya, dimensi pemindaian.

"BIT"
Nilainya adalah jumlah bit, misalnya, kedalaman warna.

"MM"
Nilai ini diukur dalam milimeter, misalnya, dimensi pemindaian.

"DPI"
Nilai ini diukur dalam titik per inci, misalnya, resolusi.

"PERCENT"
Nilainya adalah persen, misalnya, kecerahan.

"MICROSECOND"
Nilainya diukur dalam mikrodetik, misalnya, waktu eksposur.

ReadScanDataResponse

Chrome 125 dan yang lebih baru

Properti

  • data

    ArrayBuffer opsional

    Jika result adalah SUCCESS, berisi bagian berikutnya dari data gambar yang dipindai. Jika result adalah EOF, berisi bagian terakhir dari data gambar yang dipindai.

  • estimatedCompletion

    angka opsional

    Jika result adalah SUCCESS, perkiraan jumlah total data pemindaian yang telah dikirimkan sejauh ini, dalam rentang 0 hingga 100.

  • tugas

    string

    Menyediakan handle tugas yang diteruskan ke readScanData().

  • Hasil pembacaan data. Jika nilainya adalah SUCCESS, maka data berisi potongan data gambar berikutnya (mungkin dengan panjang nol) yang siap untuk dibaca. Jika nilainya adalah EOF, data berisi potongan data gambar terakhir.

ScannerInfo

Chrome 125 dan yang lebih baru

Properti

  • connectionType

    ConnectionType

    Menunjukkan bagaimana pemindai terhubung ke komputer.

  • deviceUuid

    string

    Untuk pencocokan dengan entri ScannerInfo lain yang mengarah ke perangkat fisik yang sama.

  • imageFormats

    {i>string<i}[]

    Array jenis MIME yang dapat diminta untuk pemindaian yang ditampilkan.

  • produsen

    string

    Produsen pemindai.

  • model

    string

    Model pemindai jika tersedia, atau deskripsi umum.

  • nama

    string

    Nama yang dapat dibaca manusia untuk ditampilkan oleh pemindai di UI.

  • protocolType

    string

    Deskripsi protokol atau driver yang dapat dibaca manusia yang digunakan untuk mengakses pemindai, seperti Mopria, WSD, atau epsonds. Ini terutama berguna untuk memungkinkan pengguna memilih di antara protokol jika perangkat mendukung beberapa protokol.

  • scannerId

    string

    ID pemindai tertentu.

  • aman

    boolean

    Jika true (benar), transport koneksi pemindai tidak dapat dicegat oleh pemroses pasif, seperti TLS atau USB.

ScannerOption

Chrome 125 dan yang lebih baru

Properti

  • kemampuan konfigurasi

    Kemampuan konfigurasi

    Menunjukkan apakah dan bagaimana opsi dapat diubah.

  • batasan

    OptionConstraint opsional

    Menentukan OptionConstraint pada opsi pemindai saat ini.

  • deskripsi

    string

    Deskripsi opsi yang lebih panjang.

  • isActive

    boolean

    Menunjukkan bahwa opsi aktif dan dapat ditetapkan atau diambil. Jika salah, properti value tidak akan ditetapkan.

  • isAdvanced

    boolean

    Menunjukkan bahwa UI tidak boleh menampilkan opsi ini secara default.

  • isAutoSettable

    boolean

    Dapat disetel secara otomatis oleh driver pemindai.

  • isDetectable

    boolean

    Menunjukkan bahwa opsi ini dapat dideteksi dari software.

  • isEmulated

    boolean

    Diemulasikan oleh driver pemindai jika true.

  • nama

    string

    Nama opsi yang menggunakan huruf ASCII kecil, angka, dan tanda pisah. Diakritik tidak diizinkan.

  • judul

    string

    Judul satu baris yang dapat dicetak.

  • jenis

    OptionType

    Jenis data yang ada dalam properti value, yang diperlukan untuk menetapkan opsi ini.

  • satuan

    OptionUnit

    Satuan pengukuran untuk opsi ini.

  • nilai

    string | angka | boolean | number[] opsional

    Nilai opsi saat ini, jika relevan. Perhatikan bahwa jenis data properti ini harus cocok dengan jenis data yang ditentukan di type.

ScanOptions

Properti

  • maxImages

    angka opsional

    Jumlah gambar yang dipindai yang diizinkan. Nilai defaultnya adalah 1.

  • mimeTypes

    string[] opsional

    Jenis MIME yang diterima oleh pemanggil.

ScanResults

Properti

  • dataUrls

    {i>string<i}[]

    Array URL gambar data dalam bentuk yang dapat diteruskan sebagai "src" ke tag image.

  • mimeType

    string

    Jenis MIME dataUrls.

SetOptionResult

Chrome 125 dan yang lebih baru

Properti

  • nama

    string

    Menunjukkan nama opsi yang telah ditetapkan.

  • Menunjukkan hasil penyetelan opsi.

SetOptionsResponse

Chrome 125 dan yang lebih baru

Properti

  • opsi

    objek opsional

    Pemetaan nilai kunci yang diperbarui dari nama opsi menjadi nilai ScannerOption yang berisi konfigurasi baru setelah mencoba menetapkan semua opsi yang disediakan. Properti ini memiliki struktur yang sama dengan properti options di OpenScannerResponse.

    Properti ini akan disetel meskipun beberapa opsi tidak berhasil disetel, tetapi tidak akan disetel jika pengambilan konfigurasi yang diperbarui gagal (misalnya, jika pemindai terputus di tengah pemindaian).

  • hasil

    SetOptionResult[]

    Array hasil, masing-masing satu untuk setiap OptionSetting yang diteruskan.

  • scannerHandle

    string

    Menyediakan handle pemindai yang diteruskan ke setOptions().

StartScanOptions

Chrome 125 dan yang lebih baru

Properti

  • format

    string

    Menentukan jenis MIME untuk menampilkan data yang dipindai.

  • maxReadSize

    angka opsional

    Jika nilai bukan nol ditentukan, akan membatasi byte terpindai maksimum yang ditampilkan dalam satu respons readScanData ke nilai tersebut. Nilai terkecil yang diizinkan adalah 32768 (32 KB). Jika properti ini tidak ditentukan, ukuran potongan yang dikembalikan mungkin sebesar keseluruhan gambar yang dipindai.

StartScanResponse

Chrome 125 dan yang lebih baru

Properti

  • tugas

    string opsional

    Jika result adalah SUCCESS, memberikan handle yang dapat digunakan untuk membaca data pemindaian atau membatalkan tugas.

  • Hasil dari memulai pemindaian. Jika nilai ini adalah SUCCESS, properti job akan diisi.

  • scannerHandle

    string

    Menyediakan handle pemindai yang sama dengan yang diteruskan ke startScan().

Metode

cancelScan()

Janji Chrome 125 dan yang lebih baru 
chrome.documentScan.cancelScan(
  job: string,
  callback?: function,
)

Membatalkan pemindaian yang dimulai dan menampilkan Promise yang di-resolve dengan objek CancelScanResponse. Jika callback digunakan, objek tersebut akan diteruskan ke callback tersebut.

Parameter

  • tugas

    string

    Tuas tugas pemindaian aktif yang sebelumnya ditampilkan dari panggilan ke startScan.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (response: CancelScanResponse) => void

Hasil

  • Promise&lt;CancelScanResponse&gt;

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

closeScanner()

Janji Chrome 125 dan yang lebih baru 
chrome.documentScan.closeScanner(
  scannerHandle: string,
  callback?: function,
)

Menutup pemindai dengan handle yang diteruskan dan menampilkan Promise yang di-resolve dengan objek CloseScannerResponse. Jika callback digunakan, objek tersebut akan diteruskan ke callback tersebut. Meskipun respons tidak berhasil, handle yang disediakan menjadi tidak valid dan tidak boleh digunakan untuk operasi lebih lanjut.

Parameter

  • scannerHandle

    string

    Menentukan handle pemindai terbuka yang sebelumnya ditampilkan dari panggilan ke openScanner.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (response: CloseScannerResponse) => void

Hasil

  • Promise&lt;CloseScannerResponse&gt;

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

getOptionGroups()

Janji Chrome 125 dan yang lebih baru 
chrome.documentScan.getOptionGroups(
  scannerHandle: string,
  callback?: function,
)

Mendapatkan nama grup dan opsi anggota dari pemindai yang sebelumnya dibuka oleh openScanner. Metode ini menampilkan Promise yang di-resolve dengan objek GetOptionGroupsResponse. Jika callback diteruskan ke fungsi ini, data yang ditampilkan akan diteruskan ke fungsi tersebut.

Parameter

Hasil

  • Promise&lt;GetOptionGroupsResponse&gt;

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

getScannerList()

Janji Chrome 125 dan yang lebih baru 
chrome.documentScan.getScannerList(
  filter: DeviceFilter,
  callback?: function,
)

Mendapatkan daftar pemindai yang tersedia dan menampilkan Promise yang di-resolve dengan objek GetScannerListResponse. Jika callback diteruskan ke fungsi ini, data yang ditampilkan akan diteruskan ke fungsi tersebut.

Parameter

Hasil

  • Promise&lt;GetScannerListResponse&gt;

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

openScanner()

Janji Chrome 125 dan yang lebih baru 
chrome.documentScan.openScanner(
  scannerId: string,
  callback?: function,
)

Membuka pemindai untuk akses eksklusif dan menampilkan Promise yang di-resolve dengan objek OpenScannerResponse. Jika callback diteruskan ke fungsi ini, data yang ditampilkan akan diteruskan ke fungsi tersebut.

Parameter

  • scannerId

    string

    ID pemindai yang akan dibuka. Nilai ini adalah salah satu yang ditampilkan dari panggilan sebelumnya ke getScannerList.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (response: OpenScannerResponse) => void

Hasil

  • Promise&lt;OpenScannerResponse&gt;

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

readScanData()

Janji Chrome 125 dan yang lebih baru 
chrome.documentScan.readScanData(
  job: string,
  callback?: function,
)

Membaca bagian berikutnya dari data gambar yang tersedia dari handle tugas aktif, dan menampilkan Promise yang di-resolve dengan objek ReadScanDataResponse. Jika callback digunakan, objek tersebut akan diteruskan ke callback tersebut.

**Catatan:**hasil respons adalah SUCCESS dengan anggota data berdurasi nol. Ini berarti pemindai masih bekerja tetapi belum memiliki data tambahan yang siap. Penelepon akan menunggu beberapa saat dan mencoba lagi.

Setelah tugas pemindaian selesai, respons akan memiliki nilai hasil EOF. Respons ini dapat berisi anggota akhir data yang bukan nol.

Parameter

Hasil

  • Promise&lt;ReadScanDataResponse&gt;

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

scan()

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

Melakukan pemindaian dokumen dan menampilkan Promise yang di-resolve dengan objek ScanResults. Jika callback diteruskan ke fungsi ini, data yang ditampilkan akan diteruskan ke fungsi tersebut.

Parameter

  • Objek yang berisi parameter pemindaian.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (result: ScanResults) => void

Hasil

  • Promise&lt;ScanResults&gt;

    Chrome 96 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

setOptions()

Janji Chrome 125 dan yang lebih baru 
chrome.documentScan.setOptions(
  scannerHandle: string,
  options: OptionSetting[],
  callback?: function,
)

Menetapkan opsi pada pemindai yang ditentukan dan menampilkan Promise yang di-resolve dengan objek SetOptionsResponse berisi hasil dari percobaan menetapkan setiap nilai sesuai urutan objek OptionSetting yang diteruskan. Jika callback digunakan, objek tersebut akan diteruskan ke callback tersebut.

Parameter

  • scannerHandle

    string

    Tuas pemindai untuk menyetel opsi. Nilai ini harus berupa nilai yang sebelumnya ditampilkan dari panggilan ke openScanner.

  • opsi

    OptionSetting[]

    Daftar objek OptionSetting yang akan diterapkan ke pemindai.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (response: SetOptionsResponse) => void

Hasil

  • Promise&lt;SetOptionsResponse&gt;

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

startScan()

Janji Chrome 125 dan yang lebih baru 
chrome.documentScan.startScan(
  scannerHandle: string,
  options: StartScanOptions,
  callback?: function,
)

Memulai pemindaian pada pemindai yang ditentukan dan menampilkan Promise yang di-resolve dengan StartScanResponse. Jika callback digunakan, objek tersebut akan diteruskan ke callback tersebut. Jika panggilan berhasil, respons akan menyertakan handle tugas yang dapat digunakan dalam panggilan berikutnya untuk membaca data pemindaian atau membatalkan pemindaian.

Parameter

  • scannerHandle

    string

    Gagang pemindai terbuka. Nilai ini harus berupa nilai yang sebelumnya ditampilkan dari panggilan ke openScanner.

  • Objek StartScanOptions yang menunjukkan opsi yang akan digunakan untuk pemindaian. Properti StartScanOptions.format harus cocok dengan salah satu entri yang ditampilkan dalam ScannerInfo pemindai.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti ini: 

    (response: StartScanResponse) => void

Hasil

  • Promise&lt;StartScanResponse&gt;

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.