Class Group

constructor

• new Group(sounds?): Group

• Parameters

  • sounds: Sound[] = []

  Returns Group

loopCount

sounds

duration

• get duration(): number

• Returns number

isPlaying

• get isPlaying(): boolean

• A boolean indicating whether any of the sounds in the group are currently playing.

  Returns boolean

  True if any sound is playing, false otherwise.

playbackRate

• get playbackRate(): number

• Returns number

• set playbackRate(rate): void

• Parameters

  • rate: number

  Returns void

position

• get position(): [number, number, number]

• Returns [number, number, number]

• set position(position): void

• Parameters

  • position: [number, number, number]

  Returns void

volume

• get volume(): number

• Returns number

• set volume(volume): void

• Parameters

  • volume: number

  Returns void

addFilter

• addFilter(filter): void

• Adds a filter to all sounds in the group. Filters are cloned to playbacks, not shared.

  Parameters

  • filter: BiquadFilterNode

  Returns void

addSound

• addSound(sound): void

• Parameters

  • sound: Sound

  Returns void

fadeIn

• fadeIn(duration, type?): Promise<void>

• Parameters

  • duration: number
  • Optional type: FadeType

  Returns Promise<void>

fadeOut

• fadeOut(duration, type?): Promise<void>

• Parameters

  • duration: number
  • Optional type: FadeType

  Returns Promise<void>

fadeTo

• fadeTo(value, duration, type?): Promise<void>

• Parameters

  • value: number
  • duration: number
  • Optional type: FadeType

  Returns Promise<void>

loop

• loop(loopCount?): LoopCount

• Parameters

  • Optional loopCount: LoopCount

  Returns LoopCount

pause

• pause(): void

• Returns void

play

• play(): Playback[]

• Plays all sounds in the group.

  Returns Playback[]

  An array of Playback objects, one for each sound in the group.

playOrdered

• playOrdered(shouldLoop?): undefined | Playback

• Plays the sounds in the group in a specific order.

  Parameters

  • shouldLoop: boolean = true

    Indicates whether the sounds should be played in a loop.

  Returns undefined | Playback

  The playback object representing the first sound being played, or undefined if the group is empty.

playRandom

• playRandom(): undefined | Playback

• Plays a random sound from the group.

  Returns undefined | Playback

  The playback object representing the played sound, or undefined if the group is empty.

preplay

• preplay(): Playback[]

• Returns Playback[]

preplayOrdered

• preplayOrdered(shouldLoop?): undefined | Playback

• Prepares the sounds in the group for playback in a specific order.

  Parameters

  • shouldLoop: boolean = true

    Indicates whether the sounds should be prepared for looping.

  Returns undefined | Playback

  The playback object representing the first sound being prepared, or undefined if the group is empty.

preplayRandom

• preplayRandom(): undefined | Playback

• Prepares a random sound from the group for playback.

  Returns undefined | Playback

  The playback object representing the prepared sound, or undefined if the group is empty.

randomSound

• randomSound(): Sound

• Returns a random sound from the group.

  Returns Sound

  Throws

  Error if the group is empty.

removeFilter

• removeFilter(filter): void

• Removes a filter from all sounds in the group.

  Parameters

  • filter: BiquadFilterNode

  Returns void

routeTo

• routeTo(target, sendGain?): void

• Routes every sound in this group to the specified Bus (or back to master). Fans the call out to every member; see Sound.routeTo for full semantics. With a sendGain, adds a per-sound send instead of redirecting primary routing.

  Parameters

  • target: string | Bus
  • Optional sendGain: number

  Returns void

seek

• seek(time): void

• Parameters

  • time: number

  Returns void

stop

• stop(): void

• Stops all the sounds in the group.

  Returns void

stopWithFade

• stopWithFade(duration, type?): Promise<void>

• Parameters

  • duration: number
  • Optional type: FadeType

  Returns Promise<void>