SecretLabNAudio
An advanced audio player API for SCP: Secret Laboratory using NAudio
SecretLabNAudio
An advanced audio player API for SCP: Secret Laboratory using NAudio
This library has a number of open-source dependencies. See Attributions
SecretLabNAudio is not sponsored nor endorsed by NAudio.
If you’re still using v1, migrate to v2
Features
- Fully customizable audio provider interfaces
- Real-time audio processing
- Streaming files from disk
- Resampling and downmixing
- Ogg Vorbis support using NVorbis
- MP3 support using NLayer
- Speaker personalization
- SpeakerToy pooling
- Automatic reader resolution by file type
- Cache for short audio clips
- Windows-only Media Foundation support for a wider range of formats, and decoding over the network
Installation
Single-File
- Download the
SecretLabNAudio.zipfile from the releases page - Extract
bin/SecretLabNAudio.dllfrom the archive into the global plugins directory- Linux:
~/.config/SCP Secret Laboratory/LabAPI/plugins/global/ - Windows:
%appdata%/SCP Secret Laboratory/LabAPI/plugins/global/
- Linux:
- Restart the server
The plugin must be placed in the global plugins directory to ensure that embedded dependencies are loaded. If you have a global plugin depending on SecretLabNAudio, rename it so it loads after SecretLabNAudio.
Modular
- Download the
SecretLabNAudio.Core.dllfile from the releases page - Download the
SecretLabNAudio.zipfile from the releases page - Extract the necessary DLLs from the
bin/directory- See the table below for what you need
- Place dependencies into the dependencies directory
- Linux:
~/.config/SCP Secret Laboratory/LabAPI/dependencies/<port>/ - Windows:
%appdata%/SCP Secret Laboratory/LabAPI/dependencies/<port>/
- Linux:
- Place plugins into the plugins directory
- Linux:
~/.config/SCP Secret Laboratory/LabAPI/plugins/<port>/ - Windows:
%appdata%/SCP Secret Laboratory/LabAPI/plugins/<port>/
- Linux:
- Restart the server
Modules
To support reading from some file formats, install the modules you need.
| Usage | Plugin | Dependencies |
|---|---|---|
| required | (none) | SecretLabNAudio.Core NAudio.Core |
| mp3 | SecretLabNAudio.NLayer |
NLayer NLayer.NAudioSupport |
| ogg | SecretLabNAudio.NVorbis |
NVorbis NAudio.Vorbis System.ValueTuple |
| most formats | SecretLabNAudio.MediaFoundation* |
NAudio.Wasapi* |
*MediaFoundation is only available on Windows.
Development
Simply install the SecretLabNAudio.Core package from NuGet.
Manual installation:
- Reference the
SecretLabNAudio.Core.dllfile from the releases page - Install the
NAudio.Corepackage from NuGet
Most official NAudio packages are Windows-specific. Use the NAudio.Core package for cross-platform support.
If you reference other NAudio packages, make sure you copy those dependencies to the LabAPI dependencies directory.
Author
Details
Published 7 months ago
Refreshed 54 minutes ago