public interface

IEnvironmentalReverb

implements IAudioEffect
com.h6ah4i.android.media.audiofx.IEnvironmentalReverb
Known Indirect Subclasses

Summary

Nested Classes
interface IEnvironmentalReverb.OnParameterChangeListener The OnParameterChangeListener interface defines a method called by the EnvironmentalReverb when a parameter value has changed. 
class IEnvironmentalReverb.Settings The Settings class regroups all environmental reverb parameters. 
Constants
int PARAM_DECAY_HF_RATIO Decay HF ratio.
int PARAM_DECAY_TIME Decay time.
int PARAM_DENSITY Density.
int PARAM_DIFFUSION Diffusion.
int PARAM_REFLECTIONS_DELAY Early reflections delay.
int PARAM_REFLECTIONS_LEVEL Early reflections level.
int PARAM_REVERB_DELAY Reverb delay.
int PARAM_REVERB_LEVEL Reverb level.
int PARAM_ROOM_HF_LEVEL Room HF level.
int PARAM_ROOM_LEVEL Room level.
[Expand]
Inherited Constants
From interface com.h6ah4i.android.media.audiofx.IAudioEffect
Public Methods
abstract short getDecayHFRatio()
Gets the ratio of high frequency decay time (at 5 kHz) relative to low frequencies.
abstract int getDecayTime()
Gets the decay time.
abstract short getDensity()
Gets the density level.
abstract short getDiffusion()
Gets diffusion level.
abstract IEnvironmentalReverb.Settings getProperties()
Gets the environmental reverb properties.
abstract int getReflectionsDelay()
Gets the reflections delay.
abstract short getReflectionsLevel()
Gets the volume level of the early reflections.
abstract int getReverbDelay()
Gets the reverb delay.
abstract short getReverbLevel()
Gets the reverb level.
abstract short getRoomHFLevel()
Gets the room HF level.
abstract short getRoomLevel()
Gets the master volume level of the environmental reverb effect.
abstract void setDecayHFRatio(short decayHFRatio)
Sets the ratio of high frequency decay time (at 5 kHz) relative to the decay time at low frequencies.
abstract void setDecayTime(int decayTime)
Sets the time taken for the level of reverberation to decay by 60 dB.
abstract void setDensity(short density)
Controls the modal density of the late reverberation decay.
abstract void setDiffusion(short diffusion)
Sets the echo density in the late reverberation decay.
abstract void setParameterListener(IEnvironmentalReverb.OnParameterChangeListener listener)
Registers an OnParameterChangeListener interface.
abstract void setProperties(IEnvironmentalReverb.Settings settings)
Sets the environmental reverb properties.
abstract void setReflectionsDelay(int reflectionsDelay)
Sets the delay time for the early reflections.
abstract void setReflectionsLevel(short reflectionsLevel)
Sets the volume level of the early reflections.
abstract void setReverbDelay(int reverbDelay)
Sets the time between the first reflection and the reverberation.
abstract void setReverbLevel(short reverbLevel)
Sets the volume level of the late reverberation.
abstract void setRoomHFLevel(short roomHF)
Sets the volume level at 5 kHz relative to the volume level at low frequencies of the overall reverb effect.
abstract void setRoomLevel(short room)
Sets the master volume level of the environmental reverb effect.
[Expand]
Inherited Methods
From interface com.h6ah4i.android.media.IReleasable
From interface com.h6ah4i.android.media.audiofx.IAudioEffect

Constants

public static final int PARAM_DECAY_HF_RATIO

Decay HF ratio. Parameter ID for OnParameterChangeListener

Constant Value: 3 (0x00000003)

public static final int PARAM_DECAY_TIME

Decay time. Parameter ID for OnParameterChangeListener

Constant Value: 2 (0x00000002)

public static final int PARAM_DENSITY

Density. Parameter ID for OnParameterChangeListener

Constant Value: 9 (0x00000009)

public static final int PARAM_DIFFUSION

Diffusion. Parameter ID for OnParameterChangeListener

Constant Value: 8 (0x00000008)

public static final int PARAM_REFLECTIONS_DELAY

Early reflections delay. Parameter ID for OnParameterChangeListener

Constant Value: 5 (0x00000005)

public static final int PARAM_REFLECTIONS_LEVEL

Early reflections level. Parameter ID for OnParameterChangeListener

Constant Value: 4 (0x00000004)

public static final int PARAM_REVERB_DELAY

Reverb delay. Parameter ID for OnParameterChangeListener

Constant Value: 7 (0x00000007)

public static final int PARAM_REVERB_LEVEL

Reverb level. Parameter ID for OnParameterChangeListener

Constant Value: 6 (0x00000006)

