User Guide

Sound.onLoad 767
Sound.onLoad
Availability
Flash Player 6.
Usage
my_sound.onLoad = function(success:Boolean){
// your statements here
}
Parameters
success
A Boolean value of true if my_sound has been loaded successfully, false otherwise.
Returns
Nothing.
Description
Event handler; invoked automatically when a sound loads. You must create a function that
executes when the this handler is invoked. You can use either an anonymous function or a named
function (for an example of each, see
Sound.onSoundComplete). You should define this handler
before you call
mySound.loadSound().
Example
The following example creates a new Sound object, and loads a sound. Loading the sound is
handled by the
onLoad handler, which allows you to start the song after it is successfully loaded.
Create a new FLA file, and add the following ActionScript to your FLA or AS file. For this
example to work, you must have an MP3 called song1.mp3 in the same directory as your FLA or
AS file.
this.createTextField("status_txt", this.getNextHighestDepth(), 0,0,100,22);
// create a new Sound object
var my_sound:Sound = new Sound();
// if the sound loads, play it; if not, trace failure loading
my_sound.onLoad = function(success:Boolean) {
if (success) {
my_sound.start();
status_txt.text = "Sound loaded";
} else {
status_txt.text = "Sound failed";
}
};
// load the sound
my_sound.loadSound("song1.mp3", true);
See also
Sound.loadSound()