-
Notifications
You must be signed in to change notification settings - Fork 256
/
index.html
executable file
·517 lines (451 loc) · 21.9 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="A couple of Web Components that can do amazing stuff using the Web Speech API.">
<!-- Facebook Metatags -->
<meta property="fb:app_id" content="1502439096643233">
<meta property="og:title" content="<voice-elements>">
<meta property="og:description" content="A couple of Web Components that can do amazing stuff using the Web Speech API.">
<meta property="og:url" content="http:https://zenorocha.github.io/voice-elements/">
<meta property="og:image" content="http:https://zenorocha.github.io/voice-elements/demo/fb.jpg">
<title><voice-elements></title>
<!-- Demo CSS -->
<link rel="icon" href="https://github.global.ssl.fastly.net/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="http:https://yui.yahooapis.com/pure/0.4.2/pure.css">
<link rel="stylesheet" href="http:https://fonts.googleapis.com/css?family=Roboto+Slab">
<link rel="stylesheet" href="demo/demo.css">
<!-- Importing Web Component's Polyfill -->
<script src="bower_components/webcomponentsjs/webcomponents-lite.min.js"></script>
<!-- Importing Custom Elements -->
<link rel="import" href="src/voice-player.html">
<link rel="import" href="src/voice-recognition.html">
</head>
<body>
<!-- Support Warning -->
<div class="brower-support">
<p>Sorry, your browser <a href="http:https://caniuse.com/#feat=web-speech">does not support</a> the Web Speech API :(</p>
</div>
<!-- Splash Screen -->
<div class="splash-container">
<div class="splash">
<h1 class="splash-head">
<div class="splash-first-line"><<span class="highlight">voice</span></div>
<div class="splash-second-line"><span class="highlight">elements</span>></div>
</h1>
<p class="splash-subhead">
A couple of Web Components that can do<br>amazing stuff using the Web Speech API
</p>
<p class="gh-btns pure-hidden-phone">
<iframe src="http:https://ghbtns.com/github-btn.html?user=zenorocha&repo=voice-elements&type=watch&count=true&size=large"
allowtransparency="true" frameborder="0" scrolling="0" width="152" height="30"></iframe>
<iframe src="http:https://ghbtns.com/github-btn.html?user=zenorocha&repo=voice-elements&type=fork&count=true&size=large"
allowtransparency="true" frameborder="0" scrolling="0" width="156" height="30"></iframe>
</p>
</div>
</div>
<!-- Content Wrapper -->
<div class="content-wrapper">
<!-- Install -->
<div class="content">
<h2 class="content-head is-center">Install</h2>
<div class="section pure-g-r">
<div class="center">
<div class="pure-u-1">
<h3 class="content-subhead">Install the component using Bower</h3>
<pre>$ bower install voice-elements</pre>
<a class="pure-button" href="https://github.com/zenorocha/voice-elements/fork">Fork on GitHub</a>
<a class="pure-button" href="https://github.com/zenorocha/voice-elements/archive/gh-pages.zip">Download as ZIP</a>
</div>
</div>
</div>
</div>
<!-- Voice Player -->
<div class="ribbon l-box-lrg pure-g">
<div class="center section pure-u-1 pure-u-med-1-2 pure-u-lrg-3-5">
<h2 class="content-head content-head-ribbon"><voice-player></h2>
<p>Provides you a simple DOM API to do speech synthesis (text to speech).</p>
<!-- Demo #1 -->
<p>In the following demo, we set some content into the <strong>text</strong> attribute. Then, by using the <strong>autoplay</strong> attribute, the voice is played when the element loads.</p>
<voice-player autoplay text="Welcome to the jungle! hahaha just kidding! Welcome to the Voice Elements demonstration page"></voice-player>
<div class="example">
<p>Reload the page to hear it again.</p>
</div>
<pre><code><voice-player autoplay text="Welcome to the jungle! hahaha just kidding!"></voice-player></code></pre>
<!-- Demo #2 -->
<p>In the following demo, we define a different language by using the <strong>accent</strong> attribute. When the button is clicked, we call the <strong>speak</strong> method to trigger the audio.</p>
<voice-player id="mi-elemento" accent="es-ES" text="Me gusta la gasolina (Dame más gasolina!)"></voice-player>
<script>
window.addEventListener('WebComponentsReady', function(e) {
var form = document.querySelector('#mi-form'),
element = document.querySelector('#mi-elemento');
form.addEventListener('submit', function(e) {
e.preventDefault();
element.speak();
});
});
</script>
<div class="example">
<form id="mi-form" class="pure-form">
<fieldset>
<button class="pure-button pure-button-primary">¡Habla</button>
</fieldset>
</form>
</div>
<pre><code><voice-player id="mi-elemento" accent="es-ES" text="Me gusta la gasolina"></voice-player>
<script>
var form = document.querySelector('#mi-form'),
element = document.querySelector('#mi-elemento');
form.addEventListener('submit', function(e) {
e.preventDefault();
element.speak();
});
</script></code></pre>
<!-- Demo #3 -->
<p>In the following demo, the <strong>text</strong> attribute is set according to the input value. When the form is submitted, we call the <strong>speak</strong> method to trigger the audio.</p>
<voice-player id="player-element" text=""></voice-player>
<script>
window.addEventListener('WebComponentsReady', function(e) {
var form = document.querySelector('#player-form'),
input = document.querySelector('#player-input'),
element = document.querySelector('#player-element');
element.setAttribute('text', input.value);
input.addEventListener('input', function(e) {
element.setAttribute('text', input.value);
});
form.addEventListener('submit', function(e) {
e.preventDefault();
element.speak();
});
});
</script>
<div class="example">
<form id="player-form" class="pure-form">
<fieldset>
<input id="player-input" type="text" value="You have reached your destination">
<button id="player-submit" class="pure-button pure-button-primary">Speak!</button>
</fieldset>
</form>
</div>
<pre><code><voice-player id="player-element" text=""></voice-player>
<script>
var form = document.querySelector('#player-form'),
input = document.querySelector('#player-input'),
element = document.querySelector('#player-element');
input.addEventListener('input', function(e) {
element.setAttribute('text', input.value);
});
form.addEventListener('submit', function(e) {
e.preventDefault();
element.speak();
});
</script>
</code></pre>
<!-- Options -->
<h2 class="content-head content-head-ribbon">Options</h2>
<table class="pure-table pure-table-striped">
<thead>
<tr>
<th>Attribute</th>
<th>Options</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>autoplay</td>
<td>boolean</td>
<td>false</td>
<td>Specifies if the audio should play when page loads.</td>
</tr>
<tr>
<td>accent</td>
<td>en-US, en-GB, es-ES, fr-FR, it-IT, de-DE, ja-JP, ko-KR, zh-CN</td>
<td>en-US</td>
<td>Specifies the language to be synthesized and spoken.</td>
</tr>
<tr>
<td>text</td>
<td>string</td>
<td>You are awesome</td>
<td>Specifies the text to be synthesized and spoken.</td>
</tr>
</tbody>
</table>
<!-- Methods -->
<h2 class="content-head content-head-ribbon">Methods</h2>
<table class="pure-table pure-table-striped">
<thead>
<tr>
<th>Method</th>
<th>Parameters</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>speak()</td>
<td>None</td>
<td>Nothing</td>
<td>Triggers the voice audio to be played.</td>
</tr>
<tr>
<td>cancel()</td>
<td>None</td>
<td>Nothing</td>
<td>Triggers the voice audio to be canceled.</td>
</tr>
<tr>
<td>pause()</td>
<td>None</td>
<td>Nothing</td>
<td>Triggers the voice audio to be paused.</td>
</tr>
<tr>
<td>resume()</td>
<td>None</td>
<td>Nothing</td>
<td>Triggers the voice audio to be resumed.</td>
</tr>
</tbody>
</table>
<!-- Events -->
<h2 class="content-head content-head-ribbon">Events</h2>
<table class="pure-table pure-table-striped">
<thead>
<tr>
<th>Event</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>onstart</td>
<td>Triggers when the voice begun to be spoken.</td>
</tr>
<tr>
<td>onend</td>
<td>Triggers when the voice completed to be spoken.</td>
</tr>
<tr>
<td>onerror</td>
<td>Triggers when the voice player detects an error.</td>
</tr>
<tr>
<td>onpause</td>
<td>Triggers when the voice player is resumed.</td>
</tr>
<tr>
<td>onresume</td>
<td>Triggers when the voice player is resumed.</td>
</tr>
</tbody>
</table>
</div>
</div>
<!-- Features -->
<div class="features content">
<h2 class="content-head is-center">Features</h2>
<div class="center section pure-g-r">
<div class="l-box pure-u-1-2">
<h3 class="content-subhead">
Voice recognition (speech to text)
</h3>
<p>
Voice recognition is the translation of spoken words into text. This is achieved in the browser by using the <a href="https://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html#speechreco-section">SpeechRecognition interface</a> from the Web Speech API.
</p>
</div>
<div class="l-box pure-u-1-2">
<h3 class="content-subhead">
Speech synthesis (text to speech)
</h3>
<p>
Speech synthesis is the conversion of language text into speech. This is achieved in the browser by using then <a href="https://dvcs.w3.org/hg/speech-api/raw-file/tip/speechapi.html#tts-section">SpeechSynthesis interface</a> from the Web Speech API.
</p>
</div>
</div>
</div>
<!-- Voice Recognition -->
<div class="ribbon l-box-lrg pure-g">
<div class="section pure-u-1 pure-u-med-1-2 pure-u-lrg-3-5 center">
<h2 class="content-head content-head-ribbon"><voice-recognition></h2>
<p>Provides you a simple DOM API to do voice recognition (speech to text).</p>
<!-- Demo #1 -->
<p>In the following demo, we trigger the voice recognition by using the <strong>start</strong> method when the user submits the form. Then, we add a listener to the <strong>result</strong> event to fetch the recognized content and put it into the textarea.</p>
<voice-recognition id="recognition-element"></voice-recognition>
<script>
window.addEventListener('WebComponentsReady', function(e) {
var form = document.querySelector('#recognition-form'),
input = document.querySelector('#recognition-input'),
element = document.querySelector('#recognition-element');
form.addEventListener('submit', function(e) {
e.preventDefault();
element.start();
});
element.addEventListener('result', function(e) {
input.textContent = e.detail.result;
});
});
</script>
<div class="example">
<p>Click "start", authorize, and say something...</p>
<form id="recognition-form" class="pure-form">
<fieldset>
<textarea id="recognition-input" readonly></textarea>
</fieldset>
<fieldset>
<button id="recognition-submit" class="pure-button pure-button-primary">Start!</button>
</fieldset>
</form>
</div>
<pre><code><voice-recognition id="recognition-element"></voice-recognition>
<script>
var form = document.querySelector('#recognition-form'),
input = document.querySelector('#recognition-input'),
element = document.querySelector('#recognition-element');
form.addEventListener('submit', function(e) {
e.preventDefault();
element.start();
});
element.addEventListener('result', function(e) {
input.textContent = e.detail.result;
});
</script>
</code></pre>
<!-- Options -->
<h2 class="content-head content-head-ribbon">Options</h2>
<table class="pure-table pure-table-striped">
<thead>
<tr>
<th>Attribute</th>
<th>Options</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>continuous</td>
<td>boolean</td>
<td>true</td>
<td>Specifies if the recognition should continue when the user pauses while speaking.</td>
</tr>
<tr>
<td>accent</td>
<td>en-US, en-GB, es-ES, fr-FR, it-IT, de-DE, ja-JP, ko-KR, zh-CN</td>
<td>en-US</td>
<td>Specifies the language to be synthesized.</td>
</tr>
<tr>
<td>text</td>
<td>string</td>
<td></td>
<td>Returns the recognized text.</td>
</tr>
</tbody>
</table>
<!-- Methods -->
<h2 class="content-head content-head-ribbon">Methods</h2>
<table class="pure-table pure-table-striped">
<thead>
<tr>
<th>Method</th>
<th>Parameters</th>
<th>Returns</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>start()</td>
<td>None</td>
<td>Nothing</td>
<td>Starts the voice recognition.</td>
</tr>
<tr>
<td>stop()</td>
<td>None</td>
<td>Nothing</td>
<td>Requests to recognition service to stop listening to more audio.</td>
</tr>
<tr>
<td>abort()</td>
<td>None</td>
<td>Nothing</td>
<td>Requests to immediately stop listening and stop recognizing.</td>
</tr>
</tbody>
</table>
<!-- Events -->
<h2 class="content-head content-head-ribbon">Events</h2>
<table class="pure-table pure-table-striped">
<thead>
<tr>
<th>Event</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>onstart</td>
<td>Triggers when the recognition begins.</td>
</tr>
<tr>
<td>onerror</td>
<td>Triggers when there's a recognition error.</td>
</tr>
<tr>
<td>onend</td>
<td>Triggers when the recognition ends.</td>
</tr>
<tr>
<td>onresult</td>
<td>Triggers when there's a recognition result.</td>
</tr>
</tbody>
</table>
</div>
</div>
<!-- Usage -->
<div class="content">
<h2 class="content-head is-center">Usage</h2>
<div class="section pure-g-r center">
<div class="pure-u-1">
<h3 class="content-subhead">1. Import Web Components' polyfill</h3>
<pre><code><script src="bower_components/webcomponentsjs/webcomponents-lite.min.js"></script></code></pre>
<h3 class="content-subhead">2. Import Custom Element</h3>
<pre><code><link rel="import" href="bower_components/voice-elements/dist/voice-player.html">
<link rel="import" href="bower_components/voice-elements/dist/voice-recognition.html"></code></pre>
<h3 class="content-subhead">3. Start using it!</h3>
<pre><code><voice-player></voice-player>
<voice-recognition></voice-recognition></code></pre>
</div>
</div>
</div>
<!-- Footer -->
<div class="footer l-box is-center">
<p>
Made with <span class="love">♥</span> by <a href="http:https://zenorocha.com/">Zeno Rocha</a> under <a href="http:https://zenorocha.mit-license.org/">MIT license</a>
</p>
</div>
</div>
<!-- Demo Scripts -->
<script src="demo/support.js"></script>
<!-- Syntax Highlight -->
<link href="demo/highlight.github.css" rel="stylesheet">
<script src="demo/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-4114546-42', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>