From f6abe260cd0cad8c33195088d5b18f30e906caaa Mon Sep 17 00:00:00 2001 From: __Rylex__ <134968689+msqr1@users.noreply.github.com> Date: Wed, 7 Feb 2024 22:22:27 -0800 Subject: [PATCH] Update README.md --- usage/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/usage/README.md b/usage/README.md index ab2d12e..785b13a 100644 --- a/usage/README.md +++ b/usage/README.md @@ -12,7 +12,7 @@ ## ```Module``` object | Function signature | Description | |---|---| -| ```Promise makeModel(path: string, url: string, id: string)```

```Promise makeSpkModel(path: string, url: string, id: string)``` | Make a ```Model``` or ```SpkModel```
- If **path** contains valid model files and **id** is the same, there will not be a fetch from **url**.
- If **path** doesn't contain valid model files, or if it contains valid model files but **id** is different, there will be a fetch from **url**, and the model is stored with **id**. Model files must be directly under the model root folder, and compressed model must be in .tgz format. | +| ```Promise makeModel(path: string, url: string, id: string)```

```Promise makeSpkModel(path: string, url: string, id: string)``` | Make a ```Model``` or ```SpkModel```, model files must be directly under the model root, and compressed model must be in .tgz format. If:
- **path** contains valid model files and **id** is the same, there will not be a fetch from **url**.
- **path** doesn't contain valid model files, or if it contains valid model files but **id** is different, there will be a fetch from **url**, and the model is stored with **id**. | | ```Promise makeRecognizer(model: Model, sampleRate: float)``` | Make a ```Recognizer```, it will use **model**'s thread if it's the first user of **model**, else it will use a new thread. | ```setLogLevel(lvl: int)``` | Set Vosk's log level (default: ```0```: Info)
```-2```: Error
```-1```: Warning
```1```: Verbose
```2```: More verbose
```3```: Debug | | ```revokeURLs()``` | Revoke the Blob URLs of pthread worker and worklet processor |