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

Commit b49a074

Browse files
committed
chore: release 1.0.0
1 parent 76bcf3d commit b49a074

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
@@ -32,7 +32,7 @@ If you'd prefer to use Google ASR, follow these [instructions for setting up Goo
3232

3333
**asrSocketServer**(`server`: Server): void
3434

35-
_Defined in [server/socketServer.ts:24](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/server/socketServer.ts#L24)_
35+
_Defined in [server/socketServer.ts:24](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/server/socketServer.ts#L24)_
3636

3737
Adds a web socket server to the given HTTP server
3838
to stream ASR using Spokestack ASR.
@@ -63,7 +63,7 @@ server.listen(port, () => {
6363

6464
**googleASRSocketServer**(`server`: Server): void
6565

66-
_Defined in [server/socketServer.ts:99](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/server/socketServer.ts#L99)_
66+
_Defined in [server/socketServer.ts:99](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/server/socketServer.ts#L99)_
6767

6868
Adds a web socket server to the given HTTP server
6969
to stream ASR using Google Speech.
@@ -92,7 +92,7 @@ server.listen(port, () => {
9292

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

95-
_Defined in [server/asr.ts:43](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/server/asr.ts#L43)_
95+
_Defined in [server/asr.ts:43](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/server/asr.ts#L43)_
9696

9797
A one-off method for processing speech to text
9898
using Spokestack ASR.
@@ -145,7 +145,7 @@ expressApp.post('/asr', fileUpload(), (req, res) => {
145145

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

148-
_Defined in [server/asr.ts:97](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/server/asr.ts#L97)_
148+
_Defined in [server/asr.ts:97](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/server/asr.ts#L97)_
149149

150150
A one-off method for processing speech to text
151151
using Google Speech.
@@ -196,7 +196,7 @@ expressApp.post('/asr', fileUpload(), (req, res) => {
196196

197197
**spokestackMiddleware**(): function
198198

199-
_Defined in [server/expressMiddleware.ts:37](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/server/expressMiddleware.ts#L37)_
199+
_Defined in [server/expressMiddleware.ts:37](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/server/expressMiddleware.ts#L37)_
200200

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

234234
**encryptSecret**(`body`: string): string
235235

236-
_Defined in [server/encryptSecret.ts:13](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/server/encryptSecret.ts#L13)_
236+
_Defined in [server/encryptSecret.ts:13](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/server/encryptSecret.ts#L13)_
237237

238238
This is a convenience method for properly authorizing
239239
requests to the Spokestack graphql API.
@@ -262,7 +262,7 @@ These functions are available exports from `spokestack/client`.
262262

263263
**record**(`config?`: RecordConfig): Promise\<AudioBuffer>
264264

265-
_Defined in [client/record.ts:84](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/record.ts#L84)_
265+
_Defined in [client/record.ts:84](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/record.ts#L84)_
266266

267267
A method to record audio for a given number of seconds
268268

@@ -342,31 +342,31 @@ fetch('/asr', {
342342

343343
`Optional` **onProgress**: undefined \| (remaining: number) => void
344344

345-
_Defined in [client/record.ts:16](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/record.ts#L16)_
345+
_Defined in [client/record.ts:16](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/record.ts#L16)_
346346

347347
A callback function to be called each second of recording.
348348

349349
##### onStart
350350

351351
`Optional` **onStart**: undefined \| () => void
352352

353-
_Defined in [client/record.ts:14](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/record.ts#L14)_
353+
_Defined in [client/record.ts:14](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/record.ts#L14)_
354354

355355
A callback function to be called when recording starts
356356

357357
##### time
358358

359359
`Optional` **time**: undefined \| number
360360

361-
_Defined in [client/record.ts:12](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/record.ts#L12)_
361+
_Defined in [client/record.ts:12](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/record.ts#L12)_
362362

363363
The total time to record. Default: 3
364364

365365
### startStream
366366

367367
**startStream**(`isPlaying`: () => boolean): Promise\<WebSocket>
368368

369-
_Defined in [client/recordStream.ts:29](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/recordStream.ts#L29)_
369+
_Defined in [client/recordStream.ts:29](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/recordStream.ts#L29)_
370370

371371
Returns a function to start recording using a native WebSocket.
372372
This assumes the socket is hosted on the current server.
@@ -399,7 +399,7 @@ try {
399399

400400
**stopStream**(): void
401401

402-
_Defined in [client/recordStream.ts:79](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/recordStream.ts#L79)_
402+
_Defined in [client/recordStream.ts:79](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/recordStream.ts#L79)_
403403

404404
Stop the current recording stream if one exists.
405405

@@ -414,7 +414,7 @@ stopStream()
414414

415415
**convertFloat32ToInt16**(`fp32Samples`: Float32Array): Int16Array
416416

417-
_Defined in [client/convertFloat32ToInt16.ts:16](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/convertFloat32ToInt16.ts#L16)_
417+
_Defined in [client/convertFloat32ToInt16.ts:16](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/convertFloat32ToInt16.ts#L16)_
418418

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

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

448-
_Defined in [client/processor.ts:32](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/processor.ts#L32)_
448+
_Defined in [client/processor.ts:32](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/processor.ts#L32)_
449449

450450
Underlying utility method for recording audio,
451451
used by the `record` and `recordStream` methods.
@@ -464,7 +464,7 @@ We'll switch to AudioWorklet when it does.
464464

465465
**stopProcessor**(): void
466466

467-
_Defined in [client/processor.ts:60](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/processor.ts#L60)_
467+
_Defined in [client/processor.ts:60](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/processor.ts#L60)_
468468

469469
Underlying utility method to stop the current processor
470470
if it exists and disconnect the microphone.
@@ -477,19 +477,19 @@ if it exists and disconnect the microphone.
477477

478478
**context**: AudioContext
479479

480-
_Defined in [client/processor.ts:18](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/processor.ts#L18)_
480+
_Defined in [client/processor.ts:18](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/processor.ts#L18)_
481481

482482
##### processor
483483

484484
**processor**: ScriptProcessorNode
485485

486-
_Defined in [client/processor.ts:19](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/processor.ts#L19)_
486+
_Defined in [client/processor.ts:19](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/processor.ts#L19)_
487487

488488
### concatenateAudioBuffers
489489

490490
**concatenateAudioBuffers**(`buffer1`: AudioBuffer, `buffer2`: AudioBuffer, `context`: AudioContext): null \| AudioBuffer
491491

492-
_Defined in [client/concatenateAudioBuffers.ts:4](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/concatenateAudioBuffers.ts#L4)_
492+
_Defined in [client/concatenateAudioBuffers.ts:4](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/concatenateAudioBuffers.ts#L4)_
493493

494494
A utility method to concatenate two AudioBuffers
495495

@@ -507,7 +507,7 @@ A utility method to concatenate two AudioBuffers
507507

508508
**countdown**(`time`: number, `progress`: (remaining: number) => void, `complete`: () => void): void
509509

510-
_Defined in [client/countdown.ts:7](https://github.com/spokestack/node-spokestack/blob/d0640e3/src/client/countdown.ts#L7)_
510+
_Defined in [client/countdown.ts:7](https://github.com/spokestack/node-spokestack/blob/76bcf3d/src/client/countdown.ts#L7)_
511511

512512
Countdown a number of seconds
513513

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": "1.0.0-beta.3",
3+
"version": "1.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)