| Package | away3d.audio.drivers |
| Interface | public interface ISound3DDriver |
| Implementors | SimplePanVolumeDriver |
| Property | Defined By | ||
|---|---|---|---|
| mute : Boolean
Mutes/unmutes the driver completely, which is typically only done (internally
by Sound3D) whenever the sound source is removed from the scene. | ISound3DDriver | ||
| scale : Number
Arbitrary value by which all distances are divided. | ISound3DDriver | ||
| sourceSound : Sound
The sound object (flash.media.Sound) to play at the point of the sound
source. | ISound3DDriver | ||
| volume : Number
Master volume/gain after 3D modifications to pan/volume have been applied. | ISound3DDriver | ||
| Method | Defined By | ||
|---|---|---|---|
pause():void
Temporarily pause playback. | ISound3DDriver | ||
play():void
Start playing (or resume if paused) the audio. | ISound3DDriver | ||
stop():void
Stop playback and reset playhead. | ISound3DDriver | ||
updateReferenceVector(v:Vector3D):void
Change the position of the sound source relative to the listener, known as
the reference vector. | ISound3DDriver | ||
| mute | property |
mute:BooleanMutes/unmutes the driver completely, which is typically only done (internally by Sound3D) whenever the sound source is removed from the scene. When true, any values set to the volume property will be ignored.
public function get mute():Boolean public function set mute(value:Boolean):void| scale | property |
scale:NumberArbitrary value by which all distances are divided. The default value of 1000 is usually suitable for scenes with a scale that roughly matches the standard Away3D scale, i.e. that look good from the default camera position.
public function get scale():Number public function set scale(value:Number):void| sourceSound | property |
sourceSound:SoundThe sound object (flash.media.Sound) to play at the point of the sound source. The output of this sound is modified by the driver before actual sound output.
public function get sourceSound():Sound public function set sourceSound(value:Sound):void| volume | property |
volume:NumberMaster volume/gain after 3D modifications to pan/volume have been applied. Modify this to raise or lower the overall volume regardless of where the sound source is located.
public function get volume():Number public function set volume(value:Number):void| pause | () | method |
public function pause():voidTemporarily pause playback. Resume using play().
| play | () | method |
public function play():voidStart playing (or resume if paused) the audio. This is NOT The same thing as invoking play() on the flash.media.Sound object used as the source sound for the driver.
| stop | () | method |
public function stop():voidStop playback and reset playhead. Subsequent play() calls will restart the playback from the beginning of the sound file.
| updateReferenceVector | () | method |
public function updateReferenceVector(v:Vector3D):voidChange the position of the sound source relative to the listener, known as the reference vector. This is invoked by the Sound3D object when it's position changes, and should typically not be called by any other code.
Parameters
v:Vector3D — Sound source position vector relative to the listener.
|