# speech2text
**speech2text** is a client plugin which using [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) to communicate with [Google Cloud Speech API](https://cloud.google.com/speech-to-text/) backend. Result of successful connection is Speech to Text response to client frontend. Custom backend on WebSocket protocol is required.
## installation
```javascript
npm install @comsultia/speech2text
```
## usage
In gulpfile.js add build.js to your array of JS files (or whatever you like):
```javascript
const jsFiles = [
'./node_modules/@comsultia/speech2text/dist/bundle.js',
'./public/src/js/custom.js'
];
```
*example available in 'node_modules/@comsultia/speech2text/gulpfile.js'*
In your html add build of js files and initialize speech2text plugin
```html
WebSocket Google Speech To Text
WebSocket Google Speech To Text
```
*example available in 'node_modules/@comsultia/speech2text/index.html'*
## parameters
**debug**: true || false (required)
**url**: url to your WebSocket backend (required)
**elementStart**: querySelector of recording start button element (required)
**elementStop**: querySelector of recording stop button element (required)
**elementResult**: querySelector of result holder element (required)
**defaultTimeout**: number of miliseconds for waiting on last word to stop, 4000ms is default value (optional)
**onConnecting**: callback on starting connecting with WebSocket (optional)
**onConnection**: callback on successfull connection with WebSocket (optional)
**onNotSupported**: callback on web audio not supported in selected browser (optional)
**onStart**: callback on start of recording (optional)
**onBlock**: callback on microphone block (optional)
**onError**: callback on error connecting with WebSocket (optional)
**onEnd**: callback on close WebSocket and end of recording (optional)
## demo
availbale in *'node_modules/@comsultia/speech2text'*
open *'index.html'* in your browser and check browser console with all events logs (don't forget to change url of your websocket backend)