Class: Uploadcare::Api::Rest::VideoConversions

Inherits:
Object
  • Object
show all
Defined in:
lib/uploadcare/api/rest/video_conversions.rb

Overview

REST API endpoint for video conversion operations.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rest:) ⇒ VideoConversions

Returns a new instance of VideoConversions.

Parameters:



11
12
13
 
# File 'lib/uploadcare/api/rest/video_conversions.rb', line 11

def initialize(rest:)
  @rest = rest
end

Instance Attribute Details

#rest ⇒ Uploadcare::Api::Rest (readonly)

Returns Parent REST client.

Returns:



8
9
10
 
# File 'lib/uploadcare/api/rest/video_conversions.rb', line 8

def rest
  @rest
end

Instance Method Details

#convert(paths:, options: {}, request_options: {}) ⇒ Uploadcare::Result

Convert a video to a specified format.

Parameters:

  • paths (Array<String>) —

    Conversion paths (e.g., ["uuid/video/-/format/mp4/-/quality/normal/"])

  • options (Hash) (defaults to: {}) —

    Optional parameters (:store)

  • request_options (Hash) (defaults to: {}) —

    Request options

Returns:

See Also:



22
23
24
25
26
27
28
 
# File 'lib/uploadcare/api/rest/video_conversions.rb', line 22

def convert(paths:, options: {}, request_options: {})
  params = { paths: paths }
  params[:store] = normalize_bool_param(options[:store]) if options.key?(:store)
  params.merge!(options.except(:store))
  params.compact!
  rest.post(path: '/convert/video/', params: params, headers: {}, request_options: request_options)
end

#status(token:, request_options: {}) ⇒ Uploadcare::Result

Get video conversion job status.

Parameters:

  • token (String, Integer) —

    Conversion job token

  • request_options (Hash) (defaults to: {}) —

    Request options

Returns:

See Also:



36
37
38
39
 
# File 'lib/uploadcare/api/rest/video_conversions.rb', line 36

def status(token:, request_options: {})
  rest.get(path: "/convert/video/status/#{token}/", params: {}, headers: {},
           request_options: request_options)
end