IT. Expert System.

Android Reference

EnvironmentalReverb

android.media.audiofx

Class EnvironmentalReverb

java.lang.Object
- android.media.audiofx.AudioEffect
- - android.media.audiofx.EnvironmentalReverb

```
public class EnvironmentalReverb
extends AudioEffect
```
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 android.Manifest.permission#MODIFY_AUDIO_SETTINGS
See AudioEffect class for more details on controlling audio effects.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EnvironmentalReverb.OnParameterChangeListener` The OnParameterChangeListener interface defines a method called by the EnvironmentalReverb when a parameter value has changed.
`static class`	`EnvironmentalReverb.Settings` The Settings class regroups all environmental reverb parameters.

Nested classes/interfaces inherited from class android.media.audiofx.AudioEffect
AudioEffect.Descriptor, AudioEffect.OnControlStatusChangeListener, AudioEffect.OnEnableStatusChangeListener

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PARAM_DECAY_HF_RATIO` Decay HF ratio.
`static int`	`PARAM_DECAY_TIME` Decay time.
`static int`	`PARAM_DENSITY` Density.
`static int`	`PARAM_DIFFUSION` Diffusion.
`static int`	`PARAM_REFLECTIONS_DELAY` Early reflections delay.
`static int`	`PARAM_REFLECTIONS_LEVEL` Early reflections level.
`static int`	`PARAM_REVERB_DELAY` Reverb delay.
`static int`	`PARAM_REVERB_LEVEL` Reverb level.
`static int`	`PARAM_ROOM_HF_LEVEL` Room HF level.
`static int`	`PARAM_ROOM_LEVEL` Room level.

Fields inherited from class android.media.audiofx.AudioEffect
ACTION_CLOSE_AUDIO_EFFECT_CONTROL_SESSION, ACTION_DISPLAY_AUDIO_EFFECT_CONTROL_PANEL, ACTION_OPEN_AUDIO_EFFECT_CONTROL_SESSION, ALREADY_EXISTS, CONTENT_TYPE_GAME, CONTENT_TYPE_MOVIE, CONTENT_TYPE_MUSIC, CONTENT_TYPE_VOICE, EFFECT_AUXILIARY, EFFECT_INSERT, EFFECT_PRE_PROCESSING, EFFECT_TYPE_AEC, EFFECT_TYPE_AGC, EFFECT_TYPE_BASS_BOOST, EFFECT_TYPE_ENV_REVERB, EFFECT_TYPE_EQUALIZER, EFFECT_TYPE_NS, EFFECT_TYPE_NULL, EFFECT_TYPE_PRESET_REVERB, EFFECT_TYPE_VIRTUALIZER, ERROR, ERROR_BAD_VALUE, ERROR_DEAD_OBJECT, ERROR_INVALID_OPERATION, ERROR_NO_INIT, ERROR_NO_MEMORY, EXTRA_AUDIO_SESSION, EXTRA_CONTENT_TYPE, EXTRA_PACKAGE_NAME, mListenerLock, mNativeEventHandler, NATIVE_EVENT_CONTROL_STATUS, NATIVE_EVENT_ENABLED_STATUS, NATIVE_EVENT_PARAMETER_CHANGED, STATE_INITIALIZED, STATE_UNINITIALIZED, SUCCESS

Constructor Summary

Constructors
Constructor and Description

EnvironmentalReverb(int priority, int audioSession)
Class constructor.

Constructors
Constructor and Description
`EnvironmentalReverb(int priority, int audioSession)` Class constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`short`	`getDecayHFRatio()` Gets the ratio of high frequency decay time (at 5 kHz) relative to low frequencies.
`int`	`getDecayTime()` Gets the decay time.
`short`	`getDensity()` Gets the density level.
`short`	`getDiffusion()` Gets diffusion level.
`EnvironmentalReverb.Settings`	`getProperties()` Gets the environmental reverb properties.
`int`	`getReflectionsDelay()` Gets the reflections delay.
`short`	`getReflectionsLevel()` Gets the volume level of the early reflections.
`int`	`getReverbDelay()` Gets the reverb delay.
`short`	`getReverbLevel()` Gets the reverb level.
`short`	`getRoomHFLevel()` Gets the room HF level.
`short`	`getRoomLevel()` Gets the master volume level of the environmental reverb effect.
`void`	`setDecayHFRatio(short decayHFRatio)` Sets the ratio of high frequency decay time (at 5 kHz) relative to the decay time at low frequencies.
`void`	`setDecayTime(int decayTime)` Sets the time taken for the level of reverberation to decay by 60 dB.
`void`	`setDensity(short density)` Controls the modal density of the late reverberation decay.
`void`	`setDiffusion(short diffusion)` Sets the echo density in the late reverberation decay.
`void`	`setParameterListener(EnvironmentalReverb.OnParameterChangeListener listener)` Registers an OnParameterChangeListener interface.
`void`	`setProperties(EnvironmentalReverb.Settings settings)` Sets the environmental reverb properties.
`void`	`setReflectionsDelay(int reflectionsDelay)` Sets the delay time for the early reflections.
`void`	`setReflectionsLevel(short reflectionsLevel)` Sets the volume level of the early reflections.
`void`	`setReverbDelay(int reverbDelay)` Sets the time between the first reflection and the reverberation.
`void`	`setReverbLevel(short reverbLevel)` Sets the volume level of the late reverberation.
`void`	`setRoomHFLevel(short roomHF)` Sets the volume level at 5 kHz relative to the volume level at low frequencies of the overall reverb effect.
`void`	`setRoomLevel(short room)` Sets the master volume level of the environmental reverb effect.

