| java.lang.Object | ||
| ↳ | android.media.audiofx.AudioEffect | |
| ↳ | android.media.audiofx.EnvironmentalReverb | |
A sound generated within a room travels in many directions. The listener first hears the direct
sound from the source itself. Later, he or she hears discrete echoes caused by sound bouncing off
nearby walls, the ceiling and the floor. As sound waves arrive after undergoing more and more
reflections, individual reflections become indistinguishable and the listener hears continuous
reverberation that decays over time.
Reverb is vital for modeling a listener's environment. It can be used in music applications
to simulate music being played back in various environments, or in games to immerse the
listener within the game's environment.
The EnvironmentalReverb class allows an application to control each reverb engine property in a
global reverb environment and is more suitable for games. For basic control, more suitable for
music applications, it is recommended to use the
PresetReverb class.
An application creates a EnvironmentalReverb object to instantiate and control a reverb engine in the audio framework.
The methods, parameter types and units exposed by the EnvironmentalReverb implementation are directly mapping those defined by the OpenSL ES 1.0.1 Specification (http://www.khronos.org/opensles/) for the SLEnvironmentalReverbItf interface. Please refer to this specification for more details.
The EnvironmentalReverb is an output mix auxiliary effect and should be created on Audio session 0. In order for a MediaPlayer or AudioTrack to be fed into this effect, they must be explicitely attached to it and a send level must be specified. Use the effect ID returned by getId() method to designate this particular effect when attaching it to the MediaPlayer or AudioTrack.
Creating a reverb on the output mix (audio session 0) requires permission
MODIFY_AUDIO_SETTINGS
See AudioEffect class for more details on controlling
audio effects.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| EnvironmentalReverb.OnParameterChangeListener | The OnParameterChangeListener interface defines a method called by the EnvironmentalReverb when a parameter value has changed. | ||||||||||
| EnvironmentalReverb.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 class
android.media.audiofx.AudioEffect
| |||||||||||
|
[Expand]
Inherited Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
android.media.audiofx.AudioEffect
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Class constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the ratio of high frequency decay time (at 5 kHz) relative to low frequencies.
| |||||||||||
Gets the decay time.
| |||||||||||
Gets the density level.
| |||||||||||
Gets diffusion level.
| |||||||||||
Gets the environmental reverb properties.
| |||||||||||
Gets the reflections delay.
| |||||||||||
Gets the volume level of the early reflections.
| |||||||||||
Gets the reverb delay.
| |||||||||||
Gets the reverb level.
| |||||||||||
Gets the room HF level.
| |||||||||||
Gets the master volume level of the environmental reverb effect.
| |||||||||||
Sets the ratio of high frequency decay time (at 5 kHz) relative to the decay time at low
frequencies.
| |||||||||||
Sets the time taken for the level of reverberation to decay by 60 dB.
| |||||||||||
Controls the modal density of the late reverberation decay.
| |||||||||||
Sets the echo density in the late reverberation decay.
| |||||||||||
Registers an OnParameterChangeListener interface.
| |||||||||||
Sets the environmental reverb properties.
| |||||||||||
Sets the delay time for the early reflections.
| |||||||||||
Sets the volume level of the early reflections.
| |||||||||||
Sets the time between the first reflection and the reverberation.
| |||||||||||
Sets the volume level of the late reverberation.
| |||||||||||
Sets the volume level at 5 kHz relative to the volume level at low frequencies of the
overall reverb effect.
| |||||||||||
Sets the master volume level of the environmental reverb effect.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
android.media.audiofx.AudioEffect
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Decay HF ratio. Parameter ID for
EnvironmentalReverb.OnParameterChangeListener
Decay time. Parameter ID for OnParameterChangeListener
Density. Parameter ID for OnParameterChangeListener
Diffusion. Parameter ID for OnParameterChangeListener
Early reflections delay. Parameter ID for OnParameterChangeListener
Early reflections level. Parameter ID for OnParameterChangeListener
Reverb delay. Parameter ID for OnParameterChangeListener
Reverb level. Parameter ID for OnParameterChangeListener
Room HF level. Parameter ID for OnParameterChangeListener
Room level. Parameter ID for OnParameterChangeListener
Class constructor.
| priority | the priority level requested by the application for controlling the EnvironmentalReverb engine. As the same engine can be shared by several applications, this parameter indicates how much the requesting application needs control of effect parameters. The normal priority is 0, above normal is a positive number, below normal a negative number. |
|---|---|
| audioSession | system wide unique audio session identifier. If audioSession is not 0, the EnvironmentalReverb will be attached to the MediaPlayer or AudioTrack in the same audio session. Otherwise, the EnvironmentalReverb will apply to the output mix. As the EnvironmentalReverb is an auxiliary effect it is recommended to instantiate it on audio session 0 and to attach it to the MediaPLayer auxiliary output. |
| java.lang.IllegalArgumentException | |
| java.lang.UnsupportedOperationException | |
| RuntimeException | |
| IllegalArgumentException | |
| UnsupportedOperationException |
Gets the ratio of high frequency decay time (at 5 kHz) relative to low frequencies.
setDecayHFRatio(short) for units.| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the decay time.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the density level.
setDiffusion(short) for units.| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets diffusion level.
setDiffusion(short) for units.| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the environmental reverb properties. This method is useful when a snapshot of current reverb settings must be saved by the application.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the reflections delay.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the volume level of the early reflections.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the reverb delay.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the reverb level.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the room HF level.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the master volume level of the environmental reverb effect.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Sets the ratio of high frequency decay time (at 5 kHz) relative to the decay time at low frequencies.
| 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. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Sets the time taken for the level of reverberation to decay by 60 dB.
| decayTime | decay time in milliseconds. The valid range is [100, 20000]. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
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.
| 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. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Sets the echo density in the late reverberation decay.
The scale should approximately map linearly to the perceived change in reverberation.
| 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. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Registers an OnParameterChangeListener interface.
| listener | OnParameterChangeListener interface registered |
|---|
Sets the environmental reverb properties. This method is useful when reverb settings have to be applied from a previous backup.
| settings | a EnvironmentalReverb.Settings object containing the properties to apply |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
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.
| reflectionsDelay | reflections delay in milliseconds. The valid range is [0, 300]. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Sets the volume level of the early reflections.
This level is combined with the overall room level
(set using setRoomLevel(short)).
| reflectionsLevel | reflection level in millibels. The valid range is [-9000, 1000]. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Sets the time between the first reflection and the reverberation.
| reverbDelay | reverb delay in milliseconds. The valid range is [0, 100]. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Sets the volume level of the late reverberation.
This level is combined with the overall room level (set using setRoomLevel(short)).
| reverbLevel | reverb level in millibels. The valid range is [-9000, 2000]. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
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.
| roomHF | high frequency attenuation level in millibels. The valid range is [-9000, 0]. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Sets the master volume level of the environmental reverb effect.
| room | room level in millibels. The valid range is [-9000, 0]. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |