MLKitBarcodeScanning フレームワーク リファレンス

MLKBarcodeScanner


@interface MLKBarcodeScanner : NSObject

画像内のバーコードをスキャンするバーコード スキャナ。

  • 指定されたオプションでバーコード スキャナを返します。

    宣言

    Objective-C

    + (nonnull instancetype)barcodeScannerWithOptions:
        (nonnull MLKBarcodeScannerOptions *)options;

    パラメータ

    options

    バーコード スキャナ設定を含むオプション。

    戻り値

    指定されたオプションで構成されたバーコード スキャナ。

  • デフォルトのオプションでバーコード スキャナを返します。

    宣言

    Objective-C

    + (nonnull instancetype)barcodeScanner;

    戻り値

    デフォルトのオプションで構成されたバーコード スキャナ。

  • 使用できません。クラスメソッドを使用します。

    宣言

    Objective-C

    - (nonnull instancetype)init;
  • 指定された画像をバーコード スキャン用に処理します。

    宣言

    Objective-C

    - (void)processImage:(nonnull id<MLKCompatibleImage>)image
              completion:(nonnull MLKBarcodeScanningCallback)completion;

    パラメータ

    image

    処理する画像。

    completion

    バーコードがスキャンされた、またはエラーが発生したときにメインキューにコールバックするためのハンドラ。

  • 指定された画像のバーコード結果を返します。エラーがある場合は nil を返します。バーコード スキャンは呼び出し元のスレッドで同期的に実行されます。

    UI をブロックしないよう、メインスレッド以外でこのメソッドを呼び出すことをおすすめします。そのため、このメソッドがメインスレッドで呼び出されると、NSException が発生します。

    宣言

    Objective-C

    - (nullable NSArray<MLKBarcode *> *)
        resultsInImage:(nonnull id<MLKCompatibleImage>)image
                 error:(NSError *_Nullable *_Nullable)error;

    パラメータ

    image

    結果を取得する画像。

    error

    結果の取得中にエラーが発生した場合に入力されるオプションのエラー パラメータ。

    戻り値

    バーコードの配列は指定された画像になります。エラーがある場合は nil になります。