このページは Cloud Translation API によって翻訳されました。

ML Kit を使用してバーコードをスキャンする（Android）

ML Kit を使用すると、バーコードの認識とデコードを行うことができます。

機能	バンドルされていません	バンドル
実装	モデルは Google Play 開発者サービスを介して動的にダウンロードされます。	モデルは、ビルド時にアプリに静的にリンクされます。
アプリのサイズ	約 200 KB のサイズ増加。	サイズが約 2.4 MB 増加します。
初期化時間	初めて使用するには、モデルがダウンロードされるのを待たなければならない場合があります。	モデルはすぐに使用できます。

試してみる

サンプルアプリを試してみましょう。この API の使用例をご覧ください
マテリアルデザインのショーケースを見る app をご覧ください。

始める前に

</ph> この API には Android API レベル 21 以降が必要です。アプリのビルドと実行がファイルが minSdkVersion の値 21 以上を使用していること。

プロジェクトレベルの build.gradle ファイルに、Google の buildscript セクションと allprojects セクションの両方に Maven リポジトリ

ML Kit Android ライブラリの依存関係をモジュールのアプリレベルの Gradle ファイル（通常は app/build.gradle）。次のいずれかを選択必要に応じて次の依存関係を追加します。

モデルをアプリにバンドルする場合:

dependencies {
  // ...
  // Use this dependency to bundle the model with your app
  implementation 'com.google.mlkit:barcode-scanning:17.3.0'
}

Google Play 開発者サービスでモデルを使用する場合:

dependencies {
  // ...
  // Use this dependency to use the dynamically downloaded model in Google Play Services
  implementation 'com.google.android.gms:play-services-mlkit-barcode-scanning:18.3.1'
}

Google Play 開発者サービスでモデルを使用することを選択した場合、アプリがダウンロードされると、モデルが自動的にデバイスにダウンロードされるようになります。ダウンロードする必要があります。そのためには、次の宣言をアプリの AndroidManifest.xml ファイルを次のように変更します。
```
<application ...>
      ...
      <meta-data
          android:name="com.google.mlkit.vision.DEPENDENCIES"
          android:value="barcode" >
      
</application>
```
モデルの提供状況を明示的に確認し、 Google Play 開発者サービスの ModuleInstallClient API。

インストール時のモデルのダウンロードを有効にしない場合、または明示的なダウンロードをリクエストしない場合、モデルは、初めてスキャナを実行するときにダウンロードされます。お客様が行うリクエスト結果が返されないことに注意してください。

入力画像のガイドライン

ML Kit でバーコードを正確に読み取るには、入力画像に十分なピクセルデータによって表されるバーコードです。

特定のピクセルデータ要件は、使用するピクセルとエンコードされたデータの量可変サイズのペイロードをサポートします一般的に、ラベルに対して幅 2 ピクセル以上で、かつ 2 次元コード、高さ 2 ピクセル。

たとえば、EAN-13 バーコードは、バーとスペースで構成されています。幅が 2、3、または 4 単位の場合、EAN-13 バーコード画像には、バーと少なくとも 2、4、6、8 ピクセル幅のスペース。EAN-13 はバーコードは合計で 95 ユニットの幅があり、バーコードは 190 以上である必要があります。ピクセル幅。

PDF417 などの高密度形式では、確実に読み取ることができますたとえば、PDF417 のコードには最大で 17 単位幅の「単語」が 34 個少なくとも 1 行あたり幅 1,156 ピクセル。
画像のフォーカスが不適切だと、スキャンの精度に影響する可能性があります。アプリがインストールされていない画像をキャプチャし直すようユーザーに求めます。
一般的なアプリケーションでは、より高いレベルの 1280x720 や 1920x1080 など解像度の画像を使用することになり、カメラから遠く離れた場所からでもスキャンできます。

ただし、レイテンシが重要なアプリケーションでは、パフォーマンスは向上しますがバーコードが入力画像の大部分を占めます関連項目リアルタイムのパフォーマンスを改善するためのヒント

