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
  • Description
  • Public Methods
  1. Reference
  2. Scripting API
  3. Interface

IPlayerEffect

The interface of Dominator Player feature

Last updated 1 year ago

NameSpace
Accessibility

Ami.BroAudio

public

Description

This is returned by the method. It's basically the same as , but it includes 3 new methods and excludes the AsDominator() method.

Public Methods

Method
Return
Parameters
Description

QuietOthers

float othersVolume, float fadeTime =

While this audio player is playing, the volume of other audio players will be lowered to the given volume

float othersVolume, Fading fading

Same as above, but can provide a custom fading setting

LowPassOthers

float frequency = , float fadeTime =

While this audio player is playing, a lowpass filter will be added to other audio players (i.e. their higher frequencies will be cutted off)

float frequency, Fading fading

Same as above, but can provide a custom fading setting

HighPassOthers

float frequency = , float fadeTime =

While this audio player is playing, a highpass filter will be added to other audio players (i.e. their lower frequencies will be cutted off)

float frequency, Fading fading

Same as above, but can provide a custom fading setting

AsDominator()
IAudioPlayer
IPlayerEffect
0.5f
IPlayerEffect
300f
0.5f
IPlayerEffect
2000f
0.5f