sounds & feedback

the audio API supports built-in sounds, custom note patterns and packaged WAV files, with playback controlled by the user's preferences.

API 1 · SDK 1.0.2download reference

catalogue and instruments

add audio to your manifest capabilities to use type, delete, invalid, reveal, win, fail, round, results, tick, peerWin and podium sounds. custom patterns support the wood, bell and sine instruments used by Wordle. the host automatically plays sounds for starting, joining and stopping a game.

1
2
3
4
5
6
7
8
9
10const chime = game.audio.chime([523, 659, 784], {
  instrument: "bell", step: 0.1, length: 0.22, level: 0.06
});
// inside your existing button click handler:
game.audio.unlock();
try {
  await game.audio.play(chime);
} catch {
  // sound is optional; keep the game playable.
}

packaged sounds

place PCM WAV files in assets/ and pass an asset name such as 'asset:finish.wav' to game.audio.play. clips can be mono or stereo and last up to ten seconds. note patterns can contain up to 16 notes, last up to four seconds and use frequencies between 40 and 4000Hz. playback respects host mute, volume, app visibility and voice limits. minimized games can continue playing sounds while the app is visible. sounds blocked by these controls are discarded.

accessible feedback

haptics('light' | 'success' | 'error') respects supported devices and preferences. announce(text) provides a short screen-reader announcement. honor reduced motion and do not convey results through sound or color alone.