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

AudioGenerationOptions.md

79 lines1.6 KB

1---
2id: AudioGenerationOptions
3title: AudioGenerationOptions
4---
5​
6# Interface: AudioGenerationOptions\<TProviderOptions\>
7​
8Defined in: [packages/ai/src/types.ts:1882](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1882)
9​
10Options for audio generation (music, sound effects, etc.).
11These are the common options supported across providers.
12​
13## Type Parameters
14​
15### TProviderOptions
16​
17`TProviderOptions` *extends* `object` = `object`
18​
19## Properties
20​
21### duration?
22​
23```ts
24optional duration: number;
25```
26​
27Defined in: [packages/ai/src/types.ts:1890](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1890)
28​
29Desired duration in seconds
30​
31***
32​
33### logger
34​
35```ts
36logger: InternalLogger;
37```
38​
39Defined in: [packages/ai/src/types.ts:1898](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1898)
40​
41Internal logger threaded from the generateAudio() entry point. Adapters
42must call logger.request() before the SDK call and logger.errors() in
43catch blocks.
44​
45***
46​
47### model
48​
49```ts
50model: string;
51```
52​
53Defined in: [packages/ai/src/types.ts:1886](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1886)
54​
55The model to use for audio generation
56​
57***
58​
59### modelOptions?
60​
61```ts
62optional modelOptions: TProviderOptions;
63```
64​
65Defined in: [packages/ai/src/types.ts:1892](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1892)
66​
67Model-specific options for audio generation
68​
69***
70​
71### prompt
72​
73```ts
74prompt: string;
75```
76​
77Defined in: [packages/ai/src/types.ts:1888](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1888)
78​
79Text description of the desired audio