Class FlangerEffect
java.lang.Object
com.blackrook.gloop.openal.OALObject
com.blackrook.gloop.openal.OALEffect
com.blackrook.gloop.openal.effect.FlangerEffect
Flanger effect for sound sources.
- Author:
- Matthew Tropiano
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected floatFlanger delay in seconds.protected floatFlanger depth.protected floatFlanger feedback.protected intFlanger phase in degrees.protected floatFlanger rate in Hz.protected FlangerEffect.WaveFormFlanger waveform type. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal floatgetDelay()final floatgetDepth()final floatfinal intgetPhase()final floatgetRate()final FlangerEffect.WaveFormfinal voidsetDelay(float delay) Sets this effect's delay in seconds (0.0 to 0.004).final voidsetDepth(float depth) Sets this effect's depth (0.0 to 1.0).final voidsetFeedback(float feedback) Sets this effect's feedback (-1.0 to 1.0).final voidsetPhase(int phase) Sets this effect's phase in degrees (-180 to 180).final voidsetRate(float rate) Sets this effect's rate in Hz (0.0 to 10.0).final voidsetWaveForm(FlangerEffect.WaveForm waveForm) Sets this effect's waveform type.Methods inherited from class OALObject
clearError, destroy, equals, equals, errorCheck, getName, hashCode, requestContext, toString
-
Field Details
-
waveForm
Flanger waveform type. -
phase
protected int phaseFlanger phase in degrees. -
rate
protected float rateFlanger rate in Hz. -
depth
protected float depthFlanger depth. -
feedback
protected float feedbackFlanger feedback. -
delay
protected float delayFlanger delay in seconds.
-
-
Constructor Details
-
FlangerEffect
-
-
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.004).- 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
- Returns:
- this effect's waveform type.
-
setWaveForm
Sets this effect's waveform type.- Parameters:
waveForm- the waveform enumerant.
-