five-on-it / apps/client/src/audio/sound-player / PlayOptions

Interface: PlayOptions

Defined in: apps/client/src/audio/sound-player.ts:38

How a sound plays this once.

Properties

distance?

optional distance?: number

Defined in: apps/client/src/audio/sound-player.ts:44

How far away it is (m): a sound with a range fades to nothing at its range.

---

gain?

optional gain?: number

Defined in: apps/client/src/audio/sound-player.ts:40

A factor on its volume (by how loud the event is), 1 by default.

---

pan?

optional pan?: number

Defined in: apps/client/src/audio/sound-player.ts:46

Where it is, left (−1) to right (1).

---

rate?

optional rate?: number

Defined in: apps/client/src/audio/sound-player.ts:42

Its rate, 1 by default (a factor on the bank's pitch variation).