Skip to content

MotionAdapter

Defined in: packages/ai/src/activities/generateMotion/adapter.ts:20

Experimental

Motion adapter interface with pre-resolved generics.

An adapter is created by a provider function: provider('model') → adapter. It makes skeletal animation assets (FBX, BVH, GLB, ...), not video.

Provider jobs are long-running, so the contract is job-shaped: submit, poll, fetch the finished assets. A provider that answers at once can return a job whose first status is already completed.

Motion generation is an experimental feature and may change.

Type Parameters

TModel

TModel extends string = string

TProviderOptions

TProviderOptions extends object = Record<string, unknown>

Properties

~types

ts
~types: object;

Defined in: packages/ai/src/activities/generateMotion/adapter.ts:34

Internal

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

providerOptions

ts
providerOptions: TProviderOptions;

cancelMotionJob?

ts
optional cancelMotionJob?: (jobId, options?) => Promise<void>;

Defined in: packages/ai/src/activities/generateMotion/adapter.ts:60

Experimental

Optional. Ask the provider to stop a job. Implement it only when the provider has a real cancel API. The core never calls it on its own: aborting a stream stops local observation only.

Parameters

jobId

string

options?
abortSignal?

AbortSignal

Returns

Promise<void>


createMotionJob

ts
createMotionJob: (options) => Promise<MotionJobResult>;

Defined in: packages/ai/src/activities/generateMotion/adapter.ts:39

Experimental

Submit a motion job. Returns the provider job id.

Parameters

options

MotionGenerationOptions<TProviderOptions>

Returns

Promise<MotionJobResult>


getMotion

ts
getMotion: (jobId, options?) => Promise<MotionGenerationResult>;

Defined in: packages/ai/src/activities/generateMotion/adapter.ts:50

Experimental

Fetch the finished assets. Call only after status is completed.

Parameters

jobId

string

options?
abortSignal?

AbortSignal

Returns

Promise<MotionGenerationResult>


getMotionStatus

ts
getMotionStatus: (jobId, options?) => Promise<MotionStatusResult>;

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

Experimental

Read the current status of a job.

Parameters

jobId

string

options?
abortSignal?

AbortSignal

Returns

Promise<MotionStatusResult>


kind

ts
readonly kind: "motion";

Defined in: packages/ai/src/activities/generateMotion/adapter.ts:25

Experimental

Discriminator for adapter kind - used to determine API shape


model

ts
readonly model: TModel;

Defined in: packages/ai/src/activities/generateMotion/adapter.ts:29

Experimental

The model this adapter is configured for


name

ts
readonly name: string;

Defined in: packages/ai/src/activities/generateMotion/adapter.ts:27

Experimental

Adapter name identifier