class AsposeImagingCloud::CreateImageFrameRequest

Request model for create_image_frame operation.

Public Class Methods

new(image_data, frame_id, new_width = nil, new_height = nil, x = nil, y = nil, rect_width = nil, rect_height = nil, rotate_flip_method = nil, save_other_frames = nil, out_path = nil, storage = nil) click to toggle source

Get separate frame from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream. @param [File] image_data Input image @param [Integer] frame_id Number of a frame. @param [Integer] new_width New width. @param [Integer] new_height New height. @param [Integer] x X position of start point for cropping rectangle. @param [Integer] y Y position of start point for cropping rectangle. @param [Integer] rect_width Width of cropping rectangle. @param [Integer] rect_height Height of cropping rectangle. @param [String] rotate_flip_method RotateFlip method (Rotate180FlipNone, Rotate180FlipX, Rotate180FlipXY, Rotate180FlipY, Rotate270FlipNone, Rotate270FlipX, Rotate270FlipXY, Rotate270FlipY, Rotate90FlipNone, Rotate90FlipX, Rotate90FlipXY, Rotate90FlipY, RotateNoneFlipNone, RotateNoneFlipX, RotateNoneFlipXY, RotateNoneFlipY). Default is RotateNoneFlipNone. @param [BOOLEAN] save_other_frames If result will include all other frames or just a specified frame. @param [String] out_path Path to updated file (if this is empty, response contains streamed image). @param [String] storage Your Aspose Cloud Storage name.

# File lib/aspose-imaging-cloud/models/requests/create_image_frame_request.rb, line 47
def initialize(image_data, frame_id, new_width = nil, new_height = nil, x = nil, y = nil, rect_width = nil, rect_height = nil, rotate_flip_method = nil, save_other_frames = nil, out_path = nil, storage = nil)
  @image_data = image_data
  @frame_id = frame_id
  @new_width = new_width
  @new_height = new_height
  @x = x
  @y = y
  @rect_width = rect_width
  @rect_height = rect_height
  @rotate_flip_method = rotate_flip_method
  @save_other_frames = save_other_frames
  @out_path = out_path
  @storage = storage
end

Public Instance Methods

to_http_info(config) click to toggle source
# File lib/aspose-imaging-cloud/models/requests/create_image_frame_request.rb, line 62
def to_http_info(config)
  # verify the required parameter 'image_data' is set
  if config.client_side_validation && @image_data.nil?
    raise ArgumentError, "Missing the required parameter 'image_data' when calling ImagingApi.create_image_frame"
  end

  # verify the required parameter 'frame_id' is set
  if config.client_side_validation && @frame_id.nil?
    raise ArgumentError, "Missing the required parameter 'frame_id' when calling ImagingApi.create_image_frame"
  end

  # resource path
  local_var_path = '/imaging/frames/{frameId}'.sub('{' + 'frameId' + '}', @frame_id.to_s)

  # query parameters
  query_params = {}
  query_params[:newWidth] = @new_width unless @new_width.nil?
  query_params[:newHeight] = @new_height unless @new_height.nil?
  query_params[:x] = @x unless @x.nil?
  query_params[:y] = @y unless @y.nil?
  query_params[:rectWidth] = @rect_width unless @rect_width.nil?
  query_params[:rectHeight] = @rect_height unless @rect_height.nil?
  query_params[:rotateFlipMethod] = @rotate_flip_method unless @rotate_flip_method.nil?
  query_params[:saveOtherFrames] = @save_other_frames unless @save_other_frames.nil?
  query_params[:outPath] = @out_path unless @out_path.nil?
  query_params[:storage] = @storage unless @storage.nil?

  # form parameters
  form_params = {}
  form_params['imageData'] = @image_data

  # http body (model)
  post_body = nil
  auth_names = ['JWT']

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = form_params.any? ? 'multipart/form-data' : select_header_content_type(['multipart/form-data'])

  AsposeImagingCloud::HttpRequest.new(local_var_path,
                                  header_params,
                                  query_params,
                                  form_params,
                                  post_body,
                                  auth_names)
end