MP3Loader.as
31.7 KB
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
/**
* VERSION: 1.4
* DATE: 2010-09-10
* AS3
* UPDATES AND DOCS AT: http://www.greensock.com/loadermax/
**/
package com.greensock.loading {
import com.greensock.events.LoaderEvent;
import com.greensock.loading.core.LoaderItem;
import flash.display.Shape;
import flash.events.Event;
import flash.events.ProgressEvent;
import flash.media.Sound;
import flash.media.SoundChannel;
import flash.media.SoundLoaderContext;
import flash.media.SoundTransform;
/**
* Loads an MP3 audio file and also provides convenient playback methods
* and properties like <code>pauseSound(), playSound(), gotoSoundTime(), playProgress, volume,
* soundPaused, duration, </code> and <code>soundTime</code>. An MP3Loader will dispatch useful events
* like <code>SOUND_COMPLETE, SOUND_PAUSE, SOUND_PLAY</code>, and <code>PLAY_PROGRESS</code> in addition
* to the typical loader events, making it easy to hook up your own control interface. It packs a
* surprising amount of functionality into a very small amount of kb. <br /><br />
*
* <strong>OPTIONAL VARS PROPERTIES</strong><br />
* The following special properties can be passed into the MP3Loader constructor via its <code>vars</code>
* parameter which can be either a generic object or an <code><a href="data/MP3LoaderVars.html">MP3LoaderVars</a></code> object:<br />
* <ul>
* <li><strong> name : String</strong> - A name that is used to identify the MP3Loader instance. This name can be fed to the <code>find()</code> method or traced at any time. Each loader's name should be unique. If you don't define one, a unique name will be created automatically, like "loader21".</li>
* <li><strong> autoPlay : Boolean</strong> - By default the MP3 will begin playing immediately when enough of the file has buffered, but to prevent it from autoPlaying, set <code>autoPlay</code> to <code>false</code>.</li>
* <li><strong> repeat : int</strong> - Number of times that the mp3 should repeat. To repeat indefinitely, use -1. Default is 0.</li>
* <li><strong> volume : Number</strong> - A value between 0 and 1 indicating the volume at which the sound should play when the MP3Loader's controls are used to play the sound, like <code>playSound()</code> or when <code>autoPlay</code> is <code>true</code> (default volume is 1).</li>
* <li><strong> initThreshold : uint</strong> - The minimum number of <code>bytesLoaded</code> to wait for before the <code>LoaderEvent.INIT</code> event is dispatched - the higher the number the more accurate the <code>duration</code> estimate will be when the INIT event is dispatched (the default value is 102400 which is 100k). The MP3's duration cannot be determined with 100% accuracy until it has completely loaded, but it is estimated with more and more accuracy as the file loads.</code>.</li>
* <li><strong> alternateURL : String</strong> - If you define an <code>alternateURL</code>, the loader will initially try to load from its original <code>url</code> and if it fails, it will automatically (and permanently) change the loader's <code>url</code> to the <code>alternateURL</code> and try again. Think of it as a fallback or backup <code>url</code>. It is perfectly acceptable to use the same <code>alternateURL</code> for multiple loaders (maybe a default image for various ImageLoaders for example).</li>
* <li><strong> context : SoundLoaderContext</strong> - To control things like the buffer time and whether or not a policy file is checked, define a <code>SoundLoaderContext</code> object. The default context is null. See Adobe's SoundLoaderContext documentation for details.</li>
* <li><strong> noCache : Boolean</strong> - If <code>noCache</code> is <code>true</code>, a "cacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you <code>getLoader()</code> or <code>getContent()</code> by url and when you're running locally)</li>
* <li><strong> estimatedBytes : uint</strong> - Initially, the loader's <code>bytesTotal</code> is set to the <code>estimatedBytes</code> value (or <code>LoaderMax.defaultEstimatedBytes</code> if one isn't defined). Then, when the loader begins loading and it can accurately determine the bytesTotal, it will do so. Setting <code>estimatedBytes</code> is optional, but the more accurate the value, the more accurate your loaders' overall progress will be initially. If the loader will be inserted into a LoaderMax instance (for queue management), its <code>auditSize</code> feature can attempt to automatically determine the <code>bytesTotal</code> at runtime (there is a slight performance penalty for this, however - see LoaderMax's documentation for details).</li>
* <li><strong> requireWithRoot : DisplayObject</strong> - LoaderMax supports <i>subloading</i>, where an object can be factored into a parent's loading progress. If you want LoaderMax to require this MP3Loader as part of its parent SWFLoader's progress, you must set the <code>requireWithRoot</code> property to your swf's <code>root</code>. For example, <code>var loader:MP3Loader = new MP3Loader("audio.mp3", {name:"audio", requireWithRoot:this.root});</code></li>
* <li><strong> autoDispose : Boolean</strong> - When <code>autoDispose</code> is <code>true</code>, the loader will be disposed immediately after it completes (it calls the <code>dispose()</code> method internally after dispatching its <code>COMPLETE</code> event). This will remove any listeners that were defined in the vars object (like onComplete, onProgress, onError, onInit). Once a loader is disposed, it can no longer be found with <code>LoaderMax.getLoader()</code> or <code>LoaderMax.getContent()</code> - it is essentially destroyed but its content is not unloaded (you must call <code>unload()</code> or <code>dispose(true)</code> to unload its content). The default <code>autoDispose</code> value is <code>false</code>.
*
* <br /><br />----EVENT HANDLER SHORTCUTS----</li>
* <li><strong> onOpen : Function</strong> - A handler function for <code>LoaderEvent.OPEN</code> events which are dispatched when the loader begins loading. Make sure your onOpen function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onInit : Function</strong> - A handler function for <code>Event.INIT</code> events which will be dispatched when the <code>bytesLoaded</code> exceeds the <code>initThreshold</code> (100k by default) and the MP3 has streamed enough of its content to identify the ID3 meta data. Make sure your onInit function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onProgress : Function</strong> - A handler function for <code>LoaderEvent.PROGRESS</code> events which are dispatched whenever the <code>bytesLoaded</code> changes. Make sure your onProgress function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>). You can use the LoaderEvent's <code>target.progress</code> to get the loader's progress value or use its <code>target.bytesLoaded</code> and <code>target.bytesTotal</code>.</li>
* <li><strong> onComplete : Function</strong> - A handler function for <code>LoaderEvent.COMPLETE</code> events which are dispatched when the loader has finished loading successfully. Make sure your onComplete function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onCancel : Function</strong> - A handler function for <code>LoaderEvent.CANCEL</code> events which are dispatched when loading is aborted due to either a failure or because another loader was prioritized or <code>cancel()</code> was manually called. Make sure your onCancel function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onError : Function</strong> - A handler function for <code>LoaderEvent.ERROR</code> events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). An error doesn't necessarily mean the loader failed, however - to listen for when a loader fails, use the <code>onFail</code> special property. Make sure your onError function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onFail : Function</strong> - A handler function for <code>LoaderEvent.FAIL</code> events which are dispatched whenever the loader fails and its <code>status</code> changes to <code>LoaderStatus.FAILED</code>. Make sure your onFail function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onIOError : Function</strong> - A handler function for <code>LoaderEvent.IO_ERROR</code> events which will also call the onError handler, so you can use that as more of a catch-all whereas <code>onIOError</code> is specifically for LoaderEvent.IO_ERROR events. Make sure your onIOError function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* </ul><br />
*
* <strong>Note:</strong> Using a <code><a href="data/MP3LoaderVars.html">MP3LoaderVars</a></code> instance
* instead of a generic object to define your <code>vars</code> is a bit more verbose but provides
* code hinting and improved debugging because it enforces strict data typing. Use whichever one you prefer.<br /><br />
*
* <code>content</code> data type: <strong><code>flash.media.Sound</code></strong><br /><br />
*
* <strong>NOTE:</strong> To avoid garbage collection issues in the Flash player, the <code>Sound</code>
* object that MP3Loader employs must get recreated internally anytime the MP3Loader is unloaded or its loading
* is cancelled, so it is best to access the <code>content</code> after the <code>COMPLETE</code>
* event has been dispatched. Otherwise, if you store a reference to the MP3Loader's <code>content</code>
* before or during a load and it gets cancelled or unloaded for some reason, the <code>Sound</code> object
* won't be the one into which the MP3 is eventually loaded.<br /><br />
*
* @example Example AS3 code:<listing version="3.0">
import com.greensock.~~;
import com.greensock.loading.~~;
import com.greensock.events.LoaderEvent;
//create a MP3Loader that will begin playing immediately when it loads
var sound:MP3Loader = new MP3Loader("mp3/audio.mp3", {name:"audio", autoPlay:true, repeat:3, estimatedBytes:9500});
//begin loading
sound.load();
//add a CLICK listener to a button that causes the sound to toggle its paused state.
button.addEventListener(MouseEvent.CLICK, toggleSound);
function toggleSound(event:MouseEvent):void {
sound.soundPaused = !sound.soundPaused;
}
//or you could put the MP3Loader into a LoaderMax queue. Create one first...
var queue:LoaderMax = new LoaderMax({name:"mainQueue", onProgress:progressHandler, onComplete:completeHandler, onError:errorHandler});
//append the MP3Loader and then several other loaders
queue.append( sound );
queue.append( new XMLLoader("xml/doc.xml", {name:"xmlDoc", estimatedBytes:425}) );
queue.append( new ImageLoader("img/photo1.jpg", {name:"photo1", estimatedBytes:3500}) );
//start loading
queue.load();
function progressHandler(event:LoaderEvent):void {
trace("progress: " + event.target.progress);
}
function completeHandler(event:LoaderEvent):void {
trace(event.target + " is complete!");
}
function errorHandler(event:LoaderEvent):void {
trace("error occured with " + event.target + ": " + event.text);
}
</listing>
*
* <b>Copyright 2010, GreenSock. All rights reserved.</b> This work is subject to the terms in <a href="http://www.greensock.com/terms_of_use.html">http://www.greensock.com/terms_of_use.html</a> or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.
*
* @see com.greensock.loading.data.MP3LoaderVars
*
* @author Jack Doyle, jack@greensock.com
*/
public class MP3Loader extends LoaderItem {
/** @private **/
private static var _classActivated:Boolean = _activateClass("MP3Loader", MP3Loader, "mp3");
/** @private for ENTER_FRAME listeners **/
private static var _shape:Shape = new Shape();
/** Event type constant for when the sound completes. **/
public static const SOUND_COMPLETE:String="soundComplete";
/** Event type constant for when the sound is paused. **/
public static const SOUND_PAUSE:String="soundPause";
/** Event type constant for when the sound begins or resumes playing. **/
public static const SOUND_PLAY:String="soundPlay";
/** Event type constant for when the playback progresses (only dispatched when the sound is playing). **/
public static const PLAY_PROGRESS:String="playProgress";
/** @private **/
protected var _sound:Sound;
/** @private **/
protected var _context:SoundLoaderContext;
/** @private **/
protected var _soundPaused:Boolean;
/** @private **/
protected var _soundComplete:Boolean;
/** @private **/
protected var _position:Number;
/** @private **/
protected var _soundTransform:SoundTransform;
/** @private **/
protected var _duration:Number;
/** @private Improves performance **/
protected var _dispatchPlayProgress:Boolean;
/** @private -1 = not initted, no ID3 data, 0 = received ID3 data, 1 = fully initted **/
protected var _initPhase:int;
/** The minimum number of <code>bytesLoaded</code> to wait for before the <code>LoaderEvent.INIT</code> event is dispatched - the higher the number the more accurate the <code>duration</code> estimate will be when the INIT event is dispatched (the default value is 102400 which is 100k). The MP3's duration cannot be determined with 100% accuracy until it has completely loaded, but it is estimated with more and more accuracy as the file loads. **/
public var initThreshold:uint;
/** The SoundChannel object that results from the most recent <code>playSound()</code> call (or when <code>autoPlay</code> is <code>true</code> in the constructor's <code>vars</code> parameter). Typically there isn't much reason to use this directly. Instead, use the MP3Loader's controls like <code>playSound(), pauseSound(), gotoSoundTime(), playProgress, duration, soundTime</code>, etc. **/
public var channel:SoundChannel;
/**
* Constructor.
*
* @param urlOrRequest The url (<code>String</code>) or <code>URLRequest</code> from which the loader should get its content
* @param vars An object containing optional configuration details. For example: <code>new MP3Loader("mp3/audio.mp3", {name:"audio", autoPlay:true, onComplete:completeHandler, onProgress:progressHandler})</code>.<br /><br />
*
* The following special properties can be passed into the constructor via the <code>vars</code> parameter
* which can be either a generic object or an <code><a href="data/MP3LoaderVars.html">MP3LoaderVars</a></code> object:<br />
* <ul>
* <li><strong> name : String</strong> - A name that is used to identify the MP3Loader instance. This name can be fed to the <code>find()</code> method or traced at any time. Each loader's name should be unique. If you don't define one, a unique name will be created automatically, like "loader21".</li>
* <li><strong> autoPlay : Boolean</strong> - By default the MP3 will begin playing immediately when enough of the file has buffered, but to prevent it from autoPlaying, set <code>autoPlay</code> to <code>false</code>.</li>
* <li><strong> repeat : int</strong> - Number of times that the mp3 should repeat. To repeat indefinitely, use -1. Default is 0.</li>
* <li><strong> volume : Number</strong> - A value between 0 and 1 indicating the volume at which the sound should play (default is 1).</li>
* <li><strong> initThreshold : uint</strong> - The minimum number of <code>bytesLoaded</code> to wait for before the <code>LoaderEvent.INIT</code> event is dispatched - the higher the number the more accurate the <code>duration</code> estimate will be when the INIT event is dispatched (the default value is 102400 which is 100k). The MP3's duration cannot be determined with 100% accuracy until it has completely loaded, but it is estimated with more and more accuracy as the file loads.</code>.</li>
* <li><strong> alternateURL : String</strong> - If you define an <code>alternateURL</code>, the loader will initially try to load from its original <code>url</code> and if it fails, it will automatically (and permanently) change the loader's <code>url</code> to the <code>alternateURL</code> and try again. Think of it as a fallback or backup <code>url</code>. It is perfectly acceptable to use the same <code>alternateURL</code> for multiple loaders (maybe a default image for various ImageLoaders for example).</li>
* <li><strong> context : SoundLoaderContext</strong> - To control things like the buffer time and whether or not a policy file is checked, define a <code>SoundLoaderContext</code> object. The default context is null. See Adobe's SoundLoaderContext documentation for details.</li>
* <li><strong> noCache : Boolean</strong> - If <code>noCache</code> is <code>true</code>, a "cacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you <code>getLoader()</code> or <code>getContent()</code> by url and when you're running locally)</li>
* <li><strong> estimatedBytes : uint</strong> - Initially, the loader's <code>bytesTotal</code> is set to the <code>estimatedBytes</code> value (or <code>LoaderMax.defaultEstimatedBytes</code> if one isn't defined). Then, when the loader begins loading and it can accurately determine the bytesTotal, it will do so. Setting <code>estimatedBytes</code> is optional, but the more accurate the value, the more accurate your loaders' overall progress will be initially. If the loader will be inserted into a LoaderMax instance (for queue management), its <code>auditSize</code> feature can attempt to automatically determine the <code>bytesTotal</code> at runtime (there is a slight performance penalty for this, however - see LoaderMax's documentation for details).</li>
* <li><strong> requireWithRoot : DisplayObject</strong> - LoaderMax supports <i>subloading</i>, where an object can be factored into a parent's loading progress. If you want LoaderMax to require this MP3Loader as part of its parent SWFLoader's progress, you must set the <code>requireWithRoot</code> property to your swf's <code>root</code>. For example, <code>var loader:MP3Loader = new MP3Loader("audio.mp3", {name:"audio", requireWithRoot:this.root});</code></li>
* <li><strong> autoDispose : Boolean</strong> - When <code>autoDispose</code> is <code>true</code>, the loader will be disposed immediately after it completes (it calls the <code>dispose()</code> method internally after dispatching its <code>COMPLETE</code> event). This will remove any listeners that were defined in the vars object (like onComplete, onProgress, onError, onInit). Once a loader is disposed, it can no longer be found with <code>LoaderMax.getLoader()</code> or <code>LoaderMax.getContent()</code> - it is essentially destroyed but its content is not unloaded (you must call <code>unload()</code> or <code>dispose(true)</code> to unload its content). The default <code>autoDispose</code> value is <code>false</code>.
*
* <br /><br />----EVENT HANDLER SHORTCUTS----</li>
* <li><strong> onOpen : Function</strong> - A handler function for <code>LoaderEvent.OPEN</code> events which are dispatched when the loader begins loading. Make sure your onOpen function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onInit : Function</strong> - A handler function for <code>Event.INIT</code> events which will be dispatched when the <code>bytesLoaded</code> exceeds the <code>initThreshold</code> (100k by default) and the MP3 has streamed enough of its content to identify the ID3 meta data. Make sure your onInit function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onProgress : Function</strong> - A handler function for <code>LoaderEvent.PROGRESS</code> events which are dispatched whenever the <code>bytesLoaded</code> changes. Make sure your onProgress function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>). You can use the LoaderEvent's <code>target.progress</code> to get the loader's progress value or use its <code>target.bytesLoaded</code> and <code>target.bytesTotal</code>.</li>
* <li><strong> onComplete : Function</strong> - A handler function for <code>LoaderEvent.COMPLETE</code> events which are dispatched when the loader has finished loading successfully. Make sure your onComplete function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onCancel : Function</strong> - A handler function for <code>LoaderEvent.CANCEL</code> events which are dispatched when loading is aborted due to either a failure or because another loader was prioritized or <code>cancel()</code> was manually called. Make sure your onCancel function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onError : Function</strong> - A handler function for <code>LoaderEvent.ERROR</code> events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). An error doesn't necessarily mean the loader failed, however - to listen for when a loader fails, use the <code>onFail</code> special property. Make sure your onError function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onFail : Function</strong> - A handler function for <code>LoaderEvent.FAIL</code> events which are dispatched whenever the loader fails and its <code>status</code> changes to <code>LoaderStatus.FAILED</code>. Make sure your onFail function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* <li><strong> onIOError : Function</strong> - A handler function for <code>LoaderEvent.IO_ERROR</code> events which will also call the onError handler, so you can use that as more of a catch-all whereas <code>onIOError</code> is specifically for LoaderEvent.IO_ERROR events. Make sure your onIOError function accepts a single parameter of type <code>LoaderEvent</code> (<code>com.greensock.events.LoaderEvent</code>).</li>
* </ul>
* @see com.greensock.loading.data.MP3LoaderVars
*/
public function MP3Loader(urlOrRequest:*, vars:Object=null) {
super(urlOrRequest, vars);
_type = "MP3Loader";
_position = 0;
_duration = 0;
_soundPaused = true;
_soundTransform = new SoundTransform(("volume" in this.vars) ? this.vars.volume : 1);
this.initThreshold = ("initThreshold" in this.vars) ? uint(this.vars.initThreshold) : 102400;
_initSound();
}
/** @private **/
protected function _initSound():void {
if (_sound != null) {
try {
_sound.close();
} catch (error:Error) {
}
_sound.removeEventListener(ProgressEvent.PROGRESS, _progressHandler);
_sound.removeEventListener(Event.COMPLETE, _completeHandler);
_sound.removeEventListener("ioError", _failHandler);
_sound.removeEventListener(Event.ID3, _id3Handler);
}
_initPhase = -1;
_sound = _content = new Sound();
_sound.addEventListener(ProgressEvent.PROGRESS, _progressHandler, false, 0, true);
_sound.addEventListener(Event.COMPLETE, _completeHandler, false, 0, true);
_sound.addEventListener("ioError", _failHandler, false, 0, true);
_sound.addEventListener(Event.ID3, _id3Handler, false, 0, true);
}
/** @private **/
override protected function _load():void {
_context = (this.vars.context is SoundLoaderContext) ? this.vars.context : new SoundLoaderContext(3000);
_prepRequest();
_soundComplete = false;
_initPhase = -1;
_position = 0;
_duration = 0;
try {
_sound.load(_request, _context);
if (this.vars.autoPlay != false) {
playSound();
}
} catch (error:Error) {
_errorHandler(new LoaderEvent(LoaderEvent.ERROR, this, error.message));
}
}
/** @private scrubLevel: 0 = cancel, 1 = unload, 2 = dispose, 3 = flush **/
override protected function _dump(scrubLevel:int=0, newStatus:int=0, suppressEvents:Boolean=false):void {
this.pauseSound();
_initSound();
_position = 0;
_duration = 0;
_soundComplete = false;
super._dump(scrubLevel, newStatus);
_content = _sound;
}
/**
* Plays the sound.
*
* @param event An optional Event which simply makes it easier to use the method as a handler for mouse clicks or other events.
* @return The SoundChannel object created by the play()
*
* @see #soundPaused
* @see #pauseSound()
* @see #gotoSoundTime()
* @see #soundTime
* @see #playProgress
**/
public function playSound(event:Event=null):SoundChannel {
this.soundPaused = false;
return this.channel;
}
/**
* Pauses playback of the sound.
*
* @param event An optional Event which simply makes it easier to use the method as a handler for mouse clicks or other events.
*
* @see #soundPaused
* @see #gotoSoundTime()
* @see #playSound()
* @see #soundTime
* @see #playProgress
**/
public function pauseSound(event:Event=null):void {
this.soundPaused = true;
}
/**
* Attempts to jump to a certain time in the sound. If the sound hasn't downloaded enough to get to
* the new time, it will get as close as possible.
* For example, to jump to exactly 3-seconds into the sound and play from there:<br /><br /><code>
*
* loader.gotoSoundTime(3, true);<br /><br /></code>
*
* @param time The time (in seconds, offset from the very beginning) at which to place the virtual playhead in the sound.
* @param forcePlay If <code>true</code>, the sound will resume playback immediately after seeking to the new position.
* @see #pauseSound()
* @see #playSound()
* @see #soundTime
* @see #playProgress
**/
public function gotoSoundTime(time:Number, forcePlay:Boolean=false):void {
if (time > _duration) {
time = _duration;
}
_position = time * 1000;
_soundComplete = false;
if (!_soundPaused || forcePlay) {
if (this.channel != null) {
this.channel.removeEventListener(Event.SOUND_COMPLETE, _soundCompleteHandler);
this.channel.stop();
}
this.channel = _sound.play(_position, ((this.vars.repeat == -1) ? 9999999 : uint(this.vars.repeat) + 1), _soundTransform);
this.channel.addEventListener(Event.SOUND_COMPLETE, _soundCompleteHandler);
if (_soundPaused) {
_shape.addEventListener(Event.ENTER_FRAME, _enterFrameHandler, false, 0, true);
_soundPaused = false;
dispatchEvent(new LoaderEvent(SOUND_PLAY, this));
}
}
}
//---- EVENT HANDLERS ------------------------------------------------------------------------------------
/** @private **/
protected function _id3Handler(event:Event):void {
if (_sound.bytesLoaded > this.initThreshold) {
_initPhase = 1;
dispatchEvent(new LoaderEvent(LoaderEvent.INIT, this));
} else {
_initPhase = 0;
}
}
/** @private **/
override protected function _progressHandler(event:Event):void {
if (_initPhase == 0 && _sound.bytesLoaded > this.initThreshold) {
_initPhase = 1;
dispatchEvent(new LoaderEvent(LoaderEvent.INIT, this));
}
super._progressHandler(event);
}
/** @private **/
protected function _soundCompleteHandler(event:Event):void {
_soundComplete = true;
this.soundPaused = true;
_position = _duration * 1000;
_enterFrameHandler(null);
dispatchEvent(new LoaderEvent(SOUND_COMPLETE, this));
}
/** @private **/
protected function _enterFrameHandler(event:Event):void {
if (_dispatchPlayProgress) {
dispatchEvent(new LoaderEvent(PLAY_PROGRESS, this));
}
}
/** @inheritDoc **/
override public function addEventListener(type:String, listener:Function, useCapture:Boolean=false, priority:int=0, useWeakReference:Boolean=false):void {
if (type == PLAY_PROGRESS) {
_dispatchPlayProgress = true;
}
super.addEventListener(type, listener, useCapture, priority, useWeakReference);
}
/** @private **/
override protected function _completeHandler(event:Event=null):void {
_duration = _sound.length / 1000;
if (_initPhase != 1) {
_initPhase = 1;
dispatchEvent(new LoaderEvent(LoaderEvent.INIT, this));
}
super._completeHandler(event);
}
//---- GETTERS / SETTERS -------------------------------------------------------------------------
/** The playback status of the sound: <code>true</code> if the sound's playback is paused, <code>false</code> if it isn't. **/
public function get soundPaused():Boolean {
return _soundPaused;
}
public function set soundPaused(value:Boolean):void {
var changed:Boolean = Boolean(value != _soundPaused);
_soundPaused = value;
if (!changed) {
return;
}
if (_soundPaused) {
if (this.channel != null) {
_position = this.channel.position;
this.channel.removeEventListener(Event.SOUND_COMPLETE, _soundCompleteHandler);
_shape.removeEventListener(Event.ENTER_FRAME, _enterFrameHandler);
this.channel.stop();
}
} else {
this.channel = _sound.play(_position, ((this.vars.repeat == -1) ? 9999999 : uint(this.vars.repeat) + 1), _soundTransform);
this.channel.addEventListener(Event.SOUND_COMPLETE, _soundCompleteHandler);
_shape.addEventListener(Event.ENTER_FRAME, _enterFrameHandler, false, 0, true);
}
dispatchEvent(new LoaderEvent(((_soundPaused) ? SOUND_PAUSE : SOUND_PLAY), this));
}
/** A value between 0 and 1 describing the playback progress where 0 means the virtual playhead is at the very beginning of the sound, 0.5 means it is at the halfway point and 1 means it is at the end of the sound. **/
public function get playProgress():Number {
return (_soundComplete) ? 1 : (this.soundTime / this.duration);
}
public function set playProgress(value:Number):void {
if (this.duration != 0) {
gotoSoundTime((value * _duration), !_soundPaused);
}
}
/** The volume of the sound (a value between 0 and 1). **/
public function get volume():Number {
return _soundTransform.volume;
}
public function set volume(value:Number):void {
_soundTransform.volume = value;
if (this.channel != null) {
this.channel.soundTransform = _soundTransform;
}
}
/** The time (in seconds) at which the virtual playhead is positioned on the sound. For example, if the virtual playhead is currently at the 3-second position (3 seconds from the beginning), this value would be 3. **/
public function get soundTime():Number {
return (!_soundPaused && this.channel != null) ? this.channel.position / 1000 : _position / 1000;
}
public function set soundTime(value:Number):void {
gotoSoundTime(value, !_soundPaused);
}
/** The duration (in seconds) of the sound. This value cannot be determined with 100% accuracy until the file has completely loaded, but it is estimated with more and more accuracy as the file loads. **/
public function get duration():Number {
if (_sound.bytesLoaded < _sound.bytesTotal) {
_duration = (_sound.length / 1000) / (_sound.bytesLoaded / _sound.bytesTotal);
}
return _duration;
}
}
}