UsbScanner

java.lang.Object
- com.opticon.scannersdk.scanner.UsbScanner

All Implemented Interfaces:: Scanner, IBarcodeReaderObserver

public class UsbScanner
extends java.lang.Object
implements Scanner, IBarcodeReaderObserver

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addBarcodeEventListener(BarcodeEventListener barcodeEventListener)` コールバック用のインターフェース`BarcodeEventListener`を登録する Register the interface `BarcodeEventListener` for the callback.
`void`	`connected()` デバイスに接続された時に実行されます Runs when connected to a device.
`void`	`connectFailed()` デバイスに接続を試みて、失敗した時に実行されます It will be executed when it tries to connect to the device and fails.
`void`	`connectionLost()` デバイスとの接続が解除されたときに実行されます Executed when the connection with the device is disconnected.
`boolean`	`deinit()` スキャナとの切断を行う Disconnect from the scanner.
`static UsbScanner`	`getInstance(android.content.Context context, ScannerInfo scannerInfo)`
`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.
`void`	`receive(java.lang.String str)` デバイスからデータを受信した時に実行されます Executed when data is received from the device.
`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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static UsbScanner getInstance(android.content.Context context,
                                     ScannerInfo scannerInfo)
```
  - getScannerInfo
```
public ScannerInfo getScannerInfo()
```
    Description copied from interface: Scanner
    
    インスタンスのスキャナ情報を得る
    Get instance scanner information.
    
    Specified by:
    
    getScannerInfo in interface Scanner
    
    Returns:
    
    ScannerManager.getScanner(ScannerInfo)のパラメータとして使用したScannerInfo
    ScannerInfo used as a parameter of ScannerManager.getScanner(ScannerInfo)
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: Scanner
    
    スキャナとの接続が完了しているかどうかを返す
    Returns whether the connection with the scanner is complete.
    
    Specified by:
    
    isConnected in interface Scanner
    
    Returns:
    
    接続済み true / 未接続 false
    Connected : true / Not connected : false
  - startScan
```
public boolean startScan()
```
    Description copied from interface: Scanner
    
    接続したスキャナで読み取りを開始する
    Start reading with the connected scanner.
    
    Specified by:
    
    startScan in interface Scanner
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - stopScan
```
public boolean stopScan()
```
    Description copied from interface: Scanner
    
    接続したスキャナで読み取りを終了する
    Finish reading with the connected scanner.
    
    Specified by:
    
    stopScan in interface Scanner
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - takePicture
```
public boolean takePicture(int imageType)
```
    Description copied from interface: Scanner
    
    接続したスキャナで画像撮影を行う
    Take an image with the connected scanner.
    
    Specified by:
    
    takePicture in interface Scanner
    
    Parameters:
    
    imageType - 1:jpeg , 3:BMP
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - init
```
public boolean init()
```
    Description copied from interface: Scanner
    
    スキャナとの接続を行う
    Make a connection with the scanner.
    
    Specified by:
    
    init in interface Scanner
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - deinit
```
public boolean deinit()
```
    Description copied from interface: Scanner
    
    スキャナとの切断を行う
    Disconnect from the scanner.
    
    Specified by:
    
    deinit in interface Scanner
    
    Returns:
    
    正常動作 true / 異常動作 false
    Normal operation : true / Abnormal operation : false
  - addBarcodeEventListener
```
public boolean addBarcodeEventListener(BarcodeEventListener barcodeEventListener)
```
    Description copied from interface: Scanner
    
    コールバック用のインターフェースBarcodeEventListenerを登録する
    Register the interface BarcodeEventListener for the callback.
    
    Specified by:
    
    addBarcodeEventListener in interface Scanner
    
    Returns:
    
    登録完了 true / 登録失敗 false
    Registration completed : true / Registration failed : false
  - removeBarcodeEventListener
```
public boolean removeBarcodeEventListener()
```
    Description copied from interface: Scanner
    
    コールバック用のインターフェースBarcodeEventListenerを削除する
    Remove the interface BarcodeEventListener for the callback.
    
    Specified by:
    
    removeBarcodeEventListener in interface Scanner
    
    Returns:
    
    登録完了 true / 登録失敗 false
    Registration completed : true / Registration failed : false
  - getSettings
```
public ScannerSettings getSettings()
```
    Description copied from interface: Scanner
    
    スキャナの現在の設定情報をScannerSettingsとして取得する
    Get the current scanner settings as ScannerSettings.
    
    Specified by:
    
    getSettings in interface Scanner
    
    Returns:
    
    正常に取得できた時 ScannerSettings / 異常動作 null
    When it can be acquired normally : ScannerSettings / Abnormal operation : null
  - setSettings
