com.alibaba.dashscope.aigc.videosynthesis

类 VideoSynthesis

java.lang.Object

com.alibaba.dashscope.aigc.videosynthesis.VideoSynthesis

public final class VideoSynthesis
extends Object

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	VideoSynthesis.Duration Video synthesis duration
static class	VideoSynthesis.Models
static class	VideoSynthesis.Resolution
static class	VideoSynthesis.Size Video synthesis size

构造器概要

构造器

构造器和说明
VideoSynthesis() default VideoSynthesis constructor
VideoSynthesis(String baseUrl) Create with custom baseUrl
VideoSynthesis(String baseUrl, String task) Create with custom baseUrl

方法概要

限定符和类型	方法和说明
VideoSynthesisResult	asyncCall(VideoSynthesisParam param) Async call
VideoSynthesisResult	call(VideoSynthesisParam param) Call the server to get the result.
VideoSynthesisResult	cancel(String taskId, String apiKey) Cancel the task.
VideoSynthesisResult	cancel(VideoSynthesisResult taskInfo, String apiKey) Cancel the task.
VideoSynthesisResult	fetch(String taskId, String apiKey) Fetch the result.
VideoSynthesisResult	fetch(VideoSynthesisResult taskInfo, String apiKey) Fetch the result.
VideoSynthesisListResult	list(AsyncTaskListParam param) List the tasks.
VideoSynthesisListResult	list(String startTime, String endTime, String modelName, String apiKeyId, String region, String status, Integer pageNo, Integer pageSize)
VideoSynthesisResult	wait(String taskId, String apiKey) Wait for the task to complete.
VideoSynthesisResult	wait(VideoSynthesisResult taskInfo, String apiKey) Wait for the task to complete.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

VideoSynthesis

public VideoSynthesis()

default VideoSynthesis constructor

VideoSynthesis

public VideoSynthesis(String baseUrl)

Create with custom baseUrl

参数:

baseUrl - The service base url.

VideoSynthesis

public VideoSynthesis(String baseUrl,
                      String task)

Create with custom baseUrl

参数:

baseUrl - The service base url.

方法详细资料

asyncCall

public VideoSynthesisResult asyncCall(VideoSynthesisParam param)
                               throws ApiException,
                                      NoApiKeyException,
                                      InputRequiredException

Async call

参数:

param - The input param of class VideoSynthesisParam

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

InputRequiredException - Check the input param.

call

public VideoSynthesisResult call(VideoSynthesisParam param)
                          throws ApiException,
                                 NoApiKeyException,
                                 InputRequiredException

Call the server to get the result.

参数:

param - The input param of class `VideoSynthesisParam`.

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

InputRequiredException - Check the input param.

list

public VideoSynthesisListResult list(AsyncTaskListParam param)
                              throws ApiException,
                                     NoApiKeyException

List the tasks.

参数:

param - The input param of class `AsyncTaskListParam`.

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

list

public VideoSynthesisListResult list(String startTime,
                                     String endTime,
                                     String modelName,
                                     String apiKeyId,
                                     String region,
                                     String status,
                                     Integer pageNo,
                                     Integer pageSize)
                              throws ApiException,
                                     NoApiKeyException

参数:

startTime - startTime

endTime - endTime

modelName - modelName

apiKeyId - apiKeyId

region - region

status - status

pageNo - pageNo

pageSize - pageSize

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

fetch

public VideoSynthesisResult fetch(String taskId,
                                  String apiKey)
                           throws ApiException,
                                  NoApiKeyException

Fetch the result.

参数:

taskId - The task id.

apiKey - The api key.

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

fetch

public VideoSynthesisResult fetch(VideoSynthesisResult taskInfo,
                                  String apiKey)
                           throws ApiException,
                                  NoApiKeyException

Fetch the result.

参数:

taskInfo - The task info.

apiKey - The api key.

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

cancel

public VideoSynthesisResult cancel(String taskId,
                                   String apiKey)
                            throws ApiException,
                                   NoApiKeyException

Cancel the task.

参数:

taskId - The task id.

apiKey - The api key.

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

cancel

public VideoSynthesisResult cancel(VideoSynthesisResult taskInfo,
                                   String apiKey)
                            throws ApiException,
                                   NoApiKeyException

Cancel the task.

参数:

taskInfo - The task info.

apiKey - The api key.

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

wait

public VideoSynthesisResult wait(String taskId,
                                 String apiKey)
                          throws ApiException,
                                 NoApiKeyException

Wait for the task to complete.

参数:

taskId - The task id.

apiKey - The api key.

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.

wait

public VideoSynthesisResult wait(VideoSynthesisResult taskInfo,
                                 String apiKey)
                          throws ApiException,
                                 NoApiKeyException

Wait for the task to complete.

参数:

taskInfo - The task info.

apiKey - The api key.

返回:

The video synthesis result.

抛出:

NoApiKeyException - Can not find api key.

ApiException - The request failed, possibly due to a network or data error.