Class: CloudmersiveBarcodeApiClient::BarcodeScanApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BarcodeScanApi

Returns a new instance of BarcodeScanApi.



19
20
21
 
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#barcode_scan_image(image_file, opts = {}) ⇒ BarcodeScanResult

Scan and recognize an image of a barcode Scan an image or photo of a barcode and return the result. Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB

Parameters:

  • image_file —

    Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 27

def barcode_scan_image(image_file, opts = {})
  data, _status_code, _headers = barcode_scan_image_with_http_info(image_file, opts)
  data
end

#barcode_scan_image_advanced_qr(image_file, opts = {}) ⇒ BarcodeScanQRAdvancedResult

Advanced AI scan and recognition of an image of one or more QR barcodes Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG and JPEG input file formats.

Parameters:

  • image_file —

    Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :preprocessing (String) —

    Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement.

Returns:



83
84
85
86
 
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 83

def barcode_scan_image_advanced_qr(image_file, opts = {})
  data, _status_code, _headers = barcode_scan_image_advanced_qr_with_http_info(image_file, opts)
  data
end

#barcode_scan_image_advanced_qr_with_http_info(image_file, opts = {}) ⇒ Array<(BarcodeScanQRAdvancedResult, Fixnum, Hash)>

Advanced AI scan and recognition of an image of one or more QR barcodes Scan an image or photo of a QR barcode and return the result. Uses AI deep learning to read blurry or low resultion QR barcodes. Supports PNG and JPEG input file formats.

Parameters:

  • image_file —

    Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :preprocessing (String) —

    Optional, preprocessing mode, default is &#39;Auto&#39;. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to &#39;None&#39; if you do not want to use automatic image unrotation and enhancement.

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 94

def barcode_scan_image_advanced_qr_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BarcodeScanApi.barcode_scan_image_advanced_qr ...'
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling BarcodeScanApi.barcode_scan_image_advanced_qr"
  end
  # resource path
  local_var_path = '/barcode/scan/image/advanced/qr'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
  header_params[:'preprocessing'] = opts[:'preprocessing'] if !opts[:'preprocessing'].nil?

  # form parameters
  form_params = {}
  form_params['imageFile'] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BarcodeScanQRAdvancedResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BarcodeScanApi#barcode_scan_image_advanced_qr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#barcode_scan_image_with_http_info(image_file, opts = {}) ⇒ Array<(BarcodeScanResult, Fixnum, Hash)>

Scan and recognize an image of a barcode Scan an image or photo of a barcode and return the result. Supported barcode types include AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, MAXICODE, PDF_417, QR_CODE, RSS_14, RSS_EXPANDED, UPC_A, UPC_E, All_1D, UPC_EAN_EXTENSION, MSI, PLESSEY, IMB

Parameters:

  • image_file —

    Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BarcodeScanResult, Fixnum, Hash)>) —

    BarcodeScanResult data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cloudmersive-barcode-api-client/api/barcode_scan_api.rb', line 37

def barcode_scan_image_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BarcodeScanApi.barcode_scan_image ...'
  end
  # verify the required parameter 'image_file' is set
  if @api_client.config.client_side_validation && image_file.nil?
    fail ArgumentError, "Missing the required parameter 'image_file' when calling BarcodeScanApi.barcode_scan_image"
  end
  # resource path
  local_var_path = '/barcode/scan/image'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['imageFile'] = image_file

  # http body (model)
  post_body = nil
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BarcodeScanResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BarcodeScanApi#barcode_scan_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end