説明
chrome.documentScan
API を使用して、接続されているドキュメント スキャナから画像を検出し、取得します。
権限
documentScan
可用性
ドキュメント スキャン API
Document Scan API は、アプリと拡張機能が、接続されたドキュメント スキャナで紙のドキュメントの内容を表示できるようにするように設計されています。
型
CancelScanResponse
プロパティ
-
ジョブ
string
cancelScan()
に渡されたのと同じジョブハンドルを提供します。 -
件の結果
バックエンドのスキャンのキャンセル結果。結果が
OperationResult.SUCCESS
またはOperationResult.CANCELLED
の場合、スキャンはキャンセルされており、スキャナは新しいスキャンを開始できる状態です。結果がOperationResult.DEVICE_BUSY
の場合、Scanner はリクエストされたキャンセルを引き続き処理しています。呼び出し元は、しばらく待ってからリクエストを再試行する必要があります。その他の結果値は、再試行できない永続的なエラーを示しています。
CloseScannerResponse
プロパティ
-
件の結果
スキャナを終了した結果。この値が
SUCCESS
でない場合でも、ハンドルは無効になるため、以降のオペレーションには使用しないでください。 -
scannerHandle
string
closeScanner
に渡されたものと同じスキャナ ハンドル。
Configurability
オプションの変更方法
列挙型
"NOT_CONFIGURABLE"
このオプションは読み取り専用です。
"SOFTWARE_CONFIGURABLE"
このオプションはソフトウェアで設定できます。
"HARDWARE_CONFIGURABLE"
このオプションは、ユーザーがスキャナのボタンを切り替えたり押したりすることで設定できます。
ConnectionType
スキャナがパソコンにどのように接続されているかを示します。
列挙型
列挙型
"INT_RANGE"
OptionType.INT
値の範囲に対する制約。OptionConstraint
の min
、max
、quant
プロパティは long
になり、list
プロパティは設定解除されます。
"FIXED_RANGE"
OptionType.FIXED
値の範囲に対する制約。OptionConstraint
の min
、max
、quant
プロパティは double
になり、list
プロパティは設定解除されます。
"INT_LIST"
OptionType.INT
値の特定のリストに対する制約。OptionConstraint.list
プロパティには long
値が含まれ、他のプロパティは設定解除されます。
"FIXED_LIST"
OptionType.FIXED
値の特定のリストに対する制約。OptionConstraint.list
プロパティには double
値が含まれ、他のプロパティは設定解除されます。
"STRING_LIST"
OptionType.STRING
値の特定のリストに対する制約。OptionConstraint.list
プロパティには DOMString
値が含まれ、他のプロパティは設定解除されます。
DeviceFilter
プロパティ
-
ローカル
ブール値(省略可)
コンピュータに直接接続されているスキャナのみを返します。
-
安全
ブール値(省略可)
返却するのは、USB や TLS などのセキュアなトランスポートを使用するスキャナのみにしてください。
GetOptionGroupsResponse
プロパティ
-
グループ
OptionGroup[] 省略可
result
がSUCCESS
の場合、スキャナ ドライバで指定された順序でオプション グループのリストを提供します。 -
件の結果
オプション グループの取得結果。この値が
SUCCESS
の場合、groups
プロパティに値が入力されます。 -
scannerHandle
string
getOptionGroups
に渡されたものと同じスキャナ ハンドル。
GetScannerListResponse
プロパティ
-
件の結果
列挙結果。エラーを示している場合でも、部分的な結果が返されることがあります。
-
スキャナ
指定された
DeviceFilter
に一致するスキャナのリスト。空の場合もあります。
OpenScannerResponse
プロパティ
-
オプション
オブジェクト 省略可
result
がSUCCESS
の場合、キーはデバイス固有のオプション、値はScannerOption
のインスタンスである Key-Value マッピングを提供します。 -
件の結果
スキャナを起動した結果。この値が
SUCCESS
の場合、scannerHandle
プロパティとoptions
プロパティに値が入力されます。 -
scannerHandle
string(省略可)
result
がSUCCESS
の場合、以降の操作に使用できるスキャナへのハンドル。 -
scannerId
string
openScanner()
に渡されるスキャナ ID。
OperationResult
各オペレーションの結果を示す列挙型。
列挙型
"UNKNOWN"
不明なエラーまたは一般的なエラーが発生しました。
"SUCCESS"
操作が完了しました。
"UNSUPPORTED"
この操作はサポートされていません。
"CANCELLED"
オペレーションはキャンセルされました。
"DEVICE_BUSY"
このデバイスはビジー状態です。
"INVALID"
メソッドに渡されたデータまたは引数のいずれかが無効です。
"WRONG_TYPE"
指定された値は、基になるオプションのデータ型として間違っています。
"EOF"
利用可能なデータはこれ以上ありません。
"ADF_JAMMED"
ドキュメント フィーダーが故障しています。
"ADF_EMPTY"
ドキュメント フィーダーが空です。
"COVER_OPEN"
フラットベッドのカバーが開いています。
"IO_ERROR"
デバイスとの通信中にエラーが発生しました。
"ACCESS_DENIED"
このデバイスには認証が必要です。
"NO_MEMORY"
Chromebook に十分なメモリがないため、操作を完了できません。
「接続できません」
デバイスにアクセスできません。
「MISSING」
デバイスの接続が解除されています。
"INTERNAL_ERROR"
呼び出し元のアプリケーション以外の場所でエラーが発生しました。
OptionConstraint
プロパティ
-
list
string[] | number[] 省略可
-
max
number(省略可)
-
分
number(省略可)
-
クオンツ
number(省略可)
-
type
OptionGroup
プロパティ
-
メンバー
string[]
ドライバが提供する順序でのオプション名の配列。
-
title
string
印刷可能なタイトルを指定します(「ジオメトリ オプション」など)。
OptionSetting
プロパティ
-
name
string
設定するオプションの名前を示します。
-
type
オプションのデータ型を示します。リクエストするデータ型は、基になるオプションの実際のデータ型と一致する必要があります。
-
value
string | number | boolean | number[] 省略可
設定する値を示します。
autoSettable
が有効になっているオプションの自動設定をリクエストするには、未設定のままにします。value
に指定するデータ型はtype
と一致する必要があります。
OptionType
オプションのデータタイプ。
列挙型
"UNKNOWN"
オプションのデータタイプが不明です。value
プロパティは設定解除されます。
"BOOL"
value
プロパティは、true
false のいずれかになります。
"INT"
32 ビット符号付き整数。value
プロパティは、オプションが複数の値を取るかどうかに応じて、long または long[] になります。
「修正済み」
-32768 ~ 32767.9999 の範囲の倍精度、解像度 1/65535。value
プロパティは、オプションが複数の値を取るかどうかに応じて double または double[] になります。正確に表現できない倍精度値は、使用可能な範囲と精度に丸められます。
"STRING"
NUL(「\0」)を除く任意のバイトのシーケンス。value
プロパティは DOMString になります。
"BUTTON"
このタイプのオプションには値がありません。代わりに、このタイプのオプションを設定すると、スキャナ ドライバでオプション固有の副作用が発生します。たとえば、スキャナ ドライバはボタンタイプのオプションを使用して、デフォルト値を選択する手段を提供したり、自動ドキュメント フィーダーに次の用紙に進むよう指示したりできます。
"GROUP"
グループ化オプション。値なし。互換性のために含まれていますが、通常は ScannerOption
値では返されません。getOptionGroups()
を使用して、グループのリストとそのメンバー オプションを取得します。
列挙型
"UNITLESS"
値は単位のない数値です。たとえば、しきい値などです。
"PIXEL"
値はピクセル数です(スキャン寸法など)。
"BIT"
値はビット数です(色深度など)。
"MM"
値はミリメートル単位で測定されます(スキャン寸法など)。
"DPI"
値は 1 インチあたりのドット数で測定されます(解像度など)。
"PERCENT"
値はパーセントです(明るさなど)。
"MICROSECOND"
この値はマイクロ秒単位で測定されます(露出時間など)。
ReadScanDataResponse
プロパティ
-
データ
ArrayBuffer 省略可
result
がSUCCESS
の場合、スキャンされたイメージデータの次のチャンクが含まれます。result
がEOF
の場合、スキャンされたイメージデータの最後のチャンクが含まれます。 -
estimatedCompletion
number(省略可)
result
がSUCCESS
の場合、これまでに配信されたスキャンデータの合計量の推定(0 ~ 100 の範囲)。 -
ジョブ
string
readScanData()
に渡されるジョブハンドルを提供します。 -
件の結果
データの読み取り結果。その値が
SUCCESS
の場合、data
には、読み取りの準備ができている画像データの次のチャンク(長さがゼロである場合もあります)が含まれます。値がEOF
の場合、data
には画像データの最後のチャンクが含まれます。
ScannerInfo
プロパティ
-
connectionType
スキャナがパソコンにどのように接続されているかを示します。
-
deviceUuid
string
同じ物理デバイスを指す他の
ScannerInfo
エントリと照合します。 -
imageFormats
string[]
返されるスキャンに対してリクエストできる MIME タイプの配列。
-
メーカー
string
スキャナのメーカー。
-
model
string
スキャナのモデル(利用可能な場合)、または一般的な説明。
-
name
string
UI に表示するスキャナの、人が読める形式の名前。
-
protocolType
string
Mopria、WSD、epsonds など、スキャナーへのアクセスに使用されるプロトコルまたはドライバの、人が読める形式の説明。これは主に、デバイスが複数のプロトコルをサポートしている場合に、ユーザーがプロトコルを選択できるようにする場合に便利です。
-
scannerId
string
特定のスキャナの ID。
-
安全
boolean
true の場合、TLS や USB などのパッシブ リスナーでスキャナ接続のトランスポートをインターセプトできません。
ScannerOption
プロパティ
-
構成の柔軟性
オプションを変更できるかどうか、および変更できるかどうかを示します。
-
制約
OptionConstraint 省略可
現在のスキャナ オプションで
OptionConstraint
を定義します。 -
description
string
オプションの詳細な説明。
-
isActive
boolean
オプションが有効で、設定または取得できることを示します。false の場合、
value
プロパティは設定されません。 -
isAdvanced
boolean
デフォルトでは、UI にこのオプションを表示しないことを示します。
-
isAutoSettable
boolean
スキャナ ドライバで自動的に設定できます。
-
isDetectable
boolean
このオプションがソフトウェアから検出できることを示します。
-
isEmulated
boolean
true の場合、スキャナ ドライバによってエミュレートされます。
-
name
string
小文字の ASCII 文字、数字、ダッシュを使用したオプション名。付加記号は使用できません。
-
title
string
印刷可能な 1 行のタイトル。
-
type
value
プロパティに含まれるデータ型。このオプションの設定に必要です。 -
単位
このオプションの測定単位。
-
value
string | number | boolean | number[] 省略可
オプションの現在の値(該当する場合)。このプロパティのデータ型は、
type
で指定されたデータ型と一致する必要があります。
ScanOptions
プロパティ
-
maxImages
number(省略可)
許可されるスキャン画像の数。デフォルトは 1 です。
-
mimeTypes
string[] 省略可
呼び出し元が受け入れる MIME タイプ。
ScanResults
プロパティ
-
dataUrls
string[]
「src」値として画像タグに渡すことができる形式のデータ画像 URL の配列。
-
mimeType
string
dataUrls
の MIME タイプ。
SetOptionResult
プロパティ
-
name
string
設定されたオプションの名前を示します。
-
件の結果
オプションの設定結果を示します。
SetOptionsResponse
プロパティ
-
オプション
オブジェクト 省略可
指定されたすべてのオプションを設定しようとした後の、オプション名から新しい設定を含む
ScannerOption
値への Key-Value マッピングを更新しました。これは、OpenScannerResponse
のoptions
プロパティと同じ構造です。このプロパティは、一部のオプションが正常に設定されなかった場合でも設定されますが、更新された設定を取得できなかった場合(スキャン中にスキャナが切断された場合など)は設定されません。
-
結果
結果の配列(渡された
OptionSetting
ごとに 1 つずつ)。 -
scannerHandle
string
setOptions()
に渡されるスキャナ ハンドルを提供します。
StartScanOptions
プロパティ
-
形式
string
スキャンされたデータを返す MIME タイプを指定します。
-
maxReadSize
number(省略可)
ゼロ以外の値を指定すると、1 回の
readScanData
レスポンスで返されるスキャンの最大バイト数をその値に制限します。指定できる最小値は 32,768(32 KB)です。このプロパティが指定されていない場合、返されるチャンクのサイズは、スキャンされたイメージ全体と同じ大きさになる可能性があります。
StartScanResponse
プロパティ
-
ジョブ
string(省略可)
result
がSUCCESS
の場合、スキャンデータの読み取りまたはジョブのキャンセルに使用できるハンドルを指定します。 -
件の結果
スキャンを開始した結果。この値が
SUCCESS
の場合、job
プロパティに値が入力されます。 -
scannerHandle
string
startScan()
に渡されたのと同じスキャナ ハンドルを提供します。
メソッド
cancelScan()
chrome.documentScan.cancelScan(
job: string,
callback?: function,
)
開始したスキャンをキャンセルし、CancelScanResponse
オブジェクトで解決される Promise を返します。コールバックが使用されている場合は、代わりにオブジェクトが渡されます。
パラメータ
-
ジョブ
string
以前に
startScan
の呼び出しから返されたアクティブなスキャンジョブのハンドル。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(response: CancelScanResponse) => void
-
レスポンス
-
戻り値
-
Promise<CancelScanResponse>
Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
closeScanner()
chrome.documentScan.closeScanner(
scannerHandle: string,
callback?: function,
)
渡されたハンドルでスキャナを閉じ、CloseScannerResponse
オブジェクトで解決される Promise を返します。コールバックが使用されている場合は、代わりにオブジェクトが渡されます。レスポンスが成功でない場合でも、指定されたハンドルは無効になるため、以降のオペレーションには使用しないでください。
パラメータ
-
scannerHandle
string
以前に
openScanner
の呼び出しで返された、開いているスキャナのハンドルを指定します。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(response: CloseScannerResponse) => void
-
レスポンス
-
戻り値
-
Promise<CloseScannerResponse>
Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
getOptionGroups()
chrome.documentScan.getOptionGroups(
scannerHandle: string,
callback?: function,
)
以前に openScanner
が開いたスキャナからグループ名とメンバー オプションを取得します。このメソッドは、GetOptionGroupsResponse
オブジェクトで解決される Promise を返します。この関数にコールバックが渡されると、返されたデータが代わりに渡されます。
パラメータ
-
scannerHandle
string
openScanner
の呼び出しから返された、開いているスキャナのハンドル。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(response: GetOptionGroupsResponse) => void
-
レスポンス
-
戻り値
-
Promise<GetOptionGroupsResponse>
Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
getScannerList()
chrome.documentScan.getScannerList(
filter: DeviceFilter,
callback?: function,
)
使用可能なスキャナのリストを取得し、GetScannerListResponse
オブジェクトで解決される Promise を返します。この関数にコールバックが渡されると、返されたデータが代わりに渡されます。
パラメータ
-
フィルタ
返されるスキャナの種類を示す
DeviceFilter
。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(response: GetScannerListResponse) => void
-
レスポンス
-
戻り値
-
Promise<GetScannerListResponse>
Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
openScanner()
chrome.documentScan.openScanner(
scannerId: string,
callback?: function,
)
排他的なアクセスのためにスキャナを開き、OpenScannerResponse
オブジェクトで解決される Promise を返します。この関数にコールバックが渡されると、返されたデータが代わりに渡されます。
パラメータ
-
scannerId
string
開くスキャナの ID。この値は、前回の
getScannerList
の呼び出しから返された値です。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(response: OpenScannerResponse) => void
-
レスポンス
-
戻り値
-
Promise<OpenScannerResponse>
Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
readScanData()
chrome.documentScan.readScanData(
job: string,
callback?: function,
)
アクティブなジョブハンドルから使用可能な画像データの次のチャンクを読み取り、ReadScanDataResponse
オブジェクトで解決される Promise を返します。コールバックが使用されている場合は、代わりにオブジェクトが渡されます。
**注:**長さがゼロの data
メンバーを含むレスポンス結果が SUCCESS
になることは有効です。つまり、スキャナは動作していますが、追加のデータがまだ準備されていません。発信者はしばらく待ってから再試行する必要があります。
スキャンジョブが完了すると、レスポンスの結果値は EOF
になります。このレスポンスには、最後にゼロ以外の data
メンバーが含まれる場合があります。
パラメータ
-
ジョブ
string
以前
startScan
から返されたアクティブなジョブハンドル。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(response: ReadScanDataResponse) => void
-
レスポンス
-
戻り値
-
Promise<ReadScanDataResponse>
Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
scan()
chrome.documentScan.scan(
options: ScanOptions,
callback?: function,
)
ドキュメント スキャンを実行し、ScanResults
オブジェクトで解決される Promise を返します。この関数にコールバックが渡された場合は、代わりに返されたデータが渡されます。
パラメータ
-
オプション
スキャン パラメータを含むオブジェクト。
-
callback
関数(省略可)
callback
パラメータは次のようになります。(result: ScanResults) => void
-
件の結果
-
戻り値
-
Promise<ScanResults>
Chrome 96 以降Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
setOptions()
chrome.documentScan.setOptions(
scannerHandle: string,
options: OptionSetting[],
callback?: function,
)
指定されたスキャナにオプションを設定し、渡された OptionSetting
オブジェクトの順序ですべての値を設定しようとした結果を含む SetOptionsResponse
オブジェクトで解決される Promise を返します。コールバックが使用されている場合は、代わりにオブジェクトが渡されます。
パラメータ
-
scannerHandle
string
オプションを設定するスキャナのハンドル。これは、以前に
openScanner
の呼び出しで返された値になります。 -
オプション
スキャナに適用する
OptionSetting
オブジェクトのリスト。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(response: SetOptionsResponse) => void
-
レスポンス
-
戻り値
-
Promise<SetOptionsResponse>
Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。
startScan()
chrome.documentScan.startScan(
scannerHandle: string,
options: StartScanOptions,
callback?: function,
)
指定されたスキャナのスキャンを開始し、StartScanResponse
で解決される Promise を返します。コールバックが使用されている場合は、代わりにオブジェクトが渡されます。呼び出しが成功した場合、レスポンスには、スキャンデータの読み取りやスキャンのキャンセルなどの後続の呼び出しで使用できるジョブ ハンドルが含まれます。
パラメータ
-
scannerHandle
string
開いているスキャナのハンドル。これは、以前に
openScanner
の呼び出しで返された値になります。 -
オプション
スキャンに使用するオプションを示す
StartScanOptions
オブジェクト。StartScanOptions.format
プロパティは、スキャナのScannerInfo
で返されるエントリのいずれかと一致する必要があります。 -
callback
関数(省略可)
callback
パラメータは次のようになります。(response: StartScanResponse) => void
-
レスポンス
-
戻り値
-
Promise<StartScanResponse>
Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。