@@ -52,7 +52,7 @@ If you'd prefer to use Google ASR, follow these [instructions for setting up Goo
52
52
53
53
▸ ** spokestackMiddleware** (): function
54
54
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 ) _
56
56
57
57
Express middleware for adding a proxy to the Spokestack GraphQL API.
58
58
A proxy is necessary to avoid exposing your Spokestack token secret on the client.
@@ -89,7 +89,7 @@ const graphQLFetcher = (graphQLParams) =>
89
89
90
90
▸ ** asrSocketServer** (` serverConfig ` : ServerOptions, ` asrConfig? ` : Omit<SpokestackASRConfig, \" sampleRate\"\> ): void
91
91
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 ) _
93
93
94
94
Adds a web socket server to the given HTTP server
95
95
to stream ASR using Spokestack ASR.
@@ -121,7 +121,7 @@ server.listen(port, () => {
121
121
122
122
▸ ** googleASRSocketServer** (` serverConfig ` : ServerOptions): void
123
123
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 ) _
125
125
126
126
Adds a web socket server to the given HTTP server
127
127
to stream ASR using Google Speech.
@@ -150,7 +150,7 @@ server.listen(port, () => {
150
150
151
151
▸ ** asr** (` content ` : string \| Uint8Array, ` sampleRate ` : number): Promise<string \| null\>
152
152
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 ) _
154
154
155
155
A one-off method for processing speech to text
156
156
using Spokestack ASR.
@@ -203,7 +203,7 @@ expressApp.post('/asr', fileUpload(), (req, res) => {
203
203
204
204
▸ ** googleASR** (` content ` : string \| Uint8Array, ` sampleRate ` : number): Promise<string \| null\>
205
205
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 ) _
207
207
208
208
A one-off method for processing speech to text
209
209
using Google Speech.
@@ -254,7 +254,7 @@ expressApp.post('/asr', fileUpload(), (req, res) => {
254
254
255
255
▸ ** encryptSecret** (` body ` : string): string
256
256
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 ) _
258
258
259
259
This is a convenience method for properly authorizing
260
260
requests to the Spokestack graphql API.
@@ -283,7 +283,7 @@ These functions are available exports from `spokestack/client`.
283
283
284
284
▸ ** record** (` config? ` : RecordConfig): Promise<AudioBuffer\>
285
285
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 ) _
287
287
288
288
A method to record audio for a given number of seconds
289
289
@@ -363,31 +363,31 @@ fetch('/asr', {
363
363
364
364
• ` Optional ` ** onProgress** : undefined \| (remaining: number) => void
365
365
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 ) _
367
367
368
368
A callback function to be called each second of recording.
369
369
370
370
##### onStart
371
371
372
372
• ` Optional ` ** onStart** : undefined \| () => void
373
373
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 ) _
375
375
376
376
A callback function to be called when recording starts
377
377
378
378
##### time
379
379
380
380
• ` Optional ` ** time** : undefined \| number
381
381
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 ) _
383
383
384
384
The total time to record. Default: 3
385
385
386
386
### startStream
387
387
388
388
▸ ** startStream** (` __namedParameters ` : { address: undefined \| string ; isPlaying: () => boolean }): Promise<WebSocket, [ ProcessorReturnValue] \>
389
389
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 ) _
391
391
392
392
Returns a function to start recording using a native WebSocket.
393
393
This assumes the socket is hosted on the current server.
@@ -423,7 +423,7 @@ try {
423
423
424
424
▸ ** stopStream** (): void
425
425
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 ) _
427
427
428
428
Stop the current recording stream if one exists.
429
429
@@ -438,7 +438,7 @@ stopStream()
438
438
439
439
▸ ** convertFloat32ToInt16** (` fp32Samples ` : Float32Array): Int16Array
440
440
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 ) _
442
442
443
443
A utility method to convert Float32Array audio
444
444
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
469
469
470
470
▸ ** startProcessor** (): Promise<Error] \| [ null, [ ProcessorReturnValue] \>
471
471
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 ) _
473
473
474
474
Underlying utility method for recording audio,
475
475
used by the ` record ` and ` recordStream ` methods.
@@ -488,7 +488,7 @@ We'll switch to AudioWorklet when it does.
488
488
489
489
▸ ** stopProcessor** (): void
490
490
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 ) _
492
492
493
493
Underlying utility method to stop the current processor
494
494
if it exists and disconnect the microphone.
@@ -501,19 +501,19 @@ if it exists and disconnect the microphone.
501
501
502
502
• ** context** : AudioContext
503
503
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 ) _
505
505
506
506
##### processor
507
507
508
508
• ** processor** : ScriptProcessorNode
509
509
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 ) _
511
511
512
512
### concatenateAudioBuffers
513
513
514
514
▸ ** concatenateAudioBuffers** (` buffer1 ` : AudioBuffer \| null, ` buffer2 ` : AudioBuffer \| null, ` context ` : AudioContext): null \| AudioBuffer
515
515
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 ) _
517
517
518
518
A utility method to concatenate two AudioBuffers
519
519
@@ -531,7 +531,7 @@ A utility method to concatenate two AudioBuffers
531
531
532
532
▸ ** countdown** (` time ` : number, ` progress ` : (remaining: number) => void, ` complete ` : () => void): void
533
533
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 ) _
535
535
536
536
Countdown a number of seconds
537
537
0 commit comments