This module provides the capability of recognizing barcodes from an image or image data, including 1D codes, QR codes, and multifunctional codes, and obtaining the code type, value, and position information.
Start version: 4.1.0(11)
Image where barcodes are to be scanned.
System capability: SystemCapability.Multimedia.Scan.ScanBarcode
Start version: 4.1.0(11)
Parameter | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
uri | string | No | No | Image path, for example, file://media/Photo/x/xxx.jpg. |
import { photoAccessHelper } from '@kit.MediaLibraryKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
let photoSelectOptions = new photoAccessHelper.PhotoSelectOptions();
photoSelectOptions.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
photoSelectOptions.maxSelectNumber = 1;
photoSelectOptions.isPhotoTakingSupported = false;
photoSelectOptions.isEditSupported = false;
let photoPicker = new photoAccessHelper.PhotoViewPicker();
photoPicker.select(photoSelectOptions).then((result: photoAccessHelper.PhotoSelectResult) => {
if (!result || (result.photoUris && result.photoUris.length === 0)) {
hilog.error(0x0001, 'picker', 'Failed to get PhotoSelectResult by promise.');
return;
}
hilog.info(0x0001, 'picker', `Succeeded in getting PhotoSelectResult by promise, result is ${JSON.stringify(result)}`);
}) decode(inputImage: InputImage, options?: scanBarcode.ScanOptions): Promise<Array<scanBarcode.ScanResult>>
Scans barcodes in an image based on input parameters, and asynchronously returns the result using a promise.
System capability: SystemCapability.Multimedia.Scan.ScanBarcode
Start version: 4.1.0(11)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
inputImage | Yes | Image where barcodes are to be scanned. | |
options | scanBarcode.ScanOptions | No | Parameters for scanning barcodes on the image. |
Type | Description |
|---|---|
Promise<Array<scanBarcode.ScanResult>> | Promise object, used to return the result. |
Error codes:
For details about the error codes, please refer to ArkTS API Error Codes.
Error Code | Error Message |
|---|---|
401 | Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. |
1000500001 | Internal error. |
Example:
import { scanCore, scanBarcode, detectBarcode } from '@kit.ScanKit';
import { photoAccessHelper } from '@kit.MediaLibraryKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
// Define scanning parameter.
let options: scanBarcode.ScanOptions = { scanTypes: [scanCore.ScanType.ALL], enableMultiMode: true, enableAlbum: true };
// Use picker to open the gallery and select an image.
let photoOption = new photoAccessHelper.PhotoSelectOptions();
photoOption.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
photoOption.maxSelectNumber = 1;
let photoPicker = new photoAccessHelper.PhotoViewPicker();
photoPicker.select(photoOption).then((result) => {
// Define the barcode scanning parameter inputImage. The uri parameter indicates the image selected using picker.
let inputImage: detectBarcode.InputImage = { uri: result.photoUris[0] };
try {
// Call the API for recognizing barcodes in an image.
detectBarcode.decode(inputImage, options).then((result: Array<scanBarcode.ScanResult>) => {
hilog.info(0x0001, '[Scan Sample]',
`Succeeded in getting ScanResult by promise with options, result is ${JSON.stringify(result)}`);
}).catch((error: BusinessError) => {
hilog.error(0x0001, '[Scan Sample]',
`Failed to get ScanResult by promise with options. Code: ${error.code}, message: ${error.message}`);
});
} catch (error) {
hilog.error(0x0001, '[Scan Sample]',
`Failed to detect Barcode. Code: ${error.code}, message: ${error.message}`);
}
}) decode(inputImage: InputImage, options: scanBarcode.ScanOptions, callback: AsyncCallback<Array<scanBarcode.ScanResult>>): void
Scans barcodes in an image based on input parameters, and asynchronously returns the result using a callback.
System capability: SystemCapability.Multimedia.Scan.ScanBarcode
Start version: 4.1.0(11)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
inputImage | Yes | Image where barcodes are to be scanned. | |
options | scanBarcode.ScanOptions | Yes | Parameters for scanning barcodes on the image. |
callback | AsyncCallback<Array<scanBarcode.ScanResult>> | Yes | Callback used to return the result. If the operation is successful, err is undefined and data is the recognition result (Array<scanBarcode.ScanResult>); otherwise, err is an error object. |
Error codes:
For details about the error codes, please refer to ArkTS API Error Codes.
Error Code | Error Message |
|---|---|
401 | Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. |
1000500001 | Internal error. |
Example:
import { photoAccessHelper } from '@kit.MediaLibraryKit';
import { scanCore, scanBarcode, detectBarcode } from '@kit.ScanKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
// Define scanning parameter.
let options: scanBarcode.ScanOptions = { scanTypes: [scanCore.ScanType.ALL], enableMultiMode: true, enableAlbum: true }
// Open the photoPicker UI for users to select an image.
let photoOption = new photoAccessHelper.PhotoSelectOptions();
photoOption.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
photoOption.maxSelectNumber = 1;
let photoPicker = new photoAccessHelper.PhotoViewPicker();
photoPicker.select(photoOption).then((result) => {
// Define the barcode scanning parameter inputImage. The uri parameter indicates the image selected using picker.
let inputImage: detectBarcode.InputImage = { uri: result.photoUris[0] };
try {
// Call the API for recognizing barcodes in an image.
detectBarcode.decode(inputImage, options, (error: BusinessError, result: Array<scanBarcode.ScanResult>) => {
if (error && error.code) {
hilog.error(0x0001, '[Scan Sample]',
`Failed to get ScanResult by callback with options. Code: ${error.code}, message: ${error.message}`);
return;
}
hilog.info(0x0001, '[Scan Sample]',
`Succeeded in getting ScanResult by callback with options, result is ${JSON.stringify(result)}`);
});
} catch (error) {
hilog.error(0x0001, '[Scan Sample]',
`Failed to detect Barcode. Code: ${error.code}, message: ${error.message}`);
}
}) decode(inputImage: InputImage, callback: AsyncCallback<Array<scanBarcode.ScanResult>>): void
Returns the image-based scanning result using a callback.
System capability: SystemCapability.Multimedia.Scan.ScanBarcode
Start version: 4.1.0(11)
Parameters:
Parameter | Type | Mandatory | Description |
|---|---|---|---|
inputImage | Yes | Image where barcodes are to be scanned. | |
callback | AsyncCallback<Array<scanBarcode.ScanResult>> | Yes | Callback used to return the result. If the operation is successful, err is undefined and data is the recognition result (Array<scanBarcode.ScanResult>); otherwise, err is an error object. |
Error codes:
For details about the error codes, please refer to ArkTS API Error Codes.
Error Code | Error Message |
|---|---|
401 | Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. |
1000500001 | Internal error. |
Example:
import { scanBarcode, detectBarcode } from '@kit.ScanKit';
import { photoAccessHelper } from '@kit.MediaLibraryKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
// Use picker to open the gallery and select an image.
let photoOption = new photoAccessHelper.PhotoSelectOptions();
photoOption.MIMEType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_TYPE;
photoOption.maxSelectNumber = 1;
let photoPicker = new photoAccessHelper.PhotoViewPicker();
photoPicker.select(photoOption).then((result) => {
// Define the barcode scanning parameter inputImage. The uri parameter indicates the image selected using picker.
let inputImage: detectBarcode.InputImage = { uri: result.photoUris[0] };
try {
// Call the API for recognizing barcodes in an image.
detectBarcode.decode(inputImage, (error: BusinessError, result: Array<scanBarcode.ScanResult>) => {
if (error && error.code) {
hilog.error(0x0001, '[Scan Sample]',
`Failed to get ScanResult by callback. Code: ${error.code}, message: ${error.message}`);
return;
}
hilog.info(0x0001, '[Scan Sample]',
`Succeeded in getting ScanResult by callback, result is ${JSON.stringify(result)}`);
});
} catch (error) {
hilog.error(0x0001, '[Scan Sample]',
`Failed to detect Barcode. Code: ${error.code}, message: ${error.message}`);
}
}) Contains image data to be recognized.
System capability: SystemCapability.Multimedia.Scan.ScanBarcode
Start version: 5.0.0(12)
Parameter | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
byteBuffer | ArrayBuffer | No | No | Image data. |
width | number | No | No | Image width, in px. |
height | number | No | No | Image height, in px. |
format | No | No | Image data type. |
Example:
import { detectBarcode } from '@kit.ScanKit';
// Buffer, height, and width data of the YUV image, which can be obtained from the camera preview stream data. This example assumes that the width and height obtained are 1920 x 1080.
let byteImg: detectBarcode.ByteImage = {
byteBuffer: buffer,
width: 1920,
height: 1080,
format: detectBarcode.ImageFormat.NV21
}; Defines enumerated images data types.
System capability: SystemCapability.Multimedia.Scan.ScanBarcode
Start version: 5.0.0(12)
Parameter | Value | Description |
|---|---|---|
NV21 | 0 | NV21 image format. |
Contains the recognition result.
System capability: SystemCapability.Multimedia.Scan.ScanBarcode
Start version: 5.0.0(12)
Parameter | Type | Read-Only | Optional | Description |
|---|---|---|---|---|
scanResults | Array<scanBarcode.ScanResult> | No | No | Scanning result. |
zoomValue | number | No | No | Camera zoom ratio. You can call setZoomRatio to control the zoom ratio. NOTE:
|
decodeImage(image: ByteImage, options?: scanBarcode.ScanOptions): Promise<DetectResult>
Scans barcodes in an image based on input parameters, and asynchronously returns the result using a promise.
System capability: SystemCapability.Multimedia.Scan.ScanBarcode
Start version: 5.0.0(12)
Parameters:
Parameter | Type | Read-Only | Mandatory | Description |
|---|---|---|---|---|
image | No | Yes | Image data to be recognized. | |
options | scanBarcode.ScanOptions | No | No | Parameters for scanning barcodes on the image. |
Type | Description |
|---|---|
Promise<DetectResult> | Promise object, used to return the recognition result. |
Error codes:
For details about the error codes, please refer to ArkTS API Error Codes.
Error Code | Error Message |
|---|---|
401 | Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. |
1000500001 | Internal error. |
import { scanCore, scanBarcode, detectBarcode } from '@kit.ScanKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
// Obtain the YuvByteBuffer, YuvHeight, and YuvWidth parameters of the image first. This example assumes that the width and height obtained are 1920 x 1080.
let byteImg: detectBarcode.ByteImage = {
byteBuffer: YuvByteBuffer,
width: 1920,
height: 1080,
format: detectBarcode.ImageFormat.NV21
};
let options: scanBarcode.ScanOptions = {
scanTypes: [scanCore.ScanType.ALL],
enableMultiMode: true,
enableAlbum: false
};
try {
detectBarcode.decodeImage(byteImg, options).then((result: detectBarcode.DetectResult) => {
hilog.info(0x0001, '[Scan Sample]',
`Succeeded in getting DetectResult by promise with options, result is ${JSON.stringify(result)}`);
}).catch((error: BusinessError) => {
hilog.error(0x0001, '[Scan Sample]',
`Failed to get DetectResult by promise with options. Code: ${error.code}, message: ${error.message}`);
});
} catch (error) {
hilog.error(0x0001, '[Scan Sample]', `Failed to decode Image. Code: ${error.code}, message: ${error.message}`);
}
Concurrent calls are not supported.