Dynamsoft Panorama - API Reference
Enumerations
Enumerations

Enumerations

enum  Dynamsoft.Panorama.EnumErrorCode {
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_ERROR_CALLBACK_EXISTS = -10201, Dynamsoft.Panorama.EnumErrorCode.DPSERR_RESULT_CALLBACK_EXISTS = -10202, Dynamsoft.Panorama.EnumErrorCode.DPSERR_INPUT_NULL_POINTER = -10203, Dynamsoft.Panorama.EnumErrorCode.DPSERR_DBR_VERSION_INVALID = -10204,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_PANORAMA_ALREADY_STARTED = -10206, Dynamsoft.Panorama.EnumErrorCode.DPSERR_PANORAMA_NOT_STARTED = -10207, Dynamsoft.Panorama.EnumErrorCode.DPSERR_PANORAMA_NOT_STOP = -10208, Dynamsoft.Panorama.EnumErrorCode.DPSERR_PANORAMA_STARTED_BY_FILE = -10209,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_PANORAMA_STARTED_BY_BUFFER = -10210, Dynamsoft.Panorama.EnumErrorCode.DPSERR_STITCHED_IMAGE_NOT_EXISTS = -10213, Dynamsoft.Panorama.EnumErrorCode.DPSERR_FILE_NOT_AVAILABLE = -10214, Dynamsoft.Panorama.EnumErrorCode.DPSERR_STITCH_ALREADY_INTERRUPTTED = -10215,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_VISTAIMG_NOT_SETTED = -10216, Dynamsoft.Panorama.EnumErrorCode.DPSERR_JSON_PARSE_FAILED = -10217, Dynamsoft.Panorama.EnumErrorCode.DPSERR_FUNCTIONAL_MODE_INVALID = -10218, Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_PREVIEW_SCALE_ERROR = -10219,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_RESULT_SCALE_ERROR = -10220, Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_ACCURACY_LEVEL_ERROR = -10221, Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_EXIST_DUPLICATE_CODE_ERROR = -10222, Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_MAX_THREAD_NUMBER_ERROR = -10223,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_FRAME_BUFFER_SIZE_ERROR = -10224, Dynamsoft.Panorama.EnumErrorCode.DPSERR_MAX_MEMORY_SIZE_ERROR = -10225, Dynamsoft.Panorama.EnumErrorCode.DPSERR_INPUT_SOURCE_MODE_INVALID = -10226, Dynamsoft.Panorama.EnumErrorCode.DPSERR_SCAN_PATH_MODE_INVALID = -10227,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_VISTAIMG_VALID_ERROR = -10228, Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_ALLOW_IMGSEGMENTATION_ERROR = -10229, Dynamsoft.Panorama.EnumErrorCode.DPSERR_SET_PREVIEW_COVERAGE_ERROR = -10230, Dynamsoft.Panorama.EnumErrorCode.DPSERR_OVERLAP_REGION_INVALID = -10231,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_OVERLAP_MODE_STITCH_STOPED = -10232, Dynamsoft.Panorama.EnumErrorCode.DPSERR_DBR_SOME_BARCODE_LICENSE_INVALID = -10233, Dynamsoft.Panorama.EnumErrorCode.DPSERR_DBR_JSON_FAILED = -10234, Dynamsoft.Panorama.EnumErrorCode.DPSERR_PANORAMA_LICENSE_INVALID = -10060,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_IRT_LICENSE_INVALID = -10056, Dynamsoft.Panorama.EnumErrorCode.DPSERR_RECOGNITION_TIMEOUT = -10026, Dynamsoft.Panorama.EnumErrorCode.DPSERR_DIB_BUFFER_INVALID = -10018, Dynamsoft.Panorama.EnumErrorCode.DPSERR_IMAGE_READ_FAILED = -10012,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_BPP_NOT_SUPPORTED = -10007, Dynamsoft.Panorama.EnumErrorCode.DPSERR_FILETYPE_NOT_SUPPORTED = -10006, Dynamsoft.Panorama.EnumErrorCode.DPSERR_FILE_NOT_FOUND = -10005, Dynamsoft.Panorama.EnumErrorCode.DPSERR_LICENSE_EXPIRED = -10004,
  Dynamsoft.Panorama.EnumErrorCode.DPSERR_LICENSE_INVALID = -10003, Dynamsoft.Panorama.EnumErrorCode.DPSERR_NULL_POINTER = -10002, Dynamsoft.Panorama.EnumErrorCode.DPSERR_NO_MEMORY = -10001, Dynamsoft.Panorama.EnumErrorCode.DPSERR_UNKNOWN = -10000,
  Dynamsoft.Panorama.EnumErrorCode.DPS_SUCCESS = 0, Dynamsoft.Panorama.EnumErrorCode.DPS_SYSTEM_EXCEPTION = 1, Dynamsoft.Panorama.EnumErrorCode.DPSERR_LOAD_MODULE_DLL_FAILED = 2
}
 Describes error codes. More...
 
