Quickstart Guide
Premium Sound Design for Indie Developers
Workflow Overview
Go from zero to deployment in under 10 minutes. Follow this five-step pipeline to integrate SoundScape into your Unity or Unreal project without breaking your existing audio routing.
1. Authenticate & Link Workspace
Generate an API key in your dashboard. Paste it into the SoundScape Unity/Unreal plugin under `Edit > Preferences > SoundScape`. The client will fetch your `v2.4.1` DSP chain definition automatically.
2. Configure the Master Bus
Route your game’s main audio output to the `SS_Master` bus. Enable `Dynamic Range Compression` and set the limiter threshold to `-1.5 LUFS` to match broadcast standards for indie titles.
3. Import Stem Packs
Drag your `.wem` or `.ogg` stems into the `Assets/SoundScape/Import` folder. The batch processor will normalize peaks to `-3 dBFS` and strip metadata automatically.
4. Map Triggers & Events
Use the NodeGraph editor to link gameplay states to sound events. Assign `Footstep_Concrete`, `UI_Click_Soft`, and `Ambient_Wind_Loop` to your controller blueprints using the generated C# wrapper.
5. Compile & Deploy
Hit `Build Audio Bank`. The system will package assets into a single `.ssbank` file optimized for mobile and desktop. Drop it into your project’s streaming folder and ship.
Keyboard Shortcuts & Workflow Optimization
Speed up your sound design pipeline. These native shortcuts work across the SoundScape desktop client and web editor.
Navigation & Playback
`Space` to toggle transport. `Alt + Left/Right` to skip by bar. `Ctrl + Z` for multi-track undo. `F` to frame-select the active clip.
Editing & DSP
`E` to open the spectral editor. `Shift + R` to apply the `Room_Reverb_Default` preset. `Ctrl + M` to mute/unmute stems instantly.
Export & Sync
`Ctrl + Shift + E` to trigger batch export. `Tab` to preview the last render. `Ctrl + S` syncs changes to your cloud workspace in under 200ms.
API Basics for Programmatic Control
Automate asset generation, manage licensing, and trigger real-time audio analysis directly from your build server or CI/CD pipeline.
All endpoints require a Bearer token in the `Authorization` header. Base URL: `https://api.soundscape.dev/v2`.
Asset Upload & Processing
`POST /assets/upload` accepts multipart/form-data. Returns a `job_id` for async processing. Poll `GET /jobs/{job_id}` until `status` returns `completed`. Supported formats: WAV (24-bit), OGG, FLAC.
Licensing & Entitlements
`GET /licenses/verify?project_id=proj_8821` checks seat availability. Responds with `{"valid": true, "expires_at": "2025-12-31T23:59:59Z"}`. Rate limited to 60 requests per minute.
Real-Time Analysis
`POST /analysis/loudness` streams PCM buffers and returns integrated LUFS, True Peak, and spectral centroid data. Use `Content-Type: application/octet-stream` for raw audio payloads.
Refer to the OpenAPI specification for complete schema definitions and error codes. Sandbox credentials are available in your developer console.