MENU
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

FrameDecodingParameters

Defines a struct to configure the frame decoding Parameters.

class FrameDecodingParameters

Attributes

Attribute Type
max_queue_length int
max_result_queue_length int
width int
height int
stride int
image_pixel_format ImagePixelFormat
region_top int
region_left int
region_right int
region_bottom int
region_measured_by_percentage int
threshold float
fps int
auto_filter int
clarity_calculation_method ClarityCalculationMethod
clarity_filter_mode ClarityFilterMode

max_queue_length

The maximum number of frames waiting for decoding.

FrameDecodingParameters.max_queue_length
  • Value range
    [0,0x7fffffff]

  • Default value
    3

max_result_queue_length

The maximum number of frames waiting results (text result/localization result) will be kept for further reference.

FrameDecodingParameters.max_result_queue_length
  • Value range
    [0,0x7fffffff]

  • Default value
    10

width

The width of the frame image in pixels.

FrameDecodingParameters.width
  • Value range
    [0,0x7fffffff]

  • Default value
    0

height

The height of the frame image in pixels.

FrameDecodingParameters.height
  • Value range
    [0,0x7fffffff]

  • Default value
    0

stride

The stride (or scan width) of the frame image.

FrameDecodingParameters.stride
  • Value range
    [0,0x7fffffff]

  • Default value
    0

image_pixel_format

The image pixel format used in the image byte array.

FrameDecodingParameters.image_pixel_format

region_top

The region definition of the frame to calculate the internal indicator.The top-most coordinate or percentage of the region.

FrameDecodingParameters.region_top
  • Default Value
    0

  • Value Range

    • if region_measured_by_percentage = 0, [0,0x7fffffff]
    • if region_measured_by_percentage = 1, [0,100]

region_left

The region definition of the frame to calculate the internal indicator.The left-most coordinate or percentage of the region.

FrameDecodingParameters.region_left
  • Default Value
    0

  • Value Range

    • if region_measured_by_percentage = 0, [0,0x7fffffff]
    • if region_measured_by_percentage = 1, [0,100]

region_right

The region definition of the frame to calculate the internal indicator.The right-most coordinate or percentage of the region.

FrameDecodingParameters.region_right
  • Default Value
    0

  • Value Range

    • if region_measured_by_percentage = 0, [0,0x7fffffff]
    • if region_measured_by_percentage = 1, [0,100]

region_bottom

The region definition of the frame to calculate the internal indicator.The bottom-most coordinate or percentage of the region.

FrameDecodingParameters.region_bottom
  • Default Value
    0

  • Value Range

    • if region_measured_by_percentage = 0, [0,0x7fffffff]
    • if region_measured_by_percentage = 1, [0,100]

region_measured_by_percentage

Sets whether or not to use percentage to measure the region size.

FrameDecodingParameters.region_measured_by_percentage
  • Default Value
    0

  • Value Range [0,1]

region_top

The region definition of the frame to calculate the internal indicator.The top-most coordinate or percentage of the region.

FrameDecodingParameters.region_top
  • Default Value
    0

  • Value Range

    • if region_measured_by_percentage = 0, [0,0x7fffffff]
    • if region_measured_by_percentage = 1, [0,100]

threshold

The threshold used for filtering frames.

FrameDecodingParameters.threshold
  • Value range
    [0, 1]

  • Default value
    0.1

  • Remarks
    The SDK will calculate an inner indicator for each frame from append_video_frame, if the change rate of the indicators between the current frame and the history frames is larger than the given threshold, the current frame will not be added to the inner frame queue waiting for decoding.

fps

The frequency of calling append_video_frame per second.

FrameDecodingParameters.fps
  • Value range
    [0,0x7fffffff]

  • Default value
    0

  • Remarks
    0 means the frequency will be calculated automatically by the SDK.

auto_filter

Sets whether to filter frames automatically.

FrameDecodingParameters.auto_filter
  • Value range
    [0,1]

  • Default value
    1

  • Remarks
    0: Diable filtering frames automatically.
    1: Enable filtering frames automatically.

clarity_calculation_method

Sets the method used for calculating the clarity of the frames.

FrameDecodingParameters.clarity_calculation_method

clarity_filter_mode

Sets the mode used for filtering frames by calculated clarity.

FrameDecodingParameters.clarity_filter_mode

This page is compatible for:

Version 7.5

Is this page helpful?

YesYes NoNo

latest version

  • Latest Version
  • version 7.6
  • version 7.5
Change +
© 2003–2020 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support