@mastra/voice-speechify 0.12.0 → 0.12.1

package/dist/docs/voice/02-reference.md

@@ -1,62 +0,0 @@
-# Voice API Reference
-
-> API reference for voice - 1 entries
-
-
----
-
-## Reference: Speechify
-
-> Documentation for the Speechify voice implementation, providing text-to-speech capabilities.
-
-The Speechify voice implementation in Mastra provides text-to-speech capabilities using Speechify's API.
-
-## Usage Example
-
-```typescript
-import { SpeechifyVoice } from "@mastra/voice-speechify";
-
-// Initialize with default configuration (uses SPEECHIFY_API_KEY environment variable)
-const voice = new SpeechifyVoice();
-
-// Initialize with custom configuration
-const voice = new SpeechifyVoice({
-  speechModel: {
-    name: "simba-english",
-    apiKey: "your-api-key",
-  },
-  speaker: "george", // Default voice
-});
-
-// Convert text to speech
-const audioStream = await voice.speak("Hello, world!", {
-  speaker: "henry", // Override default voice
-});
-```
-
-## Constructor Parameters
-
-### SpeechifyConfig
-
-## Methods
-
-### speak()
-
-Converts text to speech using the configured speech model and voice.
-
-Returns: `Promise<NodeJS.ReadableStream>`
-
-### getSpeakers()
-
-Returns an array of available voice options, where each node contains:
-
-### listen()
-
-This method is not supported by Speechify and will throw an error. Speechify does not provide speech-to-text functionality.
-
-## Notes
-
-- Speechify requires an API key for authentication
-- The default model is 'simba-english'
-- Speech-to-text functionality is not supported
-- Additional audio stream options can be passed through the speak() method's options parameter