Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SoundDriver

Play sounds

Hierarchy

  • SoundDriver

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

ctx

ctx: AudioContext

mixer

mixer: GainNode

Accessors

volume

  • get volume(): number
  • set volume(v: number): void

  • Volume for the mixer, between 0 and 1

    Returns number

  • Volume for the mixer, between 0 and 1

    Parameters

    • v: number

    Returns void

Methods

play

  • play(audio: AudioBuffer, time?: number, loop?: boolean): AudioBufferSourceNode

  • play a sound

    example
    import { SoundDriver } from "toupie";
    const sdrive = new SoundDriver();
    const jumpSound: AudioBuffer = ...;
    sdrive.play(jumpSound);

    Parameters

    • audio: AudioBuffer

      sound data as obtained from a loader

    • time: number = 0

      length to play in seconds, or 0 to play to the end

    • loop: boolean = false

      if true, the track loops

    Returns AudioBufferSourceNode

stop

  • stop(source: AudioBufferSourceNode, time?: number): SoundDriver

  • Parameters

    • source: AudioBufferSourceNode
    • time: number = 0

    Returns SoundDriver

Generated using TypeDoc