Skip to content

VideoAdapter.md

Latest commit

 

History

History
189 lines (110 loc) · 4.29 KB

VideoAdapter.md

File metadata and controls

189 lines (110 loc) · 4.29 KB
id VideoAdapter
title VideoAdapter

Interface: VideoAdapter<TModel, TProviderOptions, TModelProviderOptionsByName, TModelSizeByName>

Defined in: packages/typescript/ai/src/activities/generateVideo/adapter.ts:35

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)
  • TModelProviderOptionsByName: Map from model name to its specific provider options
  • TModelSizeByName: Map from model name to its supported sizes

Type Parameters

TModel

TModel extends string = string

TProviderOptions

TProviderOptions extends object = Record<string, unknown>

TModelProviderOptionsByName

TModelProviderOptionsByName extends Record<string, any> = Record<string, any>

TModelSizeByName

TModelSizeByName extends Record<string, string> = Record<string, string>

Properties

~types

~types: object;

Defined in: packages/typescript/ai/src/activities/generateVideo/adapter.ts:51

Internal

Type-only properties for inference. Not assigned at runtime.

modelProviderOptionsByName

modelProviderOptionsByName: TModelProviderOptionsByName;

modelSizeByName

modelSizeByName: TModelSizeByName;

providerOptions

providerOptions: TProviderOptions;

createVideoJob()

createVideoJob: (options) => Promise<VideoJobResult>;

Defined in: packages/typescript/ai/src/activities/generateVideo/adapter.ts:61

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, TModelSizeByName[TModel]>

Returns

Promise<VideoJobResult>

getVideoStatus()

getVideoStatus: (jobId) => Promise<VideoStatusResult>;

Defined in: packages/typescript/ai/src/activities/generateVideo/adapter.ts:68

Experimental

Get the current status of a video generation job.

Parameters

jobId

string

Returns

Promise<VideoStatusResult>

getVideoUrl()

getVideoUrl: (jobId) => Promise<VideoUrlResult>;

Defined in: packages/typescript/ai/src/activities/generateVideo/adapter.ts:74

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: packages/typescript/ai/src/activities/generateVideo/adapter.ts:42

Experimental

Discriminator for adapter kind - used to determine API shape

model

readonly model: TModel;

Defined in: packages/typescript/ai/src/activities/generateVideo/adapter.ts:46

Experimental

The model this adapter is configured for

name

readonly name: string;

Defined in: packages/typescript/ai/src/activities/generateVideo/adapter.ts:44

Experimental

Adapter name identifier