| Package | away3d.audio |
| Class | public class Sound3D |
| Inheritance | Sound3D  Object3D 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
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number
An optional alpha value that can be applied to the 3d object. | Object3D | |
| animationLibrary : AnimationLibrary
Reference container for all animations used in the container. | Object3D | |
| blendMode : String
An optional blend mode that can be applied to the 3d object. | Object3D | |
| boundingRadius : Number [read-only]
Returns the bounding radius of the 3d object
| Object3D | |
| collider : Boolean
Indicates whether this object is used for collision detection. | Object3D | |
| debugbb : Boolean
Indicates whether a debug bounding box should be rendered around the 3d object. | Object3D | |
| debugBoundingBox : WireCube [read-only] | Object3D | |
| debugBoundingSphere : WireSphere [read-only] | Object3D | |
| debugbs : Boolean
Indicates whether a debug bounding sphere should be rendered around the 3d object. | Object3D | |
| eulers : Vector3D
Defines the rotation of the 3d object as a Vector3D object containing euler angles for rotation around x, y and z axis. | Object3D | |
| extra : Object
An optional untyped object that can contain used-defined properties
| Object3D | |
| filters : Array
An optional array of filters that can be applied to the 3d object. | Object3D | |
| geometryLibrary : GeometryLibrary
Reference container for all geometries used in the container. | Object3D | |
| id : int [read-only] | Object3D | |
| inverseSceneTransform : Matrix3D
Returns the inverse of sceneTransform. | Object3D | |
| materialLibrary : MaterialLibrary
Reference container for all materials used in the container. | Object3D | |
| maxX : Number [read-only]
Returns the maximum x value of the 3d object
| Object3D | |
| maxY : Number [read-only]
Returns the maximum y value of the 3d object
| Object3D | |
| maxZ : Number [read-only]
Returns the maximum z value of the 3d object
| Object3D | |
| minX : Number [read-only]
Returns the minimum x value of the 3d object
| Object3D | |
| minY : Number [read-only]
Returns the minimum y value of the 3d object
| Object3D | |
| minZ : Number [read-only]
Returns the minimum z value of the 3d object
| Object3D | |
| mouseEnabled : Boolean = true
Defines whether mouse events are received on the 3d object
| Object3D | |
| name : String
An optional name string for the 3d object. | Object3D | |
| objectDepth : Number [read-only]
Boundary depth of the 3d object
return The depth of the mesh
| Object3D | |
| objectHeight : Number [read-only]
Boundary height of the 3d object
return The height of the mesh
| Object3D | |
| objectWidth : Number [read-only]
Boundary width of the 3d object
return The width of the object
| Object3D | |
| ownCanvas : Boolean
Defines whether the contents of the 3d object are rendered using it's own render session
| Object3D | |
| ownSession : AbstractSession
Defines a unique render session for the 3d object. | Object3D | |
| parent : 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 | ||
| pivotPoint : Vector3D
Defines the local point around which the object rotates. | Object3D | |
| pivotZero : Boolean [read-only] | Object3D | |
| playing : Boolean [read-only]
Returns a boolean indicating whether or not the sound is currently
playing. | Sound3D | ||
| position : Vector3D
Defines the position of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
| pushback : Boolean
Elements use their furthest point from the camera when z-sorting
| Object3D | |
| pushfront : Boolean
Elements use their nearest point to the camera when z-sorting
| Object3D | |
| renderer : Renderer
An optional renderer object that can be used to render the contents of the object. | Object3D | |
| rotationX : 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 | |
| rotationY : 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 | |
| rotationZ : 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 | ||
| scaleX : Number
Defines the scale of the 3d object along the x-axis, relative to local coordinates. | Object3D | |
| scaleY : Number
Defines the scale of the 3d object along the y-axis, relative to local coordinates. | Object3D | |
| scaleZ : Number
Defines the scale of the 3d object along the z-axis, relative to local coordinates. | Object3D | |
| scene : Scene3D [read-only]
Returns the parent scene of the 3d object
| Object3D | |
| scenePivotPoint : Vector3D [read-only] | Object3D | |
| scenePosition : Vector3D [read-only]
Returns the position of the 3d object, relative to the global coordinates of the Scene3D object. | Object3D | |
| sceneTransform : Matrix3D [read-only]
Returns the transformation of the 3d object, relative to the global coordinates of the Scene3D object. | Object3D | |
| screenXOffset : Number
Defines an additional offset to the x coordinate used on mesh elements or objects with ownCanvas set to true
| Object3D | |
| screenYOffset : Number
Defines an additional offset to the y coordinate used on mesh elements or objects with ownCanvas set to true
| Object3D | |
| screenZOffset : Number
Defines an additional offset to the z-sorting algorithm used on mesh elements or objects with ownCanvas set to true
| Object3D | |
| session : AbstractSession [read-only]
The render session used by the 3d object
| Object3D | |
| transform : Matrix3D
Defines the transformation of the 3d object, relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
| useHandCursor : Boolean = false
Defines whether a hand cursor is displayed when the mouse rolls over the 3d object. | Object3D | |
| visible : 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 | ||
| x : Number
Defines the x coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
| y : Number
Defines the y coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
| z : Number
Defines the z coordinate of the 3d object relative to the local coordinates of the parent ObjectContainer3D. | Object3D | |
| Method | Defined By | ||
|---|---|---|---|
Create a Sound3D object, representing the sound source used for playback of a flash Sound object. | Sound3D | ||
| addOnDimensionsChange(listener:Function):void
Default method for adding a dimensionschanged event listener
| Object3D | |
| addOnMouseDown(listener:Function):void
Default method for adding a mouseDown3D event listener
| Object3D | |
| addOnMouseMove(listener:Function):void
Default method for adding a mouseMove3D event listener
| Object3D | |
| addOnMouseOut(listener:Function):void
Default method for adding a mouseOut3D event listener
| Object3D | |
| addOnMouseOver(listener:Function):void
Default method for adding a mouseOver3D event listener
| Object3D | |
| addOnMouseUp(listener:Function):void
Default method for adding a mouseUp3D event listener
| Object3D | |
| addOnPositionChange(listener:Function):void
Default method for adding a positionchanged event listener
| Object3D | |
| addOnRollOut(listener:Function):void
Default method for adding a rollOut3D event listener
| Object3D | |
| addOnRollOver(listener:Function):void
Default method for adding a rollOver3D event listener
| Object3D | |
| addOnScaleChange(listener:Function):void
Default method for adding a scalechanged event listener
| Object3D | |
| addOnSceneChange(listener:Function):void
Default method for adding a scenechanged event listener
| Object3D | |
| addOnSceneTransformChange(listener:Function):void
Default method for adding a scenetransformchanged event listener
| Object3D | |
| addOnSessionChange(listener:Function):void
Default method for adding a sessionchanged event listener
| Object3D | |
| addOnVisibilityUpdate(listener:Function):void
Default method for adding a visibilityUpdated event listener
| Object3D | |
| applyPosition(dx:Number, dy:Number, dz:Number):void
Apply the given position to the object without altering the apperance of child objects
| Object3D | |
| applyRotations():void
Apply the local rotations to the object without altering the apperance of child objects
| Object3D | |
| centerPivot():void
Adjusts the pivot point of the object so that it lies at the center of it's geoemtry. | Object3D | |
|
Duplicates the 3d object's properties to another Object3D object
| Object3D | |
| distanceTo(obj:Object3D):Number
Calulates the absolute distance between the local 3d object position and the position of the given 3d object
| Object3D | |
| 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. | Object3D | |
| moveBackward(distance:Number):void
Moves the 3d object backwards along it's local z axis
| Object3D | |
| moveDown(distance:Number):void
Moves the 3d object backwards along it's local y axis
| Object3D | |
| moveForward(distance:Number):void
Moves the 3d object forwards along it's local z axis
| Object3D | |
| moveLeft(distance:Number):void
Moves the 3d object backwards along it's local x axis
| Object3D | |
| movePivot(dx:Number, dy:Number, dz:Number):void
Moves the local point around which the object rotates. | Object3D | |
| moveRight(distance:Number):void
Moves the 3d object forwards along it's local x axis
| Object3D | |
| moveTo(dx:Number, dy:Number, dz:Number):void
Moves the 3d object directly to a point in space
| Object3D | |
| moveUp(distance:Number):void
Moves the 3d object forwards along it's local y axis
| Object3D | |
pause():void
Pause playback. | Sound3D | ||
| pitch(angle:Number):void
Rotates the 3d object around it's local x-axis
| Object3D | |
play():void
Start (or resume, if paused) playback. | Sound3D | ||
| removeOnDimensionsChange(listener:Function):void
Default method for removing a dimensionschanged event listener
| Object3D | |
| removeOnMouseDown(listener:Function):void
Default method for removing a mouseDown3D event listener
| Object3D | |
| removeOnMouseMove(listener:Function):void
Default method for removing a mouseMove3D event listener
| Object3D | |
| removeOnMouseOut(listener:Function):void
Default method for removing a mouseOut3D event listener
| Object3D | |
| removeOnMouseOver(listener:Function):void
Default method for removing a mouseOver3D event listener
| Object3D | |
| removeOnMouseUp(listener:Function):void
Default method for removing a mouseUp3D event listener
| Object3D | |
| removeOnPositionChange(listener:Function):void
Default method for removing a positionchanged event listener
| Object3D | |
| removeOnRollOut(listener:Function):void
Default method for removing a rollOut3D event listener
| Object3D | |
| removeOnRollOver(listener:Function):void
Default method for removing a rollOver3D event listener
| Object3D | |
| removeOnScaleChange(listener:Function):void
Default method for removing a scalechanged event listener
| Object3D | |
| removeOnSceneChange(listener:Function):void
Default method for removing a scenechanged event listener
| Object3D | |
| removeOnSceneTransformChange(listener:Function):void
Default method for removing a scenetransformchanged event listener
| Object3D | |
| removeOnSessionChange(listener:Function):void
Default method for removing a sessionchanged event listener
| Object3D | |
| removeOnVisibilityUpdate(listener:Function):void
Default method for removing a visibilityUpdated event listener
| Object3D | |
| roll(angle:Number):void
Rotates the 3d object around it's local z-axis
| Object3D | |
| rotate(axis:Vector3D, angle:Number):void
Rotates the 3d object around an axis by a defined angle
| Object3D | |
| rotateTo(ax:Number, ay:Number, az:Number):void
Rotates the 3d object directly to a euler angle
| Object3D | |
| scale(scale:Number):void
Scales the contents of the 3d object. | Object3D | |
stop():void
Stop and rewind sound file. | Sound3D | ||
| tick(time:int):void
Called by the TickTraverser. | Object3D | |
togglePlayPause():void
Alternate between pausing and resuming playback of this sound. | Sound3D | ||
| toString():String [override]
Used to trace the values of a 3d object. | Object3D | |
| translate(axis:Vector3D, distance:Number):void
Moves the 3d object along a vector by a defined length
| Object3D | |
|
Used when traversing the scenegraph
| Object3D | |
| yaw(angle:Number):void
Rotates the 3d object around it's local y-axis
| Object3D | |
| paused | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespaused:Boolean [read-only] Returns a boolean indicating whether or not playback is currently paused.
public function get paused():Boolean| playing | property |
playing:Boolean [read-only] Returns a boolean indicating whether or not the sound is currently playing.
public function get playing():Boolean| scaleDistance | property |
scaleDistance:NumberDefines 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.
public function get scaleDistance():Number public function set scaleDistance(value:Number):voidSee also
| volume | property |
volume:NumberDefines 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.
public function get volume():Number public function set volume(value:Number):voidSee also
| Sound3D | () | Constructor |
public function 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.
Parameterssound: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) | |
init:Object (default = null) |
| pause | () | method |
public function pause():voidPause playback. Resume using play().
| play | () | method |
public function play():voidStart (or resume, if paused) playback.
| stop | () | method |
public function stop():voidStop 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
| togglePlayPause | () | method |
public function togglePlayPause():voidAlternate 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.