Class: AsposeImagingCloud::CreateImageFrameRequest

Inherits:
ImagingRequest show all
Defined in:
lib/aspose-imaging-cloud/models/requests/create_image_frame_request.rb

Overview

Request model for create_image_frame operation.

Instance Method Summary collapse

Constructor Details

#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) ⇒ CreateImageFrameRequest

Get separate frame from existing image. Image data is passed as zero-indexed multipart/form-data content or as raw body stream.

Parameters:

  • image_data (File) —

    Input image

  • frame_id (Integer) —

    Number of a frame.

  • new_width (Integer) (defaults to: nil) —

    New width.

  • new_height (Integer) (defaults to: nil) —

    New height.

  • x (Integer) (defaults to: nil) —

    X position of start point for cropping rectangle.

  • y (Integer) (defaults to: nil) —

    Y position of start point for cropping rectangle.

  • rect_width (Integer) (defaults to: nil) —

    Width of cropping rectangle.

  • rect_height (Integer) (defaults to: nil) —

    Height of cropping rectangle.

  • rotate_flip_method (String) (defaults to: nil) —

    RotateFlip method (Rotate180FlipNone, Rotate180FlipX, Rotate180FlipXY, Rotate180FlipY, Rotate270FlipNone, Rotate270FlipX, Rotate270FlipXY, Rotate270FlipY, Rotate90FlipNone, Rotate90FlipX, Rotate90FlipXY, Rotate90FlipY, RotateNoneFlipNone, RotateNoneFlipX, RotateNoneFlipXY, RotateNoneFlipY). Default is RotateNoneFlipNone.

  • save_other_frames (BOOLEAN) (defaults to: nil) —

    If result will include all other frames or just a specified frame.

  • out_path (String) (defaults to: nil) —

    Path to updated file (if this is empty, response contains streamed image).

  • storage (String) (defaults to: nil) —

    Your Aspose Cloud Storage name.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# 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

Instance Method Details

#to_http_info(config) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# 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