Packageaway3d.audio
Classpublic class Sound3D
InheritanceSound3D Inheritance ObjectContainer3D Inheritance Object3D Inheritance flash.events.EventDispatcher

A sound source/emitter object that can be positioned in 3D space, and from which all audio playback will be transformed to simulate orientation.

The Sound3D object works much in the same fashion as primitives, lights and cameras, in that it can be added to a scene and positioned therein. It is the main object, in the 3D sound API, which the programmer will interact with.

Actual sound transformation is performed by a driver object, which is defined at the time of creation by the driver ini variable, the default being a simple pan/volume driver.

See also

SimplePanVolumeDriver
Public Properties
 PropertyDefined by
 Inheritedeulers : Vector3D
Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis.
Object3D
 Inheritedextra : Object
An object that can contain any extra data.
Object3D
 InheritedinverseSceneTransform : Matrix3D
The inverse scene transform object that transforms from world to model space.
ObjectContainer3D
 InheritedmaxX : Number
The maximum extremum of the object along the X-axis.
ObjectContainer3D
 InheritedmaxY : Number
The maximum extremum of the object along the Y-axis.
ObjectContainer3D
 InheritedmaxZ : Number
The maximum extremum of the object along the Z-axis.
ObjectContainer3D
 InheritedminX : Number
The minimum extremum of the object along the X-axis.
ObjectContainer3D
 InheritedminY : Number
The minimum extremum of the object along the Y-axis.
ObjectContainer3D
 InheritedminZ : Number
The minimum extremum of the object along the Z-axis.
ObjectContainer3D
 Inheritedname : String
The name of the object.
Object3D
 InheritednumChildren : uint
The amount of child objects of the ObjectContainer3D.
ObjectContainer3D
 Inheritedparent : ObjectContainer3D
The parent ObjectContainer3D to which this object's transformation is relative.
ObjectContainer3D
 Inheritedpartition : Partition3D
The space partition to be used by the object container and all its recursive children, unless it has its own space partition assigned.
ObjectContainer3D
  paused : Boolean
[read-only] Returns a boolean indicating whether or not playback is currently paused.
Sound3D
 InheritedpivotPoint : Vector3D
Defines the local point around which the object rotates.
Object3D
  playing : Boolean
[read-only] Returns a boolean indicating whether or not the sound is currently playing.
Sound3D
 Inheritedposition : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationX : Number
Defines the euler angle of rotation of the 3d object around the x-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationY : Number
Defines the euler angle of rotation of the 3d object around the y-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheritedrotationZ : Number
Defines the euler angle of rotation of the 3d object around the z-axis, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
  scaleDistance : Number
Defines a scale value used by the driver when adjusting sound intensity to simulate distance.
Sound3D
 InheritedscaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates.
Object3D
 InheritedscaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates.
Object3D
 InheritedscaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates.
Object3D
 InheritedscenePosition : Vector3D
The global position of the ObjectContainer3D in the scene.
ObjectContainer3D
 InheritedsceneTransform : Matrix3D
The transformation matrix that transforms from model to world space.
ObjectContainer3D
 Inheritedtransform : Matrix3D
The local transformation matrix that transforms to the parent object's space.
ObjectContainer3D
  volume : Number
Defines the overall (master) volume of the 3D sound, after any positional adjustments to volume have been applied.
Sound3D
 Inheritedx : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedy : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedz : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D.
Object3D
Protected Properties
 PropertyDefined by
 Inherited_explicitPartition : Partition3D
ObjectContainer3D
 Inherited_implicitPartition : Partition3D
ObjectContainer3D
 Inherited_parent : ObjectContainer3D
ObjectContainer3D
 Inherited_pivotPoint : Vector3D
Object3D
 Inherited_pivotZero : Boolean = true
Object3D
 Inherited_pos : Vector3D
A calculation placeholder.
Object3D
 Inherited_scaleX : Number = 1
Object3D
 Inherited_scaleY : Number = 1
Object3D
 Inherited_scaleZ : Number = 1
Object3D
 Inherited_scene : Scene3D
ObjectContainer3D
 Inherited_sceneTransform : Matrix3D
ObjectContainer3D
 Inherited_sceneTransformDirty : Boolean = true
ObjectContainer3D
 Inherited_transform : Matrix3D
Object3D
 Inherited_x : Number = 0
Object3D
 Inherited_y : Number = 0
Object3D
 Inherited_z : Number = 0
Object3D
Public Methods
 MethodDefined by
  
Sound3D
(sound:Sound, reference:ObjectContainer3D, driver:ISound3DDriver = null, volume:Number = 1, scale:Number = 1000)
Create a Sound3D object, representing the sound source used for playback of a flash Sound object.
Sound3D
 Inherited
addChild(child:ObjectContainer3D):ObjectContainer3D
Adds a child ObjectContainer3D to the current object.
ObjectContainer3D
 Inherited
addChildren(... childarray):void
Adds an array of 3d objects to the scene as children of the container
ObjectContainer3D
 Inherited
clone():Object3D
Object3D
 Inherited
dispose(deep:Boolean):void
Cleans up any resources used by the current object.
ObjectContainer3D
 Inherited
getChildAt(index:uint):ObjectContainer3D
Retrieves the child object at the given index.
ObjectContainer3D
 Inherited
lookAt(target:Vector3D, upAxis:Vector3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
ObjectContainer3D
 Inherited
moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
Object3D
 Inherited
moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
Object3D
 Inherited
moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
Object3D
 Inherited
moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
Object3D
 Inherited
movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates.
Object3D
 Inherited
moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
Object3D
 Inherited
moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
Object3D
 Inherited
moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
Object3D
  
pause():void
Pause playback.
Sound3D
 Inherited
pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
Object3D
  
play():void
Start (or resume, if paused) playback.
Sound3D
 Inherited
removeChild(child:ObjectContainer3D):void
Removes a 3d object from the child array of the container
ObjectContainer3D
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Vector3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
Object3D
 Inherited
rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
Object3D
 Inherited
scale(value:Number):void
Appends a uniform scale to the current transformation.
Object3D
  
stop():void
Stop and rewind sound file.
Sound3D
  
togglePlayPause():void
Alternate between pausing and resuming playback of this sound.
Sound3D
 Inherited
translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
 Inherited
translateLocal(axis:Vector3D, distance:Number):void
ObjectContainer3D
  
update():void
Sound3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined by
 Inherited
invalidateSceneTransform():void
Invalidates the scene transformation matrix, causing it to be updated the next time it's requested.
ObjectContainer3D
 Inherited
invalidateTransform():void
Invalidates the transformation matrix, causing it to be updated upon the next request
ObjectContainer3D
 Inherited
updateSceneTransform():void
Updates the scene transformation matrix.
ObjectContainer3D
 Inherited
updateTransform():void
Object3D
Property detail
pausedproperty
paused:Boolean  [read-only]

Returns a boolean indicating whether or not playback is currently paused.

Implementation
    public function get paused():Boolean
playingproperty 
playing:Boolean  [read-only]

Returns a boolean indicating whether or not the sound is currently playing.

Implementation
    public function get playing():Boolean
scaleDistanceproperty 
scaleDistance:Number  [read-write]

Defines a scale value used by the driver when adjusting sound intensity to simulate distance. The default number of 1000 means that sound volume will near the hearing threshold as the distance between listener and sound source approaches 1000 Away3D units.

Implementation
    public function get scaleDistance():Number
    public function set scaleDistance(value:Number):void

See also

ISound3DDriver.scale
volumeproperty 
volume:Number  [read-write]

Defines the overall (master) volume of the 3D sound, after any positional adjustments to volume have been applied. This value can equally well be cotrolled by modifying the volume property on the driver used by this Sound3D instance.

Implementation
    public function get volume():Number
    public function set volume(value:Number):void

See also

ISound3DDriver.volume
Constructor detail
Sound3D()constructor
public function Sound3D(sound:Sound, reference:ObjectContainer3D, driver:ISound3DDriver = null, volume:Number = 1, scale:Number = 1000)Parameters
sound:Sound — The flash Sound object that is played back from this Sound3D object's position. For realistic results, this should be a mono (single-channel, non-stereo) sound stream.
 
reference:ObjectContainer3D — The reference, or "listener" object, typically a camera.
 
driver:ISound3DDriver (default = null) — Sound3D driver to use when applying simulation effects. Defaults to SimplePanVolumeDriver.
 
volume:Number (default = 1) — [optional] An initialisation object for specifying default instance properties.
 
scale:Number (default = 1000)
Init Parameters
Method detail
pause()method
public function pause():void

Pause playback. Resume using play().

play()method 
public function play():void

Start (or resume, if paused) playback.

stop()method 
public function stop():void

Stop and rewind sound file. Replay (from the beginning) using play(). To temporarily pause playback, allowing you to resume from the same point, use pause() instead.

See also

pause()
togglePlayPause()method 
public function togglePlayPause():void

Alternate between pausing and resuming playback of this sound. If called while sound is paused (or stopped), this will resume playback. When called during playback, it will pause it.

update()method 
public function update():void

Wiki link
Click to go to the wiki page for 'away3d.audio.Sound3D'

Code examples

Comments