enum  Dynamsoft.Panorama.EnumImagePixelFormat {
  Dynamsoft.Panorama.EnumImagePixelFormat.IPF_BINARY, Dynamsoft.Panorama.EnumImagePixelFormat.IPF_BINARY_INVERTED, Dynamsoft.Panorama.EnumImagePixelFormat.IPF_GRAYSCALED, Dynamsoft.Panorama.EnumImagePixelFormat.IPF_NV21,
  Dynamsoft.Panorama.EnumImagePixelFormat.IPF_RGB_565, Dynamsoft.Panorama.EnumImagePixelFormat.IPF_RGB_555, Dynamsoft.Panorama.EnumImagePixelFormat.IPF_RGB_888, Dynamsoft.Panorama.EnumImagePixelFormat.IPF_ARGB_8888,
  Dynamsoft.Panorama.EnumImagePixelFormat.IPF_RGB_161616, Dynamsoft.Panorama.EnumImagePixelFormat.IPF_ARGB_16161616
}
 Describes the image pixel format. More...
 
enum  Dynamsoft.Panorama.EnumBarcodeFormat {
  Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_ALL = -32505857, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_ONED = 0x000007FF, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_DATABAR = 0x0003F800, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_CODE_39 = 0x1,
  Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_CODE_128 = 0x2, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_CODE_93 = 0x4, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_CODABAR = 0x8, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_ITF = 0x10,
  Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_EAN_13 = 0x20, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_EAN_8 = 0x40, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_UPC_A = 0x80, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_UPC_E = 0x100,
  Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_INDUSTRIAL_25 = 0x200, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_CODE_39_EXTENDED = 0x400, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_DATABAR_OMNIDIRECTIONAL = 0x800, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_DATABAR_TRUNCATED = 0x1000,
  Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_DATABAR_STACKED = 0x2000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL = 0x4000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_DATABAR_EXPANDED = 0x8000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_DATABAR_EXPANDED_STACKED = 0x10000,
  Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_DATABAR_LIMITED = 0x20000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_PATCHCODE = 0x00040000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_PDF417 = 0x2000000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_QR_CODE = 0x4000000,
  Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_DATAMATRIX = 0x8000000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_AZTEC = 0x10000000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_MAXICODE = 0x20000000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_MICRO_QR = 0x40000000,
  Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_MICRO_PDF417 = 0x00080000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_GS1_COMPOSITE = -2147483648, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_MSI_CODE = 0x100000, Dynamsoft.Panorama.EnumBarcodeFormat.DPS_BF_NULL = 0
}
 Describes the barcode types in BarcodeFormat group 1. All the formats can be combined, such as BF_CODE_39 | BF_CODE_128. Note: The barcode format our library will search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually. More...
 
enum  Dynamsoft.Panorama.EnumBarcodeFormat_2 {
  Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_NULL = 0, Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_POSTALCODE = 0x01F00000, Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_NONSTANDARD_BARCODE = 0X01, Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_USPSINTELLIGENTMAIL = 0x00100000,
  Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_POSTNET = 0x00200000, Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_PLANET = 0x00400000, Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_AUSTRALIANPOST = 0x00800000, Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_RM4SCC = 0x01000000,
  Dynamsoft.Panorama.EnumBarcodeFormat_2.DPS_BF2_DOTCODE = 0x02
}
 Describes the barcode types in BarcodeFormat group 2. Note: The barcode format our library will search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually. More...
 

Enumeration Type Documentation

◆ EnumBarcodeFormat

