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

Commit

Permalink
chore: release 3.1.0-beta.2
Browse files Browse the repository at this point in the history
  • Loading branch information
timmywil committed Mar 26, 2021
1 parent b646155 commit 7d2e195
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 23 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ const graphQLFetcher = (graphQLParams) =>

**Returns:** (`req`: Request, `res`: Response) => _void_

Defined in: [server/expressMiddleware.ts:37](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/server/expressMiddleware.ts#L37)
Defined in: [server/expressMiddleware.ts:37](https://github.com/spokestack/node-spokestack/blob/b646155/src/server/expressMiddleware.ts#L37)

### asrSocketServer

Expand Down Expand Up @@ -134,7 +134,7 @@ server.listen(port, () => {

**Returns:** _void_

Defined in: [server/socketServer.ts:23](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/server/socketServer.ts#L23)
Defined in: [server/socketServer.ts:23](https://github.com/spokestack/node-spokestack/blob/b646155/src/server/socketServer.ts#L23)

### asr

Expand Down Expand Up @@ -185,7 +185,7 @@ expressApp.post('/asr', fileUpload(), (req, res) => {

**Returns:** _Promise_<string \| _null_\>

Defined in: [server/asr.ts:43](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/server/asr.ts#L43)
Defined in: [server/asr.ts:43](https://github.com/spokestack/node-spokestack/blob/b646155/src/server/asr.ts#L43)

### googleASRSocketServer

Expand Down Expand Up @@ -214,7 +214,7 @@ server.listen(port, () => {

**Returns:** _void_

Defined in: [server/socketServer.ts:108](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/server/socketServer.ts#L108)
Defined in: [server/socketServer.ts:108](https://github.com/spokestack/node-spokestack/blob/b646155/src/server/socketServer.ts#L108)

### googleASR

Expand Down Expand Up @@ -265,7 +265,7 @@ expressApp.post('/asr', fileUpload(), (req, res) => {

**Returns:** _Promise_<string \| _null_\>

Defined in: [server/asr.ts:104](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/server/asr.ts#L104)
Defined in: [server/asr.ts:104](https://github.com/spokestack/node-spokestack/blob/b646155/src/server/asr.ts#L104)

### encryptSecret

Expand All @@ -288,7 +288,7 @@ for example usage.

**Returns:** _string_

Defined in: [server/encryptSecret.ts:13](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/server/encryptSecret.ts#L13)
Defined in: [server/encryptSecret.ts:13](https://github.com/spokestack/node-spokestack/blob/b646155/src/server/encryptSecret.ts#L13)

---

Expand Down Expand Up @@ -372,7 +372,7 @@ fetch('/asr', {

**Returns:** _Promise_<AudioBuffer\>

Defined in: [client/record.ts:84](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/record.ts#L84)
Defined in: [client/record.ts:84](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/record.ts#L84)

#### [RecordConfig](#RecordConfig)

Expand All @@ -390,7 +390,7 @@ A callback function to be called each second of recording.

**Returns:** _void_

Defined in: [client/record.ts:16](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/record.ts#L16)
Defined in: [client/record.ts:16](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/record.ts#L16)

##### onStart

Expand All @@ -400,15 +400,15 @@ A callback function to be called when recording starts

**Returns:** _void_

Defined in: [client/record.ts:14](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/record.ts#L14)
Defined in: [client/record.ts:14](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/record.ts#L14)

##### time

`Optional` **time**: _number_

The total time to record. Default: 3

Defined in: [client/record.ts:12](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/record.ts#L12)
Defined in: [client/record.ts:12](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/record.ts#L12)

### startStream

Expand Down Expand Up @@ -441,7 +441,7 @@ try {

**Returns:** _Promise_<WebSocket, [*ProcessorReturnValue*]\>

Defined in: [client/recordStream.ts:43](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/recordStream.ts#L43)
Defined in: [client/recordStream.ts:43](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/recordStream.ts#L43)

### stopStream

Expand All @@ -456,7 +456,7 @@ stopStream()

**Returns:** _void_

Defined in: [client/recordStream.ts:96](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/recordStream.ts#L96)
Defined in: [client/recordStream.ts:96](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/recordStream.ts#L96)

### convertFloat32ToInt16

Expand All @@ -481,7 +481,7 @@ const file = new File([convertFloat32ToInt16(buffer.getChannelData(0))], 'record

**Returns:** _Int16Array_

Defined in: [client/convertFloat32ToInt16.ts:16](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/convertFloat32ToInt16.ts#L16)
Defined in: [client/convertFloat32ToInt16.ts:16](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/convertFloat32ToInt16.ts#L16)

### startPipeline

Expand Down Expand Up @@ -546,7 +546,7 @@ try {

**Returns:** _Promise_<SpeechPipeline\>

Defined in: [client/pipeline.ts:165](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/pipeline.ts#L165)
Defined in: [client/pipeline.ts:165](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/pipeline.ts#L165)

### stopPipeline

Expand All @@ -561,7 +561,7 @@ stopPipeline()

**Returns:** _void_

Defined in: [client/pipeline.ts:199](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/pipeline.ts#L199)
Defined in: [client/pipeline.ts:199](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/pipeline.ts#L199)

### countdown

Expand All @@ -580,7 +580,7 @@ This is used by record() to record a certain number of seconds.

**Returns:** _void_

Defined in: [client/countdown.ts:8](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/countdown.ts#L8)
Defined in: [client/countdown.ts:8](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/countdown.ts#L8)

---

Expand All @@ -603,21 +603,21 @@ We'll switch to AudioWorklet when it does.

**Returns:** _Promise_<Error] \| [_null_, [*ProcessorReturnValue*]\>

Defined in: [client/processor.ts:22](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/processor.ts#L22)
Defined in: [client/processor.ts:22](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/processor.ts#L22)

#### ProcessorReturnValue

##### context

**context**: AudioContext

Defined in: [client/processor.ts:8](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/processor.ts#L8)
Defined in: [client/processor.ts:8](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/processor.ts#L8)

##### processor

**processor**: ScriptProcessorNode

Defined in: [client/processor.ts:9](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/processor.ts#L9)
Defined in: [client/processor.ts:9](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/processor.ts#L9)

### stopProcessor

Expand All @@ -628,7 +628,7 @@ if it exists and disconnect the microphone.

**Returns:** _void_

Defined in: [client/processor.ts:50](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/processor.ts#L50)
Defined in: [client/processor.ts:50](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/processor.ts#L50)

### concatenateAudioBuffers

Expand All @@ -646,4 +646,4 @@ A utility method to concatenate two AudioBuffers

**Returns:** _null_ \| AudioBuffer

Defined in: [client/concatenateAudioBuffers.ts:4](https://github.com/spokestack/node-spokestack/blob/63b2a9c/src/client/concatenateAudioBuffers.ts#L4)
Defined in: [client/concatenateAudioBuffers.ts:4](https://github.com/spokestack/node-spokestack/blob/b646155/src/client/concatenateAudioBuffers.ts#L4)
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "spokestack",
"version": "3.1.0-beta.1",
"version": "3.1.0-beta.2",
"description": "Tools for integration with the Spokestack API in Node.js",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 7d2e195

Please sign in to comment.