Class Audio<NodeType>

Create a non-positional ( global ) Audio object. This uses the Web {@link Audio API}.

Example

// create an AudioListener and add it to the camera
const listener = new THREE.AudioListener();
camera.add(listener);
// create a global {@link Audio} source
const sound = new THREE.Audio(listener);
// load a sound and set it as the {@link Audio} object's buffer
const audioLoader = new THREE.AudioLoader();
audioLoader.load('sounds/ambient.ogg', function (buffer) {
    sound.setBuffer(buffer);
    sound.setLoop(true);
    sound.setVolume(0.5);
    sound.play();
});

See

Type Parameters

  • NodeType extends AudioNode = GainNode

Hierarchy (view full)

Constructors

constructor

Properties

animations autoplay buffer castShadow children context customDepthMaterial? customDistanceMaterial? detune duration filters frustumCulled gain hasPlaybackControl id isObject3D isPlaying layers listener loop loopEnd loopStart matrix matrixAutoUpdate matrixWorld matrixWorldAutoUpdate matrixWorldNeedsUpdate modelViewMatrix name normalMatrix offset parent playbackRate position quaternion receiveShadow renderOrder rotation scale source sourceType type up userData uuid visible DEFAULT_MATRIX_AUTO_UPDATE DEFAULT_MATRIX_WORLD_AUTO_UPDATE DEFAULT_UP

Methods

add addEventListener applyMatrix4 applyQuaternion attach clear clone connect copy disconnect dispatchEvent getDetune getFilter getFilters getLoop getObjectById getObjectByName getObjectByProperty getObjectsByProperty getOutput getPlaybackRate getVolume getWorldDirection getWorldPosition getWorldQuaternion getWorldScale hasEventListener localToWorld lookAt onAfterRender onAfterShadow onBeforeRender onBeforeShadow onEnded pause play raycast remove removeEventListener removeFromParent rotateOnAxis rotateOnWorldAxis rotateX rotateY rotateZ setBuffer setDetune setFilter setFilters setLoop setLoopEnd setLoopStart setMediaElementSource setMediaStreamSource setNodeSource setPlaybackRate setRotationFromAxisAngle setRotationFromEuler setRotationFromMatrix setRotationFromQuaternion setVolume stop toJSON translateOnAxis translateX translateY translateZ traverse traverseAncestors traverseVisible updateMatrix updateMatrixWorld updateWorldMatrix worldToLocal

Constructors

constructor

Properties

animations

animations: AnimationClip[]

Array with object's animation clips.

Default Value

[]

autoplay

autoplay: boolean

Whether to start playback automatically.

Default Value

false

buffer

buffer: null | AudioBuffer

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

Default Value

false

children

children: Object3D<Object3DEventMap>[]

Array with object's children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

context

context: AudioContext

The AudioContext of the listener given in the constructor.

OptionalcustomDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

Remarks

Can only be used in context of meshes.

Default Value

undefined

OptionalcustomDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

Default Value

undefined

detune

detune: number

Modify pitch, measured in cents. +/- 100 is a semitone. +/- 1200 is an octave.

Default Value

0

duration

duration: undefined | number

Overrides the duration of the audio. Same as the duration parameter of AudioBufferSourceNode.start().

Default Value

undefined to play the whole buffer.

filters

filters: AudioNode[]

Represents an array of AudioNodes. Can be used to apply a variety of low-order filters to create more complex sound effects. In most cases, the array contains instances of BiquadFilterNodes. Filters are set via THREE.Audio.setFilter | Audio.setFilter or THREE.Audio.setFilters | Audio.setFilters.

Default Value

[]

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

Default Value

true

gain

gain: GainNode

A GainNode created using AudioContext.createGain().

hasPlaybackControl

hasPlaybackControl: boolean

Whether playback can be controlled using the play(), pause() etc. methods.

Default Value

true

Readonlyid

id: number

Unique number for this Object3D instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

