Class ChorusEffect

java.lang.Object
com.blackrook.gloop.openal.OALObject
com.blackrook.gloop.openal.OALEffect
com.blackrook.gloop.openal.effect.ChorusEffect
public class ChorusEffect extends OALEffect
Chorus effect for sound sources.
Author:
Matthew Tropiano

  • Field Details

    • waveForm

      protected ChorusEffect.WaveForm waveForm
      Chorus waveform type.

    • phase

      protected int phase
      Chorus phase in degrees.

    • rate

      protected float rate
      Chorus rate in Hz.

    • depth

      protected float depth
      Chorus depth.

    • feedback

      protected float feedback
      Chorus feedback.

    • delay

      protected float delay
      Chorus delay in seconds.

  • Constructor Details

    • ChorusEffect

      public ChorusEffect(OALContext context)

  • Method Details

    • getDelay

      public final float getDelay()
      Returns:
      this effect's delay in seconds.

    • setDelay

      public final void setDelay(float delay)
      Sets this effect's delay in seconds (0.0 to 0.016).
      Parameters:
      delay - the new value.

    • getDepth

      public final float getDepth()
      Returns:
      this effect's depth.

    • setDepth

      public final void setDepth(float depth)
      Sets this effect's depth (0.0 to 1.0).
      Parameters:
      depth - the new value.

    • getFeedback

      public final float getFeedback()
      Returns:
      this effect's feedback.

    • setFeedback

      public final void setFeedback(float feedback)
      Sets this effect's feedback (-1.0 to 1.0).
      Parameters:
      feedback - the new value.

    • getPhase

      public final int getPhase()
      Returns:
      this effect's phase in degrees.

    • setPhase

      public final void setPhase(int phase)
      Sets this effect's phase in degrees (-180 to 180).
      Parameters:
      phase - the new value.

    • getRate

      public final float getRate()
      Returns:
      this effect's rate in Hz.

    • setRate

      public final void setRate(float rate)
      Sets this effect's rate in Hz (0.0 to 10.0).
      Parameters:
      rate - the new value.

    • getWaveForm

      public final ChorusEffect.WaveForm getWaveForm()
      Returns:
      this effect's waveform type.

    • setWaveForm

      public final void setWaveForm(ChorusEffect.WaveForm waveForm)
      Sets this effect's waveform type.
      Parameters:
      waveForm - the waveform enumerant.