Methods inherited from class android.media.audiofx.AudioEffect
byteArrayToInt, byteArrayToInt, byteArrayToShort, byteArrayToShort, checkState, checkStatus, command, concatArrays, finalize, getDescriptor, getEnabled, getId, getParameter, getParameter, getParameter, getParameter, getParameter, getParameter, getParameter, hasControl, intToByteArray, isEffectTypeAvailable, isError, queryEffects, queryPreProcessings, release, setControlStatusListener, setEnabled, setEnableStatusListener, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterListener, shortToByteArray

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_ROOM_LEVEL
```
public static final int PARAM_ROOM_LEVEL
```
    Room level. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_ROOM_HF_LEVEL
```
public static final int PARAM_ROOM_HF_LEVEL
```
    Room HF level. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_DECAY_TIME
```
public static final int PARAM_DECAY_TIME
```
    Decay time. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_DECAY_HF_RATIO
```
public static final int PARAM_DECAY_HF_RATIO
```
    Decay HF ratio. Parameter ID for EnvironmentalReverb.OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_REFLECTIONS_LEVEL
```
public static final int PARAM_REFLECTIONS_LEVEL
```
    Early reflections level. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_REFLECTIONS_DELAY
```
public static final int PARAM_REFLECTIONS_DELAY
```
    Early reflections delay. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_REVERB_LEVEL
```
public static final int PARAM_REVERB_LEVEL
```
    Reverb level. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_REVERB_DELAY
```
public static final int PARAM_REVERB_DELAY
```
    Reverb delay. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_DIFFUSION
```
public static final int PARAM_DIFFUSION
```
    Diffusion. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
  - PARAM_DENSITY
```
public static final int PARAM_DENSITY
```
    Density. Parameter ID for OnParameterChangeListener
    
    See Also:
    Constant Field Values
- Constructor Detail
  - EnvironmentalReverb
```
public EnvironmentalReverb(int priority,
                   int audioSession)
                    throws IllegalArgumentException,
                           UnsupportedOperationException,
                           RuntimeException
```
    Class constructor.
    
    Parameters:
    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.
    
    Throws:
    
    IllegalArgumentException
    
    UnsupportedOperationException
    
    RuntimeException
- Method Detail
  - setRoomLevel
```
public void setRoomLevel(short room)
                  throws IllegalStateException,
                         IllegalArgumentException,
                         UnsupportedOperationException
```
    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
  - getRoomLevel
```
public short getRoomLevel()
                   throws IllegalStateException,
                          IllegalArgumentException,
                          UnsupportedOperationException
```
    Gets the master volume level of the environmental reverb effect.
    
    Returns:
    the room level in millibels.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setRoomHFLevel
```
public void setRoomHFLevel(short roomHF)
                    throws IllegalStateException,
                           IllegalArgumentException,
                           UnsupportedOperationException
```
    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
  - getRoomHFLevel
```
public short getRoomHFLevel()
                     throws IllegalStateException,
                            IllegalArgumentException,
                            UnsupportedOperationException
```
    Gets the room HF level.
    
    Returns:
    the room HF level in millibels.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setDecayTime
```
public void setDecayTime(int decayTime)
                  throws IllegalStateException,
                         IllegalArgumentException,
                         UnsupportedOperationException
```
    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
  - getDecayTime
```
public int getDecayTime()
                 throws IllegalStateException,
                        IllegalArgumentException,
                        UnsupportedOperationException
```
    Gets the decay time.
    
    Returns:
    the decay time in milliseconds.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setDecayHFRatio
```
public void setDecayHFRatio(short decayHFRatio)
                     throws IllegalStateException,
                            IllegalArgumentException,
                            UnsupportedOperationException
```
    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
  - getDecayHFRatio
```
public short getDecayHFRatio()
                      throws IllegalStateException,
                             IllegalArgumentException,
                             UnsupportedOperationException
```
    Gets the ratio of high frequency decay time (at 5 kHz) relative to low frequencies.
    
    Returns:
    the decay HF ration. See setDecayHFRatio(short) for units.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setReflectionsLevel
```
public void setReflectionsLevel(short reflectionsLevel)
                         throws IllegalStateException,
                                IllegalArgumentException,
                                UnsupportedOperationException
```
    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
  - getReflectionsLevel
