Skip to content

Commit

Permalink
fix(docs): exculde private + docgen
Browse files Browse the repository at this point in the history
  • Loading branch information
@jhen0409
jhen0409 committed Nov 11, 2024
1 parent 9a3a410 commit 92b9a25
Show file tree
Hide file tree
Showing 6 changed files with 82 additions and 52 deletions.
38 changes: 19 additions & 19 deletions docs/API/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ whisper.rn

#### Defined in

[index.ts:76](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L76)
[index.ts:76](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L76)

___

Expand All @@ -80,7 +80,7 @@ ___

#### Defined in

[index.ts:177](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L177)
[index.ts:177](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L177)

___

Expand All @@ -103,7 +103,7 @@ ___

#### Defined in

[index.ts:456](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L456)
[index.ts:476](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L476)

___

Expand All @@ -113,7 +113,7 @@ ___

#### Defined in

[index.ts:59](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L59)
[index.ts:59](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L59)

___

Expand All @@ -131,7 +131,7 @@ ___

#### Defined in

[index.ts:52](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L52)
[index.ts:52](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L52)

___

Expand All @@ -150,7 +150,7 @@ ___

#### Defined in

[index.ts:45](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L45)
[index.ts:45](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L45)

___

Expand Down Expand Up @@ -180,7 +180,7 @@ ___

#### Defined in

