EnvironmentalReverb Class

Definition

Namespace:

Android.Media.Audiofx

Assembly:

Mono.Android.dll

A sound generated within a room travels in many directions.

[Android.Runtime.Register("android/media/audiofx/EnvironmentalReverb", DoNotGenerateAcw=true)]
public class EnvironmentalReverb : Android.Media.Audiofx.AudioEffect

[<Android.Runtime.Register("android/media/audiofx/EnvironmentalReverb", DoNotGenerateAcw=true)>]
type EnvironmentalReverb = class
    inherit AudioEffect

Inheritance

Object

Object

AudioEffect

EnvironmentalReverb

Attributes

RegisterAttribute

Remarks

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 android.media.audiofx.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 android.media.audiofx.AudioEffect class for more details on controlling audio effects.

Java documentation for android.media.audiofx.EnvironmentalReverb.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

EnvironmentalReverb(Int32, Int32)	Class constructor.
EnvironmentalReverb(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Fields

ActionCloseAudioEffectControlSession	Intent to signal to the effect control application or service that an audio session is closed and that effects should not be applied anymore. (Inherited from AudioEffect)
ActionDisplayAudioEffectControlPanel	Intent to launch an audio effect control panel UI. (Inherited from AudioEffect)
ActionOpenAudioEffectControlSession	Intent to signal to the effect control application or service that a new audio session is opened and requires audio effects to be applied. (Inherited from AudioEffect)
AlreadyExists	Obsolete. Internal operation status. (Inherited from AudioEffect)
ContentTypeGame	Obsolete. Value for #EXTRA_CONTENT_TYPE when the type of content played is game audio (Inherited from AudioEffect)
ContentTypeMovie	Obsolete. Value for #EXTRA_CONTENT_TYPE when the type of content played is video or movie (Inherited from AudioEffect)
ContentTypeMusic	Obsolete. Value for #EXTRA_CONTENT_TYPE when the type of content played is music (Inherited from AudioEffect)
ContentTypeVoice	Obsolete. Value for #EXTRA_CONTENT_TYPE when the type of content played is voice audio (Inherited from AudioEffect)
EffectAuxiliary	Effect connection mode is auxiliary. (Inherited from AudioEffect)
EffectInsert	Effect connection mode is insert. (Inherited from AudioEffect)
EffectPostProcessing	Effect connection mode is post processing. (Inherited from AudioEffect)
EffectPreProcessing	Effect connection mode is pre processing. (Inherited from AudioEffect)
Error	Obsolete. Unspecified error. (Inherited from AudioEffect)
ErrorBadValue	Obsolete. Operation failed due to bad parameter value. (Inherited from AudioEffect)
ErrorDeadObject	Obsolete. Operation failed due to dead remote object. (Inherited from AudioEffect)
ErrorInvalidOperation	Obsolete. Operation failed because it was requested in wrong state. (Inherited from AudioEffect)
ErrorNoInit	Obsolete. Operation failed due to bad object initialization. (Inherited from AudioEffect)
ErrorNoMemory	Obsolete. Operation failed due to lack of memory. (Inherited from AudioEffect)
ExtraAudioSession	Contains the ID of the audio session the effects should be applied to. (Inherited from AudioEffect)
ExtraContentType	Indicates which type of content is played by the application. (Inherited from AudioEffect)
ExtraPackageName	Contains the package name of the calling application. (Inherited from AudioEffect)
ParamDecayHfRatio	Obsolete. Decay HF ratio.
ParamDecayTime	Obsolete. Decay time.
ParamDensity	Obsolete. Density.
ParamDiffusion	Obsolete. Diffusion.
ParamReflectionsDelay	Obsolete. Early reflections delay.
ParamReflectionsLevel	Obsolete. Early reflections level.
ParamReverbDelay	Obsolete. Reverb delay.
ParamReverbLevel	Obsolete. Reverb level.
ParamRoomHfLevel	Obsolete. Room HF level.
ParamRoomLevel	Obsolete. Room level.
Success	Obsolete. Successful operation. (Inherited from AudioEffect)

Properties

Class	Returns the runtime class of this Object. (Inherited from Object)
DecayHFRatio	Gets the ratio of high frequency decay time (at 5 kHz) relative to low frequencies. -or- Sets the ratio of high frequency decay time (at 5 kHz) relative to the decay time at low frequencies.
DecayTime	Gets the decay time. -or- Sets the time taken for the level of reverberation to decay by 60 dB.
Density	Gets the density level. -or- Controls the modal density of the late reverberation decay.
Diffusion	Gets diffusion level. -or- Sets the echo density in the late reverberation decay.
Enabled	Returns effect enabled state (Inherited from AudioEffect)
Handle	The handle to the underlying Android instance. (Inherited from Object)
HasControl	Checks if this AudioEffect object is controlling the effect engine. (Inherited from AudioEffect)
Id	Returns effect unique identifier. (Inherited from AudioEffect)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
Properties	Gets the environmental reverb properties.
ReflectionsDelay	Gets the reflections delay. -or- Sets the delay time for the early reflections.
ReflectionsLevel	Gets the volume level of the early reflections. -or- Sets the volume level of the early reflections.
ReverbDelay	Gets the reverb delay. -or- Sets the time between the first reflection and the reverberation.
ReverbLevel	Gets the reverb level. -or- Sets the volume level of the late reverberation.
RoomHFLevel	Gets the room HF level. -or- Sets the volume level at 5 kHz relative to the volume level at low frequencies of the overall reverb effect.
RoomLevel	Gets the master volume level of the environmental reverb effect. -or- Sets the master volume level of the environmental reverb effect.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetDescriptor()	Get the effect descriptor. (Inherited from AudioEffect)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
Release()	Releases the native AudioEffect resources. (Inherited from AudioEffect)
SetControlStatusListener(AudioEffect+IOnControlStatusChangeListener)	Sets the listener AudioEffect notifies when the effect engine control is taken or returned. (Inherited from AudioEffect)
SetEnabled(Boolean)	Enable or disable the effect. (Inherited from AudioEffect)
SetEnableStatusListener(AudioEffect+IOnEnableStatusChangeListener)	Sets the listener AudioEffect notifies when the effect engine is enabled or disabled. (Inherited from AudioEffect)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetParameterListener(EnvironmentalReverb+IOnParameterChangeListener)	Registers an OnParameterChangeListener interface.
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Events

ControlStatus	(Inherited from AudioEffect)
EnableStatus	(Inherited from AudioEffect)
Parameter

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)