docs(api): update

mybigday · Oct 12, 2023 · 8503faa · 8503faa
1 parent 08d3b71
commit 8503faa
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 44 deletions.
diff --git a/docs/API/README.md b/docs/API/README.md
@@ -58,7 +58,7 @@ whisper.rn
 
 #### Defined in
 
-[index.ts:76](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L76)
+[index.ts:76](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L76)
 
 ___
 
@@ -75,10 +75,11 @@ ___
 | `coreMLModelAsset.filename` | `string` | - |
 | `filePath` | `string` \| `number` | - |
 | `isBundleAsset?` | `boolean` | Is the file path a bundle asset for pure string filePath |
+| `useCoreMLIos?` | `boolean` | Prefer to use Core ML model if exists. If set to false, even if the Core ML model exists, it will not be used. |
 
 #### Defined in
 
-[index.ts:428](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L428)
+[index.ts:428](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L428)
 
 ___
 
@@ -88,7 +89,7 @@ ___
 
 #### Defined in
 
-[index.ts:59](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L59)
+[index.ts:59](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L59)
 
 ___
 
@@ -106,7 +107,7 @@ ___
 
 #### Defined in
 
-[index.ts:52](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L52)
+[index.ts:52](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L52)
 
 ___
 
@@ -125,7 +126,7 @@ ___
 
 #### Defined in
 
-[index.ts:45](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L45)
+[index.ts:45](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L45)
 
 ___
 
@@ -155,7 +156,7 @@ ___
 
 #### Defined in
 
-[NativeRNWhisper.ts:5](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/NativeRNWhisper.ts#L5)
+[NativeRNWhisper.ts:5](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/NativeRNWhisper.ts#L5)
 
 ___
 
@@ -173,7 +174,7 @@ ___
 
 #### Defined in
 
-[index.ts:70](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L70)
+[index.ts:70](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L70)
 
 ___
 
@@ -198,7 +199,7 @@ ___
 
 #### Defined in
 
-[index.ts:133](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L133)
+[index.ts:133](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L133)
 
 ___
 
@@ -216,7 +217,7 @@ ___
 
 #### Defined in
 
-[index.ts:166](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L166)
+[index.ts:166](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L166)
 
 ___
 
@@ -240,7 +241,7 @@ ___
 
 #### Defined in
 
-[index.ts:153](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L153)
+[index.ts:153](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L153)
 
 ___
 
@@ -250,7 +251,7 @@ ___
 
 #### Defined in
 
-[index.ts:84](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L84)
+[index.ts:84](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L84)
 
 ___
 
@@ -268,7 +269,7 @@ ___
 
 #### Defined in
 
-[NativeRNWhisper.ts:37](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/NativeRNWhisper.ts#L37)
+[NativeRNWhisper.ts:37](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/NativeRNWhisper.ts#L37)
 
 ## Variables
 
@@ -293,7 +294,7 @@ AudioSession Utility, iOS only.
 
 #### Defined in
 
-[AudioSessionIos.ts:50](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L50)
+[AudioSessionIos.ts:50](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L50)
 
 ___
 
@@ -305,7 +306,7 @@ Is allow fallback to CPU if load CoreML model failed
 
 #### Defined in
 
-[index.ts:522](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L522)
+[index.ts:526](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L526)
 
 ___
 
@@ -317,7 +318,7 @@ Is use CoreML models on iOS
 
 #### Defined in
 
-[index.ts:519](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L519)
+[index.ts:523](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L523)
 
 ___
 
@@ -329,7 +330,7 @@ Current version of whisper.cpp
 
 #### Defined in
 
-[index.ts:514](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L514)
+[index.ts:518](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L518)
 
 ## Functions
 
@@ -349,7 +350,7 @@ Current version of whisper.cpp
 
 #### Defined in
 
-[index.ts:450](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L450)
+[index.ts:452](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L452)
 
 ___
 
@@ -363,4 +364,4 @@ ___
 
 #### Defined in
 
-[index.ts:509](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L509)
+[index.ts:513](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L513)
diff --git a/docs/API/classes/WhisperContext.md b/docs/API/classes/WhisperContext.md
@@ -32,7 +32,7 @@
 
 #### Defined in
 
-[index.ts:186](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L186)
+[index.ts:186](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L186)
 
 ## Properties
 
@@ -42,7 +42,7 @@
 
 #### Defined in
 
-[index.ts:184](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L184)
+[index.ts:184](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L184)
 
 ## Methods
 
@@ -56,7 +56,7 @@
 
 #### Defined in
 
-[index.ts:423](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L423)
+[index.ts:423](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L423)
 
 ___
 
@@ -84,7 +84,7 @@ Transcribe audio file
 
 #### Defined in
 
-[index.ts:191](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L191)
+[index.ts:191](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L191)
 
 ___
 
@@ -106,4 +106,4 @@ Transcribe the microphone audio stream, the microphone user permission is requir
 
 #### Defined in
 
-[index.ts:287](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/index.ts#L287)
+[index.ts:287](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/index.ts#L287)
diff --git a/docs/API/enums/AudioSessionCategoryIos.md b/docs/API/enums/AudioSessionCategoryIos.md
@@ -25,7 +25,7 @@ https://developer.apple.com/documentation/avfaudio/avaudiosessioncategory?langua
 
 #### Defined in
 
-[AudioSessionIos.ts:8](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L8)
+[AudioSessionIos.ts:8](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L8)
 
 ___
 
@@ -35,7 +35,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:13](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L13)
+[AudioSessionIos.ts:13](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L13)
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:12](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L12)
+[AudioSessionIos.ts:12](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L12)
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:10](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L10)
+[AudioSessionIos.ts:10](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L10)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:11](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L11)
+[AudioSessionIos.ts:11](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L11)
 
 ___
 
@@ -75,4 +75,4 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:9](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L9)
+[AudioSessionIos.ts:9](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L9)
diff --git a/docs/API/enums/AudioSessionCategoryOptionIos.md b/docs/API/enums/AudioSessionCategoryOptionIos.md
@@ -26,7 +26,7 @@ https://developer.apple.com/documentation/avfaudio/avaudiosessioncategoryoptions
 
 #### Defined in
 
-[AudioSessionIos.ts:25](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L25)
+[AudioSessionIos.ts:25](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L25)
 
 ___
 
@@ -36,7 +36,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:23](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L23)
+[AudioSessionIos.ts:23](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L23)
 
 ___
 
