Audio System

A system that manages your sounds based on Unity's audio system.

The audio system in the FPS Framework is built around audio profiles. These profiles are scriptable objects that carry all the essential data for a specific sound. They allow managing of how the sounds behave, giving you precise control over their functionality.

Creating and audio profile

To create an audio profile, follow these steps:

1. Right-click anywhere in your project.

2. Navigate to the Create menu.

3. Select Akila > FPS Framework > Audio Profile.

This will generate a new audio profile for you to configure. This is the menu to access:

Create audio profile menu

This is what you should see when your audio profile is created:

Newly created audio profile

Playing sounds

To use that audio profile you need a small code. Start by creating a new script and call it, AudioPlayerTest.

In the AudioPlayerTest, make sure to add the using text for FPS Framework like this:

using Akila.FPSFramework;

public class AudioPlayerTest : MonoBehaviour
{
    
}

Now add a refrence to that audio profile and an Audio object, like this:

//Audio profile to get info from
public AudioProfile Profile;

//Audio object to equip (Initialize) and play
public Audio _audio = new Audio();

The _audio class is the brain of your sound, it controls everything about it and makes every sound independent with its own audio source.

Before playing your sounds, you need to initialize them in the start method. This is how to initialize and audio object:

private void Start()
{
     //Initialize _audio by calling Equip.
     _audio.Equip(gameObject, Profile);
}

Now you can freely play your sound by calling Audio.Play() or Audio.PlayOneShot() like this:

public void PlaySound()
{
    //Play the sound with the settings of the local profile.
    _audio.Play(Profile);
}

Why use this system?

The audio system in the FPS Framework includes built-in tools to simulate sound variations by randomizing pitch, adding a layer of realism to your audio. Additionally, it provides custom events that can be triggered at specific points within a sound—whether at the midpoint, 30% in, or any other position—offering you complete control over when events are executed.

Understanding audio profiles

The fields at the beginning of the audio profile function identically to those of an AudioSource. For more detailed information, refer to Unity's official documentation on AudioSource.

Randomize pitch

To randomize the pitch, simply enable the "Dynamic Pitch" option in the audio profile settings.

Custom events

You can add events in unity editor to the "Custom Events" list or in code. If you set your custom event's "Location" to 0.1, the event will be invoked when the audio played 10% of its lenght, if you set it to 0.54 the event will be invoked at 54% of its lenght and so on.