polly-ru-ssml
Advanced tools
Comparing version 0.1.1 to 0.1.2
{ | ||
"name": "polly-ru-ssml", | ||
"version": "0.1.1", | ||
"version": "0.1.2", | ||
"description": | ||
@@ -5,0 +5,0 @@ "Convert russian text, that contains english words into a valid SSML for AWS Polly TTS, thus enhancing synthesized audio pronunciation for english words within the russian language context.", |
@@ -25,8 +25,10 @@ # Polly Russian SSML Enhancer | ||
By default configuration is not necessary, but setting one can greatly improve intelligibility of speech for russian users. Additionally, I found that the default volume for synthesized speech is quite low for using with Amazon Alexa assistant. | ||
By default configuration is not necessary, but setting one can greatly improve intelligibility of english speech for russian users. Additionally, I found that the default volume for synthesized speech is quite low for using with Amazon Alexa assistant. | ||
``` | ||
[Here](#api-reference) you can find API documentation. | ||
```js | ||
const ruSSML = require('polly-ru-ssml') | ||
// Global configuration for all further usages | ||
// 1. Global configuration for all further usages | ||
ruSSML.configure({ | ||
@@ -39,3 +41,19 @@ country: 'uk', | ||
// Local configuration only for current usage (overrides global configuration) | ||
ruSSML.speak('русский english') | ||
/** | ||
* <speak> | ||
* <prosody volume="loud"> | ||
* русский | ||
* <lang xml:lang="en-UK"> | ||
* <prosody volume="x-loud"> | ||
* <prosody rate="slow"> | ||
* english | ||
* </prosody> | ||
* </prosody> | ||
* </lang> | ||
* </prosody> | ||
* </speak> | ||
*/ | ||
// 2. Local configuration only for current usage (overrides global configuration) | ||
ruSSML.speak('русский english', { | ||
@@ -45,5 +63,14 @@ globalVolume: 'x-loud', | ||
}) | ||
// <speak> | ||
/** | ||
* <speak> | ||
* <prosody volume="x-loud"> | ||
* русский | ||
* <lang xml:lang="en-US"> | ||
* <prosody rate="x-slow"> | ||
* english | ||
* </prosody> | ||
* </lang> | ||
* </prosody> | ||
* </speak> | ||
*/ | ||
``` | ||
@@ -61,3 +88,3 @@ | ||
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live. | ||
In progress... | ||
@@ -76,2 +103,12 @@ ## Tests | ||
## Change History | ||
## Change History | ||
### [0.1.2] - 2018-04-03 | ||
- Add Readme. | ||
### [0.1.1] - 2018-04-03 | ||
- Add default configuration option `country` if it is absent in local configuration. | ||
### [0.1.0] - 2018-04-03 | ||
- Initial release. | ||
13362
110