away3d.audio.Sound3D

Public Properties

	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 Returns the bounding radius of the 3d object	Object3D
		center : Array	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	Object3D
		debugBoundingSphere : WireSphere	Object3D
		debugbs : Boolean Indicates whether a debug bounding sphere should be rendered around the 3d object.	Object3D
		eulers : Number3D Defines the rotation of the 3d object as a `Number3D` 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	Object3D
		inverseSceneTransform : MatrixAway3D Returns the inverse of sceneTransform.	Object3D
		lightarray : ILightConsumer returns the array of lights contained inside the container.	Object3D
		materialLibrary : MaterialLibrary Reference container for all materials used in the container.	Object3D
		maxX : Number Returns the maximum x value of the 3d object	Object3D
		maxY : Number Returns the maximum y value of the 3d object	Object3D
		maxZ : Number Returns the maximum z value of the 3d object	Object3D
		minX : Number Returns the minimum x value of the 3d object	Object3D
		minY : Number Returns the minimum y value of the 3d object	Object3D
		minZ : Number 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 Boundary depth of the 3d object return The depth of the mesh	Object3D
		objectHeight : Number Boundary height of the 3d object return The height of the mesh	Object3D
		objectWidth : Number 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
		ownLights : Boolean Defines whether the children of the container are rendered using it's own lights.	Object3D
		ownSession : AbstractRenderSession 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 : Number3D Defines the local point around which the object rotates.	Object3D
		pivotZero : Boolean	Object3D
		playing : Boolean [read-only] Returns a boolean indicating whether or not the sound is currently playing.	Sound3D
		position : Number3D Defines the position of the 3d object, relative to the local coordinates of the parent `ObjectContainer3D`.	Object3D
		projectorType : String	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 : IPrimitiveConsumer 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 Returns the parent scene of the 3d object	Object3D
		scenePivotPoint : Number3D	Object3D
		scenePosition : Number3D Returns the position of the 3d object, relative to the global coordinates of the `Scene3D` object.	Object3D
		sceneTransform : MatrixAway3D 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 : AbstractRenderSession The render session used by the 3d object	Object3D
		transform : MatrixAway3D 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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined by
		ini : 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
		_pivotPoint : Number3D	Object3D

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined 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
		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
		addOnParentUpdate(listener:Function):void Default method for adding a parentupdated 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
		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
		addOnTransformChange(listener:Function):void Default method for adding a transformchanged 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
		clone(object:Object3D = null):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: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
		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
		removeOnParentUpdate(listener:Function):void Default method for removing a parentupdated 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
		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
		removeOnTransformChange(listener:Function):void Default method for removing a transformchanged event listener	Object3D
		roll(angle:Number):void Rotates the 3d object around it's local z-axis	Object3D
		rotate(axis:Number3D, 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 Used to trace the values of a 3d object.	Object3D
		translate(axis:Number3D, distance:Number):void Moves the 3d object along a vector by a defined length	Object3D
		traverse(traverser:Traverser):void Used when traversing the scenegraph	Object3D
		updateObject():void	Sound3D
		updateSession():void	Object3D
		yaw(angle:Number):void Rotates the 3d object around it's local y-axis	Object3D

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		updateDimensions():void	Object3D
		updateTransform():void	Object3D

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
dimensionsChanged	Dispatched when the bounding dimensions of the 3d object changes.	Object3D
mouseDown	Dispatched when a user presses the left hand mouse button while the cursor is over the 3d object.	Object3D
mouseMove	Dispatched when a user moves the cursor while it is over the 3d object.	Object3D
mouseOut	Dispatched when a user moves the cursor away from the 3d object.	Object3D
mouseOver	Dispatched when a user moves the cursor over the 3d object.	Object3D
mouseUp	Dispatched when a user releases the left hand mouse button while the cursor is over the 3d object.	Object3D
rollOut	Dispatched when a user rolls out of the 3d object.	Object3D
rollOver	Dispatched when a user rolls over the 3d object.	Object3D
sceneChanged	Dispatched when the parent scene of the 3d object changes.	Object3D
scenetransformChanged	Dispatched when the scene transform matrix of the 3d object changes.	Object3D
sessionChanged	Dispatched when the render session property of the 3d object changes.	Object3D
sessionUpdated	Dispatched when the render session property of the 3d object updates its contents.	Object3D
transformChanged	Dispatched when the local transform matrix of the 3d object changes.	Object3D

Property detail

paused

property

paused:Boolean [read-only]

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

Implementation
public function get paused():Boolean

playing

property

playing:Boolean [read-only]

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

Implementation
public function get playing():Boolean

scaleDistance

property

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

Away3D FP10 V3.5.0 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Sound3D		Properties \| Methods \| Events

Package	away3d.audio
Class	public class Sound3D
Inheritance	Sound3D Object3D flash.events.EventDispatcher

	`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.

	`'scaleDistance':Number` (default = 1000)
	`'volume':Number` (default = 1)