Interface: VideoAdapter<TModel, TProviderOptions>#
Defined in: activities/generateVideo/adapter.ts:33
Experimental
Video adapter interface with pre-resolved generics.
An adapter is created by a provider function: provider('model') → adapter
All type resolution happens at the provider call site, not in this interface.
Video generation is an experimental feature and may change.
Generic parameters:
- TModel: The specific model name (e.g., 'sora-2')
- TProviderOptions: Provider-specific options (already resolved)
Type Parameters#
TModel#
TModel extends string = string
TProviderOptions#
TProviderOptions extends object = Record<string, unknown>
Properties#
~types#
~types: object;
Defined in: activities/generateVideo/adapter.ts:47
Internal
Type-only properties for inference. Not assigned at runtime.
providerOptions#
providerOptions: TProviderOptions;
createVideoJob()#
createVideoJob: (options) => Promise<VideoJobResult>;
Defined in: activities/generateVideo/adapter.ts:55
Experimental
Create a new video generation job. Returns a job ID that can be used to poll for status and retrieve the video.
Parameters#
options#
VideoGenerationOptions<TProviderOptions>
Returns#
Promise<VideoJobResult>
getVideoStatus()#
getVideoStatus: (jobId) => Promise<VideoStatusResult>;
Defined in: activities/generateVideo/adapter.ts:62
Experimental
Get the current status of a video generation job.
Parameters#
jobId#
string
Returns#
Promise<VideoStatusResult>
getVideoUrl()#
getVideoUrl: (jobId) => Promise<VideoUrlResult>;
Defined in: activities/generateVideo/adapter.ts:68
Experimental
Get the URL to download/view the generated video. Should only be called after status is 'completed'.
Parameters#
jobId#
string
Returns#
Promise<VideoUrlResult>
kind#
readonly kind: "video";
Defined in: activities/generateVideo/adapter.ts:38
Experimental
Discriminator for adapter kind - used to determine API shape
model#
readonly model: TModel;
Defined in: activities/generateVideo/adapter.ts:42
Experimental
The model this adapter is configured for
name#
readonly name: string;
Defined in: activities/generateVideo/adapter.ts:40
Experimental
Adapter name identifier