Class: CloudmersiveImageRecognitionApiClient::InfoApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-image-recognition-api-client/api/info_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InfoApi

Returns a new instance of InfoApi.



19
20
21
 
# File 'lib/cloudmersive-image-recognition-api-client/api/info_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-image-recognition-api-client/api/info_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#info_get_dominant_color(image_file, opts = {}) ⇒ DominantColorResult

Returns the dominant colors of the image Uses advanced image processing to extract the top 5 dominant colors in the image, returned in the order of dominance with the most-dominant color first. These are the primary perceptual colors used in the image as perceived by a viewer.

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-image-recognition-api-client/api/info_api.rb', line 27

def info_get_dominant_color(image_file, opts = {})
  data, _status_code, _headers = info_get_dominant_color_with_http_info(image_file, opts)
  data
end

#info_get_dominant_color_with_http_info(image_file, opts = {}) ⇒ Array<(DominantColorResult, Fixnum, Hash)>

Returns the dominant colors of the image Uses advanced image processing to extract the top 5 dominant colors in the image, returned in the order of dominance with the most-dominant color first. These are the primary perceptual colors used in the image as perceived by a viewer.

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<(DominantColorResult, Fixnum, Hash)>) —

    DominantColorResult 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-image-recognition-api-client/api/info_api.rb', line 37

def info_get_dominant_color_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InfoApi.info_get_dominant_color ...'
  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 InfoApi.info_get_dominant_color"
  end
  # resource path
  local_var_path = '/image/get-info/dominant-color'

  # 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 => 'DominantColorResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InfoApi#info_get_dominant_color\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#info_get_metadata(image_file, opts = {}) ⇒ ImageMetadata

Returns the image metadata including EXIF and resolution Returns the metadata information on the image, including file type, EXIF (if available), and resolution.

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:



82
83
84
85
 
# File 'lib/cloudmersive-image-recognition-api-client/api/info_api.rb', line 82

def info_get_metadata(image_file, opts = {})
  data, _status_code, _headers = info_get_metadata_with_http_info(image_file, opts)
  data
end

#info_get_metadata_with_http_info(image_file, opts = {}) ⇒ Array<(ImageMetadata, Fixnum, Hash)>

Returns the image metadata including EXIF and resolution Returns the metadata information on the image, including file type, EXIF (if available), and resolution.

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<(ImageMetadata, Fixnum, Hash)>) —

    ImageMetadata data, response status code and response headers



92
93
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
 
# File 'lib/cloudmersive-image-recognition-api-client/api/info_api.rb', line 92

def info_get_metadata_with_http_info(image_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InfoApi.info_get_metadata ...'
  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 InfoApi.info_get_metadata"
  end
  # resource path
  local_var_path = '/image/get-info/metadata'

  # 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 => 'ImageMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InfoApi#info_get_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end