menu_bookDocumentation
MusicPlayer: Streaming Audio with Visualization and World-Space Positioning
MusicPlayer in s&box handles music tracks and streaming audio with programmatic control over playback, positioning, and visualization. For sound effects, use the Sound system instead.
Basic Playback
CSHARP
var music = MusicPlayer.Play( FileSystem.Mounted, "music/theme.ogg" );
music.Volume = 0.8f;
music.Repeat = true;URL Streaming
CSHARP
var music = MusicPlayer.PlayUrl( "https://example.com/stream.ogg" );World-Space Audio
By default MusicPlayer plays globally. To position it in 3D space:CSHARP
music.ListenLocal = false;
music.Position = WorldPosition;Audio Visualization
CSHARP
ReadOnlySpan<float> spectrum = music.Spectrum; // 512-element FFT magnitudes
float amplitude = music.Amplitude; // approximate loudnessSupported Formats
- Opus (.ogg, .opus, .webm) — recommended
- Vorbis (.ogg, .webm)
- FLAC (.flac)
- MP3 (.mp3)
- WAV/PCM (.wav)
- AAC (.mp4) — Windows only, not recommended
Was this helpful?