BroAudio
Quick StartScripting APIAsset Store
  • Overview
    • Introduction
    • Getting Started
    • Compatibility
  • Core Features
    • Library Manager
      • Create The Library
      • Design The Sound
        • 🔊Volume
        • 🎚️Fading
        • 🔁Looping
        • 🎲Randomization
        • 💪Velocity
        • 🎛️Spatial & Mix
    • Audio Player
      • Music Player
      • Dominator Player
    • Playback Group
    • Audio Effect
    • No-Code Components
      • Sound Source
      • Sound Volume
      • Spectrum Analyzer
    • Addressables
    • Customization
  • Designs
    • Audio Mixer
  • Tools
    • Audio Clip Editor
    • Audio Effect Editor
    • Useful Attrubutes
  • Reference
    • Scripting API
      • Class
        • BroAudio
        • SoundSource
        • BroAdvice
      • Interface
        • IAudioPlayer
        • IMusicPlayer
        • IPlayerEffect
        • IAutoResetWaitable
        • IAudioSourceProxy
      • Struct
        • SoundID
        • Effect
        • Fading
      • Enums
        • BroAudioType
        • EffectType
        • StopMode
        • Transition
        • Ease
    • Unity API Integration
    • Audio Terminology
    • Technical Details
  • Others
    • Release Notes
    • Known Issues
      • Duplicate SoundID Issue
    • Roadmap
    • Support & Contact
Powered by GitBook
On this page
  1. Reference
  2. Scripting API
  3. Struct

Effect

Parameters for setting effects.

Last updated 11 months ago

NameSpace
Accessibility

Ami.BroAudio

public

The constructor of this struct is internal. Please use the static factory method for creation. This design provides a more organized and consistent parameter configuration and method names with clearer meanings.

Public Static Factory Method

Method
Parameters
Description

HighPass

float frequency, float fadeTime, ease = .HighPassInEase

Create a effect and set its frequency at the given value. fadeTime: The time duration from 20Hz to the given frequency. ease(optional): the ease function that applies while fading the frequency

ResetHighPass

float fadeTime, ease = .HighPassOutEase

For resetting the effect (back to 20Hz). fadeTime: The time duration from the current frequency to 20Hz.

LowPass

float frequency, float fadeTime, ease = .LowPassInEase

Create a effect and set its frequency at the given value. fadeTime: The time duration from 22000Hz to the given frequency. ease(optional): the ease function that applies while fading the frequency

ResetLowPass

float frequency, float fadeTime, ease = .LowPassOutEase

For resetting the effect (back to 22000Hz). fadeTime: The time duration from the current frequency to 22000Hz.

Custom

string exposedParameterName, float value, float fadeTime, ease = .Linear

Create a custom effect. This is similar to using the , which requires adding an effect and exposing parameters in the AudioMixer. The only difference is that the effect referred to can only be applied to the 'Effect' track of BroAudioMixer, which can be set via .

Ease
BroAdvice
Ease
BroAdvice
Ease
BroAdvice
Ease
BroAdvice
Ease
Ease
UnityAPI AudioMixer.SetFloat()
AudioEffectEditor
High Pass Filter
High Pass Filter
Low Pass Filter
Low Pass Filter