Describes the barcode types in BarcodeFormat group 1. All the formats can be combined, such as BF_CODE_39 | BF_CODE_128. Note: The barcode format our library will search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually.

Enumerator
DPS_BF_ALL 

All supported formats in BarcodeFormat group 1

DPS_BF_ONED 

Combined value of BF_CODABAR, BF_CODE_128, BF_CODE_39, BF_CODE_39_Extended, BF_CODE_93, BF_EAN_13, BF_EAN_8, INDUSTRIAL_25, BF_ITF, BF_UPC_A, BF_UPC_E;

DPS_BF_GS1_DATABAR 

Combined value of BF_GS1_DATABAR_OMNIDIRECTIONAL, BF_GS1_DATABAR_TRUNCATED, BF_GS1_DATABAR_STACKED, BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL, BF_GS1_DATABAR_EXPANDED, BF_GS1_DATABAR_EXPANDED_STACKED, BF_GS1_DATABAR_LIMITED;

DPS_BF_CODE_39 

Code 39

DPS_BF_CODE_128 

Code 128

DPS_BF_CODE_93 

Code 93

DPS_BF_CODABAR 

Codabar

DPS_BF_ITF 

ITF

DPS_BF_EAN_13 

EAN-13

DPS_BF_EAN_8 

EAN-8

DPS_BF_UPC_A 

UPC-A

DPS_BF_UPC_E 

UPC-E

DPS_BF_INDUSTRIAL_25 

Industrial 2 of 5

DPS_BF_CODE_39_EXTENDED 

Code39 Extended

DPS_BF_GS1_DATABAR_OMNIDIRECTIONAL 

Databar Omnidirectional

DPS_BF_GS1_DATABAR_TRUNCATED 

Databar Truncated

DPS_BF_GS1_DATABAR_STACKED 

Databar Stacked

DPS_BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL 

Databar Stacked Omnidirectional

DPS_BF_GS1_DATABAR_EXPANDED 

Databar Expanded

DPS_BF_GS1_DATABAR_EXPANDED_STACKED 

Databar Expaned Stacked

DPS_BF_GS1_DATABAR_LIMITED 

Databar Limited

DPS_BF_PATCHCODE 

Patch code.

DPS_BF_PDF417 

PDF417

DPS_BF_QR_CODE 

QRCode

DPS_BF_DATAMATRIX 

DataMatrix

DPS_BF_AZTEC 

AZTEC

DPS_BF_MAXICODE 

MAXICODE

DPS_BF_MICRO_QR 

Micro QR Code

DPS_BF_MICRO_PDF417 

Micro PDF417

DPS_BF_GS1_COMPOSITE 

GS1 Composite Code

DPS_BF_MSI_CODE 

MSI Code

DPS_BF_NULL 

No barcode format in BarcodeFormat group 1

◆ EnumBarcodeFormat_2

Describes the barcode types in BarcodeFormat group 2. Note: The barcode format our library will search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually.

Enumerator
DPS_BF2_NULL 

No barcode format in BarcodeFormat group 2

DPS_BF2_POSTALCODE 

Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC.

DPS_BF2_NONSTANDARD_BARCODE 

Nonstandard barcode

DPS_BF2_USPSINTELLIGENTMAIL 

USPS Intelligent Mail.

DPS_BF2_POSTNET 

Postnet.

DPS_BF2_PLANET 

Planet.

DPS_BF2_AUSTRALIANPOST 

Australian Post.

DPS_BF2_RM4SCC 

Royal Mail 4-State Customer Barcode.

DPS_BF2_DOTCODE 

DotCode.

◆ EnumErrorCode

Describes error codes.

Enumerator
DPSERR_ERROR_CALLBACK_EXISTS 

Errorcode call-back function already exists.

DPSERR_RESULT_CALLBACK_EXISTS 

Result call-back function already exists.

DPSERR_INPUT_NULL_POINTER 

NULL input pointer in Panorama.

DPSERR_DBR_VERSION_INVALID 

The DBR Version is invalid.

DPSERR_PANORAMA_ALREADY_STARTED 

Panorama has been started.

DPSERR_PANORAMA_NOT_STARTED 

Panorama is not started before appending frames.

DPSERR_PANORAMA_NOT_STOP 

Panorama is not stopped before getting final results.

