Sound class

Availability

Flash Player 5.

Description

The Sound class lets you control sound in a movie. You can add sounds to a movie clip from the library while the movie is playing and control those sounds. If you do not specify a target when you create a new Sound object, you can use the methods to control sound for the whole movie.

You must use the constructor new Sound to create a Sound object before calling the methods of the Sound class.

Method summary for the Sound class

Method	Description
`Sound.attachSound()`	Attaches the sound specified in the parameter.
`Sound.getBytesLoaded()`	Returns the number of bytes loaded for the specified sound.
`Sound.getBytesTotal()`	Returns the size of the sound in bytes.
`Sound.getPan()`	Returns the value of the previous `setPan()` call.
`Sound.getTransform()`	Returns the value of the previous `setTransform()` call.
`Sound.getVolume()`	Returns the value of the previous `setVolume()` call.
`Sound.loadSound()`	Loads an MP3 file into Flash Player.
`Sound.setPan()`	Sets the left/right balance of the sound.
`Sound.setTransform()`	Sets the amount of each channel, left and right, to be played in each speaker.
`Sound.setVolume()`	Sets the volume level for a sound.
`Sound.start()`	Starts playing a sound from the beginning or, optionally, from an offset point set in the parameter.
`Sound.stop()`	Stops the specified sound or all sounds currently playing.

Property summary for the Sound class

Property	Description
`Sound.duration`	Length of a sound, in milliseconds.
`Sound.ID3`	Provides access to the metadata that is part of an MP3 file.
`Sound.position`	Number of milliseconds a sound has been playing.

Event handler summary for the Sound class

Event handler	Description
`Sound.onID3`	Invoked each time new ID3 data is available.
`Sound.onLoad`	Invoked when a sound loads.
`Sound.onSoundComplete`	Invoked when a sound stops playing.

Constructor for the Sound class

Availability

Flash Player 5.

Usage

new Sound([target])

Parameters

target The movie clip instance on which the Sound object operates. This parameter is optional.

Returns

Nothing.

Description

Constructor; creates a new Sound object for a specified movie clip. If you do not specify a target instance, the Sound object controls all of the sounds in the movie.

Example

The following example creates a new Sound object called global_sound. The second line calls setVolume() and adjusts the volume on all sounds in the movie to 50%.

global_sound = new Sound();
global_sound.setVolume(50);

The following example creates a new Sound object, passes it the target movie clip my_mc, and calls the start method, which starts any sound in my_mc.

movie_sound = new Sound(my_mc);
movie_sound.start();