1. バーコードスキャナを構成する

読み取るバーコードの形式がわかっている場合は、その形式のみを検出するように構成します。

たとえば、Aztec コードと QR コードのみを検出するには、 BarcodeScannerOptions オブジェクトを返します。

Kotlin

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(
                Barcode.FORMAT_QR_CODE,
                Barcode.FORMAT_AZTEC)
        .build()BarcodeScanningActivity.kt

Java

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(
                Barcode.FORMAT_QR_CODE,
                Barcode.FORMAT_AZTEC)
        .build();BarcodeScanningActivity.java

次の形式がサポートされています。

Code 128（FORMAT_CODE_128）
Code 39（FORMAT_CODE_39）
Code 93（FORMAT_CODE_93）
Codabar（FORMAT_CODABAR）
EAN-13（FORMAT_EAN_13）
EAN-8（FORMAT_EAN_8）
ITF（FORMAT_ITF）
UPC-A（FORMAT_UPC_A）
UPC-E（FORMAT_UPC_E）
QR コード（FORMAT_QR_CODE）
PDF417（FORMAT_PDF417）
アステカ語（FORMAT_AZTEC）
Data Matrix（FORMAT_DATA_MATRIX）

で確認できます。

バンドルされたモデル 17.1.0 とバンドルされていないモデル 18.2.0 以降では、次を呼び出すこともできます。 enableAllPotentialBarcodes() は、次の場合であっても、潜在的なすべてのバーコードを返します。デコードできません。これは、さらなる検知を容易にするために使用できます。たとえば、返されたバーコードの鮮明な画像を取得するには、カメラをズームインします。指定します。

Kotlin

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .enableAllPotentialBarcodes() // Optional
        .build()

Java

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .enableAllPotentialBarcodes() // Optional
        .build();

Further on, starting from bundled library 17.2.0 and unbundled library 18.3.0, a new feature called auto-zoom has been introduced to further enhance the barcode scanning experience. With this feature enabled, the app is notified when all barcodes within the view are too distant for decoding. As a result, the app can effortlessly adjust the camera's zoom ratio to the recommended setting provided by the library, ensuring optimal focus and readability. This feature will significantly enhance the accuracy and success rate of barcode scanning, making it easier for apps to capture information precisely.

To enable auto-zooming and customize the experience, you can utilize the setZoomSuggestionOptions() method along with your own ZoomCallback handler and desired maximum zoom ratio, as demonstrated in the code below.

Kotlin

val options = BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .setZoomSuggestionOptions(
            new ZoomSuggestionOptions.Builder(zoomCallback)
                .setMaxSupportedZoomRatio(maxSupportedZoomRatio)
                .build()) // Optional
        .build()

Java

BarcodeScannerOptions options =
        new BarcodeScannerOptions.Builder()
        .setBarcodeFormats(...)
        .setZoomSuggestionOptions(
            new ZoomSuggestionOptions.Builder(zoomCallback)
                .setMaxSupportedZoomRatio(maxSupportedZoomRatio)
                .build()) // Optional
        .build();

zoomCallback is required to be provided to handle whenever the library suggests a zoom should be performed and this callback will always be called on the main thread.

The following code snippet shows an example of defining a simple callback.

Kotlin

fun setZoom(ZoomRatio: Float): Boolean {
    if (camera.isClosed()) return false
    camera.getCameraControl().setZoomRatio(zoomRatio)
    return true
}

Java

boolean setZoom(float zoomRatio) {
    if (camera.isClosed()) {
        return false;
    }
    camera.getCameraControl().setZoomRatio(zoomRatio);
    return true;
}

maxSupportedZoomRatio is related to the camera hardware, and different camera libraries have different ways to fetch it (see the javadoc of the setter method). In case this is not provided, an unbounded zoom ratio might be produced by the library which might not be supported. Refer to the setMaxSupportedZoomRatio() method introduction to see how to get the max supported zoom ratio with different Camera libraries.

