maidr 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (206) hide show
  1. package/.Rbuildignore +1 -0
  2. package/.eslintignore +3 -0
  3. package/.eslintrc.json +6 -0
  4. package/.github/workflows/build.yml +20 -0
  5. package/.prettierignore +3 -0
  6. package/.prettierrc.json +7 -0
  7. package/.vscode/extensions.json +25 -0
  8. package/.vscode/settings.json +30 -0
  9. package/.vscode/tasks.json +57 -0
  10. package/CHANGELOG.md +7 -0
  11. package/CITATION.cff +21 -0
  12. package/CONTRIBUTING.md +87 -0
  13. package/LICENSE.md +595 -0
  14. package/README.md +341 -0
  15. package/dist/maidr.js +8851 -0
  16. package/dist/maidr.min.js +1 -0
  17. package/dist/styles.css +244 -0
  18. package/dist/styles.min.css +1 -0
  19. package/docs/Audio.html +1398 -0
  20. package/docs/Constants.html +256 -0
  21. package/docs/Description.html +582 -0
  22. package/docs/Helper.html +364 -0
  23. package/docs/LogError.html +905 -0
  24. package/docs/Menu.html +665 -0
  25. package/docs/Position.html +174 -0
  26. package/docs/Resources.html +338 -0
  27. package/docs/Review.html +333 -0
  28. package/docs/Tracker.html +965 -0
  29. package/docs/audio.js.html +635 -0
  30. package/docs/constants.js.html +1242 -0
  31. package/docs/display.js.html +1184 -0
  32. package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
  33. package/docs/fonts/OpenSans-Bold-webfont.svg +1830 -0
  34. package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
  35. package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  36. package/docs/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  37. package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  38. package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
  39. package/docs/fonts/OpenSans-Italic-webfont.svg +1830 -0
  40. package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
  41. package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
  42. package/docs/fonts/OpenSans-Light-webfont.svg +1831 -0
  43. package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
  44. package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  45. package/docs/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  46. package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  47. package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
  48. package/docs/fonts/OpenSans-Regular-webfont.svg +1831 -0
  49. package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
  50. package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
  51. package/docs/fonts/OpenSans-Semibold-webfont.svg +1830 -0
  52. package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
  53. package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
  54. package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
  55. package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +1830 -0
  56. package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
  57. package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
  58. package/docs/index.html +66 -0
  59. package/docs/scripts/linenumber.js +25 -0
  60. package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
  61. package/docs/scripts/prettify/lang-css.js +2 -0
  62. package/docs/scripts/prettify/prettify.js +28 -0
  63. package/docs/styles/jsdoc-default.css +692 -0
  64. package/docs/styles/prettify-jsdoc.css +111 -0
  65. package/docs/styles/prettify-tomorrow.css +132 -0
  66. package/examples/dev_charts/barplot.html +1056 -0
  67. package/examples/dev_charts/boxplot.html +1856 -0
  68. package/examples/dev_charts/boxplot_flipped.svg +727 -0
  69. package/examples/dev_charts/heatmap.html +1217 -0
  70. package/examples/dev_charts/scatterplot/displ.js +18 -0
  71. package/examples/dev_charts/scatterplot/histogram_for_residual.svg +595 -0
  72. package/examples/dev_charts/scatterplot/hwy.js +15 -0
  73. package/examples/dev_charts/scatterplot/layers/point_layer.json +938 -0
  74. package/examples/dev_charts/scatterplot/layers/smooth_layer.json +322 -0
  75. package/examples/dev_charts/scatterplot/point_layer.js +938 -0
  76. package/examples/dev_charts/scatterplot/prediction_array.js +31 -0
  77. package/examples/dev_charts/scatterplot/prediction_array.json +31 -0
  78. package/examples/dev_charts/scatterplot/residual_array.js +29 -0
  79. package/examples/dev_charts/scatterplot/residual_array.json +29 -0
  80. package/examples/dev_charts/scatterplot/scatterplot.svg +1428 -0
  81. package/examples/dev_charts/scatterplot/scatterplot_data.html +2838 -0
  82. package/examples/dev_charts/scatterplot/scatterplot_no_jitter_point_only.svg +1393 -0
  83. package/examples/dev_charts/scatterplot/scatterplot_no_jitter_with_bestfit.svg +1424 -0
  84. package/examples/dev_charts/scatterplot/scatterplot_no_jitter_with_loess_curve.svg +1402 -0
  85. package/examples/dev_charts/scatterplot/smooth_layer.js +322 -0
  86. package/examples/dev_charts/scatterplot.html +4560 -0
  87. package/examples/dodged_bar/dodged_bar.png +0 -0
  88. package/examples/dodged_bar/dodged_bar.svg +198 -0
  89. package/examples/dodged_bar/schema.json +41 -0
  90. package/examples/histogram/histogram_tutorial.svg +482 -0
  91. package/examples/histogram/histogram_tutorial_raw_data.json +362 -0
  92. package/examples/histogram/histogram_user_study.svg +578 -0
  93. package/examples/histogram/histogram_user_study_raw_data.json +362 -0
  94. package/examples/lineplot/lineplot_sample.svg +126 -0
  95. package/examples/lineplot/lineplot_sample_raw_data.json +1 -0
  96. package/examples/lineplot/point+lineplot_sample.svg +700 -0
  97. package/examples/other/audio_oscillator_boxplot.js +95 -0
  98. package/examples/other/barplot_labels.svg +314 -0
  99. package/examples/other/barplot_user_study.svg +313 -0
  100. package/examples/other/boxplot.html +927 -0
  101. package/examples/other/boxplot_data_frame.html +568 -0
  102. package/examples/other/boxplot_label.svg +751 -0
  103. package/examples/other/braille-display_boxplot.js +79 -0
  104. package/examples/other/control_boxplot.js +55 -0
  105. package/examples/other/draft.js +56 -0
  106. package/examples/other/getData.html +400 -0
  107. package/examples/other/getData.js +41 -0
  108. package/examples/other/ggplot_to_svg.R +371 -0
  109. package/examples/other/heatmap.svg +582 -0
  110. package/examples/other/heatmap_label.svg +608 -0
  111. package/examples/other/multiple_barplot.html +2250 -0
  112. package/examples/other/new_scatterplot_user_study_point_layer.json +122 -0
  113. package/examples/other/py_binder_output.html +1167 -0
  114. package/examples/other/scatterplot_label.svg +1429 -0
  115. package/examples/other/seaborn_plot.py +9 -0
  116. package/examples/other/svglite_bar.svg +136 -0
  117. package/examples/other/tutorial_boxplot.svg +727 -0
  118. package/examples/other/tutorial_boxplot_data.json +72 -0
  119. package/examples/other/user_study_boxplot.svg +676 -0
  120. package/examples/stacked_bar/schema.json +41 -0
  121. package/examples/stacked_bar/stack_bar.png +0 -0
  122. package/examples/stacked_bar/stacked_bar.svg +180 -0
  123. package/examples/stacked_normalized_bar/stacked_normalized_bar.png +0 -0
  124. package/examples/stacked_normalized_bar/stacked_normalized_bar.svg +189 -0
  125. package/examples/static/barplot.svg +263 -0
  126. package/examples/static/barplot_diamonds_gridSVG.svg +254 -0
  127. package/examples/static/boxplot.svg +424 -0
  128. package/examples/static/heatmap.svg +373 -0
  129. package/examples/static/heatmap_penguins_table.html +486 -0
  130. package/examples/static/scatterplot.svg +530 -0
  131. package/examples/svglite/task_heatmap.html +802 -0
  132. package/examples/svglite/task_heatmap.svg +111 -0
  133. package/examples/svglite/tutorial_bar.svg +136 -0
  134. package/examples/svglite/tutorial_bar_plot.html +504 -0
  135. package/examples/svglite/tutorial_boxplot.html +1850 -0
  136. package/examples/svglite/tutorial_boxplot.svg +727 -0
  137. package/examples/svglite/tutorial_scatterplot.html +3135 -0
  138. package/examples/svglite/tutorial_scatterplot.svg +311 -0
  139. package/gulpfile.js +49 -0
  140. package/index.html +40 -0
  141. package/jsconfig.json +10 -0
  142. package/jsdoc.json +19 -0
  143. package/package.json +47 -0
  144. package/src/css/styles.css +241 -0
  145. package/src/js/__tests__/audio.test.js +49 -0
  146. package/src/js/__tests__/constants.test.js +622 -0
  147. package/src/js/audio.js +575 -0
  148. package/src/js/barplot.js +254 -0
  149. package/src/js/boxplot.js +682 -0
  150. package/src/js/constants.js +1182 -0
  151. package/src/js/controls.js +3182 -0
  152. package/src/js/display.js +1124 -0
  153. package/src/js/heatmap.js +411 -0
  154. package/src/js/histogram.js +134 -0
  155. package/src/js/init.js +427 -0
  156. package/src/js/lineplot.js +219 -0
  157. package/src/js/scatterplot.js +619 -0
  158. package/src/js/segmented.js +268 -0
  159. package/user_study_pilot/binder_test.html +526 -0
  160. package/user_study_pilot/data/barplot_user_study.svg +492 -0
  161. package/user_study_pilot/data/barplot_user_study_raw_data.json +22 -0
  162. package/user_study_pilot/data/boxplot_tutorial.json +72 -0
  163. package/user_study_pilot/data/boxplot_tutorial_horizontal.svg +727 -0
  164. package/user_study_pilot/data/boxplot_user_study.json +52 -0
  165. package/user_study_pilot/data/boxplot_user_study_vertical.svg +675 -0
  166. package/user_study_pilot/data/boxplot_user_study_vertical_horizontal.svg +676 -0
  167. package/user_study_pilot/data/heatmap_user_study.svg +719 -0
  168. package/user_study_pilot/data/heatmap_user_study_raw_data.json +127 -0
  169. package/user_study_pilot/data/new_barplot_user_study.svg +269 -0
  170. package/user_study_pilot/data/new_heatmap_user_study.svg +367 -0
  171. package/user_study_pilot/data/new_scatterplot_user_study.svg +603 -0
  172. package/user_study_pilot/data/new_scatterplot_user_study_point_layer.json +122 -0
  173. package/user_study_pilot/data/scatterplot_user_study (1).svg +321 -0
  174. package/user_study_pilot/data/scatterplot_user_study.svg +603 -0
  175. package/user_study_pilot/data/scatterplot_user_study_point_layer.json +122 -0
  176. package/user_study_pilot/data/scatterplot_user_study_smooth_layer.json +322 -0
  177. package/user_study_pilot/intro.html +215 -0
  178. package/user_study_pilot/jaws_settings/Chrome.JDF +10 -0
  179. package/user_study_pilot/jaws_settings/Firefox.JDF +10 -0
  180. package/user_study_pilot/jaws_settings/backup_utf8/Chrome.JDF +10 -0
  181. package/user_study_pilot/jaws_settings/backup_utf8/Firefox.JDF +10 -0
  182. package/user_study_pilot/jaws_settings/backup_utf8/msedge.JDF +10 -0
  183. package/user_study_pilot/jaws_settings/msedge.JDF +10 -0
  184. package/user_study_pilot/nvda_settings/chrome.dic +10 -0
  185. package/user_study_pilot/nvda_settings/default.dic +10 -0
  186. package/user_study_pilot/nvda_settings/firefox.dic +10 -0
  187. package/user_study_pilot/nvda_settings/msedge.dic +10 -0
  188. package/user_study_pilot/scatterplot.html +4560 -0
  189. package/user_study_pilot/seaborn_test.html +1059 -0
  190. package/user_study_pilot/svglite_test.html +534 -0
  191. package/user_study_pilot/task1_bar_plot.html +1111 -0
  192. package/user_study_pilot/task2_heatmap.html +1661 -0
  193. package/user_study_pilot/task3_boxplot_horizontal.html +1690 -0
  194. package/user_study_pilot/task3_boxplot_vertical.html +1689 -0
  195. package/user_study_pilot/task4_scatterplot.html +2091 -0
  196. package/user_study_pilot/tutorial1_bar_plot.html +1159 -0
  197. package/user_study_pilot/tutorial2_heatmap.html +1276 -0
  198. package/user_study_pilot/tutorial3_boxplot_horizontal.html +1861 -0
  199. package/user_study_pilot/tutorial3_boxplot_vertical.html +1807 -0
  200. package/user_study_pilot/tutorial4_scatterplot.html +5893 -0
  201. package/user_study_pilot/tutorial5_histogram.html +1553 -0
  202. package/user_study_pilot/tutorial6_lineplot.html +1011 -0
  203. package/user_study_pilot/tutorial7_stacked.html +763 -0
  204. package/user_study_pilot/tutorial8_stacked_normalized.html +796 -0
  205. package/user_study_pilot/tutorial9_dodged_bar.html +831 -0
  206. package/user_study_pilot/voiceover_settings/user_study_VoiceOver Archive.voprefs +573 -0