@@ -46,7 +46,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:24](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L24)
+[AudioSessionIos.ts:24](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L24)
 
 ___
 
@@ -56,7 +56,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:26](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L26)
+[AudioSessionIos.ts:26](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L26)
 
 ___
 
@@ -66,7 +66,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:21](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L21)
+[AudioSessionIos.ts:21](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L21)
 
 ___
 
@@ -76,7 +76,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:22](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L22)
+[AudioSessionIos.ts:22](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L22)
 
 ___
 
@@ -86,4 +86,4 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:20](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L20)
+[AudioSessionIos.ts:20](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L20)
diff --git a/docs/API/enums/AudioSessionModeIos.md b/docs/API/enums/AudioSessionModeIos.md
@@ -27,7 +27,7 @@ https://developer.apple.com/documentation/avfaudio/avaudiosessionmode?language=o
 
 #### Defined in
 
-[AudioSessionIos.ts:33](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L33)
+[AudioSessionIos.ts:33](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L33)
 
 ___
 
@@ -37,7 +37,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:36](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L36)
+[AudioSessionIos.ts:36](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L36)
 
 ___
 
@@ -47,7 +47,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:38](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L38)
+[AudioSessionIos.ts:38](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L38)
 
 ___
 
@@ -57,7 +57,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:39](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L39)
+[AudioSessionIos.ts:39](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L39)
 
 ___
 
@@ -67,7 +67,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:40](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L40)
+[AudioSessionIos.ts:40](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L40)
 
 ___
 
@@ -77,7 +77,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:35](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L35)
+[AudioSessionIos.ts:35](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L35)
 
 ___
 
@@ -87,7 +87,7 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:37](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L37)
+[AudioSessionIos.ts:37](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L37)
 
 ___
 
@@ -97,4 +97,4 @@ ___
 
 #### Defined in
 
-[AudioSessionIos.ts:34](https://github.com/mybigday/whisper.rn/blob/ca8e344/src/AudioSessionIos.ts#L34)
+[AudioSessionIos.ts:34](https://github.com/mybigday/whisper.rn/blob/66e9a0c/src/AudioSessionIos.ts#L34)