FinalEngine.Audio 2023.4.0-pre

FinalEngine.Audio

FinalEngine.Audio provides interfaces and abstractions to be used when handling audio within Final Engine. If you are looking for an implementation of the interfaces described in this package we currently have support for the following APIs:

• CASL - OpenAL
• More coming soon...

Getting started

Below you'll find instructions on how to take advantage of this package. Please note that Final Engine is in active development and a full release is still underway.

Prerequisites

First, you'll need to install an additional NuGet dependency that implements the interfaces and abstractions provided by this package (such as CASL - OpenAL or design your own implementation using a different API such as FMOD or TinySound.

Additionally, if you plan on loading sounds using IResourceManager you might have to install FinalEngine.Extensions.Resources as it contains a SoundResourceLoader used to load sound resources. This isn't necessarily required but will make your life easier.

Usage

Once the additional dependencies have been resolved you can now create a sound using the resource loader or create an OpenALSound object directly:

// Somewhere in your initialization/load content logic.
var sound = new OpenALSound("sound.mp3");

// Or, use the resource manager.
var sound2 = ResourceManager.Instance.LoadResource<ISound>("sound2.mp3");

Additional documentation

This package is provided as a standalone package to encourage a non-monolithic approach to developing your game. The developers of Final Engine encourage the use of the resource manager found in FinalEngine.Resources to handle the lifetime of an ISound resource.

Feedback

Want to provide feedback? Perhaps you have a found a bug or wish to provide a feature request? Look no further!

• GitHub
• Discord