S > Sound.setTransform

 

Sound.setTransform

Availability

Flash Player 5.

Usage

mySound.setTransform(soundTransformObject) 

Parameters

soundTransformObject An object created with the constructor for the generic Object object.

Returns

Nothing.

Description

Method; sets the sound transform, or "balance" information, for a Sound object.

The soundTransformObject parameter is an object that you create using the constructor method of the generic Object object with parameters specifying how the sound is distributed to the left and right channels (speakers).

Sounds use a considerable amount of disk space and memory. Because stereo sounds use twice as much data as mono sounds, it is generally best to use 22-KHz 6-bit mono sounds. You can use the setTransform method to play mono sounds as stereo, play stereo sounds as mono, and to add interesting effects to sounds.

The parameters for the soundTransformObject are as follows:

11 A percentage value specifying how much of the left input to play in the left speaker (0-100).

1r A percentage value specifying how much of the right input to play in the left speaker (0-100).

rr A percentage value specifying how much of the right input to play in the right speaker (0-100).

rl A percentage value specifying how much of the left input to play in the right speaker (0-100).

The net result of the parameters is represented by the following formula:

leftOutput = left_input * ll + right_input * lr
rightOutput = right_input * rr + left_input * rl

The values for left_input or right_input are determined by the type (stereo or mono) of sound in your movie.

Stereo sounds divide the sound input evenly between the left and right speakers and have the following transform settings by default:

ll = 100
lr = 0
rr = 100
rl = 0

Mono sounds play all sound input in the left speaker and have the following transform settings by default:

ll = 100
lr = 100
rr = 0
rl = 0

Example

The following example illustrates a setting that can be achieved by using the setTransform method, but cannot be achieved by using the setVolume or setPan methods, even if they are combined.

The following code creates a new soundTransformObject object and sets its properties so that sound from both channels will play only in the left channel.

mySoundTransformObject = new Object;
mySoundTransformObject.ll = 100;
mySoundTransformObject.lr = 100;
mySoundTransformObject.rr = 0;
mySoundTransformObject.rl = 0;

To apply the soundTransformObject object to a Sound object, you then need to pass the object to the Sound object using the setTransform method as follows:

mySound.setTransform(mySoundTransformObject);

The following example plays a stereo sound as mono; the soundTransformObjectMono has the following parameters.

mySoundTransformObjectMono = new Object;
mySoundTransformObjectMono.ll = 50;
mySoundTransformObjectMono.lr = 50;
mySoundTransformObjectMono.rr = 50;
mySoundTransformObjectMono.rl = 50;
mySound.setTransform(soundTransformObjectMono);

This example plays the left channel at half capacity and adds the rest of the left channel to the right channel; the soundTransformObjectHalf has the following parameters.

mySoundTransformObjectHalf = new Object;
mySoundTransformObjectHalf.ll = 50;
mySoundTransformObjectHalf.lr = 0;
mySoundTransformObjectHalf.rr = 100;
mySoundTransformObjectHalf.rl = 50;
setTransform(soundTransformObjectHalf);

See also

Constructor for the Object object