Class AudioSourceNode

Scene node that can play audio. Can be either spatial or global.

Hierarchy (View Summary)

SceneNode
- AudioSourceNode

Index

Constructors

constructor

new AudioSourceNode(
    scene: IScene,
    name: string,
    parent?: SceneNode,
): AudioSourceNode
No description provided.
Parameters
- scene: IScene
- name: string
- Optionalparent: SceneNode
Returns AudioSourceNode

Overrides SceneNode.constructor

Properties

global

global: boolean

Whether this audio source is global. Global audio sources are not affected spatially and always play at a constant volume. Often used for audio like music and UI sound effects. Default: false.

maxRange

maxRange: number

(Spatial audio sources only) The range at which audio can no longer be heard. When the listener is further away than minRange, any audio will be played at 0% volume. Default: 30.

minRange

minRange: number

(Spatial audio sources only) The range at which audio volume starts to attenuate. When the listener is closer than minRange, any audio is played at max volume. Default: 0.

name

name: string

No description provided.

`Protected`scene

scene: IScene

No description provided.

Accessors

absolutePosition

get absolutePosition(): Vector3

No description provided.

Returns Vector3

Inherited from SceneNode.absolutePosition
set absolutePosition(value: Vector3): void
No description provided.
Parameters
- value: Vector3
Returns void

Inherited from SceneNode.absolutePosition

absoluteRotation

get absoluteRotation(): Rotation

No description provided.

Returns Rotation

Inherited from SceneNode.absoluteRotation

absoluteScale

get absoluteScale(): Vector3

No description provided.

Returns Vector3

Inherited from SceneNode.absoluteScale
set absoluteScale(value: Vector3): void
No description provided.
Parameters
- value: Vector3
Returns void

Inherited from SceneNode.absoluteScale

isPlaying

get isPlaying(): boolean

No description provided.

Returns boolean

parent

get parent(): SceneNode | undefined

No description provided.

Returns SceneNode | undefined

Inherited from SceneNode.parent
set parent(value: SceneNode | undefined): void
No description provided.
Parameters
- value: SceneNode | undefined
Returns void

Inherited from SceneNode.parent

position

get position(): Vector3

No description provided.

Returns Vector3

Inherited from SceneNode.position
set position(value: Vector3): void
No description provided.
Parameters
- value: Vector3
Returns void

Inherited from SceneNode.position

rotation

get rotation(): Rotation

No description provided.

Returns Rotation

Inherited from SceneNode.rotation

scale

get scale(): Vector3

No description provided.

Returns Vector3

Inherited from SceneNode.scale
set scale(value: Vector3): void
No description provided.
Parameters
- value: Vector3
Returns void

Inherited from SceneNode.scale

volume

get volume(): number

No description provided.

Returns number
set volume(value: number): void
No description provided.
Parameters
- value: number
Returns void

worldMatrix

get worldMatrix(): Matrix4

No description provided.

Returns Matrix4

Inherited from SceneNode.worldMatrix

worldMatrixComputed

get worldMatrixComputed(): Computed<Matrix4>

No description provided.

Returns Computed<Matrix4>

Inherited from SceneNode.worldMatrixComputed

Methods

destroy

destroy(): void

No description provided.

Returns void

Inherited from SceneNode.destroy

findChild

findChild(
fn: (child: SceneNode) => boolean,
recursive?: boolean,
): SceneNode | undefined
No description provided.
Parameters
- fn: (child: SceneNode) => boolean
  - (child: SceneNode): boolean
    
    No description provided.
    
    Parameters
    
    child: SceneNode
    
    Returns boolean
- Optionalrecursive: boolean
Returns SceneNode | undefined

Inherited from SceneNode.findChild

forEachChild

forEachChild(fn: (child: SceneNode) => void, recursive?: boolean): void
Execute a callback function for each child node of this node.
Parameters
- fn: (child: SceneNode) => void
  The callback function to execute for each child
  - (child: SceneNode): void
    
    No description provided.
    
    Parameters
    
    child: SceneNode
    
    Returns void
- Optionalrecursive: boolean
  Whether to iterate recursively through the entire hierarchy or just this SceneNode's direct children.
Returns void

Inherited from SceneNode.forEachChild

onUpdate

onUpdate(_dt: number, _time: number): void
Called each frame to update this node's state. Override this method in subclasses to implement per-frame update logic.
Parameters
- _dt: number
  The time elapsed since the last frame, in seconds
- _time: number
  Arbitrary number that increases in real time.
Returns void

Overrides SceneNode.onUpdate

playClip

playClip(audioClip: AudioClip, options?: PlayClipOptions): void
No description provided.
Parameters
- audioClip: AudioClip
- Optionaloptions: PlayClipOptions
Returns void

stopPlaying

stopPlaying(): void

No description provided.

Returns void

Class AudioSourceNode

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AudioSourceNode

Properties

global

maxRange

minRange

name

Protectedscene

Accessors

absolutePosition

Returns Vector3

Parameters

Returns void

absoluteRotation

Returns Rotation

absoluteScale

Returns Vector3

Parameters

Returns void

isPlaying

Returns boolean

parent

Returns SceneNode | undefined

Parameters

Returns void

position

Returns Vector3

Parameters

Returns void

rotation

Returns Rotation

scale

Returns Vector3

Parameters

Returns void

volume

Returns number

Parameters

Returns void

worldMatrix

Returns Matrix4

worldMatrixComputed

Returns Computed<Matrix4>

Methods

destroy

Returns void

findChild

Parameters

Parameters

Returns boolean

Returns SceneNode | undefined

forEachChild

Parameters

Parameters

Returns void

Returns void

onUpdate

Parameters

Returns void

playClip

Parameters

Returns void

stopPlaying

Returns void

Settings

On This Page

`Protected`scene