Class: RunApi::VolcengineLipSync::Resources::LipSyncVideo

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

Overview

Volcengine Lip Sync video resource.

Constant Summary collapse

ENDPOINT = 
"/api/v1/volcengine_lip_sync/lip_sync_video"
RESPONSE_CLASS = 
Types::LipSyncVideoResponse
COMPLETED_RESPONSE_CLASS = 
Types::CompletedLipSyncVideoResponse

Instance Method Summary collapse

Constructor Details

#initialize(http) ⇒ LipSyncVideo

Returns a new instance of LipSyncVideo.



14
15
16
 
# File 'lib/runapi/volcengine_lip_sync/resources/lip_sync_video.rb', line 14

def initialize(http)
  @http = http
end

Instance Method Details

#create(options: nil, **params) ⇒ RunApi::VolcengineLipSync::Types::LipSyncVideoResponse

Start a lip-sync video task.

Parameters:

  • params (Hash) —

    lip-sync parameters

Returns:



31
32
33
34
35
 
# File 'lib/runapi/volcengine_lip_sync/resources/lip_sync_video.rb', line 31

def create(options: nil, **params)
  params = compact_params(params)
  validate_contract!(CONTRACT["lip-sync-video"], params)
  request(:post, ENDPOINT, body: params, options: options)
end

#get(id, options: nil) ⇒ RunApi::VolcengineLipSync::Types::LipSyncVideoResponse

Get lip-sync video task status by task ID.

Parameters:

  • id (String) —

    task ID

Returns:



41
42
43
 
# File 'lib/runapi/volcengine_lip_sync/resources/lip_sync_video.rb', line 41

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

#run(options: nil, **params) ⇒ RunApi::VolcengineLipSync::Types::CompletedLipSyncVideoResponse

Create a lip-sync video task and wait until complete.

Parameters:

  • params (Hash) —

    lip-sync parameters

Returns:



22
23
24
25
 
# File 'lib/runapi/volcengine_lip_sync/resources/lip_sync_video.rb', line 22

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