Skip to content

Commit 57f8209

Browse files
committed
docs(README): update the modern concurrency section
1 parent 89e957b commit 57f8209

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ This package contains some very straightforward wrappers around TTS part of AVFo
88

99
## Modern concurrency usage
1010

11-
* `func speak(string: String)`: call this method when you simply want to use the TTS with a simple String
12-
* subscribe to `isSpeakingPublisher` to know when the utterance starts to be heard, and when it's stopped
13-
* subscribe to `speakingProgressPublisher` to know the progress, from 0 to 1
14-
* `var rateRatio: Float`: set the rate to slow down or accelerate the TTS engine
15-
* `var voice: AVSpeechSynthesisVoice?`: set the voice of the TTS engine, by default, it's the voice for `en-GB`
11+
* `speak(String) -> Void` - call this method when you simply want to use the TTS with a simple String
12+
* `isSpeaking() -> AsyncStream<Bool>` - to know when the utterance starts to be heard, and when it's stopped
13+
* `speakingProgress() -> AsyncStream<Double>` - to know the progress, from 0 to 1
14+
* `rateRatio() -> Float` - set the rate to slow down or accelerate the TTS engine
15+
* `setRateRatio(Float) -> Void` - set the rate to slow down or accelerate the TTS engine
16+
* `voice() -> AVSpeechSynthesisVoice?` - the voice of the TTS engine, by default, it's the voice for `en-GB`
17+
* `setVoice(AVSpeechSynthesisVoice) -> Void` - set the voice of the TTS engine
1618

1719
### Example
1820

0 commit comments

Comments
 (0)