Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

AudioGenerationOptions.md

79 lines1.7 KB

Interface: AudioGenerationOptions<TProviderOptions>

Defined in: packages/typescript/ai/src/types.ts:1489

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

Type Parameters

TProviderOptions

TProviderOptions extends object = object

Properties

duration?

optional duration: number;

Defined in: packages/typescript/ai/src/types.ts:1497

Desired duration in seconds


logger

logger: InternalLogger;

Defined in: packages/typescript/ai/src/types.ts:1505

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/typescript/ai/src/types.ts:1493

The model to use for audio generation


modelOptions?

optional modelOptions: TProviderOptions;

Defined in: packages/typescript/ai/src/types.ts:1499

Model-specific options for audio generation


prompt

prompt: string;

Defined in: packages/typescript/ai/src/types.ts:1495

Text description of the desired audio