![](\"https://github.com/mastashake08/speech-kit/blob/main/cover.png\")
\n \n\n \n \n \n
Start listening for speech recognition.
\nStop listening for speech recognition.
\nUse Speech Synthesis to speak text.
\nSpeechRecognitionResultListGet current SpeechRecognition resultsList.
\nstringReturn text
\nBlobReturn text file with results.
\nobjectReturn text as JSON.
\nAdd grammar to the SpeechGrammarList from a URI.
\nAdd grammar to the SpeechGrammarList from a Grammar String.
\nSpeechGrammarListReturn current SpeechGrammarList.
\nSpeechRecognitionReturn the urrent SpeechRecognition object.
\nSpeechSynthesisReturn the current Speech Synthesis object.
\nArray.<SpeechSynthesisVoice>Return the current voices available to the user.
\nSet the SpeechSynthesisUtterance object with the text that is meant to be spoken.
\nSet the SpeechSynthesisVoice object with the desired voice.
\nSpeechSynthesisVoiceReturn the current voice being used in the utterance.
\nnullShare the text using the Web Share API or copy to Clipboard if not available
\nstringTakes text and returns SSML encoded XML object
\nstringTakes sentence and returns SSML paragraph object with sentences.
\nobject | stringTakes text and returns SSML object
\nstring | | Text to be spoken |\n| [voice] | SpeechSynthesisVoice | SpeechRecognitionResultList\nGet current SpeechRecognition resultsList.\n\n**Kind**: global function \n**Returns**: SpeechRecognitionResultList - - List of Speech Recognition results \n\n\n## getText() ⇒ string\nReturn text\n\n**Kind**: global function \n**Returns**: string - resultList as text string \n\n\n## getTextAsFile() ⇒ Blob\nReturn text file with results.\n\n**Kind**: global function \n**Returns**: Blob - transcript \n\n\n## getTextAsJson() ⇒ object\nReturn text as JSON.\n\n**Kind**: global function \n**Returns**: object - transcript \n\n\n## addGrammarFromUri()\nAdd grammar to the SpeechGrammarList from a URI.\n\n**Kind**: global function \n**Params**: string uri - URI that contains grammar \n\n\n## addGrammarFromString()\nAdd grammar to the SpeechGrammarList from a Grammar String.\n\n**Kind**: global function \n**Params**: string grammar - String containing grammar \n\n\n## getGrammarList() ⇒ SpeechGrammarList\nReturn current SpeechGrammarList.\n\n**Kind**: global function \n**Returns**: SpeechGrammarList - current SpeechGrammarList object \n\n\n## getRecognition() ⇒ SpeechRecognition\nReturn the urrent SpeechRecognition object.\n\n**Kind**: global function \n**Returns**: SpeechRecognition - current SpeechRecognition object \n\n\n## getSynth() ⇒ SpeechSynthesis\nReturn the current Speech Synthesis object.\n\n**Kind**: global function \n**Returns**: SpeechSynthesis - current instance of Speech Synthesis object \n\n\n## getVoices() ⇒ Array.<SpeechSynthesisVoice>\nReturn the current voices available to the user.\n\n**Kind**: global function \n**Returns**: Array.<SpeechSynthesisVoice> - Array of available Speech Synthesis Voices \n\n\n## setSpeechText()\nSet the SpeechSynthesisUtterance object with the text that is meant to be spoken.\n\n**Kind**: global function \n**Params**: string text - Text to be spoken \n\n\n## setSpeechVoice()\nSet the SpeechSynthesisVoice object with the desired voice.\n\n**Kind**: global function \n**Params**: SpeechSynthesisVoice voice - Voice to be spoken \n\n\n## getCurrentVoice() ⇒ SpeechSynthesisVoice\nReturn the current voice being used in the utterance.\n\n**Kind**: global function \n**Returns**: SpeechSynthesisVoice - current voice \n\n\n## share() ⇒ null\nShare the text using the Web Share API or copy to Clipboard if not available\n\n**Kind**: global function \n\n\n## createSSML() ⇒ string\nTakes text and returns SSML encoded XML object\n\n**Kind**: global function \n**Returns**: string - - XML DOM object in SSML format serialized to a string \n**Params**: string - Text to convert \n\n\n## parseSentenceSSML() ⇒ string\nTakes sentence and returns SSML paragraph object with sentences.\n\n**Kind**: global function \n**Returns**: string - xmlString - XML DOM object in SSML format \n**Params**: string xmlString - Text to convert \n\n\n## parseSSML() ⇒ object \\| string\nTakes text and returns SSML object\n\n**Kind**: global function \n**Returns**: object \\| string - xmlDoc - XML DOM object in SSML format or XML object serialized to string \n**Params**: string xmlString - Text to convert \n# Contributing\nIf you want to add functionality or fix a bug please provide a PR!\n\n# Sponsorships\nThis project is free for public use and will always be in perpetuity. That being said a brotha got bills to pay and ish! If you would like to sponsor this and all of my open source projects, then please consider becoming a patron on [Patreon](https://patreon.com/mastashake08) or a one time donation via [Cash App](https://cash.me/$mastashake08)\n","readmeFilename":"README.md"}