{
  "api": {
    "name": "TextToSpeechPlugin",
    "slug": "texttospeechplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "speak",
        "signature": "(options: TTSOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "TTSOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Starts the TTS engine and plays the desired text.",
        "complexTypes": [
          "TTSOptions"
        ],
        "slug": "speak"
      },
      {
        "name": "stop",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Stops the TTS engine.",
        "complexTypes": [],
        "slug": "stop"
      },
      {
        "name": "getSupportedLanguages",
        "signature": "() => Promise<{ languages: string[]; }>",
        "parameters": [],
        "returns": "Promise<{ languages: string[]; }>",
        "tags": [],
        "docs": "Returns a list of supported BCP 47 language tags.",
        "complexTypes": [],
        "slug": "getsupportedlanguages"
      },
      {
        "name": "getSupportedVoices",
        "signature": "() => Promise<{ voices: SpeechSynthesisVoice[]; }>",
        "parameters": [],
        "returns": "Promise<{ voices: SpeechSynthesisVoice[]; }>",
        "tags": [],
        "docs": "Returns a list of supported voices.",
        "complexTypes": [
          "SpeechSynthesisVoice"
        ],
        "slug": "getsupportedvoices"
      },
      {
        "name": "isLanguageSupported",
        "signature": "(options: { lang: string; }) => Promise<{ supported: boolean; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ lang: string; }"
          }
        ],
        "returns": "Promise<{ supported: boolean; }>",
        "tags": [],
        "docs": "Checks if a specific BCP 47 language tag is supported.",
        "complexTypes": [],
        "slug": "islanguagesupported"
      },
      {
        "name": "openInstall",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Verifies proper installation and availability of resource files on the system.\n\nOnly available for Android.",
        "complexTypes": [],
        "slug": "openinstall"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'onRangeStart', listenerFunc: (info: { start: number; end: number; spokenWord: string; }) => void) => Promise<PluginListenerHandle>",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'onRangeStart'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "(info: { start: number; end: number; spokenWord: string; }) => void"
          }
        ],
        "returns": "Promise<PluginListenerHandle>",
        "tags": [],
        "docs": "",
        "complexTypes": [
          "PluginListenerHandle"
        ],
        "slug": "addlisteneronrangestart-"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "TTSOptions",
      "slug": "ttsoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "text",
          "tags": [
            {
              "text": "\"Hello world\"",
              "name": "example"
            }
          ],
          "docs": "The text that will be synthesised when the utterance is spoken.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "lang",
          "tags": [
            {
              "text": "\"en-US\"",
              "name": "default"
            }
          ],
          "docs": "The language of the utterance.\nPossible languages can be queried using `getSupportedLanguages`.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "rate",
          "tags": [
            {
              "text": "1.0",
              "name": "default"
            }
          ],
          "docs": "The speed at which the utterance will be spoken at.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "pitch",
          "tags": [
            {
              "text": "1.0",
              "name": "default"
            }
          ],
          "docs": "The pitch at which the utterance will be spoken at.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "volume",
          "tags": [
            {
              "text": "1.0",
              "name": "default"
            }
          ],
          "docs": "The volume that the utterance will be spoken at.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "voice",
          "tags": [],
          "docs": "The index of the selected voice that will be used to speak the utterance.\nPossible voices can be queried using `getSupportedVoices`.",
          "complexTypes": [],
          "type": "number | undefined"
        },
        {
          "name": "category",
          "tags": [
            {
              "text": "\"ambient\"",
              "name": "default"
            }
          ],
          "docs": "Select the iOS Audio session category.\nPossible values: `ambient` and `playback`.\nUse `playback` to play audio even when the app is in the background.\n\nOnly available for iOS.",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "queueStrategy",
          "tags": [
            {
              "text": "5.1.0",
              "name": "since"
            },
            {
              "text": "QueueStrategy.Flush",
              "name": "default"
            }
          ],
          "docs": "Select the strategy to adopt when several requests to speak overlap.",
          "complexTypes": [
            "QueueStrategy"
          ],
          "type": "QueueStrategy"
        }
      ]
    },
    {
      "name": "SpeechSynthesisVoice",
      "slug": "speechsynthesisvoice",
      "docs": "The SpeechSynthesisVoice interface represents a voice that the system supports.",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "default",
          "tags": [
            {
              "text": "false",
              "name": "example"
            }
          ],
          "docs": "Specifies whether the voice is the default voice for the current app (`true`) or not (`false`).",
          "complexTypes": [],
          "type": "boolean"
        },
        {
          "name": "lang",
          "tags": [
            {
              "text": "\"en-US\"",
              "name": "example"
            }
          ],
          "docs": "BCP 47 language tag indicating the language of the voice.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "localService",
          "tags": [
            {
              "text": "true",
              "name": "example"
            }
          ],
          "docs": "Specifies whether the voice is supplied by a local (`true`) or remote (`false`) speech synthesizer service.",
          "complexTypes": [],
          "type": "boolean"
        },
        {
          "name": "name",
          "tags": [
            {
              "text": "\"Microsoft Zira Desktop - English (United States)\"",
              "name": "example"
            }
          ],
          "docs": "Human-readable name that represents the voice.",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "voiceURI",
          "tags": [
            {
              "text": "\"urn:moz-tts:sapi:Microsoft Zira Desktop - English (United States)?en-US\"",
              "name": "example"
            }
          ],
          "docs": "Type of URI and location of the speech synthesis service for this voice.",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "PluginListenerHandle",
      "slug": "pluginlistenerhandle",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "remove",
          "tags": [],
          "docs": "",
          "complexTypes": [],
          "type": "() => Promise<void>"
        }
      ]
    }
  ],
  "enums": [
    {
      "name": "QueueStrategy",
      "slug": "queuestrategy",
      "members": [
        {
          "name": "Flush",
          "value": "0",
          "tags": [],
          "docs": "Use `Flush` to stop the current request when a new request is sent."
        },
        {
          "name": "Add",
          "value": "1",
          "tags": [],
          "docs": "Use `Add` to buffer the speech request. The request will be executed when all previous requests have been completed."
        }
      ]
    }
  ],
  "typeAliases": [],
  "pluginConfigs": []
}