When auto-zooming is enabled and no barcodes are successfully decoded within the view, BarcodeScanner triggers your zoomCallback with the requested zoomRatio. If the callback correctly adjusts the camera to this zoomRatio, it is highly probable that the most centered potential barcode will be decoded and returned.

A barcode may remain undecodable even after a successful zoom-in. In such cases, BarcodeScanner may either invoke the callback for another round of zoom-in until the maxSupportedZoomRatio is reached, or provide an empty list (or a list containing potential barcodes that were not decoded, if enableAllPotentialBarcodes() was called) to the OnSuccessListener (which will be defined in step 4. Process the image).

2. Prepare the input image

To recognize barcodes in an image, create an InputImage object from either a Bitmap, media.Image, ByteBuffer, byte array, or a file on the device. Then, pass the InputImage object to the BarcodeScanner's process method.

You can create an InputImage object from different sources, each is explained below.

Using a `media.Image`

To create an InputImage object from a media.Image object, such as when you capture an image from a device's camera, pass the media.Image object and the image's rotation to InputImage.fromMediaImage().

If you use the CameraX library, the OnImageCapturedListener and ImageAnalysis.Analyzer classes calculate the rotation value for you.

Kotlin

private class YourImageAnalyzer : ImageAnalysis.Analyzer {

    override fun analyze(imageProxy: ImageProxy) {
        val mediaImage = imageProxy.image
        if (mediaImage != null) {
            val image = InputImage.fromMediaImage(mediaImage, imageProxy.imageInfo.rotationDegrees)
            // Pass image to an ML Kit Vision API
            // ...
        }
    }
}

Java

private class YourAnalyzer implements ImageAnalysis.Analyzer {

    @Override
    public void analyze(ImageProxy imageProxy) {
        Image mediaImage = imageProxy.getImage();
        if (mediaImage != null) {
          InputImage image =
                InputImage.fromMediaImage(mediaImage, imageProxy.getImageInfo().getRotationDegrees());
          // Pass image to an ML Kit Vision API
          // ...
        }
    }
}

画像の回転角度を取得するカメラライブラリを使用しない場合は、デバイスの回転角度とカメラの向きから計算できます。次の動作を行います。

Kotlin

private val ORIENTATIONS = SparseIntArray()

init {
    ORIENTATIONS.append(Surface.ROTATION_0, 0)
    ORIENTATIONS.append(Surface.ROTATION_90, 90)
    ORIENTATIONS.append(Surface.ROTATION_180, 180)
    ORIENTATIONS.append(Surface.ROTATION_270, 270)
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
@Throws(CameraAccessException::class)
private fun getRotationCompensation(cameraId: String, activity: Activity, isFrontFacing: Boolean): Int {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    val deviceRotation = activity.windowManager.defaultDisplay.rotation
    var rotationCompensation = ORIENTATIONS.get(deviceRotation)

    // Get the device's sensor orientation.
    val cameraManager = activity.getSystemService(CAMERA_SERVICE) as CameraManager
    val sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION)!!

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360
    }
    return rotationCompensation
}MLKitVisionImage.kt

Java

private static final SparseIntArray ORIENTATIONS = new SparseIntArray();
static {
    ORIENTATIONS.append(Surface.ROTATION_0, 0);
    ORIENTATIONS.append(Surface.ROTATION_90, 90);
    ORIENTATIONS.append(Surface.ROTATION_180, 180);
    ORIENTATIONS.append(Surface.ROTATION_270, 270);
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
private int getRotationCompensation(String cameraId, Activity activity, boolean isFrontFacing)
        throws CameraAccessException {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    int deviceRotation = activity.getWindowManager().getDefaultDisplay().getRotation();
    int rotationCompensation = ORIENTATIONS.get(deviceRotation);

    // Get the device's sensor orientation.
    CameraManager cameraManager = (CameraManager) activity.getSystemService(CAMERA_SERVICE);
    int sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION);

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360;
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360;
    }
    return rotationCompensation;
}

次に、media.Image オブジェクトと回転角度の値を InputImage.fromMediaImage() に設定する:

Kotlin