public static final int PARAM_ROOM_HF_LEVEL

Room HF level. Parameter ID for OnParameterChangeListener

Constant Value: 1 (0x00000001)

public static final int PARAM_ROOM_LEVEL

Room level. Parameter ID for OnParameterChangeListener

Constant Value: 0 (0x00000000)

Public Methods

public abstract short getDecayHFRatio ()

Gets the ratio of high frequency decay time (at 5 kHz) relative to low frequencies.

Returns
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract int getDecayTime ()

Gets the decay time.

Returns
  • the decay time in milliseconds.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getDensity ()

Gets the density level.

Returns
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getDiffusion ()

Gets diffusion level.

Returns
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract IEnvironmentalReverb.Settings getProperties ()

Gets the environmental reverb properties. This method is useful when a snapshot of current reverb settings must be saved by the application.

Returns
  • an IEnvironmentalReverb.Settings object containing all current parameters values
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract int getReflectionsDelay ()

Gets the reflections delay.

Returns
  • the early reflections delay in milliseconds.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getReflectionsLevel ()

Gets the volume level of the early reflections.

Returns
  • the early reflections level in millibels.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract int getReverbDelay ()

Gets the reverb delay.

Returns
  • the reverb delay in milliseconds.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getReverbLevel ()

Gets the reverb level.

Returns
  • the reverb level in millibels.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getRoomHFLevel ()

Gets the room HF level.

Returns
  • the room HF level in millibels.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract short getRoomLevel ()

Gets the master volume level of the environmental reverb effect.

Returns
  • the room level in millibels.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setDecayHFRatio (short decayHFRatio)

Sets the ratio of high frequency decay time (at 5 kHz) relative to the decay time at low frequencies.

Parameters
decayHFRatio high frequency decay ratio using a permille scale. The valid range is [100, 2000]. A ratio of 1000 indicates that all frequencies decay at the same rate.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setDecayTime (int decayTime)

Sets the time taken for the level of reverberation to decay by 60 dB.

Parameters
decayTime decay time in milliseconds. The valid range is [100, 20000].
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setDensity (short density)

Controls the modal density of the late reverberation decay.

The scale should approximately map linearly to the perceived change in reverberation. A lower density creates a hollow sound that is useful for simulating small reverberation spaces such as bathrooms.

Parameters
density density specified using a permille scale. The valid range is [0, 1000]. A value of 1000 o/oo indicates a natural sounding reverberation. Values below this level produce a more colored effect.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setDiffusion (short diffusion)

Sets the echo density in the late reverberation decay.

The scale should approximately map linearly to the perceived change in reverberation.

Parameters
diffusion diffusion specified using a permille scale. The diffusion valid range is [0, 1000]. A value of 1000 o/oo indicates a smooth reverberation decay. Values below this level give a more grainy character.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setParameterListener (IEnvironmentalReverb.OnParameterChangeListener listener)

Registers an OnParameterChangeListener interface.

Parameters
listener OnParameterChangeListener interface registered

public abstract void setProperties (IEnvironmentalReverb.Settings settings)

Sets the environmental reverb properties. This method is useful when reverb settings have to be applied from a previous backup.

Parameters
settings a IEnvironmentalReverb.Settings object containing the properties to apply
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setReflectionsDelay (int reflectionsDelay)

Sets the delay time for the early reflections.

This method sets the time between when the direct path is heard and when the first reflection is heard.

Parameters
reflectionsDelay reflections delay in milliseconds. The valid range is [0, 300].
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setReflectionsLevel (short reflectionsLevel)

Sets the volume level of the early reflections.

This level is combined with the overall room level (set using setRoomLevel(short)).

Parameters
reflectionsLevel reflection level in millibels. The valid range is [-9000, 1000].
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setReverbDelay (int reverbDelay)

Sets the time between the first reflection and the reverberation.

Parameters
reverbDelay reverb delay in milliseconds. The valid range is [0, 100].
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setReverbLevel (short reverbLevel)

Sets the volume level of the late reverberation.

This level is combined with the overall room level (set using setRoomLevel(short)).

Parameters
reverbLevel reverb level in millibels. The valid range is [-9000, 2000].
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setRoomHFLevel (short roomHF)

Sets the volume level at 5 kHz relative to the volume level at low frequencies of the overall reverb effect.

This controls a low-pass filter that will reduce the level of the high-frequency.

Parameters
roomHF high frequency attenuation level in millibels. The valid range is [-9000, 0].
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException

public abstract void setRoomLevel (short room)

Sets the master volume level of the environmental reverb effect.

Parameters
room room level in millibels. The valid range is [-9000, 0].
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalArgumentException
IllegalStateException