Skip to content

Commit 4f540ed

Browse files
committed
docs: update documentation
1 parent 0b9daf5 commit 4f540ed

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

README.md

+27-7
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ will not report an error.
5656
## Usage
5757

5858
```
59-
usage: aspeak [-h] [-V | -L | -Q | [-t [TEXT] | -s [SSML]]] [-p PITCH] [-r RATE] [-S STYLE] [-f FILE] [-e ENCODING] [-o OUTPUT_PATH] [--mp3 | --ogg | --webm | --wav | -F FORMAT]
60-
[-l LOCALE] [-v VOICE] [-q QUALITY]
59+
usage: aspeak [-h] [-V | -L | -Q | [-t [TEXT] | -s [SSML]]] [-p PITCH] [-r RATE] [-S STYLE] [-R ROLE] [-d STYLE_DEGREE] [-f FILE] [-e ENCODING] [-o OUTPUT_PATH]
60+
[--mp3 | --ogg | --webm | --wav | -F FORMAT] [-l LOCALE] [-v VOICE] [-q QUALITY]
6161
6262
This program uses trial auth token of Azure Cognitive Services to do speech synthesis for you
6363
@@ -92,9 +92,13 @@ options:
9292
Options for --text:
9393
-p PITCH, --pitch PITCH
9494
Set pitch, default to 0
95-
-r RATE, --rate RATE Set speech rate, default to 0.04
95+
-r RATE, --rate RATE Set speech rate, default to 0
9696
-S STYLE, --style STYLE
9797
Set speech style, default to "general"
98+
-R ROLE, --role ROLE Set speech role. This only works for some Chinese voices! Available values are Girl, Boy, YoungAdultFemale, YoungAdultMale, OlderAdultFemale, OlderAdultMale,
99+
SeniorFemale, SeniorMale.
100+
-d STYLE_DEGREE, --style-degree STYLE_DEGREE
101+
Set speech style degree, range: [0.01, 2]. This only works for some Chinese voices!
98102
```
99103

100104
- If you don't specify `-o`, we will use your default speaker.
@@ -108,9 +112,8 @@ Options for --text:
108112
- The default value is 0.
109113
- Rate is also a float value.
110114
- It is usually between -1 and 2.
111-
- The default value is 0.04.
112-
- This value is different from the speaking speed field on the trial page.
113-
- The value 0.04 is the normal speech rate, corresponding to default speaking speed on the trial page.
115+
- The default value is 0.
116+
- Note that this value is different from the speaking speed field on the trial page.
114117

115118
### Examples
116119

@@ -308,7 +311,7 @@ $ aspeak -t "你好,世界!" -v zh-CN-YunjianNeural
308311
$ aspeak -t "你好,世界!" -v zh-CN-XiaoxiaoNeural -p 1.5 -r 0.5 -S sad
309312
```
310313

311-
### Examples for Advanced Users
314+
### Advanced Usage
312315

313316
#### Use a custom audio format for output
314317

@@ -318,6 +321,23 @@ $ aspeak -t "你好,世界!" -v zh-CN-XiaoxiaoNeural -p 1.5 -r 0.5 -S sad
318321
$ aspeak -t "Hello World" -F Riff48Khz16BitMonoPcm -o high-quality.wav
319322
```
320323

324+
#### Custom style degree and role
325+
326+
According to the
327+
[Azure documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-synthesis-markup?tabs=csharp#adjust-speaking-styles)
328+
, style degree specifies the intensity of the speaking style.
329+
It is a floating point number between 0.01 and 2, inclusive.
330+
331+
At the time of writing, style degree adjustments are supported for Chinese (Mandarin, Simplified) neural voices.
332+
333+
According to the
334+
[Azure documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-synthesis-markup?tabs=csharp#adjust-speaking-styles)
335+
, `role` specifies the speaking role-play. The voice acts as a different age and gender, but the voice name isn't
336+
changed.
337+
338+
At the time of writing, role adjustments are supported for these Chinese (Mandarin, Simplified) neural voices:
339+
`zh-CN-XiaomoNeural`, `zh-CN-XiaoxuanNeural`, `zh-CN-YunxiNeural`, and `zh-CN-YunyeNeural`.
340+
321341
## About This Application
322342

323343
- I found Azure TTS can synthesize nearly authentic human voice, which is very interesting :laughing:.

0 commit comments

Comments
 (0)