val image = InputImage.fromMediaImage(mediaImage, rotation)MLKitVisionImage.kt

Java

InputImage image = InputImage.fromMediaImage(mediaImage, rotation);

ファイル URI の使用

InputImage を作成するには: 渡すことにより、アプリのコンテキストとファイルの URI を InputImage.fromFilePath()。これは、 ACTION_GET_CONTENT インテントを使用してユーザーに選択を求めるギャラリーアプリから画像を作成できます

Kotlin

val image: InputImage
try {
    image = InputImage.fromFilePath(context, uri)
} catch (e: IOException) {
    e.printStackTrace()
}MLKitVisionImage.kt

Java

InputImage image;
try {
    image = InputImage.fromFilePath(context, uri);
} catch (IOException e) {
    e.printStackTrace();
}

`ByteBuffer` または `ByteArray` の使用

InputImage を作成するには: 作成するには、まず画像を計算してByteBufferByteArray 前述の media.Image 入力に対する回転角度。次に、バッファまたは配列を含む InputImage オブジェクトを、画像の高さ、幅、カラーエンコード形式、回転角度:

Kotlin

val image = InputImage.fromByteBuffer(
        byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)MLKitVisionImage.kt
// Or:
val image = InputImage.fromByteArray(
        byteArray,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromByteBuffer(byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);MLKitVisionImage.java
// Or:
InputImage image = InputImage.fromByteArray(
        byteArray,
        /* image width */480,
        /* image height */360,
        rotation,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);MLKitVisionImage.java

`Bitmap` の使用

InputImage を作成するには: Bitmap オブジェクトから呼び出す場合は、次のように宣言します。

Kotlin

val image = InputImage.fromBitmap(bitmap, 0)MLKitVisionImage.kt

Java

InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);MLKitVisionImage.java

画像は、Bitmap オブジェクトと回転角度で表されます。

3. BarcodeScanner のインスタンスを取得する

Kotlin

val scanner = BarcodeScanning.getClient()
// Or, to specify the formats to recognize:
// val scanner = BarcodeScanning.getClient(options)BarcodeScanningActivity.kt

Java

BarcodeScanner scanner = BarcodeScanning.getClient();
// Or, to specify the formats to recognize:
// BarcodeScanner scanner = BarcodeScanning.getClient(options);BarcodeScanningActivity.java

4. 画像を処理する

画像を process メソッドに渡します。

Kotlin

val result = scanner.process(image)
        .addOnSuccessListener { barcodes ->
            // Task completed successfully
            // ...
        }
        .addOnFailureListener {
            // Task failed with an exception
            // ...
        }BarcodeScanningActivity.kt

Java

Task<List<Barcode>> result = scanner.process(image)
        .addOnSuccessListener(new OnSuccessListener<List<Barcode>>() {
            @Override
            public void onSuccess(List<Barcode> barcodes) {
                // Task completed successfully
                // ...
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Task failed with an exception
                // ...
            }
        });BarcodeScanningActivity.java

</ph> 注: CameraX API を使用する場合は、使用が終了したら必ず ImageProxy を閉じてください。たとえば、返された Task に OnCompleteListener を process メソッドを使用します。詳しくは、 <ph type="x-smartling-placeholder"></ph> VisionProcessorBase クラスをご覧ください。

5. バーコードから情報を取得する

バーコード認識オペレーションが成功すると、Barcode のリスト成功リスナーに渡されます。各 Barcode オブジェクトは、画像から検出されたバーコードが表示されます。バーコードごとに、入力画像の境界座標と、入力画像の境界座標と、できます。また、バーコードスキャナでデータの種類が判別できた場合も、解析されたデータを含むオブジェクトを取得できます。

例:

Kotlin

for (barcode in barcodes) {
    val bounds = barcode.boundingBox
    val corners = barcode.cornerPoints

    val rawValue = barcode.rawValue

    val valueType = barcode.valueType
    // See API reference for complete list of supported types
    when (valueType) {
        Barcode.TYPE_WIFI -> {
            val ssid = barcode.wifi!!.ssid
            val password = barcode.wifi!!.password
            val type = barcode.wifi!!.encryptionType
        }
        Barcode.TYPE_URL -> {
            val title = barcode.url!!.title
            val url = barcode.url!!.url
        }
    }
}BarcodeScanningActivity.kt

