class Shotstack::EditApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/shotstack/api/edit_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_render(id, opts = {}) click to toggle source

Get Render Status Get the rendering status, temporary asset url and details of a render by ID. **base URL:** api.shotstack.io/{version} @param id [String] The id of the timeline render task in UUID format @param [Hash] opts the optional parameters @return [RenderResponse]

# File lib/shotstack/api/edit_api.rb, line 27
def get_render(id, opts = {})
  data, _status_code, _headers = get_render_with_http_info(id, opts)
  data
end
get_render_with_http_info(id, opts = {}) click to toggle source

Get Render Status Get the rendering status, temporary asset url and details of a render by ID. **base URL:** api.shotstack.io/{version} @param id [String] The id of the timeline render task in UUID format @param [Hash] opts the optional parameters @return [Array<(RenderResponse, Integer, Hash)>] RenderResponse data, response status code and response headers

# File lib/shotstack/api/edit_api.rb, line 37
def get_render_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditApi.get_render ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EditApi.get_render"
  end
  pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
  if @api_client.config.client_side_validation && id !~ pattern
    fail ArgumentError, "invalid value for 'id' when calling EditApi.get_render, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/render/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RenderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['DeveloperKey']

  new_options = opts.merge(
    :operation => :"EditApi.get_render",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditApi#get_render\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_render(edit, opts = {}) click to toggle source

Render Asset Queue and render the contents of a timeline as a video, image or audio file. @param edit [Edit] The video, image or audio edit specified using JSON. **base URL:** api.shotstack.io/{version} @param [Hash] opts the optional parameters @return [QueuedResponse]

# File lib/shotstack/api/edit_api.rb, line 95
def post_render(edit, opts = {})
  data, _status_code, _headers = post_render_with_http_info(edit, opts)
  data
end
post_render_with_http_info(edit, opts = {}) click to toggle source

Render Asset Queue and render the contents of a timeline as a video, image or audio file. @param edit [Edit] The video, image or audio edit specified using JSON. **base URL:** api.shotstack.io/{version} @param [Hash] opts the optional parameters @return [Array<(QueuedResponse, Integer, Hash)>] QueuedResponse data, response status code and response headers

# File lib/shotstack/api/edit_api.rb, line 105
def post_render_with_http_info(edit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EditApi.post_render ...'
  end
  # verify the required parameter 'edit' is set
  if @api_client.config.client_side_validation && edit.nil?
    fail ArgumentError, "Missing the required parameter 'edit' when calling EditApi.post_render"
  end
  # resource path
  local_var_path = '/render'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(edit)

  # return_type
  return_type = opts[:debug_return_type] || 'QueuedResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['DeveloperKey']

  new_options = opts.merge(
    :operation => :"EditApi.post_render",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EditApi#post_render\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end