ReadonlyisObject3D

isObject3D

Flag to check if a given object is of type Object3D.

Remarks

This is a constant value

Default Value

true

isPlaying

isPlaying: boolean

Whether the Audio is currently playing.

Default Value

false

layers

layers: Layers

The layer membership of the object.

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.

Default Value

new THREE.Layers()

listener

listener: AudioListener

A reference to the listener object of this audio.

loop

loop: boolean

Default

false

loopEnd

loopEnd: number

Default

0

loopStart

loopStart: number

Default

0

matrix

matrix: Matrix4

The local transform matrix.

Default Value

new THREE.Matrix4()

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.

Default Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

Remarks

If the Object3D has no parent, then it's identical to the local transform .matrix.

Default Value

new THREE.Matrix4()

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates. When it isn't, then you have to maintain all matrices in the object and its children yourself.

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

Default Value

false

ReadonlymodelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

ReadonlynormalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

offset

offset: number

An offset to the time within the Audio buffer that playback should begin. Same as the offset parameter of AudioBufferSourceNode.start().

Default Value

0

parent

parent: null | Object3D<Object3DEventMap>

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

playbackRate

playbackRate: number

Speed of playback.

Default Value

1

Readonlyposition

position: Vector3

Object's local position.

Default Value

new THREE.Vector3() - that is (0, 0, 0).

Readonlyquaternion

quaternion: Quaternion

Object's local rotation as a Quaternion.

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

Default Value

false

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently.

Remarks

When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.

Default Value

0

Readonlyrotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

Readonlyscale

scale: Vector3

The object's local scale.

Default Value

new THREE.Vector3( 1, 1, 1 )

source

source: null | AudioScheduledSourceNode

An AudioBufferSourceNode created using AudioContext.createBufferSource().

sourceType

sourceType: string

Type of the Audio source.

Default Value

'empty'.

Readonlytype

type: string

A Read-only string to check if this object type.

Remarks

Sub-classes will update this value.

Default Value

Audio

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

userData

userData: Record<string, any>

An object that can be used to store custom data about the Object3D.

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

visible

visible: boolean

Object gets rendered if true.

Default Value

true

StaticDEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

Default Value

true

StaticDEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

Default Value

true

StaticDEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for DirectionalLight, HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

Default Value

new THREE.Vector3( 0, 1, 0)

Methods

add

  • add(...object): this

  • Adds another Object3D as child of this Object3D.

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be added

    See

addEventListener

applyMatrix4

  • applyMatrix4(matrix): void

  • Applies the matrix transform to the object and updates the object's position, rotation and scale.

    Parameters

    Returns void

applyQuaternion

  • applyQuaternion(quaternion): this

  • Applies the rotation represented by the quaternion to the object.

    Parameters

    Returns this

attach

  • attach(object): this

  • Adds a Object3D as a child of this, while maintaining the object's world transform.

    Parameters

    Returns this

    Remarks

    Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

    See

    add

clear

  • clear(): this

  • Removes all child objects.

    Returns this

clone

  • clone(recursive?): this

  • Returns a clone of this object and optionally all descendants.

    Parameters

    • Optionalrecursive: boolean

      If true, descendants of the object are also cloned. Default true

    Returns this

connect

  • connect(): this

  • Connect to the THREE.Audio.source | Audio.source

    Returns this

    Remarks

    This is used internally on initialisation and when setting / removing filters.

copy

  • copy(source, recursive?): this

  • Copy the given object into this object

    Parameters

    • source: this
    • Optionalrecursive: boolean

      If true, descendants of the object are also copied. Default true

    Returns this

    Remarks

    Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.

disconnect

  • disconnect(): this

  • Disconnect from the THREE.Audio.source | Audio.source

    Returns this

    Remarks

    This is used internally when setting / removing filters.

dispatchEvent

getDetune

  • getDetune(): number

  • Returns the detuning of oscillation in cents.

    Returns number