Java

for (Barcode barcode: barcodes) {
    Rect bounds = barcode.getBoundingBox();
    Point[] corners = barcode.getCornerPoints();

    String rawValue = barcode.getRawValue();

    int valueType = barcode.getValueType();
    // See API reference for complete list of supported types
    switch (valueType) {
        case Barcode.TYPE_WIFI:
            String ssid = barcode.getWifi().getSsid();
            String password = barcode.getWifi().getPassword();
            int type = barcode.getWifi().getEncryptionType();
            break;
        case Barcode.TYPE_URL:
            String title = barcode.getUrl().getTitle();
            String url = barcode.getUrl().getUrl();
            break;
    }
}BarcodeScanningActivity.java

リアルタイムのパフォーマンスを改善するためのヒント

リアルタイムアプリケーションでバーコードをスキャンする場合は、実現するためのガイドラインは次のとおりです。

カメラのネイティブ解像度で入力をキャプチャしないでください。デバイスによってはネイティブ解像度で入力をキャプチャすると、ありますが、レイテンシが非常に低くなり、分析に向上します代わりに、必要なサイズのみをカメラにリクエストしてください。（通常 2 メガピクセル以下）です。

スキャン速度が重要な場合は、画像のキャプチャ速度を解決します。ただし、バーコードのサイズの最小要件には概要をご覧ください。

一連のストリーミングからバーコードを認識する場合認識機能によって生成される結果はフレームによって異なり、クリックします。同じ注文が連続して届くまでお待ちください。正しい結果を返していると確信できます。

チェックサムは、ITF および CODE-39 ではサポートされていません。
「 Camera または camera2 API、スロットリングするように構成されています。新しい動画がフレームが使用可能になる場合は、そのフレームをドロップします。詳しくは、 <ph type="x-smartling-placeholder"></ph> VisionProcessorBase クラスをご覧ください。
CameraX API を使用する場合は、バックプレッシャー戦略がデフォルト値に <ph type="x-smartling-placeholder"></ph> ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST。これにより、分析のために一度に 1 つの画像のみが配信されるようになります。もしより多くの画像が生成された場合、自動的に破棄され、提供します。次の呼び出しによって分析中の画像を閉じたら、 ImageProxy.close() が呼び出されると、次に最新の画像が配信されます。
検出機能の出力を使用して、ディスプレイにグラフィックをオーバーレイする場合、まず ML Kit から結果を取得してから、画像をレンダリングする 1 ステップでオーバーレイできますこれにより、ディスプレイサーフェスにレンダリングされます。入力フレームごとに 1 回だけです。詳しくは、 <ph type="x-smartling-placeholder"></ph> CameraSourcePreview および <ph type="x-smartling-placeholder"></ph> GraphicOverlay クラスをご覧ください。
Camera2 API を使用する場合は、 ImageFormat.YUV_420_888 形式。古い Camera API を使用する場合は、 ImageFormat.NV21 形式。

ML Kit を使用してバーコードをスキャンする（Android）

試してみる

始める前に

入力画像のガイドライン

1. バーコード スキャナを構成する

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

2. Prepare the input image

Using a media.Image

Kotlin

Java

Kotlin

Java

Kotlin

Java

ファイル URI の使用

Kotlin

Java

ByteBuffer または ByteArray の使用

Kotlin

Java

Bitmap の使用

Kotlin

Java

3. BarcodeScanner のインスタンスを取得する

Kotlin

Java

4. 画像を処理する

Kotlin

Java

5. バーコードから情報を取得する

Kotlin

Java

リアルタイムのパフォーマンスを改善するためのヒント

1. バーコードスキャナを構成する

Using a `media.Image`

`ByteBuffer` または `ByteArray` の使用

`Bitmap` の使用