-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(plugin): Text to Speech Advanced (#3627)
* Text to speech advanced plugin * Add @interface * docs update * jsdoc fix * jsdoc fix
- Loading branch information
Showing
1 changed file
with
89 additions
and
0 deletions.
There are no files selected for viewing
89 changes: 89 additions & 0 deletions
89
src/@ionic-native/plugins/text-to-speech-advanced/index.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
import { Injectable } from '@angular/core'; | ||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; | ||
|
||
export interface TTSOptions { | ||
/** text to speak */ | ||
text: string; | ||
/** cancel, boolean: true/false */ | ||
identifier: string; | ||
/** voice identifier (iOS / Android) from getVoices */ | ||
locale?: string; | ||
/** speed rate, 0 ~ 1 */ | ||
rate?: number; | ||
/** pitch, 0 ~ 1 */ | ||
pitch?: number; | ||
/** cancel, boolean: true/false */ | ||
cancel?: boolean; | ||
} | ||
|
||
export interface TTSVoice { | ||
/** Voice name */ | ||
name: string; | ||
/** Voice language */ | ||
language: string; | ||
/** Voice identifier string */ | ||
identifier: string; | ||
} | ||
|
||
/** | ||
* @name Text To Speech Advanced | ||
* @description | ||
* Text to Speech plugin | ||
* | ||
* @usage | ||
* ```typescript | ||
* import { TextToSpeechAdvanced } from '@ionic-native/text-to-speech-advanced/ngx'; | ||
* | ||
* constructor(private tts: TextToSpeechAdvanced) { } | ||
* | ||
* ... | ||
* | ||
* this.tts.speak('Hello World') | ||
* .then(() => console.log('Success')) | ||
* .catch((reason: any) => console.log(reason)); | ||
* | ||
* ``` | ||
* @interfaces | ||
* TTSOptions | ||
* TTSVoice | ||
*/ | ||
@Plugin({ | ||
pluginName: 'Text To Speech Advanced', | ||
plugin: 'cordova-plugin-tts-advanced', | ||
pluginRef: 'TTS', | ||
repo: 'https://github.com/spasma/cordova-plugin-tts-advanced', | ||
platforms: ['Android', 'iOS'], | ||
}) | ||
@Injectable() | ||
export class TextToSpeechAdvanced extends IonicNativePlugin { | ||
/** | ||
* This function speaks | ||
* @param textOrOptions {string | TTSOptions} Text to speak or TTSOptions | ||
* @return {Promise<any>} Returns a promise that resolves when the speaking finishes | ||
*/ | ||
@Cordova({ | ||
successIndex: 1, | ||
errorIndex: 2, | ||
}) | ||
speak(textOrOptions: string | TTSOptions): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* Stop any current TTS playback | ||
* @return {Promise<any>} | ||
*/ | ||
@Cordova() | ||
stop(): Promise<any> { | ||
return; | ||
} | ||
|
||
/** | ||
* Get all voices | ||
* @return {Promise<TTSVoice[]>} | ||
*/ | ||
@Cordova() | ||
getVoices(): Promise<TTSVoice[]> { | ||
return; | ||
} | ||
} |