[NativeRNWhisper.ts:5](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/NativeRNWhisper.ts#L5)
[NativeRNWhisper.ts:5](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/NativeRNWhisper.ts#L5)

___

Expand All @@ -198,7 +198,7 @@ ___

#### Defined in

[index.ts:70](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L70)
[index.ts:70](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L70)

___

Expand All @@ -223,7 +223,7 @@ ___

#### Defined in

[index.ts:138](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L138)
[index.ts:138](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L138)

___

Expand All @@ -241,7 +241,7 @@ ___

#### Defined in

[index.ts:171](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L171)
[index.ts:171](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L171)

___

Expand All @@ -265,7 +265,7 @@ ___

#### Defined in

[index.ts:158](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L158)
[index.ts:158](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L158)

___

Expand All @@ -275,7 +275,7 @@ ___

#### Defined in

[index.ts:84](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L84)
[index.ts:84](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L84)

___

Expand All @@ -293,7 +293,7 @@ ___

#### Defined in

[NativeRNWhisper.ts:37](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/NativeRNWhisper.ts#L37)
[NativeRNWhisper.ts:37](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/NativeRNWhisper.ts#L37)

## Variables

Expand All @@ -318,7 +318,7 @@ AudioSession Utility, iOS only.

#### Defined in

[AudioSessionIos.ts:50](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/AudioSessionIos.ts#L50)
[AudioSessionIos.ts:50](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/AudioSessionIos.ts#L50)

___

Expand All @@ -330,7 +330,7 @@ Is allow fallback to CPU if load CoreML model failed

#### Defined in

[index.ts:562](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L562)
[index.ts:582](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L582)

___

Expand All @@ -342,7 +342,7 @@ Is use CoreML models on iOS

#### Defined in

[index.ts:559](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L559)
[index.ts:579](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L579)

___

Expand All @@ -354,7 +354,7 @@ Current version of whisper.cpp

#### Defined in

[index.ts:554](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L554)
[index.ts:574](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L574)

## Functions

Expand All @@ -374,7 +374,7 @@ Current version of whisper.cpp

#### Defined in

[index.ts:484](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L484)
[index.ts:504](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L504)

___

Expand All @@ -388,4 +388,4 @@ ___

#### Defined in

[index.ts:549](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L549)
[index.ts:569](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L569)
52 changes: 41 additions & 11 deletions docs/API/classes/WhisperContext.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- [bench](WhisperContext.md#bench)
- [release](WhisperContext.md#release)
- [transcribe](WhisperContext.md#transcribe)
- [transcribeData](WhisperContext.md#transcribedata)
- [transcribeRealtime](WhisperContext.md#transcriberealtime)

## Constructors
Expand All @@ -35,7 +36,7 @@

#### Defined in

[index.ts:204](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L204)
[index.ts:204](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L204)

## Properties

Expand All @@ -45,7 +46,7 @@

#### Defined in

[index.ts:200](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L200)
[index.ts:200](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L200)

___

Expand All @@ -55,7 +56,7 @@ ___

#### Defined in

[index.ts:198](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L198)
[index.ts:198](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L198)

___

Expand All @@ -65,7 +66,7 @@ ___

#### Defined in

[index.ts:202](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L202)
[index.ts:202](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L202)

## Methods

Expand All @@ -85,7 +86,7 @@ ___

#### Defined in

[index.ts:445](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L445)
[index.ts:465](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L465)

___

Expand All @@ -99,21 +100,22 @@ ___

#### Defined in

[index.ts:451](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L451)
[index.ts:471](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L471)

___

### transcribe

▸ **transcribe**(`filePath`, `options?`): `Object`
▸ **transcribe**(`filePathOrBase64`, `options?`): `Object`

Transcribe audio file
Transcribe audio file (path or base64 encoded wav file)
base64: need add `data:audio/wav;base64,` prefix

#### Parameters

| Name | Type |
| :------ | :------ |
| `filePath` | `string` \| `number` |
| `filePathOrBase64` | `string` \| `number` |
| `options` | [`TranscribeFileOptions`](../README.md#transcribefileoptions) |

#### Returns
Expand All @@ -127,7 +129,35 @@ Transcribe audio file

#### Defined in

[index.ts:215](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L215)
[index.ts:292](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L292)

___

### transcribeData

▸ **transcribeData**(`data`, `options?`): `Object`

Transcribe audio data (base64 encoded float32 PCM data)

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | `string` |
| `options` | [`TranscribeFileOptions`](../README.md#transcribefileoptions) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `promise` | `Promise`<[`TranscribeResult`](../README.md#transcriberesult)\> |
| `stop` | () => `Promise`<`void`\> |

#### Defined in

[index.ts:323](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L323)

___

Expand All @@ -149,4 +179,4 @@ Transcribe the microphone audio stream, the microphone user permission is requir

#### Defined in

[index.ts:311](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/index.ts#L311)
[index.ts:331](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/index.ts#L331)
12 changes: 6 additions & 6 deletions docs/API/enums/AudioSessionCategoryIos.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ https://developer.apple.com/documentation/avfaudio/avaudiosessioncategory?langua

#### Defined in

[AudioSessionIos.ts:8](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/AudioSessionIos.ts#L8)
[AudioSessionIos.ts:8](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/AudioSessionIos.ts#L8)

___

Expand All @@ -35,7 +35,7 @@ ___

#### Defined in

[AudioSessionIos.ts:13](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/AudioSessionIos.ts#L13)
[AudioSessionIos.ts:13](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/AudioSessionIos.ts#L13)

___

Expand All @@ -45,7 +45,7 @@ ___

#### Defined in

[AudioSessionIos.ts:12](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/AudioSessionIos.ts#L12)
[AudioSessionIos.ts:12](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/AudioSessionIos.ts#L12)

___

Expand All @@ -55,7 +55,7 @@ ___

#### Defined in

[AudioSessionIos.ts:10](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/AudioSessionIos.ts#L10)
[AudioSessionIos.ts:10](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/AudioSessionIos.ts#L10)

___

Expand All @@ -65,7 +65,7 @@ ___

#### Defined in

[AudioSessionIos.ts:11](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/AudioSessionIos.ts#L11)
[AudioSessionIos.ts:11](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/AudioSessionIos.ts#L11)

___

Expand All @@ -75,4 +75,4 @@ ___

#### Defined in

[AudioSessionIos.ts:9](https://github.com/mybigday/whisper.rn/blob/5effdc8/src/AudioSessionIos.ts#L9)
[AudioSessionIos.ts:9](https://github.com/mybigday/whisper.rn/blob/9a3a410/src/AudioSessionIos.ts#L9)
Loading

0 comments on commit 92b9a25

Please sign in to comment.