Skip to content
This repository was archived by the owner on May 6, 2022. It is now read-only.

Commit cace6f3

Browse files
committed
chore: release 3.0.0
1 parent d50a959 commit cace6f3

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ If you'd prefer to use Google ASR, follow these [instructions for setting up Goo
5252

5353
**spokestackMiddleware**(): function
5454

55-
_Defined in [server/expressMiddleware.ts:37](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/server/expressMiddleware.ts#L37)_
55+
_Defined in [server/expressMiddleware.ts:37](https://github.com/spokestack/node-spokestack/blob/d50a959/src/server/expressMiddleware.ts#L37)_
5656

5757
Express middleware for adding a proxy to the Spokestack GraphQL API.
5858
A proxy is necessary to avoid exposing your Spokestack token secret on the client.
@@ -89,7 +89,7 @@ const graphQLFetcher = (graphQLParams) =>
8989

9090
**asrSocketServer**(`serverConfig`: ServerOptions, `asrConfig?`: Omit<SpokestackASRConfig, \"sampleRate\"\>): void
9191

92-
_Defined in [server/socketServer.ts:25](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/server/socketServer.ts#L25)_
92+
_Defined in [server/socketServer.ts:23](https://github.com/spokestack/node-spokestack/blob/d50a959/src/server/socketServer.ts#L23)_
9393

9494
Adds a web socket server to the given HTTP server
9595
to stream ASR using Spokestack ASR.
@@ -121,7 +121,7 @@ server.listen(port, () => {
121121

122122
**googleASRSocketServer**(`serverConfig`: ServerOptions): void
123123

124-
_Defined in [server/socketServer.ts:110](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/server/socketServer.ts#L110)_
124+
_Defined in [server/socketServer.ts:108](https://github.com/spokestack/node-spokestack/blob/d50a959/src/server/socketServer.ts#L108)_
125125

126126
Adds a web socket server to the given HTTP server
127127
to stream ASR using Google Speech.
@@ -150,7 +150,7 @@ server.listen(port, () => {
150150

151151
**asr**(`content`: string \| Uint8Array, `sampleRate`: number): Promise<string \| null\>
152152

153-
_Defined in [server/asr.ts:43](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/server/asr.ts#L43)_
153+
_Defined in [server/asr.ts:43](https://github.com/spokestack/node-spokestack/blob/d50a959/src/server/asr.ts#L43)_
154154

155155
A one-off method for processing speech to text
156156
using Spokestack ASR.
@@ -203,7 +203,7 @@ expressApp.post('/asr', fileUpload(), (req, res) => {
203203

204204
**googleASR**(`content`: string \| Uint8Array, `sampleRate`: number): Promise<string \| null\>
205205

206-
_Defined in [server/asr.ts:97](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/server/asr.ts#L97)_
206+
_Defined in [server/asr.ts:97](https://github.com/spokestack/node-spokestack/blob/d50a959/src/server/asr.ts#L97)_
207207

208208
A one-off method for processing speech to text
209209
using Google Speech.
@@ -254,7 +254,7 @@ expressApp.post('/asr', fileUpload(), (req, res) => {
254254

255255
**encryptSecret**(`body`: string): string
256256

257-
_Defined in [server/encryptSecret.ts:13](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/server/encryptSecret.ts#L13)_
257+
_Defined in [server/encryptSecret.ts:13](https://github.com/spokestack/node-spokestack/blob/d50a959/src/server/encryptSecret.ts#L13)_
258258

259259
This is a convenience method for properly authorizing
260260
requests to the Spokestack graphql API.
@@ -283,7 +283,7 @@ These functions are available exports from `spokestack/client`.
283283

284284
**record**(`config?`: RecordConfig): Promise<AudioBuffer\>
285285

286-
_Defined in [client/record.ts:84](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/record.ts#L84)_
286+
_Defined in [client/record.ts:84](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/record.ts#L84)_
287287

288288
A method to record audio for a given number of seconds
289289

@@ -363,31 +363,31 @@ fetch('/asr', {
363363

364364
`Optional` **onProgress**: undefined \| (remaining: number) => void
365365

366-
_Defined in [client/record.ts:16](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/record.ts#L16)_
366+
_Defined in [client/record.ts:16](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/record.ts#L16)_
367367

368368
A callback function to be called each second of recording.
369369

370370
##### onStart
371371

372372
`Optional` **onStart**: undefined \| () => void
373373

374-
_Defined in [client/record.ts:14](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/record.ts#L14)_
374+
_Defined in [client/record.ts:14](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/record.ts#L14)_
375375

376376
A callback function to be called when recording starts
377377

378378
##### time
379379

380380
`Optional` **time**: undefined \| number
381381

382-
_Defined in [client/record.ts:12](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/record.ts#L12)_
382+
_Defined in [client/record.ts:12](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/record.ts#L12)_
383383

384384
The total time to record. Default: 3
385385

386386
### startStream
387387

388388
**startStream**(`__namedParameters`: { address: undefined \| string ; isPlaying: () => boolean }): Promise<WebSocket, [ProcessorReturnValue]\>
389389

390-
_Defined in [client/recordStream.ts:44](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/recordStream.ts#L44)_
390+
_Defined in [client/recordStream.ts:44](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/recordStream.ts#L44)_
391391

392392
Returns a function to start recording using a native WebSocket.
393393
This assumes the socket is hosted on the current server.
@@ -423,7 +423,7 @@ try {
423423

424424
**stopStream**(): void
425425

426-
_Defined in [client/recordStream.ts:97](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/recordStream.ts#L97)_
426+
_Defined in [client/recordStream.ts:97](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/recordStream.ts#L97)_
427427

428428
Stop the current recording stream if one exists.
429429

@@ -438,7 +438,7 @@ stopStream()
438438

439439
**convertFloat32ToInt16**(`fp32Samples`: Float32Array): Int16Array
440440

441-
_Defined in [client/convertFloat32ToInt16.ts:16](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/convertFloat32ToInt16.ts#L16)_
441+
_Defined in [client/convertFloat32ToInt16.ts:16](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/convertFloat32ToInt16.ts#L16)_
442442

443443
A utility method to convert Float32Array audio
444444
to an Int16Array to be passed directly to Speech APIs
@@ -469,7 +469,7 @@ These are low-level functions for working with your own processors, available fr
469469

470470
**startProcessor**(): Promise<Error] \| [null, [ProcessorReturnValue]\>
471471

472-
_Defined in [client/processor.ts:32](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/processor.ts#L32)_
472+
_Defined in [client/processor.ts:32](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/processor.ts#L32)_
473473

474474
Underlying utility method for recording audio,
475475
used by the `record` and `recordStream` methods.
@@ -488,7 +488,7 @@ We'll switch to AudioWorklet when it does.
488488

489489
**stopProcessor**(): void
490490

491-
_Defined in [client/processor.ts:60](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/processor.ts#L60)_
491+
_Defined in [client/processor.ts:60](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/processor.ts#L60)_
492492

493493
Underlying utility method to stop the current processor
494494
if it exists and disconnect the microphone.
@@ -501,19 +501,19 @@ if it exists and disconnect the microphone.
501501

502502
**context**: AudioContext
503503

504-
_Defined in [client/processor.ts:18](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/processor.ts#L18)_
504+
_Defined in [client/processor.ts:18](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/processor.ts#L18)_
505505

506506
##### processor
507507

508508
**processor**: ScriptProcessorNode
509509

510-
_Defined in [client/processor.ts:19](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/processor.ts#L19)_
510+
_Defined in [client/processor.ts:19](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/processor.ts#L19)_
511511

512512
### concatenateAudioBuffers
513513

514514
**concatenateAudioBuffers**(`buffer1`: AudioBuffer \| null, `buffer2`: AudioBuffer \| null, `context`: AudioContext): null \| AudioBuffer
515515

516-
_Defined in [client/concatenateAudioBuffers.ts:4](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/concatenateAudioBuffers.ts#L4)_
516+
_Defined in [client/concatenateAudioBuffers.ts:4](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/concatenateAudioBuffers.ts#L4)_
517517

518518
A utility method to concatenate two AudioBuffers
519519

@@ -531,7 +531,7 @@ A utility method to concatenate two AudioBuffers
531531

532532
**countdown**(`time`: number, `progress`: (remaining: number) => void, `complete`: () => void): void
533533

534-
_Defined in [client/countdown.ts:7](https://github.com/spokestack/node-spokestack/blob/47dbb86/src/client/countdown.ts#L7)_
534+
_Defined in [client/countdown.ts:7](https://github.com/spokestack/node-spokestack/blob/d50a959/src/client/countdown.ts#L7)_
535535

536536
Countdown a number of seconds
537537

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "spokestack",
3-
"version": "2.0.0",
3+
"version": "3.0.0",
44
"description": "Tools for integration with the Spokestack API in Node.js",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)