You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Description
Move Speech To Text implementation to c++
### Introduces a breaking change?
- [x] Yes
- [ ] No
### Type of change
- [ ] Bug fix (change which fixes an issue)
- [ ] New feature (change which adds functionality)
- [x] Documentation update (improves or adds clarity to existing
documentation)
- [x] Other (chores, tests, code style improvements etc.)
### Tested on
- [x] iOS
- [x] Android
### Checklist
- [x] I have performed a self-review of my code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have updated the documentation accordingly
- [x] My changes generate no new warnings
|`transcribe`|`(waveform: number[], options?: DecodingOptions \| undefined) => Promise<string>`| Starts a transcription process for a given input array, which should be a waveform at 16kHz. The second argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Resolves a promise with the output transcription when the model is finished. |
82
-
|`stream`|`() => Promise<string>`| Starts a streaming transcription process. Use in combination with `streamInsert` to feed audio chunks and `streamStop` to end the stream. Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses. |
83
-
|`streamInsert`|`(waveform: number[]) => void`| Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Call this repeatedly as new audio data becomes available. |
84
-
|`streamStop`|`() => void`| Stops the ongoing streaming transcription process. |
85
-
|`encode`|`(waveform: Float32Array) => Promise<void>`| Runs the encoding part of the model on the provided waveform. Stores the result internally.|
86
-
|`decode`|`(tokens: number[]) => Promise<Float32Array>`| Runs the decoder of the model. Returns the decoded waveform as a Float32Array.|
87
-
|`committedTranscription`|`string`| Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming. |
88
-
|`nonCommittedTranscription`|`string`| Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming. |
89
-
|`error`|`string \| null`| Contains the error message if the model failed to load. |
90
-
|`isGenerating`|`boolean`| Indicates whether the model is currently processing an inference. |
91
-
|`isReady`|`boolean`| Indicates whether the model has successfully loaded and is ready for inference. |
92
-
|`downloadProgress`|`number`| Tracks the progress of the model download process. |
|`transcribe`|`(waveform: Float32Array \| number[], options?: DecodingOptions \| undefined) => Promise<string>`| Starts a transcription process for a given input array, which should be a waveform at 16kHz. The second argument is an options object, e.g. `{ language: 'es' }` for multilingual models. Resolves a promise with the output transcription when the model is finished. Passing `number[]` is deprecated. |
81
+
|`stream`|`() => Promise<string>`| Starts a streaming transcription process. Use in combination with `streamInsert` to feed audio chunks and `streamStop` to end the stream. Updates `committedTranscription` and `nonCommittedTranscription` as transcription progresses.|
82
+
|`streamInsert`|`(waveform: Float32Array \| number[]) => Promise<void>`| Inserts a chunk of audio data (sampled at 16kHz) into the ongoing streaming transcription. Call this repeatedly as new audio data becomes available. Passing `number[]` is deprecated. |
83
+
|`streamStop`|`() => Promise<void>`| Stops the ongoing streaming transcription process.|
84
+
|`encode`|`(waveform: Float32Array \| number[]) => Promise<Float32Array>`| Runs the encoding part of the model on the provided waveform. Passing `number[]` is deprecated. |
85
+
|`decode`|`(tokens: number[] \| Int32Array, encoderOutput: Float32Array \| number[]) => Promise<Float32Array>`| Runs the decoder of the model. Passing `number[]` is deprecated.|
86
+
|`committedTranscription`|`string`| Contains the part of the transcription that is finalized and will not change. Useful for displaying stable results during streaming.|
87
+
|`nonCommittedTranscription`|`string`| Contains the part of the transcription that is still being processed and may change. Useful for displaying live, partial results during streaming.|
88
+
|`error`|`string \| null`| Contains the error message if the model failed to load.|
89
+
|`isGenerating`|`boolean`| Indicates whether the model is currently processing an inference.|
90
+
|`isReady`|`boolean`| Indicates whether the model has successfully loaded and is ready for inference.|
91
+
|`downloadProgress`|`number`| Tracks the progress of the model download process.|
0 commit comments