-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbase_asset_SoundAsset.js.html
260 lines (216 loc) · 10.5 KB
/
base_asset_SoundAsset.js.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: base/asset/SoundAsset.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: base/asset/SoundAsset.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/*
* Copyright 2020 WICKLETS LLC
*
* This file is part of Wick Engine.
*
* Wick Engine is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Wick Engine is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Wick Engine. If not, see <https://www.gnu.org/licenses/>.
*/
Wick.SoundAsset = class extends Wick.FileAsset {
/**
* Returns valid MIME types for a Sound Asset.
* @returns {string[]} Array of strings representing MIME types in the form audio/Subtype.
*/
static getValidMIMETypes () {
let mp3Types = ['audio/mp3', 'audio/mpeg3', 'audio/x-mpeg-3', 'audio/mpeg', 'video/mpeg', 'video/x-mpeg']
let oggTypes = ['audio/ogg', 'video/ogg', 'application/ogg']
let wavTypes = ['audio/wave', 'audio/wav', 'audio/x-wav', 'audio/x-pn-wav']
return mp3Types.concat(oggTypes).concat(wavTypes);
}
/**
* Returns valid extensions for a sound asset.
* @returns {string[]} Array of strings representing valid
*/
static getValidExtensions () {
return ['.mp3', '.ogg', '.wav'];
}
/**
* Creates a new SoundAsset.
* @param {object} args - Asset constructor args. see constructor for Wick.Asset
*/
constructor (args) {
super(args);
this._waveform = null;
}
_serialize (args) {
var data = super._serialize(args);
return data;
}
_deserialize (data) {
super._deserialize(data);
}
get classname () {
return 'SoundAsset';
}
/**
* Plays this asset's sound.
* @param {number} seekMS - the amount of time in milliseconds to start the sound at.
* @param {number} volume - the volume of the sound, from 0.0 - 1.0
* @param {boolean} loop - if set to true, the sound will loop
* @return {number} The id of the sound instance that was played.
*/
play (options) {
if(!options) options = {};
if(options.seekMS === undefined) options.seekMS = 0;
if(options.volume === undefined) options.volume = 1.0;
if(options.loop === undefined) options.loop = false;
// don't do anything if the project is muted...
if(this.project.muted) {
return;
}
var id = this._howl.play();
this._howl.seek(options.seekMS / 1000, id);
this._howl.volume(options.volume, id);
this._howl.loop(options.loop, id);
return id;
}
/**
* Stops this asset's sound.
* @param {number} id - (optional) the ID of the instance to stop. If ID is not given, every instance of this sound will stop.
*/
stop (id) {
// Howl instance was never created, sound has never played yet, so do nothing
if(!this._howl) {
return;
}
if(id === undefined) {
this._howl.stop();
} else {
this._howl.stop(id);
}
}
/**
* The length of the sound in seconds
* @type {number}
*/
get duration () {
return this._howl.duration();
}
/**
* A list of Wick Paths that use this font as their fontFamily.
* @returns {Wick.Path[]}
*/
getInstances () {
var frames = [];
this.project.getAllFrames().forEach(frame => {
if(frame._soundAssetUUID === this.uuid) {
frames.push(frame);
}
});
return frames;
}
/**
* Check if there are any objects in the project that use this asset.
* @returns {boolean}
*/
hasInstances () {
return this.getInstances().length > 0;
}
/**
* Remove the sound from any frames in the project that use this asset as their sound.
*/
removeAllInstances () {
this.getInstances().forEach(frame => {
frame.removeSound();
});
}
/**
* Loads data about the sound into the asset.
* @param {function} callback - function to call when the data is done being loaded.
*/
load (callback) {
this._generateWaveform(() => {
this._waitForHowlLoad(() => {
callback();
});
});
}
/**
* Image of the waveform of this sound.
* @type {Image}
*/
get waveform () {
return this._waveform;
}
get _howl () {
// Lazily create howler instance
if(!this._howlInstance) {
// This fixes OGGs in firefox, as video/ogg is sometimes set as the MIMEType, which Howler doesn't like.
var srcFixed = this.src;
srcFixed = this.src.replace('video/ogg', 'audio/ogg');
this._howlInstance = new Howl({
src: [srcFixed]
});
}
return this._howlInstance;
}
_waitForHowlLoad (callback) {
if(this._howl.state() === 'loaded') {
callback();
} else {
this._howl.on('load', () => {
callback();
});
}
}
_generateWaveform (callback) {
if(this._waveform) {
callback();
return;
}
var soundSrc = this.src;
var scwf = new SCWF();
scwf.generate(soundSrc, {
onComplete: (png, pixels) => {
this._waveform = new Image();
this._waveform.onload = () => {
callback();
}
this._waveform.src = png;
}
});
}
}
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BuiltinAssets.html">BuiltinAssets</a></li><li><a href="GlobalAPI.html">GlobalAPI</a></li><li><a href="paper.SelectionGUI.html">SelectionGUI</a></li><li><a href="paper-paper.Selection.html">Selection</a></li><li><a href="SelectionWidget.html">SelectionWidget</a></li><li><a href="Wick.AutoSave.html">AutoSave</a></li><li><a href="Wick.Base.html">Base</a></li><li><a href="Wick.Button.html">Button</a></li><li><a href="Wick.Clip.html">Clip</a></li><li><a href="Wick.Clipboard.html">Clipboard</a></li><li><a href="Wick.FileCache.html">FileCache</a></li><li><a href="Wick.Frame.html">Frame</a></li><li><a href="Wick.GUIElement.Project.html">Project</a></li><li><a href="Wick.GUIElement.Timeline.html">Timeline</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Breadcrumbs.html">Breadcrumbs</a></li><li><a href="Wick.GUIElement-Wick.GUIElement.Button.html">Button</a></li><li><a href="Wick.History.html">History</a></li><li><a href="Wick.HTMLExport.html">HTMLExport</a></li><li><a href="Wick.HTMLPreview.html">HTMLPreview</a></li><li><a href="Wick.ImageSequence.html">ImageSequence</a></li><li><a href="Wick.Layer.html">Layer</a></li><li><a href="Wick.Path.html">Path</a></li><li><a href="Wick.Project.html">Project</a></li><li><a href="Wick.Selection.html">Selection</a></li><li><a href="Wick.Tickable.html">Tickable</a></li><li><a href="Wick.Timeline.html">Timeline</a></li><li><a href="Wick.Tools-Wick.Tools.Brush.html">Brush</a></li><li><a href="Wick.Tools-Wick.Tools.Cursor.html">Cursor</a></li><li><a href="Wick.Tools-Wick.Tools.Ellipse.html">Ellipse</a></li><li><a href="Wick.Tools-Wick.Tools.Eraser.html">Eraser</a></li><li><a href="Wick.Tools-Wick.Tools.Eyedropper.html">Eyedropper</a></li><li><a href="Wick.Tools-Wick.Tools.FillBucket.html">FillBucket</a></li><li><a href="Wick.Tools-Wick.Tools.Interact.html">Interact</a></li><li><a href="Wick.Tools-Wick.Tools.Line.html">Line</a></li><li><a href="Wick.Tools-Wick.Tools.None.html">None</a></li><li><a href="Wick.Tools-Wick.Tools.Pan.html">Pan</a></li><li><a href="Wick.Tools-Wick.Tools.Pencil.html">Pencil</a></li><li><a href="Wick.Tools-Wick.Tools.Rectangle.html">Rectangle</a></li><li><a href="Wick.Tools-Wick.Tools.Text.html">Text</a></li><li><a href="Wick.Tools-Wick.Tools.Zoom.html">Zoom</a></li><li><a href="Wick.Transformation.html">Transformation</a></li><li><a href="Wick.Tween.html">Tween</a></li><li><a href="Wick.View-Wick.View.Clip.html">Clip</a></li><li><a href="Wick.View-Wick.View.Frame.html">Frame</a></li><li><a href="Wick.View-Wick.View.Path.html">Path</a></li><li><a href="Wick.View-Wick.View.Selection.html">Selection</a></li><li><a href="Wick.WickFile.html">WickFile</a></li><li><a href="Wick.WickObjectFile.html">WickObjectFile</a></li><li><a href="Wick.ZIPExport.html">ZIPExport</a></li><li><a href="WickObjectCache.html">WickObjectCache</a></li><li><a href="Wick-Wick.Asset.html">Asset</a></li><li><a href="Wick-Wick.AudioTrack.html">AudioTrack</a></li><li><a href="Wick-Wick.ClipAsset.html">ClipAsset</a></li><li><a href="Wick-Wick.Color.html">Color</a></li><li><a href="Wick-Wick.FileAsset.html">FileAsset</a></li><li><a href="Wick-Wick.FontAsset.html">FontAsset</a></li><li><a href="Wick-Wick.GIFAsset.html">GIFAsset</a></li><li><a href="Wick-Wick.GUIElement.html">GUIElement</a></li><li><a href="Wick-Wick.ImageAsset.html">ImageAsset</a></li><li><a href="Wick-Wick.SoundAsset.html">SoundAsset</a></li><li><a href="Wick-Wick.SVGAsset.html">SVGAsset</a></li><li><a href="Wick-Wick.Tool.html">Tool</a></li><li><a href="Wick-Wick.ToolSettings.html">ToolSettings</a></li><li><a href="Wick-Wick.View.html">View</a></li></ul><h3>Global</h3><ul><li><a href="global.html#type">type</a></li><li><a href="global.html#Wick">Wick</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Fri Apr 24 2020 15:26:13 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>