index-v9.4.0.md

layout	title	description	keywords	needAutoGenerateSidebar	needGenerateH3Content	permalink
default-layout	Main Page - Dynamsoft Barcode Reader SDK Python Edition API Reference	This is the main page of Dynamsoft Barcode Reader SDK Python Edition API Reference.	api reference, python	true	true	/programming/python/api-reference/index-v9.4.0.html

Python API Reference

BarcodeReader Class

BarcodeReader Attributes

Attribute	Description
version	dbr-python version
dbr_version	Dynamsoft Barcode Reader version

Constructor and Destructor

Method	Description
BarcodeReader	Constructor of BarcodeReader object.

License Methods

Method	Description
init_license	Reads product key and activates the SDK.
get_idle_instances_count	Gets available instances count when charging by concurrent instances count.
set_device_friendly_name	Sets a human-readable name that identifies the device.
init_license_from_server	Deprecated
init_license_from_license_content	Deprecated
output_license_to_string	Deprecated
init_dls_connection_parameters	Deprecated
init_license_from_dls	Deprecated
init_lts_connection_parameters	Deprecated.
init_license_from_lts	Deprecated.

Decode Methods

Method	Description
decode_file	Decodes barcodes from a specified image file.
decode_buffer	Decodes barcodes from the memory buffer containing image pixels in defined format.
decode_file_stream	Decodes barcodes from an image file in memory.
decode_buffer_manually	Decodes barcodes from the memory buffer containing image pixels in defined format.
decode_base64_string	Decodes barcodes from the base64 encoded string.
init_intermediate_result	Inits an intermediateResult struct with default values.
decode_intermediate_results	Decodes barcode from intermediate results.

Basic Settings Methods

Method	Description
set_mode_argument	Sets the optional argument for a specified mode in Modes parameters.
get_mode_argument	Gets the optional argument for a specified mode in Modes parameters.
get_runtime_settings	Gets current runtime settings.
update_runtime_settings	Updates runtime settings with a given struct.
reset_runtime_settings	Resets all parameters to default values.

Advanced Settings Methods

Method	Description
init_runtime_settings_with_file	Initializes runtime settings with the settings in a given JSON file.
init_runtime_settings_with_string	Initializes runtime settings with the settings in a given JSON string.
append_template_file_to_runtime_settings	Appends a new template file to the current runtime settings.
append_template_string_to_runtime_settings	Appends a new template string to the current runtime settings.
get_all_template_names	Gets the parameter templates name array.
output_settings_to_json_file	Outputs runtime settings to a settings file (JSON file).
output_settings_to_json_string	Outputs runtime settings to a string.

Video Methods

Decode

Method	Description
start_video_mode	Starts a new thread to decode barcodes from the inner frame queue.
append_video_frame	Appends a frame image buffer to the inner frame queue.
stop_video_mode	Stops the frame decoding thread created by start_video_mode().

Parameter

Method	Description
init_frame_decoding_parameters	Initializes frame decoding parameters.

Status retrieval

Method	Description
get_length_of_frame_queue	Gets length of current inner frame queue.

Auxiliary Classes

• AztecDetailedResult
• BarcodeReaderError
• Contour
• DataMatrixDetailedResult
• ExtendedResult
• FrameDecodingParameters
• ImageData
• IntermediateResult
• LineSegment
• LocalizationResult
• OnedDetailedResult
• PDFDetailedResult
• Point
• PublicRuntimeSettings
• QRCodeDetailedResult
• Quadrilateral
• RegionOfInterest
• SamplingImageData
• TextResult
• DMLTSConnectionParameters
• IntermediateResultCallBack
• TextResultCallBack
• ErrorCallBack

Enumerations

• [AccompanyingTextRecognitionMode]({{ site.python_enumerations }}parameter-mode-enums.html#accompanyingtextrecognitionmode)
• [BarcodeColourMode]({{ site.python_enumerations }}parameter-mode-enums.html#barcodecolourmode)
• [BarcodeComplementMode]({{ site.python_enumerations }}parameter-mode-enums.html#barcodecomplementmode)
• [BarcodeFormat]({{ site.python_enumerations }}format-enums.html#barcodeformat)
• [BarcodeFormat_2]({{ site.python_enumerations }}format-enums.html#barcodeformat_2)
• [BinarizationMode]({{ site.python_enumerations }}parameter-mode-enums.html#binarizationmode)
• [ClarityCalculationMethod]({{ site.python_enumerations }}frame-decoding-enums.html#claritycalculationmethod)
• [ClarityFilterMode]({{ site.python_enumerations }}frame-decoding-enums.html#clarityfiltermode)
• [ColourClusteringMode]({{ site.python_enumerations }}parameter-mode-enums.html#colourclusteringmode)
• [ColourConversionMode]({{ site.python_enumerations }}parameter-mode-enums.html#colourconversionmode)
• [ConflictMode]({{ site.python_enumerations }}parameter-mode-enums.html#conflictmode)
• [DeblurMode]({{ site.python_enumerations }}parameter-mode-enums.html#deblurmode)
• [DeformationResistingMode]({{ site.python_enumerations }}parameter-mode-enums.html#deformationresistingmode)
• [DMChargeWay]({{ site.python_enumerations }}other-enums.html#dm_chargeway)
• [DMDeploymentType]({{ site.python_enumerations }}other-enums.html#dm_deploymenttype)
• [DMLicenseModule]({{ site.python_enumerations }}other-enums.html#dm_licensemodule)
• [DMUUIDGenerationMethod]({{ site.python_enumerations }}other-enums.html#dm_uuidgenerationmethod)
• [DPMCodeReadingMode]({{ site.python_enumerations }}parameter-mode-enums.html#dpmcodereadingmode)
• [GrayscaleTransformationMode]({{ site.python_enumerations }}parameter-mode-enums.html#grayscaletransformationmode)
• [ImagePixelFormat]({{ site.python_enumerations }}other-enums.html#imagepixelformat)
• [ImagePreprocessingMode]({{ site.python_enumerations }}parameter-mode-enums.html#imagepreprocessingmode)
• [IMResultDataType]({{ site.python_enumerations }}result-enums.html#imresultdatatype)
• [IntermediateResultSavingMode]({{ site.python_enumerations }}result-enums.html#intermediateresultsavingmode)
• [IntermediateResultType]({{ site.python_enumerations }}result-enums.html#intermediateresulttype)
• [LocalizationMode]({{ site.python_enumerations }}parameter-mode-enums.html#localizationmode)
• [PDFReadingMode]({{ site.python_enumerations }}parameter-mode-enums.html#pdfreadingmode)
• [Product]({{ site.python_enumerations }}other-enums.html#product)
• [QRCodeErrorCorrectionLevel]({{ site.python_enumerations }}other-enums.html#qrcodeerrorcorrectionlevel)
• [RegionPredetectionMode]({{ site.python_enumerations }}parameter-mode-enums.html#regionpredetectionmode)
• [ResultCoordinateType]({{ site.python_enumerations }}result-enums.html#resultcoordinatetype)
• [ResultType]({{ site.python_enumerations }}result-enums.html#resulttype)
• [ScaleUpMode]({{ site.python_enumerations }}parameter-mode-enums.html#scaleupmode)
• [TerminatePhase]({{ site.python_enumerations }}parameter-mode-enums.html#terminatephase)
• [TextFilterMode]({{ site.python_enumerations }}parameter-mode-enums.html#textfiltermode)
• [TextResultOrderMode]({{ site.python_enumerations }}result-enums.html#textresultordermode)
• [TextureDetectionMode]({{ site.python_enumerations }}parameter-mode-enums.html#texturedetectionmode)