getFilter

  • getFilter(): AudioNode

  • Returns the first element of the filters array.

    Returns AudioNode

getFilters

  • getFilters(): AudioNode[]

  • Returns the filters array.

    Returns AudioNode[]

getLoop

  • getLoop(): boolean

  • Return the value of source.loop (whether playback should loop).

    Returns boolean

getObjectById

  • getObjectById(id): undefined | Object3D<Object3DEventMap>

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

    Returns undefined | Object3D<Object3DEventMap>

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    See

    id

getObjectByName

  • getObjectByName(name): undefined | Object3D<Object3DEventMap>

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching name.

    Parameters

    • name: string

      String to match to the children's Object3D.name property.

    Returns undefined | Object3D<Object3DEventMap>

    Remarks

    Note that for most objects the name is an empty string by default

getObjectByProperty

  • getObjectByProperty(name, value): undefined | Object3D<Object3DEventMap>

  • Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

    Parameters

    • name: string

      the property name to search for.

    • value: any

      value of the given property.

    Returns undefined | Object3D<Object3DEventMap>

getObjectsByProperty

  • getObjectsByProperty(name, value, optionalTarget?): Object3D<Object3DEventMap>[]

  • Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

    Parameters

    • name: string

      The property name to search for.

    • value: any

      Value of the given property.

    • OptionaloptionalTarget: Object3D<Object3DEventMap>[]

      target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).

    Returns Object3D<Object3DEventMap>[]

getOutput

  • getOutput(): NodeType

  • Return the gainNode.

    Returns NodeType

getPlaybackRate

  • getPlaybackRate(): number

  • Return the value of playbackRate.

    Returns number

getVolume

  • getVolume(): number

  • Return the current volume.

    Returns number

getWorldDirection

  • getWorldDirection(target): Vector3

  • Returns a vector representing the direction of object's positive z-axis in world space.

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

    Returns Vector3

getWorldPosition

  • getWorldPosition(target): Vector3

  • Returns a vector representing the position of the object in world space.

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

    Returns Vector3

getWorldQuaternion

  • getWorldQuaternion(target): Quaternion

  • Returns a quaternion representing the rotation of the object in world space.

    Parameters

    • target: Quaternion

      The result will be copied into this Quaternion.

    Returns Quaternion

getWorldScale

  • getWorldScale(target): Vector3

  • Returns a vector of the scaling factors applied to the object for each axis in world space.

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

    Returns Vector3

hasEventListener

  • hasEventListener<T>(type, listener): boolean

  • Checks if listener is added to an event type.

    Type Parameters

    Parameters

    Returns boolean

  • hasEventListener<T>(type, listener): boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

localToWorld

  • localToWorld(vector): Vector3

  • Converts the vector from this object's local space to world space.

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

    Returns Vector3

lookAt

  • lookAt(vector): void

  • Rotates the object to face a point in world space.

    Parameters

    • vector: Vector3

      A vector representing a position in world space to look at.

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

  • lookAt(x, y, z): void

  • Rotates the object to face a point in world space.

    Parameters

    • x: number

      Expects a Float

    • y: number

      Expects a Float

    • z: number

      Expects a Float

    Returns void

    Remarks

    This method does not support objects having non-uniformly-scaled parent(s).

onAfterRender

onAfterShadow

  • onAfterShadow(renderer, scene, shadowCamera, geometry, depthMaterial, group): void

  • An optional callback that is executed immediately after a 3D object is rendered to a shadow map.

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.

onBeforeRender

onBeforeShadow

  • onBeforeShadow(renderer, scene, shadowCamera, geometry, depthMaterial, group): void

  • An optional callback that is executed immediately before a 3D object is rendered to a shadow map.

    Parameters

    Returns void

    Remarks

    This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group.

onEnded

  • onEnded(): void

  • Called automatically when playback finished.

    Returns void

pause

  • pause(): this

  • If hasPlaybackControl is true, pauses playback.

    Returns this

