Clayground Sound Module

The Clayground.Sound module provides cross-platform audio playback for games:

• Sound - For short sound effects (fire-and-forget, overlapping)
• Music - For background music (play/pause/stop/loop/seek)

Platform Support

Usage

Import the module:

import Clayground.Sound

Sound Effects

Use Sound for short audio like jumps, clicks, or explosions:

Sound {
    id: jumpSound
    source: "sounds/jump.wav"
    volume: 0.8
}

// Play sound (can overlap multiple times)
onPlayerJumped: jumpSound.play()

Background Music

Use Music for longer tracks with playback controls:

Music {
    id: bgMusic
    source: "music/theme.mp3"
    volume: 0.5
    loop: true
}

onGameStarted: bgMusic.play()
onGamePaused: bgMusic.pause()
onGameOver: bgMusic.stop()

Lazy Loading

By default, audio is preloaded when source is set. For memory optimization, enable lazy loading to defer loading until first play:

Sound {
    source: "sounds/rare_event.wav"
    lazyLoading: true  // Only loads when play() is called
}

Technical Notes

• Audio files are fully preloaded before playback (no streaming)
• WASM: Browser autoplay policies require user interaction before audio plays
• WASM: Remote URLs must have CORS headers enabled
• Desktop: Uses low-latency QSoundEffect for Sound, full-featured QMediaPlayer for Music