ActionScript: The Definitive Guide

Name

Sound.stop( ) Method — silences all sounds or a specified attached sound

Availability

Flash 5

Synopsis

soundObject.stop( )
soundObject.stop(linkageIdentifier)

Arguments

linkageIdentifier

The name of any sound attached to any Sound object with the same target as soundObject. Linkage identifiers are specified in the Library under Options → Linkage.

Description

When invoked without a linkageIdentifier, stop( ) silences all sounds controlled by soundObject; if soundObject is a global sound, stop( ) silences all sounds in a movie; if soundObject was created with a target parameter, stop( ) silences all sounds in target.

When invoked with a linkageIdentifier, stop( ) silences only the specific sound named by linkageIdentifier. In that case, linkageIdentifier must be a sound that was attached to a Sound object via attachSound( ). However, the sound to stop need not be attached to soundObject itself. It may be attached to any Sound object that shares the same target as soundObject. Or, if soundObject was created with no target (i.e., is a global Sound object), the sound to stop may be attached to any other global Sound object.

Example

// Create a global Sound object mySound = new Sound( ); // Attach the sound doorbell to the object mySound.attachSound("doorbell"); // Stop all sounds in the movie mySound.stop( ); // Play doorbell mySound.start( ); // Stop just doorbell mySound.stop("doorbell"); // Create another global Sound object myOtherSound = new Sound( ); // Attach a doorknock sound to ...