Skip to content

Commit efc65a3

Browse files
committed
chore: add missing doc as requested
chore: add missing doc as requested
1 parent 294c738 commit efc65a3

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,33 @@ resumePlayer(): Promise<boolean>
191191

192192
It returns a boolean indicating whether playback is resumed again.
193193

194+
#### stopAllPlayers()
195+
196+
```ts
197+
stopAllPlayers(): Promise<boolean>
198+
```
199+
200+
Stops all the players at once and frees their native resources. Useful on unmount!
201+
It returns a boolean indicating that all players were stopped.
202+
203+
#### stopAllWaveFormExtractors()
204+
205+
```ts
206+
stopAllWaveFormExtractors(): Promise<boolean>
207+
```
208+
209+
Stops all the extractors used to build the audio waveform and frees its native resource. Useful on unmount!
210+
It returns a boolean indicating that all extractors were stopped.
211+
212+
#### stopPlayersAndExtractors()
213+
214+
```ts
215+
stopPlayersAndExtractors(): Promise<[boolean, boolean]>
216+
```
217+
218+
Combined the `stopAllWaveFormExtractors` and `stopAllPlayers` in one call to free up the maximum possible resources. Very useful on unmount!
219+
It returns an array of two booleans indicating if all players and all waveform extractors were stopped.
220+
194221
#### For Live mode
195222

196223
#### startRecord()

0 commit comments

Comments
 (0)