@@ -0,0 +1,1398 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <title>Audio - Documentation</title>
7
+
8
+ <script src="scripts/prettify/prettify.js"></script>
9
+ <script src="scripts/prettify/lang-css.js"></script>
10
+ <!--[if lt IE 9]>
11
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12
+ <![endif]-->
13
+ <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16
+ </head>
17
+ <body>
18
+
19
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
20
+ <label for="nav-trigger" class="navicon-button x">
21
+ <div class="navicon"></div>
22
+ </label>
23
+
24
+ <label for="nav-trigger" class="overlay"></label>
25
+
26
+ <nav>
27
+ <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Audio.html">Audio</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Audio.html#KillSmooth">KillSmooth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Audio.html#PlayNull">PlayNull</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Audio.html#SlideBetween">SlideBetween</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Audio.html#compressorSetup">compressorSetup</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Audio.html#playOscillator">playOscillator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Audio.html#playSmooth">playSmooth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Audio.html#playTone">playTone</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Constants.html">Constants</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Description.html">Description</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Description.html#CreateComponent">CreateComponent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Description.html#Destroy">Destroy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Description.html#PopulateData">PopulateData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Description.html#Toggle">Toggle</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Helper.html">Helper</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Helper.html#.containsObject">containsObject</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="LogError.html">LogError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="LogError.html#LogAbsentElement">LogAbsentElement</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="LogError.html#LogCriticalElement">LogCriticalElement</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="LogError.html#LogDifferentLengths">LogDifferentLengths</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="LogError.html#LogNotArray">LogNotArray</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="LogError.html#LogTooManyElements">LogTooManyElements</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Menu.html">Menu</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Menu.html#CreateMenu">CreateMenu</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Menu.html#LoadDataFromLocalStorage">LoadDataFromLocalStorage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Menu.html#PopulateData">PopulateData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Menu.html#SaveData">SaveData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Menu.html#Toggle">Toggle</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Position.html">Position</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Resources.html">Resources</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Resources.html#GetString">GetString</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Review.html">Review</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Review.html#ToggleReviewMode">ToggleReviewMode</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Tracker.html">Tracker</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Tracker.html#DataSetup">DataSetup</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Tracker.html#Delete">Delete</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Tracker.html#DownloadTrackerData">DownloadTrackerData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Tracker.html#GetTrackerData">GetTrackerData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Tracker.html#LogEvent">LogEvent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Tracker.html#SaveTrackerData">SaveTrackerData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Tracker.html#isUndefinedOrNull">isUndefinedOrNull</a></span></li>
28
+ </nav>
29
+
30
+ <div id="main">
31
+
32
+ <h1 class="page-title">Audio</h1>
33
+
34
+
35
+
36
+
37
+
38
+
39
+
40
+ <section>
41
+
42
+ <header>
43
+
44
+ <h2>
45
+ Audio
46
+ </h2>
47
+
48
+ <div class="class-description">Audio class
49
+
50
+
51
+ </header>
52
+
53
+ <article>
54
+ <div class="container-overview">
55
+
56
+
57
+ <div class="section-method">
58
+
59
+
60
+ <h2>Constructor</h2>
61
+
62
+
63
+ <h4 class="name" id="Audio"><span class="type-signature"></span>new Audio<span class="signature">()</span><span class="type-signature"></span></h4>
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+ <dl class="details">
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
+ <dt class="tag-source">Source:</dt>
101
+ <dd class="tag-source"><ul class="dummy"><li>
102
+ <a href="audio.js.html">audio.js</a>, <a href="audio.js.html#line9">line 9</a>
103
+ </li></ul></dd>
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+ </dl>
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ </div>
136
+
137
+ </div>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <h3 class="subsection-title">Methods</h3>
153
+
154
+
155
+
156
+ <div class="section-method">
157
+
158
+
159
+
160
+ <h4 class="name" id="KillSmooth"><span class="type-signature"></span>KillSmooth<span class="signature">()</span><span class="type-signature"> &rarr; {void}</span></h4>
161
+
162
+
163
+
164
+
165
+
166
+ <div class="description">
167
+ Stops the smooth gain and cancels any scheduled values.
168
+ </div>
169
+
170
+
171
+
172
+
173
+
174
+ <dl class="details">
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
+ <dt class="tag-source">Source:</dt>
202
+ <dd class="tag-source"><ul class="dummy"><li>
203
+ <a href="audio.js.html">audio.js</a>, <a href="audio.js.html#line544">line 544</a>
204
+ </li></ul></dd>
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ </dl>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <div class="section-returns">
235
+ <h5>Returns:</h5>
236
+
237
+
238
+
239
+ <dl class="param-type">
240
+ <dt>
241
+ Type:
242
+ </dt>
243
+ <dd>
244
+
245
+ <span class="param-type"><code>void</code></span>
246
+
247
+
248
+ </dd>
249
+ </dl>
250
+
251
+
252
+
253
+ </div>
254
+
255
+
256
+
257
+ </div>
258
+
259
+
260
+ <div class="section-method">
261
+
262
+
263
+
264
+ <h4 class="name" id="PlayNull"><span class="type-signature"></span>PlayNull<span class="signature">()</span><span class="type-signature"></span></h4>
265
+
266
+
267
+
268
+
269
+
270
+ <div class="description">
271
+ Plays a null frequency sound.
272
+ </div>
273
+
274
+
275
+
276
+
277
+
278
+ <dl class="details">
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
+ <dt class="tag-source">Source:</dt>
306
+ <dd class="tag-source"><ul class="dummy"><li>
307
+ <a href="audio.js.html">audio.js</a>, <a href="audio.js.html#line478">line 478</a>
308
+ </li></ul></dd>
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ </dl>
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+ </div>
341
+
342
+
343
+ <div class="section-method">
344
+
345
+
346
+
347
+ <h4 class="name" id="SlideBetween"><span class="type-signature"></span>SlideBetween<span class="signature">(val, a, b, min, max)</span><span class="type-signature"> &rarr; {number}</span></h4>
348
+
349
+
350
+
351
+
352
+
353
+ <div class="description">
354
+ Goes between min and max proportional to how val goes between a and b.
355
+ </div>
356
+
357
+
358
+
359
+
360
+
361
+ <dl class="details">
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
+ <dt class="tag-source">Source:</dt>
389
+ <dd class="tag-source"><ul class="dummy"><li>
390
+ <a href="audio.js.html">audio.js</a>, <a href="audio.js.html#line567">line 567</a>
391
+ </li></ul></dd>
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+ </dl>
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+ <h5>Parameters:</h5>
410
+
411
+
412
+ <table class="params">
413
+ <thead>
414
+ <tr>
415
+
416
+ <th>Name</th>
417
+
418
+
419
+ <th>Type</th>
420
+
421
+
422
+
423
+
424
+
425
+ <th class="last">Description</th>
426
+ </tr>
427
+ </thead>
428
+
429
+ <tbody>
430
+
431
+
432
+ <tr>
433
+
434
+ <td class="name"><code>val</code></td>
435
+
436
+
437
+ <td class="type">
438
+
439
+
440
+ <span class="param-type"><code>number</code></span>
441
+
442
+
443
+
444
+ </td>
445
+
446
+
447
+
448
+
449
+
450
+ <td class="description last">
451
+ The value to slide between a and b.
452
+
453
+ </td>
454
+ </tr>
455
+
456
+
457
+
458
+ <tr>
459
+
460
+ <td class="name"><code>a</code></td>
461
+
462
+
463
+ <td class="type">
464
+
465
+
466
+ <span class="param-type"><code>number</code></span>
467
+
468
+
469
+
470
+ </td>
471
+
472
+
473
+
474
+
475
+
476
+ <td class="description last">
477
+ The start value of the slide.
478
+
479
+ </td>
480
+ </tr>
481
+
482
+
483
+
484
+ <tr>
485
+
486
+ <td class="name"><code>b</code></td>
487
+
488
+
489
+ <td class="type">
490
+
491
+
492
+ <span class="param-type"><code>number</code></span>
493
+
494
+
495
+
496
+ </td>
497
+
498
+
499
+
500
+
501
+
502
+ <td class="description last">
503
+ The end value of the slide.
504
+
505
+ </td>
506
+ </tr>
507
+
508
+
509
+
510
+ <tr>
511
+
512
+ <td class="name"><code>min</code></td>
513
+
514
+
515
+ <td class="type">
516
+
517
+
518
+ <span class="param-type"><code>number</code></span>
519
+
520
+
521
+
522
+ </td>
523
+
524
+
525
+
526
+
527
+
528
+ <td class="description last">
529
+ The minimum value of the slide.
530
+
531
+ </td>
532
+ </tr>
533
+
534
+
535
+
536
+ <tr>
537
+
538
+ <td class="name"><code>max</code></td>
539
+
540
+
541
+ <td class="type">
542
+
543
+
544
+ <span class="param-type"><code>number</code></span>
545
+
546
+
547
+
548
+ </td>
549
+
550
+
551
+
552
+
553
+
554
+ <td class="description last">
555
+ The maximum value of the slide.
556
+
557
+ </td>
558
+ </tr>
559
+
560
+
561
+ </tbody>
562
+ </table>
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+ <div class="section-returns">
578
+ <h5>Returns:</h5>
579
+
580
+
581
+
582
+ <dl class="param-type">
583
+ <dt>
584
+ Type:
585
+ </dt>
586
+ <dd>
587
+
588
+ <span class="param-type"><code>number</code></span>
589
+
590
+
591
+ </dd>
592
+ </dl>
593
+
594
+
595
+ <div class="param-desc">
596
+ The new value between min and max.
597
+ </div>
598
+
599
+
600
+ </div>
601
+
602
+
603
+
604
+ </div>
605
+
606
+
607
+ <div class="section-method">
608
+
609
+
610
+
611
+ <h4 class="name" id="compressorSetup"><span class="type-signature"></span>compressorSetup<span class="signature">()</span><span class="type-signature"> &rarr; {DynamicsCompressorNode}</span></h4>
612
+
613
+
614
+
615
+
616
+
617
+ <div class="description">
618
+ Sets up a dynamics compressor for better audio quality.
619
+ </div>
620
+
621
+
622
+
623
+
624
+
625
+ <dl class="details">
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+
650
+
651
+
652
+ <dt class="tag-source">Source:</dt>
653
+ <dd class="tag-source"><ul class="dummy"><li>
654
+ <a href="audio.js.html">audio.js</a>, <a href="audio.js.html#line20">line 20</a>
655
+ </li></ul></dd>
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+ </dl>
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+ <div class="section-returns">
686
+ <h5>Returns:</h5>
687
+
688
+
689
+
690
+ <dl class="param-type">
691
+ <dt>
692
+ Type:
693
+ </dt>
694
+ <dd>
695
+
696
+ <span class="param-type"><code>DynamicsCompressorNode</code></span>
697
+
698
+
699
+ </dd>
700
+ </dl>
701
+
702
+
703
+ <div class="param-desc">
704
+ The created compressor.
705
+ </div>
706
+
707
+
708
+ </div>
709
+
710
+
711
+
712
+ </div>
713
+
714
+
715
+ <div class="section-method">
716
+
717
+
718
+
719
+ <h4 class="name" id="playOscillator"><span class="type-signature"></span>playOscillator<span class="signature">(frequency, currentDuration, panning, currentVol<span class="signature-attributes">opt</span>, wave<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
720
+
721
+
722
+
723
+
724
+
725
+ <div class="description">
726
+ Plays an oscillator with the given frequency, duration, panning, volume, and wave type.
727
+ </div>
728
+
729
+
730
+
731
+
732
+
733
+ <dl class="details">
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+ <dt class="tag-source">Source:</dt>
761
+ <dd class="tag-source"><ul class="dummy"><li>
762
+ <a href="audio.js.html">audio.js</a>, <a href="audio.js.html#line340">line 340</a>
763
+ </li></ul></dd>
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+ </dl>
772
+
773
+
774
+
775
+
776
+
777
+
778
+
779
+
780
+
781
+ <h5>Parameters:</h5>
782
+
783
+
784
+ <table class="params">
785
+ <thead>
786
+ <tr>
787
+
788
+ <th>Name</th>
789
+
790
+
791
+ <th>Type</th>
792
+
793
+
794
+ <th>Attributes</th>
795
+
796
+
797
+
798
+ <th>Default</th>
799
+
800
+
801
+ <th class="last">Description</th>
802
+ </tr>
803
+ </thead>
804
+
805
+ <tbody>
806
+
807
+
808
+ <tr>
809
+
810
+ <td class="name"><code>frequency</code></td>
811
+
812
+
813
+ <td class="type">
814
+
815
+
816
+ <span class="param-type"><code>number</code></span>
817
+
818
+
819
+
820
+ </td>
821
+
822
+
823
+ <td class="attributes">
824
+
825
+
826
+
827
+
828
+
829
+ </td>
830
+
831
+
832
+
833
+ <td class="default">
834
+
835
+ </td>
836
+
837
+
838
+ <td class="description last">
839
+ The frequency of the oscillator.
840
+
841
+ </td>
842
+ </tr>
843
+
844
+
845
+
846
+ <tr>
847
+
848
+ <td class="name"><code>currentDuration</code></td>
849
+
850
+
851
+ <td class="type">
852
+
853
+
854
+ <span class="param-type"><code>number</code></span>
855
+
856
+
857
+
858
+ </td>
859
+
860
+
861
+ <td class="attributes">
862
+
863
+
864
+
865
+
866
+
867
+ </td>
868
+
869
+
870
+
871
+ <td class="default">
872
+
873
+ </td>
874
+
875
+
876
+ <td class="description last">
877
+ The duration of the oscillator in seconds.
878
+
879
+ </td>
880
+ </tr>
881
+
882
+
883
+
884
+ <tr>
885
+
886
+ <td class="name"><code>panning</code></td>
887
+
888
+
889
+ <td class="type">
890
+
891
+
892
+ <span class="param-type"><code>number</code></span>
893
+
894
+
895
+
896
+ </td>
897
+
898
+
899
+ <td class="attributes">
900
+
901
+
902
+
903
+
904
+
905
+ </td>
906
+
907
+
908
+
909
+ <td class="default">
910
+
911
+ </td>
912
+
913
+
914
+ <td class="description last">
915
+ The panning value of the oscillator.
916
+
917
+ </td>
918
+ </tr>
919
+
920
+
921
+
922
+ <tr>
923
+
924
+ <td class="name"><code>currentVol</code></td>
925
+
926
+
927
+ <td class="type">
928
+
929
+
930
+ <span class="param-type"><code>number</code></span>
931
+
932
+
933
+
934
+ </td>
935
+
936
+
937
+ <td class="attributes">
938
+
939
+ &lt;optional><br>
940
+
941
+
942
+
943
+
944
+
945
+ </td>
946
+
947
+
948
+
949
+ <td class="default">
950
+
951
+ 1
952
+
953
+ </td>
954
+
955
+
956
+ <td class="description last">
957
+ The volume of the oscillator.
958
+
959
+ </td>
960
+ </tr>
961
+
962
+
963
+
964
+ <tr>
965
+
966
+ <td class="name"><code>wave</code></td>
967
+
968
+
969
+ <td class="type">
970
+
971
+
972
+ <span class="param-type"><code>string</code></span>
973
+
974
+
975
+
976
+ </td>
977
+
978
+
979
+ <td class="attributes">
980
+
981
+ &lt;optional><br>
982
+
983
+
984
+
985
+
986
+
987
+ </td>
988
+
989
+
990
+
991
+ <td class="default">
992
+
993
+ 'sine'
994
+
995
+ </td>
996
+
997
+
998
+ <td class="description last">
999
+ The wave type of the oscillator.
1000
+
1001
+ </td>
1002
+ </tr>
1003
+
1004
+
1005
+ </tbody>
1006
+ </table>
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+ </div>
1024
+
1025
+
1026
+ <div class="section-method">
1027
+
1028
+
1029
+
1030
+ <h4 class="name" id="playSmooth"><span class="type-signature"></span>playSmooth<span class="signature">(freqArr, currentDuration, panningArr, currentVol, wave)</span><span class="type-signature"></span></h4>
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+ <div class="description">
1037
+ Plays a smooth sound with the given frequency array, duration, panning array, volume, and wave type.
1038
+ </div>
1039
+
1040
+
1041
+
1042
+
1043
+
1044
+ <dl class="details">
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+ <dt class="tag-source">Source:</dt>
1072
+ <dd class="tag-source"><ul class="dummy"><li>
1073
+ <a href="audio.js.html">audio.js</a>, <a href="audio.js.html#line415">line 415</a>
1074
+ </li></ul></dd>
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+ </dl>
1083
+
1084
+
1085
+
1086
+
1087
+
1088
+
1089
+
1090
+
1091
+
1092
+ <h5>Parameters:</h5>
1093
+
1094
+
1095
+ <table class="params">
1096
+ <thead>
1097
+ <tr>
1098
+
1099
+ <th>Name</th>
1100
+
1101
+
1102
+ <th>Type</th>
1103
+
1104
+
1105
+
1106
+
1107
+ <th>Default</th>
1108
+
1109
+
1110
+ <th class="last">Description</th>
1111
+ </tr>
1112
+ </thead>
1113
+
1114
+ <tbody>
1115
+
1116
+
1117
+ <tr>
1118
+
1119
+ <td class="name"><code>freqArr</code></td>
1120
+
1121
+
1122
+ <td class="type">
1123
+
1124
+
1125
+ <span class="param-type"><code>Array.&lt;number></code></span>
1126
+
1127
+
1128
+
1129
+ </td>
1130
+
1131
+
1132
+
1133
+
1134
+ <td class="default">
1135
+
1136
+ </td>
1137
+
1138
+
1139
+ <td class="description last">
1140
+ The array of frequencies to play.
1141
+
1142
+ </td>
1143
+ </tr>
1144
+
1145
+
1146
+
1147
+ <tr>
1148
+
1149
+ <td class="name"><code>currentDuration</code></td>
1150
+
1151
+
1152
+ <td class="type">
1153
+
1154
+
1155
+ <span class="param-type"><code>number</code></span>
1156
+
1157
+
1158
+
1159
+ </td>
1160
+
1161
+
1162
+
1163
+
1164
+ <td class="default">
1165
+
1166
+ 2
1167
+
1168
+ </td>
1169
+
1170
+
1171
+ <td class="description last">
1172
+ The duration of the sound in seconds.
1173
+
1174
+ </td>
1175
+ </tr>
1176
+
1177
+
1178
+
1179
+ <tr>
1180
+
1181
+ <td class="name"><code>panningArr</code></td>
1182
+
1183
+
1184
+ <td class="type">
1185
+
1186
+
1187
+ <span class="param-type"><code>Array.&lt;number></code></span>
1188
+
1189
+
1190
+
1191
+ </td>
1192
+
1193
+
1194
+
1195
+
1196
+ <td class="default">
1197
+
1198
+ </td>
1199
+
1200
+
1201
+ <td class="description last">
1202
+ The array of panning values.
1203
+
1204
+ </td>
1205
+ </tr>
1206
+
1207
+
1208
+
1209
+ <tr>
1210
+
1211
+ <td class="name"><code>currentVol</code></td>
1212
+
1213
+
1214
+ <td class="type">
1215
+
1216
+
1217
+ <span class="param-type"><code>number</code></span>
1218
+
1219
+
1220
+
1221
+ </td>
1222
+
1223
+
1224
+
1225
+
1226
+ <td class="default">
1227
+
1228
+ 1
1229
+
1230
+ </td>
1231
+
1232
+
1233
+ <td class="description last">
1234
+ The volume of the sound.
1235
+
1236
+ </td>
1237
+ </tr>
1238
+
1239
+
1240
+
1241
+ <tr>
1242
+
1243
+ <td class="name"><code>wave</code></td>
1244
+
1245
+
1246
+ <td class="type">
1247
+
1248
+
1249
+ <span class="param-type"><code>string</code></span>
1250
+
1251
+
1252
+
1253
+ </td>
1254
+
1255
+
1256
+
1257
+
1258
+ <td class="default">
1259
+
1260
+ sine
1261
+
1262
+ </td>
1263
+
1264
+
1265
+ <td class="description last">
1266
+ The type of wave to use for the oscillator.
1267
+
1268
+ </td>
1269
+ </tr>
1270
+
1271
+
1272
+ </tbody>
1273
+ </table>
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+ </div>
1291
+
1292
+
1293
+ <div class="section-method">
1294
+
1295
+
1296
+
1297
+ <h4 class="name" id="playTone"><span class="type-signature"></span>playTone<span class="signature">()</span><span class="type-signature"></span></h4>
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+ <div class="description">
1304
+ Plays a tone based on the current chart type and position.
1305
+ </div>
1306
+
1307
+
1308
+
1309
+
1310
+
1311
+ <dl class="details">
1312
+
1313
+
1314
+
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+
1323
+
1324
+
1325
+
1326
+
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+ <dt class="tag-source">Source:</dt>
1339
+ <dd class="tag-source"><ul class="dummy"><li>
1340
+ <a href="audio.js.html">audio.js</a>, <a href="audio.js.html#line40">line 40</a>
1341
+ </li></ul></dd>
1342
+
1343
+
1344
+
1345
+
1346
+
1347
+
1348
+
1349
+ </dl>
1350
+
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+
1359
+
1360
+
1361
+
1362
+
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+
1372
+
1373
+ </div>
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+ </article>
1381
+
1382
+ </section>
1383
+
1384
+
1385
+
1386
+
1387
+ </div>
1388
+
1389
+ <br class="clear">
1390
+
1391
+ <footer>
1392
+ Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Sun Nov 05 2023 14:27:04 GMT-0600 (Central Standard Time) using the Minami theme.
1393
+ </footer>
1394
+
1395
+ <script>prettyPrint();</script>
1396
+ <script src="scripts/linenumber.js"></script>
1397
+ </body>
1398
+ </html>