```
public short getReflectionsLevel()
                          throws IllegalStateException,
                                 IllegalArgumentException,
                                 UnsupportedOperationException
```
    Gets the volume level of the early reflections.
    
    Returns:
    the early reflections level in millibels.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setReflectionsDelay
```
public void setReflectionsDelay(int reflectionsDelay)
                         throws IllegalStateException,
                                IllegalArgumentException,
                                UnsupportedOperationException
```
    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
  - getReflectionsDelay
```
public int getReflectionsDelay()
                        throws IllegalStateException,
                               IllegalArgumentException,
                               UnsupportedOperationException
```
    Gets the reflections delay.
    
    Returns:
    the early reflections delay in milliseconds.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setReverbLevel
```
public void setReverbLevel(short reverbLevel)
                    throws IllegalStateException,
                           IllegalArgumentException,
                           UnsupportedOperationException
```
    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
  - getReverbLevel
```
public short getReverbLevel()
                     throws IllegalStateException,
                            IllegalArgumentException,
                            UnsupportedOperationException
```
    Gets the reverb level.
    
    Returns:
    the reverb level in millibels.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setReverbDelay
```
public void setReverbDelay(int reverbDelay)
                    throws IllegalStateException,
                           IllegalArgumentException,
                           UnsupportedOperationException
```
    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
  - getReverbDelay
```
public int getReverbDelay()
                   throws IllegalStateException,
                          IllegalArgumentException,
                          UnsupportedOperationException
```
    Gets the reverb delay.
    
    Returns:
    the reverb delay in milliseconds.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setDiffusion
```
public void setDiffusion(short diffusion)
                  throws IllegalStateException,
                         IllegalArgumentException,
                         UnsupportedOperationException
```
    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
  - getDiffusion
```
public short getDiffusion()
                   throws IllegalStateException,
                          IllegalArgumentException,
                          UnsupportedOperationException
```
    Gets diffusion level.
    
    Returns:
    the diffusion level. See setDiffusion(short) for units.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setDensity
```
public void setDensity(short density)
                throws IllegalStateException,
                       IllegalArgumentException,
                       UnsupportedOperationException
```
    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
  - getDensity
```
public short getDensity()
                 throws IllegalStateException,
                        IllegalArgumentException,
                        UnsupportedOperationException
```
    Gets the density level.
    
    Returns:
    the density level. See setDiffusion(short) for units.
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setParameterListener
```
public void setParameterListener(EnvironmentalReverb.OnParameterChangeListener listener)
```
    Registers an OnParameterChangeListener interface.
    
    Parameters:
    listener - OnParameterChangeListener interface registered
  - getProperties
```
public EnvironmentalReverb.Settings getProperties()
                                           throws IllegalStateException,
                                                  IllegalArgumentException,
                                                  UnsupportedOperationException
```
    Gets the environmental reverb properties. This method is useful when a snapshot of current reverb settings must be saved by the application.
    
    Returns:
    an EnvironmentalReverb.Settings object containing all current parameters values
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException
  - setProperties
```
public void setProperties(EnvironmentalReverb.Settings settings)
                   throws IllegalStateException,
                          IllegalArgumentException,
                          UnsupportedOperationException
```
    Sets the environmental reverb properties. This method is useful when reverb settings have to be applied from a previous backup.
    
    Parameters:
    settings - a EnvironmentalReverb.Settings object containing the properties to apply
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    UnsupportedOperationException

Content

Android Reference

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.

All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.

IT. Expert System.

Android Reference

EnvironmentalReverb

Class EnvironmentalReverb

Nested Class Summary

Nested classes/interfaces inherited from class android.media.audiofx.AudioEffect

Field Summary

Fields inherited from class android.media.audiofx.AudioEffect

Constructor Summary

Method Summary

Methods inherited from class android.media.audiofx.AudioEffect

Methods inherited from class java.lang.Object

Field Detail

PARAM_ROOM_LEVEL

PARAM_ROOM_HF_LEVEL

PARAM_DECAY_TIME

PARAM_DECAY_HF_RATIO

PARAM_REFLECTIONS_LEVEL

PARAM_REFLECTIONS_DELAY

PARAM_REVERB_LEVEL

PARAM_REVERB_DELAY

PARAM_DIFFUSION

PARAM_DENSITY

Constructor Detail

EnvironmentalReverb

Method Detail

setRoomLevel

getRoomLevel

setRoomHFLevel

getRoomHFLevel

setDecayTime

getDecayTime

setDecayHFRatio

getDecayHFRatio

setReflectionsLevel

getReflectionsLevel

setReflectionsDelay

getReflectionsDelay

setReverbLevel

getReverbLevel

setReverbDelay

getReverbDelay

setDiffusion

getDiffusion

setDensity

getDensity

setParameterListener

getProperties

setProperties

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary