Skip to content

generateSpeech.md

Latest commit

 

History

History
61 lines (41 loc) · 1.22 KB

generateSpeech.md

File metadata and controls

61 lines (41 loc) · 1.22 KB
id generateSpeech
title generateSpeech

Function: generateSpeech()

function generateSpeech<TAdapter, TStream>(options): TTSActivityResult<TStream>;

Defined in: packages/typescript/ai/src/activities/generateSpeech/index.ts:128

TTS activity - generates speech from text.

Uses AI text-to-speech models to create audio from natural language text.

Type Parameters

TAdapter

TAdapter extends TTSAdapter<string, object>

TStream

TStream extends boolean = false

Parameters

options

TTSActivityOptions<TAdapter, TStream>

Returns

TTSActivityResult<TStream>

Examples

import { generateSpeech } from '@tanstack/ai'
import { openaiTTS } from '@tanstack/ai-openai'

const result = await generateSpeech({
  adapter: openaiTTS('tts-1-hd'),
  text: 'Hello, welcome to TanStack AI!',
  voice: 'nova'
})

console.log(result.audio) // base64-encoded audio
const result = await generateSpeech({
  adapter: openaiTTS('tts-1'),
  text: 'This is slower speech.',
  voice: 'alloy',
  format: 'wav',
  speed: 0.8
})