# speechtextconverter

> This lightweight, easy-to-integrate library enables real-time speech to text and Text to speech convert for your web application. Using the Web Speech API's SpeechRecognition interface, it provides a simplified method to access the user's microphone, list

Latest version **1.0.2** (published 2023-05-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install speechtextconverter
pnpm add speechtextconverter
yarn add speechtextconverter
bun add speechtextconverter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-05-11 |
| First published | 2023-05-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 553.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | skeletalspar |

## Links

- npm: https://www.npmjs.com/package/speechtextconverter
- npm.io page: https://npm.io/package/speechtextconverter

## Recent versions

- 1.0.2 (latest) — 2023-05-11
- 1.0.1 — 2023-05-11
- 1.0.0 — 2023-05-11

## README

# SpeechTextConverter

SpeechTextConverter is a real-time speech recognition library for web applications. Utilizing the Web Speech API's SpeechRecognition interface, this library provides a streamlined method to convert spoken language into written text, enhancing the user experience and accessibility of your application.

## Features

- Easy access to microphone stream and initiation of speech recognition
- Real-time transcription of spoken words into text
- Simplified error handling and browser compatibility checks
- Graceful start and stop of speech recognition
- Ablity to speak a statement.

## Check out demo app

[Demo App Link](https://dextrop.github.io/speechtextconverter/)

## Installation

You can install SpeechTextConverter using npm:

```bash
npm install speechtextconverter
```

## How to use

First, import the `{ TextToSpeech, SpeechToText }` function from the library:

```javascript
import { TextToSpeech, SpeechToText }  from 'speechtextconverter';

// Speech to text 
// SpeechToText ( callback )
SpeechToText((text) => {
    console.log(`You said: ${text}`);
    // .. add futher processing.
    // Required to detect changed if any
    this.cd.detectChanges();
});

// Text to speech
// SpeechToText ( "Text to speak...." )
TextToSpeech("Hey harry how are you?")
```

## Compatibility

The software is compatible with NodeJS, ReactJS and Angular.
SpeechToText uses the Web Speech API, which is supported by most modern browsers. However, it may not work on some older browsers or certain mobile browsers.

## Contributing

We welcome contributions! Please feel free to submit a pull request or open an issue on our [GitHub repository](https://github.com/dextrop/speechtextconverter).

## License

SpeechTextConverter is [MIT licensed](./LICENSE).

---
_Source: https://npm.io/package/speechtextconverter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._