Scanner

All Known Implementing Classes:

BluetoothScanner, SoftwareScanner, SoftwareScanner_H35, UsbScanner
```
public interface Scanner
```
スキャナを操作するためのインターフェース
このクラスを通してスキャナとアプリの接続・切断や読み取りなどの操作をする
Interface for operating the scanner
Through this class, you can connect / disconnect the scanner and the application, read them, and so on.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addBarcodeEventListener(BarcodeEventListener barcodeEventListener)` コールバック用のインターフェース`BarcodeEventListener`を登録する Register the interface `BarcodeEventListener` for the callback.
`boolean`	`deinit()` スキャナとの切断を行う Disconnect from the scanner.
`ReadDataExtra`	`getReadDataExtra()` 最後に読み取りが成功したデータの拡張情報を取得する Get the extended information of the last successfully read data.
`ScannerInfo`	`getScannerInfo()` インスタンスのスキャナ情報を得る Get instance scanner information.
`ScannerSettings`	`getSettings()` スキャナの現在の設定情報を`ScannerSettings`として取得する Get the current scanner settings as `ScannerSettings`.
`boolean`	`init()` スキャナとの接続を行う Make a connection with the scanner.
`boolean`	`isConnected()` スキャナとの接続が完了しているかどうかを返す Returns whether the connection with the scanner is complete.
`ScannerSettings`	`readFileSettings(java.lang.String filePath)` 設定値をファイルから読み込む Read the setting value from the file.
`boolean`	`removeBarcodeEventListener()` コールバック用のインターフェース`BarcodeEventListener`を削除する Remove the interface `BarcodeEventListener` for the callback.
`boolean`	`saveFileSettings(java.lang.String filePath, ScannerSettings settings)` 設定値をファイルに保存する Save the settings to a file.
`boolean`	`sendCommand(java.lang.String universalCommand)` スキャンエンジンが備える機能をAPIを介さずにUniversalコマンドで設定する Set the functions provided by the scan engine with universal commands without going through the API.
`boolean`	`setDefaultSettings()` スキャナの設定を工場出荷時設定に戻す Reset scanner settings to factory settings.
`boolean`	`setSettings(ScannerSettings scannerSettings)` スキャナへ設定情報を送信する Send the setting information to the scanner.
`boolean`	`startScan()` 接続したスキャナで読み取りを開始する Start reading with the connected scanner.
`boolean`	`stopScan()` 接続したスキャナで読み取りを終了する Finish reading with the connected scanner.
`boolean`	`takePicture(int imageType)` 接続したスキャナで画像撮影を行う Take an image with the connected scanner.

- Method Detail
  - getScannerInfo
```
ScannerInfo getScannerInfo()
```
    インスタンスのスキャナ情報を得る
    Get instance scanner information.
    
    Returns:
    
    ScannerManager.getScanner(ScannerInfo)のパラメータとして使用したScannerInfo
    ScannerInfo used as a parameter of ScannerManager.getScanner(ScannerInfo)
  - isConnected
```
boolean isConnected()
```
    スキャナとの接続が完了しているかどうかを返す
    Returns whether the connection with the scanner is complete.
    
    Returns:
    
    接続済み true / 未接続 false
    Connected : true / Not connected : false
  - startScan
```
boolean startScan()
```
    接続したスキャナで読み取りを開始する
    Start reading with the connected scanner.
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - stopScan
```
boolean stopScan()
```
    接続したスキャナで読み取りを終了する
    Finish reading with the connected scanner.
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - takePicture
```
boolean takePicture(int imageType)
```
    接続したスキャナで画像撮影を行う
    Take an image with the connected scanner.
    
    Parameters:
    
    imageType - 1:jpeg , 3:BMP
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - init
```
boolean init()
```
    スキャナとの接続を行う
    Make a connection with the scanner.
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - deinit
```
boolean deinit()
```
    スキャナとの切断を行う
    Disconnect from the scanner.
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - addBarcodeEventListener
```
boolean addBarcodeEventListener(BarcodeEventListener barcodeEventListener)
```
    コールバック用のインターフェースBarcodeEventListenerを登録する
    Register the interface BarcodeEventListener for the callback.
    
    Returns:
    
    登録完了 true / 登録失敗 false
    Registration completed : true / Registration failed : false
  - removeBarcodeEventListener
```
boolean removeBarcodeEventListener()
```
    コールバック用のインターフェースBarcodeEventListenerを削除する
    Remove the interface BarcodeEventListener for the callback.
    
    Returns:
    
    登録完了 true / 登録失敗 false
    Registration completed : true / Registration failed : false
  - getSettings
```
ScannerSettings getSettings()
```
    スキャナの現在の設定情報をScannerSettingsとして取得する
    Get the current scanner settings as ScannerSettings.
    
    Returns:
    
    正常に取得できた時 ScannerSettings / 異常動作 null
    When it can be acquired normally : ScannerSettings / Abnormal operation : null
  - setSettings
```
boolean setSettings(ScannerSettings scannerSettings)
```
    スキャナへ設定情報を送信する
    Send the setting information to the scanner.
    
    Parameters:
    
    scannerSettings - 設定内容を編集したScannerSettings
    Edited settings ScannerSettings
    
    Returns:
    
    送信成功 true / 送信失敗 false
    Send success : true / Send failure : false
  - setDefaultSettings
```
boolean setDefaultSettings()
```
    スキャナの設定を工場出荷時設定に戻す
    Reset scanner settings to factory settings.
    
    Returns:
    
    正常に設定できた時 true / 設定失敗 false
    When it can be set normally : true / Setting failure : false
  - sendCommand
```
boolean sendCommand(java.lang.String universalCommand)
```
    スキャンエンジンが備える機能をAPIを介さずにUniversalコマンドで設定する
    Set the functions provided by the scan engine with universal commands without going through the API.
    
    設定した内容を無効にしたい場合は、文字列を含まない状態(””)で設定してください。
    一部のコマンドは設定することが出来ません。
    なお、前回設定したコマンドは破棄されて、新たにコマンドが設定されます。
    If you want to disable the set content, set it without a character string ("").
    Some commands cannot be set.
    The previously set command will be discarded and a new command will be set.
    
    Parameters:
    
    universalCommand - ユニバーサルコマンド
    Universal command
    
    Returns:
    
    送信成功 true / 送信失敗 false
    Send success : true / Send failure : false
  - getReadDataExtra
```
ReadDataExtra getReadDataExtra()
```
    最後に読み取りが成功したデータの拡張情報を取得する
    Get the extended information of the last successfully read data.
    
    Returns:
    
    正常に取得できた時 ReadDataExtra / 異常動作 null
    When it can be acquired normally : ReadDataExtra / Abnormal operation : null
  - saveFileSettings
```
boolean saveFileSettings(java.lang.String filePath,
                         ScannerSettings settings)
```
    設定値をファイルに保存する
    Save the settings to a file.
    
    Parameters:
    
    filePath - ファイルパス
    File Path
    
    settings - 設定値ScannerSettings
    Settings ScannerSettings
    
    Returns:
    
    保存成功 true /保存失敗 false
    Save successful : true / Save failed : false
  - readFileSettings
```
ScannerSettings readFileSettings(java.lang.String filePath)
```
    設定値をファイルから読み込む
    Read the setting value from the file.
    
    Parameters:
    
    filePath - ファイルパス
    File Path
    
    Returns:
    
    正常に読み込めた時設定値ScannerSettings /読み込み失敗 null
    When it can be read normally : ScannerSettings / Read failure : null

Interface Scanner

Method Summary

Method Detail

getScannerInfo

isConnected

startScan

stopScan

takePicture

init

deinit

addBarcodeEventListener

removeBarcodeEventListener

getSettings

setSettings

setDefaultSettings

sendCommand

getReadDataExtra

saveFileSettings

readFileSettings