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

AudioAdapter.md

105 lines2.5 KB

1---
2id: AudioAdapter
3title: AudioAdapter
4---
5​
6# Interface: AudioAdapter\<TModel, TProviderOptions\>
7​
8Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:24](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L24)
9​
10Audio generation adapter interface with pre-resolved generics.
11​
12An adapter is created by a provider function: `provider('model')` → `adapter`
13All type resolution happens at the provider call site, not in this interface.
14​
15Generic parameters:
16- TModel: The specific model name (e.g., 'fal-ai/diffrhythm')
17- TProviderOptions: Provider-specific options (already resolved)
18​
19## Type Parameters
20​
21### TModel
22​
23`TModel` *extends* `string` = `string`
24​
25### TProviderOptions
26​
27`TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\>
28​
29## Properties
30​
31### ~types
32​
33```ts
34~types: object;
35```
36​
37Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:38](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L38)
38​
39**`Internal`**
40​
41Type-only properties for inference. Not assigned at runtime.
42​
43#### providerOptions
44​
45```ts
46providerOptions: TProviderOptions;
47```
48​
49***
50​
51### generateAudio()
52​
53```ts
54generateAudio: (options) => Promise<AudioGenerationResult>;
55```
56​
57Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:45](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L45)
58​
59Generate audio from a text prompt
60​
61#### Parameters
62​
63##### options
64​
65[`AudioGenerationOptions`](AudioGenerationOptions.md)\<`TProviderOptions`\>
66​
67#### Returns
68​
69`Promise`\<[`AudioGenerationResult`](AudioGenerationResult.md)\>
70​
71***
72​
73### kind
74​
75```ts
76readonly kind: "audio";
77```
78​
79Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:29](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L29)
80​
81Discriminator for adapter kind - used to determine API shape
82​
83***
84​
85### model
86​
87```ts
88readonly model: TModel;
89```
90​
91Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L33)
92​
93The model this adapter is configured for
94​
95***
96​
97### name
98​
99```ts
100readonly name: string;
101```
102​
103Defined in: [packages/typescript/ai/src/activities/generateAudio/adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/generateAudio/adapter.ts#L31)
104​
105Adapter name identifier