Audio Effect

Introduction

Audio effects can enhance the immersion and fun of your game. BroAudio supports all the built-in effects of the Unity Audio Mixer and allows dynamic adjustment of all parameters during gameplay.

How To Use

Create an 'Effect' data struct

To trigger an audio effect at runtime, you need to create an 'Effect' struct with the parameter values via the static factory methods. This data will be passed as a parameter to the SetEffect APIs.

// Create high pass filter and low pass filter effect
Effect highPassFilter = Effect.HighPass(highPassFrequency, fadeTime);
Effect lowPassFilter = Effect.LowPass(lowPassFrequency, fadeTime);

//Create a custom effect
Effect reverbEffect = Effect.Custom("exposedParameter", value, fadeTime);
//The custom effect and "exposedParameter" must be created and available in BroAudioMixer.

BroAudio.SetEffect(Effect, BroAudioType)

Common use cases and API examples:

When the player is underwater

Effect lowPassFilter = Effect.LowPass(freq, fadeTime);
BroAudio.SetEffect(lowPassFilter, BroAudioType.SFX | BroAudioType.Ambience); 

// Or write it in one line!
BroAudio.SetEffect(Effect.LowPass(freq, fadeTime)); 

// If the BroAudioType is not specified, it will apply to all.

Add more effect

Bro Audio only offers two initial effects, but you can add more! However, since BroAudio has already set up a comprehensive audio mixer with numerous Exposed Parameters, editing it directly through Unity's Audio Mixer Window can be challenging.

Therefore, it's highly recommended to use the 'Audio Effect Editor' to add more effect. It lets you focus on the 'Effect' track and only displays the Exposed Parameters of the Audio Effects.

Limitation

Currently, BroAudio only provides one Effect track, so it's not possible to add different Effects to various sounds individually. More versatile and powerful Audio Effect features are still in development. Please be patient, and feel free to provide feedback, suggestions, or support to BroAudio, helping expedite the release of this feature.