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

generateAudio.md

51 lines1.1 KB

1---
2id: generateAudio
3title: generateAudio
4---
5​
6# Function: generateAudio()
7​
8```ts
9function generateAudio<TAdapter, TStream>(options): AudioActivityResult<TStream>;
10```
11​
12Defined in: [packages/ai/src/activities/generateAudio/index.ts:130](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/index.ts#L130)
13​
14Audio generation activity - generates audio from text prompts.
15​
16Uses AI models to create music, sound effects, and other audio content.
17​
18## Type Parameters
19​
20### TAdapter
21​
22`TAdapter` *extends* [`AudioAdapter`](../interfaces/AudioAdapter.md)\<`string`, `AudioProviderOptions`\<`TAdapter`\>\>
23​
24### TStream
25​
26`TStream` *extends* `boolean` = `false`
27​
28## Parameters
29​
30### options
31​
32`AudioActivityOptions`\<`TAdapter`, `TStream`\>
33​
34## Returns
35​
36`AudioActivityResult`\<`TStream`\>
37​
38## Example
39​
40```ts
41import { generateAudio } from '@tanstack/ai'
42import { falAudio } from '@tanstack/ai-fal'
43​
44const result = await generateAudio({
45 adapter: falAudio('fal-ai/diffrhythm'),
46 prompt: 'An upbeat electronic track with synths',
47 duration: 10
48})
49​
50console.log(result.audio.url) // URL to generated audio
51```