## polly-ru-ssml Polly SSML generator for russian texts, that contain latin characters. **Example** ```js const pollyRuSSML = require('polly-ru-ssml') ``` * [polly-ru-ssml](#module_polly-ru-ssml) * [~PollyRuSSML](#module_polly-ru-ssml..PollyRuSSML) * [.ssml(text, [options])](#module_polly-ru-ssml..PollyRuSSML+ssml) ⇒ string * [.speak(text, [options])](#module_polly-ru-ssml..PollyRuSSML+speak) ⇒ string * [.configure(options)](#module_polly-ru-ssml..PollyRuSSML+configure) * [~ConfigurationOptions](#module_polly-ru-ssml..ConfigurationOptions) : Object ### polly-ru-ssml~PollyRuSSML PollyRuSSML **Kind**: inner class of [polly-ru-ssml](#module_polly-ru-ssml) * [~PollyRuSSML](#module_polly-ru-ssml..PollyRuSSML) * [.ssml(text, [options])](#module_polly-ru-ssml..PollyRuSSML+ssml) ⇒ string * [.speak(text, [options])](#module_polly-ru-ssml..PollyRuSSML+speak) ⇒ string * [.configure(options)](#module_polly-ru-ssml..PollyRuSSML+configure) #### pollyRuSSML.ssml(text, [options]) ⇒ string Wrap all english words with `` SSML tags. **Kind**: instance method of [PollyRuSSML](#module_polly-ru-ssml..PollyRuSSML) **Returns**: string - SSML text with wrapped latin characters. | Param | Type | Description | | --- | --- | --- | | text | string | String input for converting to SSML. | | [options] | ConfigurationOptions | Local configuration options. | **Example** ```js const pollyRuSSML = require('polly-ru-ssml') pollyRuSSML.ssml("текс text") ``` #### pollyRuSSML.speak(text, [options]) ⇒ string Wrap all english words with `` SSML tags and enclose the result with `` tags. **Kind**: instance method of [PollyRuSSML](#module_polly-ru-ssml..PollyRuSSML) **Returns**: string - Processed text ready for Polly TTS. | Param | Type | Description | | --- | --- | --- | | text | string | String input for converting to SSML. | | [options] | ConfigurationOptions | Local configuration options. | **Example** ```js const pollyRuSSML = require('polly-ru-ssml') pollyRuSSML.speak("текс text") ``` #### pollyRuSSML.configure(options) Set the global configuration options. **Kind**: instance method of [PollyRuSSML](#module_polly-ru-ssml..PollyRuSSML) | Param | Type | Description | | --- | --- | --- | | options | ConfigurationOptions | Object with configuration options. | **Example** ```js const pollyRuSSML = require('polly-ru-ssml') pollyRuSSML.configure({country: "uk", volume: "loud"}) ``` ### polly-ru-ssml~ConfigurationOptions : Object Configuration options. **Kind**: inner typedef of [polly-ru-ssml](#module_polly-ru-ssml) **Properties** | Name | Type | Default | Description | | --- | --- | --- | --- | | [country] | string | "us" | Country code for `` tags. Valid values: `us`, `uk`. | | [rate] | string | | Speech rate for latin characters. Valid values: `x-slow`, `slow`, `medium`, `fast`, `x-fast`. | | [globalVolume] | string | | Global audio volume. Valid values: `x-soft`, `soft`, `medium`, `loud`, `x-loud`. | | [volume] | string | | Local audio volume for latin characters. Valid values: `x-soft`, `soft`, `medium`, `loud`, `x-loud`. |