Class: RunApi::PixVerse::Resources::TransitionVideo

Inherits:
Object
  • Object
show all
Includes:
Core::ResourceHelpers
Defined in:
lib/runapi/pixverse/resources/transition_video.rb

Overview

PixVerse transition-video resource. Generate a transition between first and last frame images.

Constant Summary collapse

ENDPOINT = 
"/api/v1/pixverse/transition_video"
RESPONSE_CLASS = 
Types::TransitionVideoResponse
COMPLETED_RESPONSE_CLASS = 
Types::CompletedTransitionVideoResponse

Instance Method Summary collapse

Constructor Details

#initialize(http) ⇒ TransitionVideo

Returns a new instance of TransitionVideo.



16
17
18
 
# File 'lib/runapi/pixverse/resources/transition_video.rb', line 16

def initialize(http)
  @http = http
end

Instance Method Details

#create(options: nil, **params) ⇒ RunApi::PixVerse::Types::TransitionVideoResponse

Create a transition-video task.

Parameters:

  • params (Hash) —

    transition-video parameters

Returns:



33
34
35
36
37
 
# File 'lib/runapi/pixverse/resources/transition_video.rb', line 33

def create(options: nil, **params)
  params = compact_params(params)
  validate_params!(params)
  request(:post, ENDPOINT, body: params, options: options)
end

#get(id, options: nil) ⇒ RunApi::PixVerse::Types::TransitionVideoResponse

Get transition-video task status by task ID.

Parameters:

  • id (String) —

    task ID

Returns:



43
44
45
 
# File 'lib/runapi/pixverse/resources/transition_video.rb', line 43

def get(id, options: nil)
  request(:get, "#{ENDPOINT}/#{id}", options: options)
end

#run(options: nil, **params) ⇒ RunApi::PixVerse::Types::CompletedTransitionVideoResponse

Create a transition-video task and wait until complete.

Parameters:

  • params (Hash) —

    transition-video parameters

Returns:



24
25
26
27
 
# File 'lib/runapi/pixverse/resources/transition_video.rb', line 24

def run(options: nil, **params)
  task = create(options: options, **params)
  poll_until_complete { get(task.id, options: options) }
end