# polly-ru-ssml

> 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.

Latest version **0.1.5** (published 2018-04-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install polly-ru-ssml
pnpm add polly-ru-ssml
yarn add polly-ru-ssml
bun add polly-ru-ssml
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2018-04-23 |
| First published | 2018-04-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.2.4 |
| Dependencies | 0 |
| Unpacked size | 19 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Oleg Legun |
| Maintainers | oleglegun |
| Keywords | aws, amazon, alexa, polly, ssml, tts, russian tts |

## Links

- npm: https://www.npmjs.com/package/polly-ru-ssml
- Repository: https://github.com/oleglegun/polly-ru-ssml
- Homepage: https://github.com/oleglegun/polly-ru-ssml#readme
- Issues: https://github.com/oleglegun/polly-ru-ssml/issues
- npm.io page: https://npm.io/package/polly-ru-ssml

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.5 (latest) — 2018-04-23
- 0.1.4 — 2018-04-03
- 0.1.3 — 2018-04-03
- 0.1.2 — 2018-04-03
- 0.1.1 — 2018-04-03
- 0.1.0 — 2018-04-03

## README

# Polly Russian SSML Enhancer

[![Build Status](https://travis-ci.org/oleglegun/polly-ru-ssml.svg?branch=master)](https://travis-ci.org/oleglegun/polly-ru-ssml)
[![Coverage Status](https://coveralls.io/repos/github/oleglegun/polly-ru-ssml/badge.svg?branch=master)](https://coveralls.io/github/oleglegun/polly-ru-ssml?branch=master)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

## Synopsis

Convert russian text, that contains english words into a valid SSML for [AWS Polly TTS](https://aws.amazon.com/ru/polly/), thus enhancing synthesized audio pronunciation for english words within the russian language context.

## Motivation

By default, russian speakers in [AWS Polly TTS](https://aws.amazon.com/ru/polly/) service (Maxim, Tatiana) are not particularly good at pronouncing english words within the russian language context, so this library fixes it by explicitly wrapping each english word with `<lang xml:lang="en-US">word</lang>` tags.

## Installation

`npm install polly-ru-ssml`

## Code Example

### Basic usage

```js
const pollyRuSSML = require('polly-ru-ssml')

// Method ssml() returns string with wrapped english words
pollyRuSSML.ssml("русский english")
// русский <lang xml:lang="en-US">english</lang>

// Method speak() additionally wraps result with <speak/> tags
pollyRuSSML.speak("русский english")
// <speak>русский <lang xml:lang="en-US">english</lang></speak>
```

### Configuration

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.

```js
const pollyRuSSML = require('polly-ru-ssml')

// 1. Global configuration for all further usages
pollyRuSSML.configure({
    country: 'uk',
    globalVolume: 'loud',
    volume: 'x-loud',
    rate: 'slow',
})

pollyRuSSML.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 the current usage (overrides global configuration)
pollyRuSSML.speak('русский english', {
    globalVolume: 'x-loud',
    rate: 'x-slow',
})
/**
 * <speak>
 *  <prosody volume="x-loud">
 *      русский
 *      <lang xml:lang="en-US">
 *          <prosody rate="x-slow">
 *              english
 *          </prosody>
 *      </lang>
 *  </prosody>
 * </speak>
 */
```

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| [country] | <code>string</code> | <code>&quot;us&quot;</code> | Country code for `<lang/>` tags. Valid values: `us`, `uk`. |
| [rate] | <code>string</code> |  | Speech rate for latin characters. Valid values: `x-slow`, `slow`, `medium`, `fast`, `x-fast`. |
| [globalVolume] | <code>string</code> |  | Global audio volume. Valid values: `x-soft`, `soft`, `medium`, `loud`, `x-loud`. |
| [volume] | <code>string</code> |  | Local audio volume for latin characters. Valid values: `x-soft`, `soft`, `medium`, `loud`, `x-loud`. |

[API documentation](./API.md)


## Tests

`npm test`

## Contributors

Any contributions are very welcome.

## License

MIT.

## Changelog

### [0.1.5] - 2018-04-23
- Hide private methods from user API.

### [0.1.4] - 2018-04-03
- Add more tests.

### [0.1.3] - 2018-04-03
- Add API reference.

### [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.

---
_Source: https://npm.io/package/polly-ru-ssml · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._