@capgo/capacitor-speech-synthesis 7.0.0

package/dist/docs.json

@@ -0,0 +1,1089 @@
+{
+  "api": {
+    "name": "SpeechSynthesisPlugin",
+    "slug": "speechsynthesisplugin",
+    "docs": "Speech Synthesis Plugin for synthesizing speech from text.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "speak",
+        "signature": "(options: SpeakOptions) => Promise<SpeakResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The speech options including text and voice settings",
+            "type": "SpeakOptions"
+          }
+        ],
+        "returns": "Promise<SpeakResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The speech options including text and voice settings"
+          },
+          {
+            "name": "returns",
+            "text": "Promise resolving with the utterance ID"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await SpeechSynthesis.speak({\n  text: 'Hello, world!',\n  language: 'en-US',\n  rate: 1.0,\n  pitch: 1.0,\n  volume: 1.0,\n  queueStrategy: 'Add'\n});\nconsole.log('Utterance ID:', result.utteranceId);\n```"
+          }
+        ],
+        "docs": "Speaks the given text with specified options.\nThe utterance is added to the speech queue.",
+        "complexTypes": [
+          "SpeakResult",
+          "SpeakOptions"
+        ],
+        "slug": "speak"
+      },
+      {
+        "name": "synthesizeToFile",
+        "signature": "(options: SpeakOptions) => Promise<SynthesizeToFileResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The speech options including text and voice settings",
+            "type": "SpeakOptions"
+          }
+        ],
+        "returns": "Promise<SynthesizeToFileResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The speech options including text and voice settings"
+          },
+          {
+            "name": "returns",
+            "text": "Promise resolving with the file path and utterance ID"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst result = await SpeechSynthesis.synthesizeToFile({\n  text: 'Hello, world!',\n  language: 'en-US'\n});\nconsole.log('Audio file saved at:', result.filePath);\n```"
+          }
+        ],
+        "docs": "Synthesizes speech to an audio file (Android/iOS only).\nReturns the file path where the audio was saved.",
+        "complexTypes": [
+          "SynthesizeToFileResult",
+          "SpeakOptions"
+        ],
+        "slug": "synthesizetofile"
+      },
+      {
+        "name": "cancel",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when speech is cancelled"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait SpeechSynthesis.cancel();\n```"
+          }
+        ],
+        "docs": "Cancels all queued utterances and stops current speech.",
+        "complexTypes": [],
+        "slug": "cancel"
+      },
+      {
+        "name": "pause",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when speech is paused"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait SpeechSynthesis.pause();\n```"
+          }
+        ],
+        "docs": "Pauses speech immediately.",
+        "complexTypes": [],
+        "slug": "pause"
+      },
+      {
+        "name": "resume",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when speech is resumed"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait SpeechSynthesis.resume();\n```"
+          }
+        ],
+        "docs": "Resumes paused speech.",
+        "complexTypes": [],
+        "slug": "resume"
+      },
+      {
+        "name": "isSpeaking",
+        "signature": "() => Promise<{ isSpeaking: boolean; }>",
+        "parameters": [],
+        "returns": "Promise<{ isSpeaking: boolean; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise resolving with the speaking state"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { isSpeaking } = await SpeechSynthesis.isSpeaking();\nconsole.log('Is speaking:', isSpeaking);\n```"
+          }
+        ],
+        "docs": "Checks if speech synthesis is currently speaking.",
+        "complexTypes": [],
+        "slug": "isspeaking"
+      },
+      {
+        "name": "isAvailable",
+        "signature": "() => Promise<{ isAvailable: boolean; }>",
+        "parameters": [],
+        "returns": "Promise<{ isAvailable: boolean; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise resolving with the availability status"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { isAvailable } = await SpeechSynthesis.isAvailable();\nif (isAvailable) {\n  console.log('Speech synthesis is available');\n}\n```"
+          }
+        ],
+        "docs": "Checks if speech synthesis is available on the device.",
+        "complexTypes": [],
+        "slug": "isavailable"
+      },
+      {
+        "name": "getVoices",
+        "signature": "() => Promise<{ voices: VoiceInfo[]; }>",
+        "parameters": [],
+        "returns": "Promise<{ voices: VoiceInfo[]; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise resolving with the list of available voices"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { voices } = await SpeechSynthesis.getVoices();\nvoices.forEach(voice => {\n  console.log(`${voice.name} (${voice.language})`);\n});\n```"
+          }
+        ],
+        "docs": "Gets all available voices.",
+        "complexTypes": [
+          "VoiceInfo"
+        ],
+        "slug": "getvoices"
+      },
+      {
+        "name": "getLanguages",
+        "signature": "() => Promise<{ languages: string[]; }>",
+        "parameters": [],
+        "returns": "Promise<{ languages: string[]; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise resolving with the list of available language codes"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { languages } = await SpeechSynthesis.getLanguages();\nconsole.log('Available languages:', languages);\n```"
+          }
+        ],
+        "docs": "Gets all available languages.",
+        "complexTypes": [],
+        "slug": "getlanguages"
+      },
+      {
+        "name": "isLanguageAvailable",
+        "signature": "(options: IsLanguageAvailableOptions) => Promise<{ isAvailable: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The language to check",
+            "type": "IsLanguageAvailableOptions"
+          }
+        ],
+        "returns": "Promise<{ isAvailable: boolean; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The language to check"
+          },
+          {
+            "name": "returns",
+            "text": "Promise resolving with the availability status"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { isAvailable } = await SpeechSynthesis.isLanguageAvailable({\n  language: 'es-ES'\n});\nconsole.log('Spanish available:', isAvailable);\n```"
+          }
+        ],
+        "docs": "Checks if a specific language is available.",
+        "complexTypes": [
+          "IsLanguageAvailableOptions"
+        ],
+        "slug": "islanguageavailable"
+      },
+      {
+        "name": "isVoiceAvailable",
+        "signature": "(options: IsVoiceAvailableOptions) => Promise<{ isAvailable: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The voice ID to check",
+            "type": "IsVoiceAvailableOptions"
+          }
+        ],
+        "returns": "Promise<{ isAvailable: boolean; }>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The voice ID to check"
+          },
+          {
+            "name": "returns",
+            "text": "Promise resolving with the availability status"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { isAvailable } = await SpeechSynthesis.isVoiceAvailable({\n  voiceId: 'com.apple.ttsbundle.Samantha-compact'\n});\nconsole.log('Voice available:', isAvailable);\n```"
+          }
+        ],
+        "docs": "Checks if a specific voice is available.",
+        "complexTypes": [
+          "IsVoiceAvailableOptions"
+        ],
+        "slug": "isvoiceavailable"
+      },
+      {
+        "name": "initialize",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when initialized"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait SpeechSynthesis.initialize();\n```"
+          }
+        ],
+        "docs": "Initializes the speech synthesis engine (iOS optimization).\nThis can reduce latency for the first speech request.",
+        "complexTypes": [],
+        "slug": "initialize"
+      },
+      {
+        "name": "activateAudioSession",
+        "signature": "(options: ActivateAudioSessionOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The audio session category",
+            "type": "ActivateAudioSessionOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The audio session category"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when activated"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait SpeechSynthesis.activateAudioSession({\n  category: 'Playback'\n});\n```"
+          }
+        ],
+        "docs": "Activates the audio session with a specific category (iOS only).",
+        "complexTypes": [
+          "ActivateAudioSessionOptions"
+        ],
+        "slug": "activateaudiosession"
+      },
+      {
+        "name": "deactivateAudioSession",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when deactivated"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait SpeechSynthesis.deactivateAudioSession();\n```"
+          }
+        ],
+        "docs": "Deactivates the audio session (iOS only).",
+        "complexTypes": [],
+        "slug": "deactivateaudiosession"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise resolving with the plugin version"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await SpeechSynthesis.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
+          }
+        ],
+        "docs": "Gets the native plugin version.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'start', listenerFunc: (event: UtteranceEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name ('start')",
+            "type": "'start'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The callback function",
+            "type": "(event: UtteranceEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name ('start')"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The callback function"
+          },
+          {
+            "name": "returns",
+            "text": "A handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst listener = await SpeechSynthesis.addListener('start', (event) => {\n  console.log('Started speaking:', event.utteranceId);\n});\n// Later: listener.remove();\n```"
+          }
+        ],
+        "docs": "Listens for when an utterance starts speaking.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "UtteranceEvent"
+        ],
+        "slug": "addlistenerstart-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'end', listenerFunc: (event: UtteranceEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name ('end')",
+            "type": "'end'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The callback function",
+            "type": "(event: UtteranceEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name ('end')"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The callback function"
+          },
+          {
+            "name": "returns",
+            "text": "A handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst listener = await SpeechSynthesis.addListener('end', (event) => {\n  console.log('Finished speaking:', event.utteranceId);\n});\n```"
+          }
+        ],
+        "docs": "Listens for when an utterance finishes speaking.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "UtteranceEvent"
+        ],
+        "slug": "addlistenerend-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'boundary', listenerFunc: (event: BoundaryEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name ('boundary')",
+            "type": "'boundary'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The callback function",
+            "type": "(event: BoundaryEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name ('boundary')"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The callback function"
+          },
+          {
+            "name": "returns",
+            "text": "A handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst listener = await SpeechSynthesis.addListener('boundary', (event) => {\n  console.log('Word boundary at:', event.charIndex);\n});\n```"
+          }
+        ],
+        "docs": "Listens for word boundaries during speech.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "BoundaryEvent"
+        ],
+        "slug": "addlistenerboundary-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'error', listenerFunc: (event: ErrorEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name ('error')",
+            "type": "'error'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The callback function",
+            "type": "(event: ErrorEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name ('error')"
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The callback function"
+          },
+          {
+            "name": "returns",
+            "text": "A handle to remove the listener"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst listener = await SpeechSynthesis.addListener('error', (event) => {\n  console.error('Speech error:', event.error);\n});\n```"
+          }
+        ],
+        "docs": "Listens for synthesis errors.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ErrorEvent"
+        ],
+        "slug": "addlistenererror-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves when listeners are removed"
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nawait SpeechSynthesis.removeAllListeners();\n```"
+          }
+        ],
+        "docs": "Removes all event listeners.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "SpeakResult",
+      "slug": "speakresult",
+      "docs": "Result from speaking text.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "utteranceId",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Unique identifier for this utterance.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "SpeakOptions",
+      "slug": "speakoptions",
+      "docs": "Options for speaking text.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "text",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The text to speak.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "language",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The BCP-47 language tag (e.g., 'en-US', 'es-ES').",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "voiceId",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The voice identifier to use.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "pitch",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The pitch of the voice (0.5 to 2.0, default: 1.0).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "rate",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The speaking rate (0.1 to 10.0, default: 1.0).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "volume",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The volume (0.0 to 1.0, default: 1.0).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "queueStrategy",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The queue strategy: 'Add' to append or 'Flush' to replace queue.\nDefault: 'Add'",
+          "complexTypes": [],
+          "type": "'Add' | 'Flush' | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SynthesizeToFileResult",
+      "slug": "synthesizetofileresult",
+      "docs": "Result from synthesizing to file.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "filePath",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The file path where audio was saved.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "utteranceId",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Unique identifier for this utterance.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "VoiceInfo",
+      "slug": "voiceinfo",
+      "docs": "Information about a voice.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Unique voice identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Display name of the voice.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "language",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "BCP-47 language code.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "gender",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Gender of the voice (iOS only).",
+          "complexTypes": [],
+          "type": "'male' | 'female' | 'neutral' | undefined"
+        },
+        {
+          "name": "isNetworkConnectionRequired",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether this voice requires a network connection.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "default",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether this is the default voice (Web only).",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "IsLanguageAvailableOptions",
+      "slug": "islanguageavailableoptions",
+      "docs": "Options for checking language availability.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "language",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The BCP-47 language code to check.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "IsVoiceAvailableOptions",
+      "slug": "isvoiceavailableoptions",
+      "docs": "Options for checking voice availability.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "voiceId",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The voice ID to check.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ActivateAudioSessionOptions",
+      "slug": "activateaudiosessionoptions",
+      "docs": "Options for activating the audio session (iOS only).",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "category",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio session category.\n- 'Ambient': Mixes with other audio\n- 'Playback': Stops other audio",
+          "complexTypes": [],
+          "type": "'Ambient' | 'Playback'"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "UtteranceEvent",
+      "slug": "utteranceevent",
+      "docs": "Event emitted when utterance starts or ends.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "utteranceId",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The utterance identifier.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "BoundaryEvent",
+      "slug": "boundaryevent",
+      "docs": "Event emitted at word boundaries.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "utteranceId",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The utterance identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "charIndex",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The character index in the text.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "charLength",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The character length of the current word.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ErrorEvent",
+      "slug": "errorevent",
+      "docs": "Event emitted on synthesis error.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "utteranceId",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The utterance identifier.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "error",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The error message.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}