docs: update

mybigday · Sep 23, 2023 · 5dfcb84 · 5dfcb84
1 parent 70b7bfb
commit 5dfcb84
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 23 deletions.
diff --git a/docs/API/README.md b/docs/API/README.md
@@ -49,7 +49,7 @@ whisper.rn
 
 #### Defined in
 
-[index.ts:289](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L289)
+[index.ts:312](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L312)
 
 ___
 
@@ -59,7 +59,7 @@ ___
 
 #### Defined in
 
-[index.ts:34](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L34)
+[index.ts:34](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L34)
 
 ___
 
@@ -89,7 +89,7 @@ ___
 
 #### Defined in
 
-[NativeRNWhisper.ts:5](https://github.com/mybigday/whisper.rn/blob/2aed191/src/NativeRNWhisper.ts#L5)
+[NativeRNWhisper.ts:5](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/NativeRNWhisper.ts#L5)
 
 ___
 
@@ -107,7 +107,7 @@ ___
 
 #### Defined in
 
-[index.ts:41](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L41)
+[index.ts:41](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L41)
 
 ___
 
@@ -132,7 +132,7 @@ ___
 
 #### Defined in
 
-[index.ts:63](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L63)
+[index.ts:86](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L86)
 
 ___
 
@@ -150,7 +150,7 @@ ___
 
 #### Defined in
 
-[index.ts:96](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L96)
+[index.ts:119](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L119)
 
 ___
 
@@ -174,17 +174,17 @@ ___
 
 #### Defined in
 
-[index.ts:83](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L83)
+[index.ts:106](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L106)
 
 ___
 
 ### TranscribeRealtimeOptions
 
-Ƭ **TranscribeRealtimeOptions**: [`TranscribeOptions`](README.md#transcribeoptions) & { `realtimeAudioSec?`: `number` ; `realtimeAudioSliceSec?`: `number`  }
+Ƭ **TranscribeRealtimeOptions**: [`TranscribeOptions`](README.md#transcribeoptions) & { `audioOutputPath?`: `string` ; `realtimeAudioSec?`: `number` ; `realtimeAudioSliceSec?`: `number` ; `useVad?`: `boolean` ; `vadFreqThold?`: `number` ; `vadMs?`: `number` ; `vadThold?`: `number`  }
 
 #### Defined in
 
-[index.ts:48](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L48)
+[index.ts:48](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L48)
 
 ___
 
@@ -202,7 +202,7 @@ ___
 
 #### Defined in
 
-[NativeRNWhisper.ts:37](https://github.com/mybigday/whisper.rn/blob/2aed191/src/NativeRNWhisper.ts#L37)
+[NativeRNWhisper.ts:37](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/NativeRNWhisper.ts#L37)
 
 ## Variables
 
@@ -214,7 +214,7 @@ Is allow fallback to CPU if load CoreML model failed
 
 #### Defined in
 
-[index.ts:374](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L374)
+[index.ts:397](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L397)
 
 ___
 
@@ -226,7 +226,7 @@ Is use CoreML models on iOS
 
 #### Defined in
 
-[index.ts:371](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L371)
+[index.ts:394](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L394)
 
 ___
 
@@ -238,7 +238,7 @@ Current version of whisper.cpp
 
 #### Defined in
 
-[index.ts:366](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L366)
+[index.ts:389](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L389)
 
 ## Functions
 
@@ -258,7 +258,7 @@ Current version of whisper.cpp
 
 #### Defined in
 
-[index.ts:311](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L311)
+[index.ts:334](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L334)
 
 ___
 
@@ -272,4 +272,4 @@ ___
 
 #### Defined in
 
-[index.ts:361](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L361)
+[index.ts:384](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L384)
diff --git a/docs/API/classes/WhisperContext.md b/docs/API/classes/WhisperContext.md
@@ -32,7 +32,7 @@
 
 #### Defined in
 
-[index.ts:105](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L105)
+[index.ts:128](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L128)
 
 ## Properties
 
@@ -42,7 +42,7 @@
 
 #### Defined in
 
-[index.ts:103](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L103)
+[index.ts:126](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L126)
 
 ## Methods
 
@@ -56,7 +56,7 @@
 
 #### Defined in
 
-[index.ts:284](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L284)
+[index.ts:307](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L307)
 
 ___
 
@@ -80,17 +80,17 @@ Transcribe audio file
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `promise` | `Promise`<[`TranscribeResult`](../README.md#transcriberesult)\> | Transcribe result promise |
-| `stop` | () => `Promise<void>` | Stop the transcribe |
+| `stop` | () => `Promise`<`void`\> | Stop the transcribe |
 
 #### Defined in
 
-[index.ts:110](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L110)
+[index.ts:133](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L133)
 
 ___
 
 ### transcribeRealtime
 
-▸ **transcribeRealtime**(`options?`): `Promise`<{ `stop`: () => `Promise<void>` ; `subscribe`: (`callback`: (`event`: [`TranscribeRealtimeEvent`](../README.md#transcriberealtimeevent)) => `void`) => `void`  }\>
+▸ **transcribeRealtime**(`options?`): `Promise`<{ `stop`: () => `Promise`<`void`\> ; `subscribe`: (`callback`: (`event`: [`TranscribeRealtimeEvent`](../README.md#transcriberealtimeevent)) => `void`) => `void`  }\>
 
 Transcribe the microphone audio stream, the microphone user permission is required
 
@@ -102,8 +102,8 @@ Transcribe the microphone audio stream, the microphone user permission is requir
 
 #### Returns
 
-`Promise`<{ `stop`: () => `Promise<void>` ; `subscribe`: (`callback`: (`event`: [`TranscribeRealtimeEvent`](../README.md#transcriberealtimeevent)) => `void`) => `void`  }\>
+`Promise`<{ `stop`: () => `Promise`<`void`\> ; `subscribe`: (`callback`: (`event`: [`TranscribeRealtimeEvent`](../README.md#transcriberealtimeevent)) => `void`) => `void`  }\>
 
 #### Defined in
 
-[index.ts:178](https://github.com/mybigday/whisper.rn/blob/2aed191/src/index.ts#L178)
+[index.ts:201](https://github.com/mybigday/whisper.rn/blob/70b7bfb/src/index.ts#L201)