```
public boolean setSettings(ScannerSettings scannerSettings)
```
    Description copied from interface: Scanner
    
    スキャナへ設定情報を送信する
    Send the setting information to the scanner.
    
    Specified by:
    
    setSettings in interface Scanner
    
    Parameters:
    
    scannerSettings - 設定内容を編集したScannerSettings
    Edited settings ScannerSettings
    
    Returns:
    
    送信成功 true / 送信失敗 false
    Send success : true / Send failure : false
  - setDefaultSettings
```
public boolean setDefaultSettings()
```
    Description copied from interface: Scanner
    
    スキャナの設定を工場出荷時設定に戻す
    Reset scanner settings to factory settings.
    
    Specified by:
    
    setDefaultSettings in interface Scanner
    
    Returns:
    
    正常に設定できた時 true / 設定失敗 false
    When it can be set normally : true / Setting failure : false
  - sendCommand
```
public boolean sendCommand(java.lang.String universalCommand)
```
    Description copied from interface: Scanner
    
    スキャンエンジンが備える機能を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.
    
    Specified by:
    
    sendCommand in interface Scanner
    
    Parameters:
    
    universalCommand - ユニバーサルコマンド
    Universal command
    
    Returns:
    
    送信成功 true / 送信失敗 false
    Send success : true / Send failure : false
  - getReadDataExtra
```
public ReadDataExtra getReadDataExtra()
```
    Description copied from interface: Scanner
    
    最後に読み取りが成功したデータの拡張情報を取得する
    Get the extended information of the last successfully read data.
    
    Specified by:
    
    getReadDataExtra in interface Scanner
    
    Returns:
    
    正常に取得できた時 ReadDataExtra / 異常動作 null
    When it can be acquired normally : ReadDataExtra / Abnormal operation : null
  - saveFileSettings
```
public boolean saveFileSettings(java.lang.String filePath,
                                ScannerSettings settings)
```
    Description copied from interface: Scanner
    
    設定値をファイルに保存する
    Save the settings to a file.
    
    Specified by:
    
    saveFileSettings in interface Scanner
    
    Parameters:
    
    filePath - ファイルパス
    File Path
    
    settings - 設定値ScannerSettings
    Settings ScannerSettings
    
    Returns:
    
    保存成功 true /保存失敗 false
    Save successful : true / Save failed : false
  - readFileSettings
```
public ScannerSettings readFileSettings(java.lang.String filePath)
```
    Description copied from interface: Scanner
    
    設定値をファイルから読み込む
    Read the setting value from the file.
    
    Specified by:
    
    readFileSettings in interface Scanner
    
    Parameters:
    
    filePath - ファイルパス
    File Path
    
    Returns:
    
    正常に読み込めた時設定値ScannerSettings /読み込み失敗 null
    When it can be read normally : ScannerSettings / Read failure : null
  - connected
```
public void connected()
```
    Description copied from interface: IBarcodeReaderObserver
    
    デバイスに接続された時に実行されます
    Runs when connected to a device.
    
    Specified by:
    
    connected in interface IBarcodeReaderObserver
  - connectFailed
```
public void connectFailed()
```
    Description copied from interface: IBarcodeReaderObserver
    
    デバイスに接続を試みて、失敗した時に実行されます
    It will be executed when it tries to connect to the device and fails.
    
    Specified by:
    
    connectFailed in interface IBarcodeReaderObserver
  - connectionLost
```
public void connectionLost()
```
    Description copied from interface: IBarcodeReaderObserver
    
    デバイスとの接続が解除されたときに実行されます
    Executed when the connection with the device is disconnected.
    
    Specified by:
    
    connectionLost in interface IBarcodeReaderObserver
  - receive
```
public void receive(java.lang.String str)
```
    Description copied from interface: IBarcodeReaderObserver
    
    デバイスからデータを受信した時に実行されます
    Executed when data is received from the device.
    
    Specified by:
    
    receive in interface IBarcodeReaderObserver
    
    Parameters:
    
    str - 受信したデータ
    Received data.

Class UsbScanner

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getScannerInfo

isConnected

startScan

stopScan

takePicture

init

deinit

addBarcodeEventListener

removeBarcodeEventListener

getSettings

setSettings

setDefaultSettings

sendCommand

getReadDataExtra

saveFileSettings

readFileSettings

connected

connectFailed

connectionLost

receive