The SoundTransform class contains properties for volume and panning.
See also:
Constructor
new(vol:Float = 1, panning:Float = 0)
Creates a SoundTransform object.
Parameters:
vol | The volume, ranging from 0 (silent) to 1 (full volume). |
|---|---|
panning | The left-to-right panning of the sound, ranging from -1 (full pan left) to 1 (full pan right). A value of 0 represents no panning (center). |
Variables
leftToLeft:Float
A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the left speaker.
leftToRight:Float
A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the right speaker.
pan:Float
The left-to-right panning of the sound, ranging from -1 (full pan left) to 1 (full pan right). A value of 0 represents no panning (balanced center between right and left).
The following example sets the pan to 0.5 (half pan right) when starting to play a Sound.
var transform = new SoundTransform(1.0, 0.5);
var soundChannel = sound.play(0, 0, transform);The following example sets the pan to -1 (full pan left) for a SoundChannel that is currently playing.
var transform = soundChannel.soundTransform;
transform.pan = -1.0;
soundChannel.soundTransform = transform;See also:
rightToLeft:Float
A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the left speaker.
rightToRight:Float
A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the right speaker.
volume:Float
The volume, ranging from 0 (silent) to 1 (full volume).
The following example sets the volume to 0.5 (half volume) when starting to play a Sound.
var transform = new SoundTransform(0.5);
var soundChannel = sound.play(0, 0, transform);The following example sets the volume to 0.0 (silent) for a SoundChannel that is currently playing.
var transform = soundChannel.soundTransform;
transform.volume = 0.0;
soundChannel.soundTransform = transform;See also: