Packageaway3d.audio
Classpublic class Sound3D
InheritanceSound3D 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
 Inheritedalpha : Number
An optional alpha value that can be applied to the 3d object.
Object3D
 InheritedanimationLibrary : AnimationLibrary
Reference container for all animations used in the container.
Object3D
 InheritedblendMode : String
An optional blend mode that can be applied to the 3d object.
Object3D
 InheritedboundingRadius : Number
Returns the bounding radius of the 3d object
Object3D
 Inheritedcenter : Array
Object3D
 Inheritedcollider : Boolean
Indicates whether this object is used for collision detection.
Object3D
 Inheriteddebugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object.
Object3D
 InheriteddebugBoundingBox : WireCube
Object3D
 InheriteddebugBoundingSphere : WireSphere
Object3D
 Inheriteddebugbs : Boolean
Indicates whether a debug bounding sphere should be rendered around the 3d object.
Object3D
 Inheritedeulers : Number3D
Defines the rotation of the 3d object as a Number3D object containing euler angles for rotation around x, y and z axis.
Object3D
 Inheritedextra : Object
An optional untyped object that can contain used-defined properties
Object3D
 Inheritedfilters : Array
An optional array of filters that can be applied to the 3d object.
Object3D
 InheritedgeometryLibrary : GeometryLibrary
Reference container for all geometries used in the container.
Object3D
 Inheritedid : int
Object3D
 InheritedinverseSceneTransform : MatrixAway3D
Returns the inverse of sceneTransform.
Object3D
 InheritedmaterialLibrary : MaterialLibrary
Reference container for all materials used in the container.
Object3D
 InheritedmaxX : Number
Returns the maximum x value of the 3d object
Object3D
 InheritedmaxY : Number
Returns the maximum y value of the 3d object
Object3D
 InheritedmaxZ : Number
Returns the maximum z value of the 3d object
Object3D
 InheritedminX : Number
Returns the minimum x value of the 3d object
Object3D
 InheritedminY : Number
Returns the minimum y value of the 3d object
Object3D
 InheritedminZ : Number
Returns the minimum z value of the 3d object
Object3D
 InheritedmouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
Object3D
 Inheritedname : String
An optional name string for the 3d object.
Object3D
 InheritedobjectDepth : Number
Boundary depth of the 3d object return The depth of the mesh
Object3D
 InheritedobjectHeight : Number
Boundary height of the 3d object return The height of the mesh
Object3D
 InheritedobjectWidth : Number
Boundary width of the 3d object return The width of the object
Object3D
 InheritedownCanvas : Boolean
Defines whether the contents of the 3d object are rendered using it's own render session
Object3D
 InheritedownSession : AbstractSession
Defines a unique render session for the 3d object.
Object3D
 Inheritedparent : ObjectContainer3D
Defines the parent of the 3d object.
Object3D
  paused : Boolean
[read-only] Returns a boolean indicating whether or not playback is currently paused.
Sound3D
 InheritedpivotPoint : Number3D
Defines the local point around which the object rotates.
Object3D
 InheritedpivotZero : Boolean
Object3D
  playing : Boolean
[read-only] Returns a boolean indicating whether or not the sound is currently playing.
Sound3D
 Inheritedposition : Number3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 Inheritedpushback : Boolean
Elements use their furthest point from the camera when z-sorting
Object3D
 Inheritedpushfront : Boolean
Elements use their nearest point to the camera when z-sorting
Object3D
 Inheritedrenderer : Renderer
An optional renderer object that can be used to render the contents of the object.
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
 Inheritedscene : Scene3D
Returns the parent scene of the 3d object
Object3D
 InheritedscenePivotPoint : Number3D
Object3D
 InheritedscenePosition : Number3D
Returns the position of the 3d object, relative to the global coordinates of the Scene3D object.
Object3D
 InheritedsceneTransform : MatrixAway3D
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D object.
Object3D
 InheritedscreenXOffset : Number
Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true
Object3D
 InheritedscreenYOffset : Number
Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true
Object3D
 InheritedscreenZOffset : Number
Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true
Object3D
 Inheritedsession : AbstractSession
The render session used by the 3d object
Object3D
 Inheritedtransform : MatrixAway3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 InheriteduseHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object.
Object3D
 Inheritedvisible : Boolean
Defines whether the 3d object is visible in the scene
Object3D
  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
 Inheritedini : Init
Instance of the Init object used to hold and parse default property values specified by the initialiser object in the 3d object constructor.
Object3D
 Inherited_pivotPoint : Number3D
Object3D
Public Methods
 MethodDefined by
  
Sound3D
(sound:Sound, reference:Object3D, driver:ISound3DDriver = null, init:Object = null)
Create a Sound3D object, representing the sound source used for playback of a flash Sound object.
Sound3D
 Inherited
addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
Object3D
 Inherited
addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
Object3D
 Inherited
addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
Object3D
 Inherited
addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
Object3D
 Inherited
addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
Object3D
 Inherited
addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
Object3D
 Inherited
addOnPositionChange(listener:Function):void
Default method for adding a positionchanged event listener
Object3D
 Inherited
addOnRollOut(listener:Function):void
Default method for adding a rollOut3D event listener
Object3D
 Inherited
addOnRollOver(listener:Function):void
Default method for adding a rollOver3D event listener
Object3D
 Inherited
addOnScaleChange(listener:Function):void
Default method for adding a scalechanged event listener
Object3D
 Inherited
addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
Object3D
 Inherited
addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
Object3D
 Inherited
addOnSessionChange(listener:Function):void
Default method for adding a sessionchanged event listener
Object3D
 Inherited
addOnVisibilityUpdate(listener:Function):void
Default method for adding a visibilityUpdated event listener
Object3D
 Inherited
applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position to the object without altering the apperance of child objects
Object3D
 Inherited
applyRotations():void
Apply the local rotations to the object without altering the apperance of child objects
Object3D
 Inherited
centerPivot():void
Adjusts the pivot point of the object so that it lies at the center of it's geoemtry.
Object3D
 Inherited
clone(object:Object3D = null):Object3D
Duplicates the 3d object's properties to another Object3D object
Object3D
 Inherited
distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
Object3D
 Inherited
lookAt(target:Number3D, upAxis:Number3D = null):void
Rotates the 3d object around to face a point defined relative to the local coordinates of the parent ObjectContainer3D.
Object3D
 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
removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
Object3D
 Inherited
removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
Object3D
 Inherited
removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
Object3D
 Inherited
removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
Object3D
 Inherited
removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
Object3D
 Inherited
removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
Object3D
 Inherited
removeOnPositionChange(listener:Function):void
Default method for removing a positionchanged event listener
Object3D
 Inherited
removeOnRollOut(listener:Function):void
Default method for removing a rollOut3D event listener
Object3D
 Inherited
removeOnRollOver(listener:Function):void
Default method for removing a rollOver3D event listener
Object3D
 Inherited
removeOnScaleChange(listener:Function):void
Default method for removing a scalechanged event listener
Object3D
 Inherited
removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
Object3D
 Inherited
removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
Object3D
 Inherited
removeOnSessionChange(listener:Function):void
Default method for removing a sessionchanged event listener
Object3D
 Inherited
removeOnVisibilityUpdate(listener:Function):void
Default method for removing a visibilityUpdated event listener
Object3D
 Inherited
roll(angle:Number):void
Rotates the 3d object around it's local z-axis
Object3D
 Inherited
rotate(axis:Number3D, 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(scale:Number):void
Scales the contents of the 3d object.
Object3D
  
stop():void
Stop and rewind sound file.
Sound3D
 Inherited
tick(time:int):void
Called by the TickTraverser.
Object3D
  
togglePlayPause():void
Alternate between pausing and resuming playback of this sound.
Sound3D
 Inherited
toString():String
Used to trace the values of a 3d object.
Object3D
 Inherited
translate(axis:Number3D, distance:Number):void
Moves the 3d object along a vector by a defined length
Object3D
 Inherited
traverse(traverser:Traverser):void
Used when traversing the scenegraph
Object3D
 Inherited
yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
Object3D
Protected Methods
 MethodDefined by
 Inherited
updateDimensions():void
Object3D
 Inherited
updateTransform():void
Object3D
Events
 EventSummaryDefined by
 Inherited
contentUpdated
Dispatched when the contents of the 3d object updates.Object3D
 Inherited
dimensionsChanged
Dispatched when the bounding dimensions of the 3d object changes.Object3D
 Inherited
mouseDown
Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited
mouseMove
Dispatched when a user moves the cursor while it is over the 3d object.Object3D
 Inherited
mouseOut
Dispatched when a user moves the cursor away from the 3d object.Object3D
 Inherited
mouseOver
Dispatched when a user moves the cursor over the 3d object.Object3D
 Inherited
mouseUp
Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.Object3D
 Inherited
rollOut
Dispatched when a user rolls out of the 3d object.Object3D
 Inherited
rollOver
Dispatched when a user rolls over the 3d object.Object3D
 Inherited
sceneChanged
Dispatched when the parent scene of the 3d object changes.Object3D
 Inherited
scenetransformChanged
Dispatched when the scene transform matrix of the 3d object changes.Object3D
 Inherited
sessionChanged
Dispatched when the render session property of the 3d object changes.Object3D
 Inherited
transformChanged
Dispatched when the local transform matrix of the 3d object changes.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:Object3D, driver:ISound3DDriver = null, init:Object = null)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:Object3D — The reference, or "listener" object, typically a camera.
 
driver:ISound3DDriver (default = null) — Sound3D driver to use when applying simulation effects. Defaults to SimplePanVolumeDriver.
 
init:Object (default = null) — [optional] An initialisation object for specifying default instance properties.
Init Parameters
 'scaleDistance':Number (default = 1000)
 'volume':Number (default = 1)
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.

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

Code examples

Comments