play

  • play(delay?): this

  • If hasPlaybackControl is true, starts playback.

    Parameters

    • Optionaldelay: number

    Returns this

raycast

  • raycast(raycaster, intersects): void

  • Abstract (empty) method to get intersections between a casted ray and this object

    Parameters

    Returns void

    Remarks

    Subclasses such as Mesh, Line, and Points implement this method in order to use raycasting.

    See

    Raycaster

    Default Value

    () => {}

remove

  • remove(...object): this

  • Removes a Object3D as child of this Object3D.

    Parameters

    Returns this

    Remarks

    An arbitrary number of objects may be removed.

    See

    Group for info on manually grouping objects.

removeEventListener

removeFromParent

  • removeFromParent(): this

  • Removes this object from its current parent.

    Returns this

rotateOnAxis

  • rotateOnAxis(axis, angle): this

  • Rotate an object along an axis in object space.

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • angle: number

      The angle in radians. Expects a Float

    Returns this

    Remarks

    The axis is assumed to be normalized.

rotateOnWorldAxis

  • rotateOnWorldAxis(axis, angle): this

  • Rotate an object along an axis in world space.

    Parameters

    • axis: Vector3

      A normalized vector in world space.

    • angle: number

      The angle in radians. Expects a Float

    Returns this

    Remarks

    The axis is assumed to be normalized

rotateX

  • rotateX(angle): this

  • Rotates the object around x axis in local space.

    Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle): this

  • Rotates the object around y axis in local space.

    Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle): this

  • Rotates the object around z axis in local space.

    Parameters

    • angle: number

    Returns this

setBuffer

  • setBuffer(audioBuffer): this

  • Setup the source to the audioBuffer, and sets sourceType to 'buffer'.

    Parameters

    • audioBuffer: AudioBuffer

    Returns this

    Remarks

    If autoplay, also starts playback.

setDetune

  • setDetune(value): this

  • Defines the detuning of oscillation in cents.

    Parameters

    • value: number

      Expects a Float

    Returns this

setFilter

  • setFilter(filter): this

  • Applies a single filter node to the audio.

    Parameters

    • filter: AudioNode

    Returns this

setFilters

  • setFilters(value): this

  • Applies an array of filter nodes to the audio.

    Parameters

    • value: AudioNode[]

      Arrays of filters.

    Returns this

setLoop

  • setLoop(value): this

  • Set source.loop to value (whether playback should loop).

    Parameters

    • value: boolean

    Returns this

setLoopEnd

  • setLoopEnd(value): this

  • Set source.loopEnd to value.

    Parameters

    • value: number

      Expects a Float

    Returns this

setLoopStart

  • setLoopStart(value): this

  • Set source.loopStart to value.

    Parameters

    • value: number

      Expects a Float

    Returns this

setMediaElementSource

  • setMediaElementSource(mediaElement): this

  • Applies the given object of type HTMLMediaElement as the source of this audio.

    Parameters

    • mediaElement: HTMLMediaElement

    Returns this

    Remarks

    Also sets hasPlaybackControl to false.

setMediaStreamSource

  • setMediaStreamSource(mediaStream): this

  • Applies the given object of type MediaStream as the source of this audio.

    Parameters

    • mediaStream: MediaStream

    Returns this

    Remarks

    Also sets hasPlaybackControl to false.

setNodeSource

  • setNodeSource(audioNode): this

  • Setup the source to the audioBuffer, and sets sourceType to 'audioNode'.

    Parameters

    • audioNode: AudioScheduledSourceNode

    Returns this

    Remarks

    Also sets hasPlaybackControl to false.

setPlaybackRate

  • setPlaybackRate(value): this

  • If hasPlaybackControl is enabled, set the playbackRate to value.

    Parameters

    • value: number

      Expects a Float

    Returns this

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis, angle): void

  • Calls setFromAxisAngle(axis, angle) on the .quaternion.

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • angle: number

      Angle in radians. Expects a Float

    Returns void

