Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vilicvane/cordova-plugin-tts
Cordova Text-to-Speech Plugin (Maintainer WANTED!)
https://github.com/vilicvane/cordova-plugin-tts
Last synced: 20 days ago
JSON representation
Cordova Text-to-Speech Plugin (Maintainer WANTED!)
- Host: GitHub
- URL: https://github.com/vilicvane/cordova-plugin-tts
- Owner: vilicvane
- Created: 2014-12-29T16:03:07.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2020-06-10T10:50:52.000Z (over 4 years ago)
- Last Synced: 2024-11-28T22:17:38.923Z (25 days ago)
- Language: Java
- Homepage:
- Size: 38.1 KB
- Stars: 177
- Watchers: 19
- Forks: 137
- Open Issues: 86
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cordova Text-to-Speech Plugin
## Platforms
iOS 7+
Windows Phone 8
Android 4.0.3+ (API Level 15+)
## Installation
```sh
cordova plugin add cordova-plugin-tts
```
## Usage
```javascript
// make sure your the code gets executed only after `deviceready`.
document.addEventListener('deviceready', function () {
// basic usage
TTS
.speak('hello, world!').then(function () {
alert('success');
}, function (reason) {
alert(reason);
});
// or with more options
TTS
.speak({
text: 'hello, world!',
locale: 'en-GB',
rate: 0.75
}).then(function () {
alert('success');
}, function (reason) {
alert(reason);
});
}, false);
```
**Tips:** `speak` an empty string to interrupt.
```typescript
declare namespace TTS {
interface IOptions {
/** text to speak */
text: string;
/** a string like 'en-US', 'zh-CN', etc */
locale?: string;
/** speed rate, 0 ~ 1 */
rate?: number;
/** ambient(iOS) */
category?: string;
}
function speak(options: IOptions): Promise;
function speak(text: string): Promise;
function stop(): Promise;
function checkLanguage(): Promise;
function openInstallTts(): Promise;
}
```