DPSERR_PANORAMA_STARTED_BY_FILE 

Panorama is already started by file.

DPSERR_PANORAMA_STARTED_BY_BUFFER 

Panorama is already started by buffer.

DPSERR_STITCHED_IMAGE_NOT_EXISTS 

No stitched images exist.

DPSERR_FILE_NOT_AVAILABLE 

The size of the incoming img is different from before.

DPSERR_STITCH_ALREADY_INTERRUPTTED 

The stitching is up to stop as image segmentation is not allowed by settings.

DPSERR_VISTAIMG_NOT_SETTED 

The vista img appended is not far enough from the previous frame.

DPSERR_JSON_PARSE_FAILED 

Failed to init json settings.

DPSERR_FUNCTIONAL_MODE_INVALID 

The functional mode is invalid.

DPSERR_SET_PREVIEW_SCALE_ERROR 

Failed to set preview scale.

DPSERR_SET_RESULT_SCALE_ERROR 

Failed to set result scale.

DPSERR_SET_ACCURACY_LEVEL_ERROR 

Failed to set stitching accuracy level.

DPSERR_SET_EXIST_DUPLICATE_CODE_ERROR 

Failed to set whether duplicate code exist.

DPSERR_SET_MAX_THREAD_NUMBER_ERROR 

Failed to set max number of threads.

DPSERR_SET_FRAME_BUFFER_SIZE_ERROR 

The frame buffer size setted is out of range.

DPSERR_MAX_MEMORY_SIZE_ERROR 

Failed to set max memory size.

DPSERR_INPUT_SOURCE_MODE_INVALID 

The input source mode is invalid.

DPSERR_SCAN_PATH_MODE_INVALID 

The scanpath mode is invalid.

DPSERR_SET_VISTAIMG_VALID_ERROR 

Failed to set whether vista image is valid.

DPSERR_SET_ALLOW_IMGSEGMENTATION_ERROR 

Failed to set whether image segmentation is allowed.

DPSERR_SET_PREVIEW_COVERAGE_ERROR 

Failed to set preview image coverage.

DPSERR_OVERLAP_REGION_INVALID 

The overlap region is invalid.

DPSERR_OVERLAP_MODE_STITCH_STOPED 

The frames can not continue to be stitched in overlap mode.

DPSERR_DBR_SOME_BARCODE_LICENSE_INVALID 

Some barcode licenses are invalid.

DPSERR_DBR_JSON_FAILED 

An error occurs in the DBR JSON settings.

DPSERR_PANORAMA_LICENSE_INVALID 

The panorama license is invalid.

DPSERR_IRT_LICENSE_INVALID 

The Intermediate Result Types license is invalid.

DPSERR_RECOGNITION_TIMEOUT 

Recognition timeout.

DPSERR_DIB_BUFFER_INVALID 

The DIB(Device-independent bitmaps) buffer is invalid.

DPSERR_IMAGE_READ_FAILED 

Failed to read the image.

DPSERR_BPP_NOT_SUPPORTED 

The BPP(Bits per pixel) is not supported.

DPSERR_FILETYPE_NOT_SUPPORTED 

The file type is not supported.

DPSERR_FILE_NOT_FOUND 

The file is not found.

DPSERR_LICENSE_EXPIRED 

The license has expired.

DPSERR_LICENSE_INVALID 

The license is invalid.

DPSERR_NULL_POINTER 

Null pointer.

DPSERR_NO_MEMORY 

Not enough memory to perform the operation.

DPSERR_UNKNOWN 

Unknown error.

DPS_SUCCESS 

Successful.

DPS_SYSTEM_EXCEPTION 

System exception

DPSERR_LOAD_MODULE_DLL_FAILED 

Failed to load module dll .

◆ EnumImagePixelFormat

Describes the image pixel format.

Enumerator
IPF_BINARY 

0:Black, 1:White

IPF_BINARY_INVERTED 

0:White, 1:Black

IPF_GRAYSCALED 

8bit gray

IPF_NV21 

NV21

IPF_RGB_565 

16bit

IPF_RGB_555 

16bit

IPF_RGB_888 

24bit

IPF_ARGB_8888 

32bit

IPF_RGB_161616 

48bit

IPF_ARGB_16161616 

64bit