AudioGenerationOptions

Defined in: packages/ai/src/types.ts:2473

Options for audio generation (music, sound effects, etc.). These are the common options supported across providers.

Type Parameters#

TProviderOptions#

TProviderOptions extends object = object

Properties#

abortSignal?#

optional abortSignal?: AbortSignal;

Defined in: packages/ai/src/types.ts:2495

Effective abort signal composed by the activity from caller abortSignal and/or timeout. Adapters should forward this to the provider SDK when supported. Request-specific — never store on a global client config.

duration?#

optional duration?: number;

Defined in: packages/ai/src/types.ts:2481

Desired duration in seconds

logger#

logger: InternalLogger;

Defined in: packages/ai/src/types.ts:2489

Internal logger threaded from the generateAudio() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks.

model#

model: string;

Defined in: packages/ai/src/types.ts:2477

The model to use for audio generation

modelOptions?#

optional modelOptions?: TProviderOptions;

Defined in: packages/ai/src/types.ts:2483

Model-specific options for audio generation

prompt#

prompt: string;

Defined in: packages/ai/src/types.ts:2479

Text description of the desired audio