Taos API Reference
    Preparing search index...

    Class AudioSource

    Plays a sound that tracks its GameObject's world position. A thin component wrapper over AudioEngine.playAt: each frame it pushes the object's world translation into the live SoundHandle's panner, so the sound moves with the object.

    const src = bee.addComponent(new AudioSource(audio, { clip: buzz, loop: true }));
    src.play();

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    id: string = ...

    Stable identity for this component, unique within a session. Auto-generated for runtime-created components; the editor overwrites it with a persistent id when projecting a saved document so references survive save / load / undo.

    gameObject: GameObject

    The owning GameObject; assigned by addComponent before onAttach runs.

    clip: AudioClip | null

    The clip to play on play.

    bus: BusName

    Bus to route through.

    loop: boolean

    Loop until stopped.

    volume: number

    Per-voice volume.

    playbackRate: number

    Playback rate / pitch.

    spatial: boolean

    When true, the source is positioned in 3D; otherwise it plays flat.

    spatialOptions: SpatialOptions | undefined

    Panner tuning when spatial.

    Accessors

    • get time(): Time

      The simulation clock of the scene this component belongs to. Read inside update (or any time after the GameObject is added to a scene) for absolute time, frame count, FPS, and timeScale-aware delta — e.g. this.time.elapsed, this.time.delta, this.time.frameCount.

      this.time.delta equals the dt argument passed to update, so components can ignore that argument entirely and pull everything from here.

      Returns Time

      if the owning GameObject is not currently part of a scene.

    Methods

    • Called every frame by the GameObject's render traversal, after update and any input/controller mutations to the transform. Override to refresh per-frame state that render passes consume (e.g. Camera recomputes its cached view/projection matrices here).

      Parameters

      • _ctx: RenderContext

        Active render context (provides canvas width/height etc.).

      Returns void