SecretLabNAudio

An advanced audio player API for SCP: Secret Laboratory using NAudio

This library has a number of open-source dependencies. See Attributions

Note

SecretLabNAudio is not sponsored nor endorsed by NAudio.

Features

Watch the demo

• 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

Tip

Check the wiki for more information.

Installation

Single-File

1. Download the SecretLabNAudio.zip file from the releases page
2. Extract bin/SecretLabNAudio.dll from the archive into the global plugins directory
   • Linux: .config/SCP Secret Laboratory/LabAPI/plugins/global/
   • Windows: %appdata%/SCP Secret Laboratory/LabAPI/plugins/global/
3. Restart the server

Important

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

1. Download the SecretLabNAudio.Core.dll file from the releases page
2. Place the file in the dependencies directory
   • Linux: .config/SCP Secret Laboratory/LabAPI/dependencies/<port>/
   • Windows: %appdata%/SCP Secret Laboratory/LabAPI/dependencies/<port>/
3. Download the SecretLabNAudio.zip file from the releases page
4. Extract the necessary files from the bin/ directory of the archive as dependencies
   • NAudio.Core.dll is always required
   • NLayer and NLayer.NAudioSpport.dll for .mp3 support (optional)
   • NAudio.Vorbis.dll and NVorbis.dll for .ogg support (optional)
   • NAudio.Wasapi.dll for Media Foundation support (optional, WIndows-only)
5. Optionally download the necessary plugin(s) from the releases page
   • SecretLabNAudio.NLayer.dll for .mp3 support
   • SecretLabNAudio.NVorbis.dll for .ogg support
   • SecretLabNAudio.MediaFoundation.dll for Media Foundation support (Windows-only)
6. Place the downloaded plugin(s) into the plugins directory
   • Linux: .config/SCP Secret Laboratory/LabAPI/plugins/<port>/
   • Windows: %appdata%/SCP Secret Laboratory/LabAPI/plugins/<port>/
7. Restart the server

Development

Simply install the SecretLabNAudio.Core package from NuGet.

Manual installation:

1. Reference the SecretLabNAudio.Core.dll file from the releases page
2. Install the NAudio.Core package from NuGet

Caution

Most official NAudio packages are Windows-specific. Use the NAudio.Core package for cross-platform support.

Important

If you reference other NAudio packages, make sure you copy those dependencies to the LabAPI dependencies directory.