index-v7.5.0.md

layout	title	description	keywords	needAutoGenerateSidebar	breadcrumbText	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	false	API Reference	/programming/python/api-reference/index-v7.5.0.html

Dynamsoft Barcode Reader SDK - Python API Reference

• BarcodeReader Methods
• BarcodeReader Attributes
• Error Code
• Classes
• Enumerations

BarcodeReader Methods

Constructor and Destructor

Method	Description
BarcodeReader	Constructor of BarcodeReader object.

Decode

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.

Parameter and Runtime Settings

Basic

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	Update runtime settings with a given struct.
reset_runtime_settings	Resets all parameters to default values.

Advanced

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.

License

Method	Description
init_license	Reads product key and activates the SDK.
init_license_from_server	Initializes license and connect to the specified server for online verification.
init_license_from_license_content	Initializes license from the license content on client machine for offline verification.
output_license_to_string	Outputs the license content as an encrypted string from the license server to be used for offline license verification.

Video

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.

BarcodeReader Attributes

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

[Error Code]({{ site.python_enumerations }}error-code.html)

Classes

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

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)
• [DeformationResistingMode]({{ site.python_enumerations }}parameter-mode-enums.html#deformationresistingmode)
• [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)
• [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)
• [TextAssistedCorrectionMode]({{ site.python_enumerations }}parameter-mode-enums.html#textassistedcorrectionmode)
• [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)