@unith-ai/core-client 2.0.3-beta.3 → 2.0.4-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -0
- package/dist/lib.js +1 -1
- package/dist/lib.js.map +1 -1
- package/dist/lib.module.js +1 -1
- package/dist/lib.module.js.map +1 -1
- package/dist/lib.web.js +20 -24205
- package/dist/lib.web.js.map +1 -1
- package/dist/modules/microphone.d.ts +0 -1
- package/dist/modules/microphone.d.ts.map +1 -1
- package/package.json +10 -7
package/README.md
CHANGED
|
@@ -18,6 +18,26 @@ yarn add @unith-ai/core-client
|
|
|
18
18
|
pnpm install @unith-ai/core-client
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
+
### Azure Speech SDK (when using `microphoneProvider: "azure"`)
|
|
22
|
+
|
|
23
|
+
If you plan to use the built-in Azure microphone provider you must provide the Azure Speech SDK at runtime. This library declares the SDK as a peer dependency so your application should install it or include the browser bundle.
|
|
24
|
+
|
|
25
|
+
Install locally:
|
|
26
|
+
|
|
27
|
+
```shell
|
|
28
|
+
npm install microsoft-cognitiveservices-speech-sdk
|
|
29
|
+
# or
|
|
30
|
+
pnpm add microsoft-cognitiveservices-speech-sdk
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Or include the browser bundle via CDN in your HTML before initializing the SDK:
|
|
34
|
+
|
|
35
|
+
```html
|
|
36
|
+
<script src="https://aka.ms/csspeech/jsbrowserpackageraw"></script>
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
If the SDK isn't available at runtime the Azure microphone will not initialize and you'll see errors referencing missing `SpeechConfig`.
|
|
40
|
+
|
|
21
41
|
## Usage
|
|
22
42
|
|
|
23
43
|
This library is designed for use in plain JavaScript applications or to serve as a foundation for framework-specific implementations. Before integrating it, verify if a dedicated library exists for your particular framework. That said, it's compatible with any project built on JavaScript.
|