class CloudmersiveImageRecognitionApiClient::InfoApi
Attributes
Public Class Methods
# File lib/cloudmersive-image-recognition-api-client/api/info_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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. @param image_file Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. @param [Hash] opts the optional parameters @return [DominantColorResult]
# 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
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. @param image_file Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. @param [Hash] opts the optional parameters @return [Array<(DominantColorResult
, Fixnum, Hash)>] DominantColorResult
data, response status code and response headers
# 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
Returns the image metadata including EXIF and resolution Returns the metadata information on the image, including file type, EXIF (if available), and resolution. @param image_file Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. @param [Hash] opts the optional parameters @return [ImageMetadata]
# 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
Returns the image metadata including EXIF and resolution Returns the metadata information on the image, including file type, EXIF (if available), and resolution. @param image_file Image file to perform the operation on. Common file formats such as PNG, JPEG are supported. @param [Hash] opts the optional parameters @return [Array<(ImageMetadata
, Fixnum, Hash)>] ImageMetadata
data, response status code and response headers
# 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