Skip to content

Commit 1e93591

Browse files
committed
docs: update
1 parent 9d46027 commit 1e93591

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# :speaking_head: aspeak
2+
23
[![GitHub stars](https://img.shields.io/github/stars/kxxt/aspeak)](https://github.com/kxxt/aspeak/stargazers)
34
[![GitHub issues](https://img.shields.io/github/issues/kxxt/aspeak)](https://github.com/kxxt/aspeak/issues)
45
[![GitHub forks](https://img.shields.io/github/forks/kxxt/aspeak)](https://github.com/kxxt/aspeak/network)
@@ -28,7 +29,7 @@ $ pip install aspeak
2829
## Usage
2930

3031
```
31-
usage: aspeak [-h] [-V | [-t [TEXT] | -s [SSML]]] [-f FILE] [-o OUTPUT_PATH] [-l LOCALE] [-v VOICE]
32+
usage: aspeak [-h] [-V | [-t [TEXT] | -s [SSML]]] [-p PITCH] [-r RATE] [-f FILE] [-o OUTPUT_PATH] [-l LOCALE] [-v VOICE]
3233
3334
This program uses trial auth token of Azure Cognitive Services to do speech synthesis for you.
3435
@@ -46,10 +47,16 @@ options:
4647
Locale to use, default to en-US
4748
-v VOICE, --voice VOICE
4849
Voice to use.
50+
51+
Text options:
52+
-p PITCH, --pitch PITCH
53+
Set pitch, default to 0
54+
-r RATE, --rate RATE Set speech rate, default to 0.04
4955
```
5056

5157
- If you don't specify `-o`, we will use your default speaker.
5258
- If you don't specify `-t` or `-s`, we will assume `-t` is provided.
59+
- You must specify voice if you want to use `-p` or `-r` option.
5360

5461
### Examples
5562

@@ -101,11 +108,18 @@ $ aspeak -t "你好,世界!" -l zh-CN
101108
$ aspeak -t "你好,世界!" -v zh-CN-YunjianNeural
102109
```
103110

111+
#### Custom pitch and rate
112+
113+
```sh
114+
$ aspeak -t "你好,世界!" -v zh-CN-XiaoxiaoNeural -p 1.5 -r 0.5
115+
```
116+
104117
## About This Application
105118

106119
- I found Azure TTS can synthesize nearly authentic human voice, which is very interesting :laughing:.
107120
- I wrote this program to learn Azure Cognitive Services.
108121
- And I use this program daily, because `espeak` and `festival` outputs terrible :fearful: audio.
109-
- But I respect :raised_hands: their maintainers' work, both are good open source software and they can be used off-line.
122+
- But I respect :raised_hands: their maintainers' work, both are good open source software and they can be used
123+
off-line.
110124
- I hope you like it :heart:.
111125

0 commit comments

Comments
 (0)