Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Eliastik committed Dec 31, 2024
1 parent 46ca2cd commit 1d88c53
Show file tree
Hide file tree
Showing 32 changed files with 532 additions and 425 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Once the server is running, open example/index.html in your browser to see the m

Please note that there are other more advanced examples:

- [example/custom-filters.js]: explain how to create a custom audio filter
- [example/custom-filter.js](example/custom-filter.js): explain how to create a custom audio filter

### Compile the project

Expand Down Expand Up @@ -176,7 +176,7 @@ Une fois le serveur lancé, ouvrez example/index.html dans votre navigateur pour

Il y a également d'autres exemples avancés :

- [example/custom-filters.js](example/custom-filters.js): montre comment créer un filtre audio personnalisé
- [example/custom-filter.js](example/custom-filter.js): montre comment créer un filtre audio personnalisé

#### Compiler le projet

Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Once the server is running, open example/index.html in your browser to see the m

Please note that there are other more advanced examples:

- [example/custom-filters.js]: explain how to create a custom audio filter
- [example/custom-filter.js](_media/custom-filter.js): explain how to create a custom audio filter

### Compile the project

Expand Down Expand Up @@ -179,7 +179,7 @@ Une fois le serveur lancé, ouvrez example/index.html dans votre navigateur pour

Il y a également d'autres exemples avancés :

- [example/custom-filters.js]: montre comment créer un filtre audio personnalisé
- [example/custom-filter.js](_media/custom-filter.js): montre comment créer un filtre audio personnalisé

#### Compiler le projet

Expand Down
96 changes: 48 additions & 48 deletions docs/_media/AudioEditor.md

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/_media/SoundStudioFactory.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Class: SoundStudioFactory

Defined in: [utils/SoundStudioFactory.ts:10](https://github.com/Eliastik/simple-sound-studio-lib/blob/8690802f01b749e56e5136b5a5dc05dee7f77984/lib/utils/SoundStudioFactory.ts#L10)
Defined in: [utils/SoundStudioFactory.ts:10](https://github.com/Eliastik/simple-sound-studio-lib/blob/e2381543acd624d47bf0e56bee059ac07e0632f6/lib/utils/SoundStudioFactory.ts#L10)

## Constructors

Expand All @@ -24,7 +24,7 @@ Defined in: [utils/SoundStudioFactory.ts:10](https://github.com/Eliastik/simple-

> `static` **createAudioEditor**(`configService`?, `buffersToFetch`?): `AudioEditorInterface`
Defined in: [utils/SoundStudioFactory.ts:14](https://github.com/Eliastik/simple-sound-studio-lib/blob/8690802f01b749e56e5136b5a5dc05dee7f77984/lib/utils/SoundStudioFactory.ts#L14)
Defined in: [utils/SoundStudioFactory.ts:14](https://github.com/Eliastik/simple-sound-studio-lib/blob/e2381543acd624d47bf0e56bee059ac07e0632f6/lib/utils/SoundStudioFactory.ts#L14)

#### Parameters

Expand All @@ -46,7 +46,7 @@ Defined in: [utils/SoundStudioFactory.ts:14](https://github.com/Eliastik/simple-

> `static` **createVoiceRecorder**(): `VoiceRecorderInterface`
Defined in: [utils/SoundStudioFactory.ts:30](https://github.com/Eliastik/simple-sound-studio-lib/blob/8690802f01b749e56e5136b5a5dc05dee7f77984/lib/utils/SoundStudioFactory.ts#L30)
Defined in: [utils/SoundStudioFactory.ts:30](https://github.com/Eliastik/simple-sound-studio-lib/blob/e2381543acd624d47bf0e56bee059ac07e0632f6/lib/utils/SoundStudioFactory.ts#L30)

#### Returns

Expand All @@ -58,7 +58,7 @@ Defined in: [utils/SoundStudioFactory.ts:30](https://github.com/Eliastik/simple-

> `static` **getAudioEditorInstance**(): `null` \| `AudioEditorInterface`
Defined in: [utils/SoundStudioFactory.ts:34](https://github.com/Eliastik/simple-sound-studio-lib/blob/8690802f01b749e56e5136b5a5dc05dee7f77984/lib/utils/SoundStudioFactory.ts#L34)
Defined in: [utils/SoundStudioFactory.ts:34](https://github.com/Eliastik/simple-sound-studio-lib/blob/e2381543acd624d47bf0e56bee059ac07e0632f6/lib/utils/SoundStudioFactory.ts#L34)

#### Returns

Expand All @@ -70,7 +70,7 @@ Defined in: [utils/SoundStudioFactory.ts:34](https://github.com/Eliastik/simple-

> `static` **getAudioPlayerInstance**(): `null` \| `BufferPlayerInterface`
Defined in: [utils/SoundStudioFactory.ts:38](https://github.com/Eliastik/simple-sound-studio-lib/blob/8690802f01b749e56e5136b5a5dc05dee7f77984/lib/utils/SoundStudioFactory.ts#L38)
Defined in: [utils/SoundStudioFactory.ts:38](https://github.com/Eliastik/simple-sound-studio-lib/blob/e2381543acd624d47bf0e56bee059ac07e0632f6/lib/utils/SoundStudioFactory.ts#L38)

#### Returns

Expand All @@ -82,7 +82,7 @@ Defined in: [utils/SoundStudioFactory.ts:38](https://github.com/Eliastik/simple-

> `static` **getAudioRecorderInstance**(): `null` \| `VoiceRecorderInterface`
Defined in: [utils/SoundStudioFactory.ts:42](https://github.com/Eliastik/simple-sound-studio-lib/blob/8690802f01b749e56e5136b5a5dc05dee7f77984/lib/utils/SoundStudioFactory.ts#L42)
Defined in: [utils/SoundStudioFactory.ts:42](https://github.com/Eliastik/simple-sound-studio-lib/blob/e2381543acd624d47bf0e56bee059ac07e0632f6/lib/utils/SoundStudioFactory.ts#L42)

#### Returns

Expand All @@ -94,7 +94,7 @@ Defined in: [utils/SoundStudioFactory.ts:42](https://github.com/Eliastik/simple-

> `static` **getConfigServiceInstance**(): `undefined` \| [`ConfigService`](../interfaces/ConfigService.md)
Defined in: [utils/SoundStudioFactory.ts:50](https://github.com/Eliastik/simple-sound-studio-lib/blob/8690802f01b749e56e5136b5a5dc05dee7f77984/lib/utils/SoundStudioFactory.ts#L50)
Defined in: [utils/SoundStudioFactory.ts:50](https://github.com/Eliastik/simple-sound-studio-lib/blob/e2381543acd624d47bf0e56bee059ac07e0632f6/lib/utils/SoundStudioFactory.ts#L50)

#### Returns

Expand All @@ -106,7 +106,7 @@ Defined in: [utils/SoundStudioFactory.ts:50](https://github.com/Eliastik/simple-

> `static` **getEventEmitterInstance**(): `null` \| `EventEmitterInterface`
Defined in: [utils/SoundStudioFactory.ts:46](https://github.com/Eliastik/simple-sound-studio-lib/blob/8690802f01b749e56e5136b5a5dc05dee7f77984/lib/utils/SoundStudioFactory.ts#L46)
Defined in: [utils/SoundStudioFactory.ts:46](https://github.com/Eliastik/simple-sound-studio-lib/blob/e2381543acd624d47bf0e56bee059ac07e0632f6/lib/utils/SoundStudioFactory.ts#L46)

#### Returns

Expand Down
Loading

0 comments on commit 1d88c53

Please sign in to comment.