Java API Reference - BarcodeReader Video Methods
-
Decode
Method Description startFrameDecoding
Decode barcodes from inner frame queue. startFrameDecodingEx
Decode barcodes from inner frame queue. appendFrame
Append a frame image buffer to the inner frame queue. stopFrameDecoding
Stop thread used for frame decoding. -
Parameter
Method Description initFrameDecodingParameters
Initialize frame decoding parameter. -
Callback
Method Description setErrorCallback
Set callback interface to process errors which is triggered when the library finishes decoding a frame. setTextResultCallback
Set callback interface to process text results which is triggered when the library finishes decoding a frame. setIntermediateResultCallback
Set callback interface to process intermediate results which is triggered when the library finishes decoding a frame. -
Status retrieval
Method Description getLengthOfFrameQueue
Get length of current inner frame queue.
startFrameDecoding
Start a new thread to decode barcodes from the inner frame queue with specific frame decoding setting passed in.
void com.dynamsoft.barcode.BarcodeReader.startFrameDecoding (final int maxQueueLength, final int maxResultQueueLength, final int width, final int height, final int stride, final int enumImagePixelFormat, final String templateName) throws BarcodeReaderException
Parameters
maxQueueLength
The max number of frames waiting for decoding.
maxResultQueueLength
The max number of frames whose results (text result/localization result) will be kept.
width
The width of the frame image in pixels.
height
The height of the frame image in pixels.
stride
The stride (or scan width) of the frame image.
format
The image pixel format used in the image byte array.
templateName
The template name.
Exceptions
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
reader.setErrorCallback(new ErrorCallback() {
@Override
public void errorCallback(int frameId, int errorCode, Object userData) {
//TODO add your code for using error code
}
}, null);
reader.startFrameDecoding(2, 10, 1024, 720, 1024, EnumImagePixelFormat.IPF_GRAYSCALED, "");
startFrameDecodingEx
Start a new thread to decode barcodes from the inner frame queue with specific frame decoding setting defined in FrameDecodingParameters
struct.
void com.dynamsoft.barcode.BarcodeReader.startFrameDecodingEx(FrameDecodingParameters parameters, String templateName) throws BarcodeReaderException
Parameters
parameters
The frame decoding parameters.
templateName
The template name.
Exceptions
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
FrameDecodingParameters parameters = reader.initFrameDecodingParameters();
parameters.maxQueueLength = 2;
parameters.maxResultQueueLength = 10;
parameters.width = 1024;
parameters.height = 720;
parameters.stride = 1024;
parameters.imagePixelFormat = EnumImagePixelFormat.IPF_GRAYSCALED;
reader.setErrorCallback(new ErrorCallback() {
@Override
public void errorCallback(int frameId, int errorCode, Object userData) {
//TODO add your code for using error code
}
}, null);
reader.startFrameDecodingEx(parameters, "");
reader.destroy();
appendFrame
Append a frame image buffer to the inner frame queue.
int com.dynamsoft.barcode.BarcodeReader.appendFrame(byte[] bufferBytes)
Parameters
bufferBytes
The array of bytes which contain the image data.
Return value
Returns the ID of the appended frame.
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
reader.startFrameDecoding(2, 10, 1024, 720, 1024, EnumImagePixelFormat.IPF_GRAYSCALED, "");
int frameId = reader.appendFrame(bufferBytes);
reader.destroy();
stopFrameDecoding
Stop the frame decoding thread created by StartFrameDecoding
or StartFrameDecodingEx
.
void com.dynamsoft.barcode.BarcodeReader.stopFrameDecoding() throws BarcodeReaderException
Exceptions
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
reader.startFrameDecoding(2, 10, 1024, 720, 1024, EnumImagePixelFormat.IPF_GRAYSCALED, "");
reader.stopFrameDecoding();
reader.destroy();
initFrameDecodingParameters
Initialize frame decoding parameters with default values.
FrameDecodingParameters com.dynamsoft.barcode.BarcodeReader.initFrameDecodingParameters() throws BarcodeReaderException
Return value
The frame decoding parameters.
Exceptions
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
FrameDecodingParameters parameters = reader.initFrameDecodingParameters();
reader.destroy();
setErrorCallback
Set callback interface to process errors which is triggered when the library finishes decoding a frame.
void com.dynamsoft.barcode.BarcodeReader.setErrorCallback(ErrorCallback errorCallback, Object userData) throws BarcodeReaderException
Parameters
errorCallback
Callback interface.
userData
Customized arguments passed to your function.
Exceptions
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
reader.setErrorCallback(new ErrorCallback() {
@Override
public void errorCallback(int frameId, int errorCode, Object userData) {
//TODO add your code for using error code
}
}, null);
reader.startFrameDecoding(2, 10, 1024, 720, 1024, EnumImagePixelFormat.IPF_GRAYSCALED, "");
setTextResultCallback
Set callback interface to process text results which is triggered when the library finishes decoding a frame.
void com.dynamsoft.barcode.BarcodeReader.setTextResultCallback(TextResultCallback textResultCallback, Object userData) throws BarcodeReaderException
Parameters
textResultCallback
Callback interface.
userData
Customized arguments passed to your function.
Exceptions
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
reader.setTextResultCallback(new TextResultCallback() {
@Override
public void textResultCallback(int frameId, TextResult[] results, Object userData) {
//TODO add your code for using text results
}
}, null);
reader.startFrameDecoding(2, 10, 1024, 720, 1024, EnumImagePixelFormat.IPF_GRAYSCALED, "");
setIntermediateResultCallback
Set callback interface to process intermediate results which is triggered when the library finishes decoding a frame.
void com.dynamsoft.barcode.BarcodeReader.setIntermediateResultCallback(IntermediateResultCallback intermediateResultCallback, Object userData} throws BarcodeReaderException
Parameters
intermediateResultCallback
Callback interface.
userData
Customized arguments passed to your function.
Exceptions
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
PublicRuntimeSettings settings = reader.getRuntimeSettings();
settings.intermediateResultTypes = EnumIntermediateResultType.IRT_ORIGINAL_IMAGE | EnumIntermediateResultType.IRT_COLOUR_CLUSTERED_IMAGE | EnumIntermediateResultType.IRT_COLOUR_CONVERTED_GRAYSCALE_IMAGE;
reader.updateRuntimeSettings(settings);
reader.setIntermediateResultCallback(new IntermediateResultCallback() {
@Override
public void intermediateResultCallback(int frameId, IntermediateResult[] results, Object userData) {
//TODO add your code for using intermediate results
}
}, null);
reader.startFrameDecoding(2, 10, 1024, 720, 1024, EnumImagePixelFormat.IPF_GRAYSCALED, "");
getLengthOfFrameQueue
Get length of current inner frame queue.
int com.dynamsoft.barcode.BarcodeReader.getLengthOfFrameQueue()
Return value
Returns length of current inner frame queue.
Code Snippet
BarcodeReader reader = new BarcodeReader("t0260NwAAAHV***************");
int length = reader.getLengthOfFrameQueue();
reader.destroy();