setRotationFromEuler

setRotationFromMatrix

  • setRotationFromMatrix(m): void

  • Calls setFromRotationMatrix(m) on the .quaternion.

    Parameters

    • m: Matrix4

      Rotate the quaternion by the rotation component of the matrix.

    Returns void

    Remarks

    Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).

setRotationFromQuaternion

setVolume

  • setVolume(value): this

  • Set the volume.

    Parameters

    • value: number

      Expects a Float

    Returns this

stop

  • stop(): this

  • If hasPlaybackControl is enabled, stops playback.

    Returns this

toJSON

  • toJSON(meta?): any

  • Convert the object to three.js JSON Object/Scene format.

    Parameters

    • Optionalmeta: {
          geometries: any;
          images: any;
          materials: any;
          textures: any;
      }

      Object containing metadata such as materials, textures or images for the object.

      • geometries: any
      • images: any
      • materials: any
      • textures: any

    Returns any

translateOnAxis

  • translateOnAxis(axis, distance): this

  • Translate an object by distance along an axis in object space

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • distance: number

      The distance to translate. Expects a Float

    Returns this

    Remarks

    The axis is assumed to be normalized.

translateX

  • translateX(distance): this

  • Translates object along x axis in object space by distance units.

    Parameters

    • distance: number

      Expects a Float

    Returns this

translateY

  • translateY(distance): this

  • Translates object along y axis in object space by distance units.

    Parameters

    • distance: number

      Expects a Float

    Returns this

translateZ

  • translateZ(distance): this

  • Translates object along z axis in object space by distance units.

    Parameters

    • distance: number

      Expects a Float

    Returns this

traverse

  • traverse(callback): void

  • Executes the callback on this object and all descendants.

    Parameters

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

traverseAncestors

  • traverseAncestors(callback): void

  • Executes the callback on all ancestors.

    Parameters

    Returns void

    Remarks

    Note: Modifying the scene graph inside the callback is discouraged.

traverseVisible

  • traverseVisible(callback): void

  • Like traverse, but the callback will only be executed for visible objects

    Parameters

    Returns void

    Remarks

    Descendants of invisible objects are not traversed.

updateMatrix

  • updateMatrix(): void

  • Updates local transform.

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?): void

  • Updates the global transform of the object. And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.

    Parameters

    • Optionalforce: boolean

      A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame. Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.

    Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents, updateChildren): void

  • Updates the global transform of the object.

    Parameters

    • updateParents: boolean

      Recursively updates global transform of ancestors.

    • updateChildren: boolean

      Recursively updates global transform of descendants.

    Returns void

worldToLocal

  • worldToLocal(vector): Vector3

  • Converts the vector from world space to this object's local space.

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

    Returns Vector3

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
addaddEventListenerapplyMatrix4applyQuaternionattachclearcloneconnectcopydisconnectdispatchEventgetDetunegetFiltergetFiltersgetLoopgetObjectByIdgetObjectByNamegetObjectByPropertygetObjectsByPropertygetOutputgetPlaybackRategetVolumegetWorldDirectiongetWorldPositiongetWorldQuaterniongetWorldScalehasEventListenerlocalToWorldlookAtonAfterRenderonAfterShadowonBeforeRenderonBeforeShadowonEndedpauseplayraycastremoveremoveEventListenerremoveFromParentrotateOnAxisrotateOnWorldAxisrotateXrotateYrotateZsetBuffersetDetunesetFiltersetFilterssetLoopsetLoopEndsetLoopStartsetMediaElementSourcesetMediaStreamSourcesetNodeSourcesetPlaybackRatesetRotationFromAxisAnglesetRotationFromEulersetRotationFromMatrixsetRotationFromQuaternionsetVolumestoptoJSONtranslateOnAxistranslateXtranslateYtranslateZtraversetraverseAncestorstraverseVisibleupdateMatrixupdateMatrixWorldupdateWorldMatrixworldToLocal