Requires: module:jquery
See: https://github.com/wendelin/jquery.speak/blob/master/LICENSE
Author: Wendelin Thomas wendelin.thomas@gmail.com
Copyright: Copyright 2016 Wendelin Thomas. All rights reserved
Licensed under the MIT License.
- jquery.speak
- ~DEFAULTS :
Object - ~getVoices(o) ⇒
Array - ~getVoice([o]) ⇒
SpeechSynthesisVoice|Null - ~paused()
- ~resume()
- ~cancel()
- ~speaking()
- ~DEFAULTS :
Kind: inner constant of jquery.speak
Kind: inner method of jquery.speak
| Param | Type | Description |
|---|---|---|
| o | Object | String |
Filter options |
Kind: inner method of jquery.speak
| Param | Type | Description |
|---|---|---|
| [o] | Object | String |
Filter options |
Kind: inner method of jquery.speak
Kind: inner method of jquery.speak
Kind: inner method of jquery.speak
Kind: inner method of jquery.speak
Kind: global function
| Param | Type | Default | Description |
|---|---|---|---|
| text | String |
Text to be spoken by the browser | |
| [o] | Object |
Optional parameters | |
| [o.voice.name] | Object |
Name of the voice to be used (e.g. "Bruce") | |
| [o.voice.lang] | String |
en |
Language of the voice |
| [o.pitch] | Number |
1 |
Speaking pitch |
| [o.rate] | Number |
1 |
Speaking rate/speed |
| [o.volume] | Number |
1 |
Speaking volume |
| [o.lang] | String |
en |
Shorthand for o.voice.lang. |
| [interrupt] | Boolean |
true |
Interrupt if something is already being said. |
Example
$.speak("I'm sorry Dave, I'm afraid I can't do that", "en");Example
$.speak("I'm sorry Dave, I'm afraid I can't do that", {voice:{name:"Hysterical", lang:"en"}, pitch:0.6,rate:1.5});