java.lang.Object
- com.google.zxing.client.android.Intents.Scan

Enclosing class:: Intents

public static final class Intents.Scan
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ACTION`	Send this intent to open the Barcodes app in scanning mode, find a barcode, and return the results.
`static String`	`AZTEC_MODE`	Decode only Aztec.
`static String`	`BARCODE_IMAGE_ENABLED`	Set to true to return a path to the barcode's image as it was captured.
`static String`	`BEEP_ENABLED`	Set to false to disable beep.
`static String`	`CAMERA_ID`	Optional parameter to specify the id of the camera from which to recognize barcodes.
`static String`	`CHARACTER_SET`
`static String`	`DATA_MATRIX_MODE`	Decode only Data Matrix codes.
`static String`	`FORMATS`	Comma-separated list of formats to scan for.
`static int`	`INVERTED_SCAN`	The scan should be inverted.
`static String`	`MISSING_CAMERA_PERMISSION`	Set the time to finish the scan screen.
`static String`	`MISSING_CAMERA_PERMISSION_DIALOG_MESSAGE`	Set the time to finish the scan screen.
`static int`	`MIXED_SCAN`	Scan alternating inverted and normal barcodes.
`static String`	`MODE`	By default, sending this will decode all barcodes that we understand.
`static int`	`NORMAL_SCAN`	Scan normal barcodes white on black
`static String`	`ONE_D_MODE`	Decode only 1D barcodes.
`static String`	`ORIENTATION_LOCKED`	Whether or not the orientation should be locked when the activity is first started.
`static String`	`PDF417_MODE`	Decode only PDF417.
`static String`	`PRODUCT_MODE`	Decode only UPC and EAN barcodes.
`static String`	`PROMPT_MESSAGE`	Prompt to show on-screen when scanning by intent.
`static String`	`QR_CODE_MODE`	Decode only QR codes.
`static String`	`RESULT`	If a barcode is found, Barcodes returns `Activity.RESULT_OK` to `Activity.onActivityResult(int, int, android.content.Intent)` of the app which requested the scan via `Activity.startActivityForResult(android.content.Intent, int)` The barcodes contents can be retrieved with `Intent.getStringExtra(String)`.
`static String`	`RESULT_BARCODE_IMAGE_PATH`	Call `Intent.getStringExtra(String)` with `RESULT_BARCODE_IMAGE_PATH` to get a `String` path to a cropped and compressed png file of the barcode's image as it was displayed.
`static String`	`RESULT_BYTE_SEGMENTS_PREFIX`	Prefix for keys that map to the values of `ResultMetadataType.BYTE_SEGMENTS`, if available.
`static String`	`RESULT_BYTES`	Call `Intent.getByteArrayExtra(String)` with `RESULT_BYTES` to get a `byte[]` of raw bytes in the barcode, if available.
`static String`	`RESULT_ERROR_CORRECTION_LEVEL`	Key for the value of `ResultMetadataType.ERROR_CORRECTION_LEVEL`, if available.
`static String`	`RESULT_FORMAT`	Call `Intent.getStringExtra(String)` with `RESULT_FORMAT` to determine which barcode format was found.
`static String`	`RESULT_ORIENTATION`	Key for the value of `ResultMetadataType.ORIENTATION`, if available.
`static String`	`RESULT_UPC_EAN_EXTENSION`	Call `Intent.getStringExtra(String)` with `RESULT_UPC_EAN_EXTENSION` to return the content of any UPC extension barcode that was also found.
`static String`	`SCAN_TYPE`	Define the scan type.
`static String`	`SHOW_MISSING_CAMERA_PERMISSION_DIALOG`	Set the time to finish the scan screen.
`static String`	`TIMEOUT`	Set the time to finish the scan screen.
`static String`	`TORCH_ENABLED`	Optional parameter to switch the torch on at camera startup.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ACTION
```
public static final String ACTION
```
    Send this intent to open the Barcodes app in scanning mode, find a barcode, and return the results.
    
    See Also:
    
    Constant Field Values
  - MODE
```
public static final String MODE
```
    By default, sending this will decode all barcodes that we understand. However it may be useful to limit scanning to certain formats. Use Intent.putExtra(String, String) with one of the values below. Setting this is effectively shorthand for setting explicit formats with FORMATS. It is overridden by that setting.
    
    See Also:
    
    Constant Field Values
  - PRODUCT_MODE
```
public static final String PRODUCT_MODE
```
    Decode only UPC and EAN barcodes. This is the right choice for shopping apps which get prices, reviews, etc. for products.
    
    See Also:
    
    Constant Field Values
  - ONE_D_MODE
```
public static final String ONE_D_MODE
```
    Decode only 1D barcodes.
    
    See Also:
    
    Constant Field Values
  - QR_CODE_MODE
```
public static final String QR_CODE_MODE
```
    Decode only QR codes.
    
    See Also:
    
    Constant Field Values
  - DATA_MATRIX_MODE
```
public static final String DATA_MATRIX_MODE
```
    Decode only Data Matrix codes.
    
    See Also:
    
    Constant Field Values
  - AZTEC_MODE
```
public static final String AZTEC_MODE
```
    Decode only Aztec.
    
    See Also:
    
    Constant Field Values
  - PDF417_MODE
```
public static final String PDF417_MODE
```
    Decode only PDF417.
    
    See Also:
    
    Constant Field Values
  - FORMATS
```
public static final String FORMATS
```
    Comma-separated list of formats to scan for. The values must match the names of BarcodeFormats, e.g. BarcodeFormat.EAN_13. Example: "EAN_13,EAN_8,QR_CODE". This overrides MODE.
    
    See Also:
    
    Constant Field Values
  - CAMERA_ID
```
public static final String CAMERA_ID
```
    Optional parameter to specify the id of the camera from which to recognize barcodes. Overrides the default camera that would otherwise would have been selected. If provided, should be an int.
    
    See Also:
    
    Constant Field Values
  - TORCH_ENABLED
```
public static final String TORCH_ENABLED
```
    Optional parameter to switch the torch on at camera startup. Enables the torch on camera startup If provided, should be a boolean.
    
    See Also:
    
    Constant Field Values
  - CHARACTER_SET
```
public static final String CHARACTER_SET
```
    See Also:
    
    DecodeHintType.CHARACTER_SET, Constant Field Values
  - BEEP_ENABLED
```
public static final String BEEP_ENABLED
```
    Set to false to disable beep. Defaults to true.
    
    See Also:
    
    Constant Field Values
  - BARCODE_IMAGE_ENABLED
```
public static final String BARCODE_IMAGE_ENABLED
```
    Set to true to return a path to the barcode's image as it was captured. Defaults to false.
    
    See Also:
    
    Constant Field Values
  - TIMEOUT
```
public static final String TIMEOUT
```
    Set the time to finish the scan screen.
    
    See Also:
    
    Constant Field Values
  - MISSING_CAMERA_PERMISSION
```
public static final String MISSING_CAMERA_PERMISSION
```
    Set the time to finish the scan screen.
    
    See Also:
    
    Constant Field Values
  - SHOW_MISSING_CAMERA_PERMISSION_DIALOG
```
public static final String SHOW_MISSING_CAMERA_PERMISSION_DIALOG
```
    Set the time to finish the scan screen.
    
    See Also:
    
    Constant Field Values
  - MISSING_CAMERA_PERMISSION_DIALOG_MESSAGE
```
public static final String MISSING_CAMERA_PERMISSION_DIALOG_MESSAGE
```
    Set the time to finish the scan screen.
    
    See Also:
    
    Constant Field Values
  - ORIENTATION_LOCKED
```
public static final String ORIENTATION_LOCKED
```
    Whether or not the orientation should be locked when the activity is first started. Defaults to true.
    
    See Also:
    
    Constant Field Values
  - PROMPT_MESSAGE
```
public static final String PROMPT_MESSAGE
```
    Prompt to show on-screen when scanning by intent. Specified as a String.
    
    See Also:
    
    Constant Field Values
  - RESULT
```
public static final String RESULT
```
    If a barcode is found, Barcodes returns Activity.RESULT_OK to Activity.onActivityResult(int, int, android.content.Intent) of the app which requested the scan via Activity.startActivityForResult(android.content.Intent, int) The barcodes contents can be retrieved with Intent.getStringExtra(String). If the user presses Back, the result code will be Activity.RESULT_CANCELED.
    
    See Also:
    
    Constant Field Values
  - RESULT_FORMAT
```
public static final String RESULT_FORMAT
```
    Call Intent.getStringExtra(String) with RESULT_FORMAT to determine which barcode format was found. See BarcodeFormat for possible values.
    
    See Also:
    
    Constant Field Values
  - RESULT_UPC_EAN_EXTENSION
```
public static final String RESULT_UPC_EAN_EXTENSION
```
    Call Intent.getStringExtra(String) with RESULT_UPC_EAN_EXTENSION to return the content of any UPC extension barcode that was also found. Only applicable to BarcodeFormat.UPC_A and BarcodeFormat.EAN_13 formats.
    
    See Also:
    
    Constant Field Values
  - RESULT_BYTES
```
public static final String RESULT_BYTES
```
    Call Intent.getByteArrayExtra(String) with RESULT_BYTES to get a byte[] of raw bytes in the barcode, if available.
    
    See Also:
    
    Constant Field Values
  - RESULT_ORIENTATION
```
public static final String RESULT_ORIENTATION
```
    Key for the value of ResultMetadataType.ORIENTATION, if available. Call Intent.getIntArrayExtra(String) with RESULT_ORIENTATION.
    
    See Also:
    
    Constant Field Values
  - RESULT_ERROR_CORRECTION_LEVEL
```
public static final String RESULT_ERROR_CORRECTION_LEVEL
```
    Key for the value of ResultMetadataType.ERROR_CORRECTION_LEVEL, if available. Call Intent.getStringExtra(String) with RESULT_ERROR_CORRECTION_LEVEL.
    
    See Also:
    
    Constant Field Values
  - RESULT_BYTE_SEGMENTS_PREFIX
```
public static final String RESULT_BYTE_SEGMENTS_PREFIX
```
    Prefix for keys that map to the values of ResultMetadataType.BYTE_SEGMENTS, if available. The actual values will be set under a series of keys formed by adding 0, 1, 2, ... to this prefix. So the first byte segment is under key "SCAN_RESULT_BYTE_SEGMENTS_0" for example. Call Intent.getByteArrayExtra(String) with these keys.
    
    See Also:
    
    Constant Field Values
  - RESULT_BARCODE_IMAGE_PATH
```
public static final String RESULT_BARCODE_IMAGE_PATH
```
    Call Intent.getStringExtra(String) with RESULT_BARCODE_IMAGE_PATH to get a String path to a cropped and compressed png file of the barcode's image as it was displayed. Only available if IntentIntegrator.setBarcodeImageEnabled(boolean) is called with true.
    
    See Also:
    
    Constant Field Values
  - SCAN_TYPE
```
public static final String SCAN_TYPE
```
    Define the scan type.
    
    See Also:
    
    Constant Field Values
  - NORMAL_SCAN
```
public static final int NORMAL_SCAN
```
    Scan normal barcodes white on black
    
    See Also:
    
    Constant Field Values
  - INVERTED_SCAN
```
public static final int INVERTED_SCAN
```
    The scan should be inverted. White becomes black, black becomes white.
    
    See Also:
    
    Constant Field Values
  - MIXED_SCAN
```
public static final int MIXED_SCAN
```
    Scan alternating inverted and normal barcodes.
    
    See Also:
    
    Constant Field Values

Class Intents.Scan

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION

MODE

PRODUCT_MODE

ONE_D_MODE

QR_CODE_MODE

DATA_MATRIX_MODE

AZTEC_MODE

PDF417_MODE

FORMATS

CAMERA_ID

TORCH_ENABLED

CHARACTER_SET

BEEP_ENABLED

BARCODE_IMAGE_ENABLED

TIMEOUT

MISSING_CAMERA_PERMISSION

SHOW_MISSING_CAMERA_PERMISSION_DIALOG

MISSING_CAMERA_PERMISSION_DIALOG_MESSAGE

ORIENTATION_LOCKED

PROMPT_MESSAGE

RESULT

RESULT_FORMAT

RESULT_UPC_EAN_EXTENSION

RESULT_BYTES

RESULT_ORIENTATION

RESULT_ERROR_CORRECTION_LEVEL

RESULT_BYTE_SEGMENTS_PREFIX

RESULT_BARCODE_IMAGE_PATH

SCAN_TYPE

NORMAL_SCAN

INVERTED_SCAN

MIXED_SCAN