Equalizer Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An Equalizer is used to alter the frequency response of a particular music source or of the main output mix.
[Android.Runtime.Register("android/media/audiofx/Equalizer", DoNotGenerateAcw=true)]
public class Equalizer : Android.Media.Audiofx.AudioEffect[<Android.Runtime.Register("android/media/audiofx/Equalizer", DoNotGenerateAcw=true)>]
type Equalizer = class
inherit AudioEffect- Inheritance
- Attributes
Remarks
An Equalizer is used to alter the frequency response of a particular music source or of the main output mix.
An application creates an Equalizer object to instantiate and control an Equalizer engine in the audio framework. The application can either simply use predefined presets or have a more precise control of the gain in each frequency band controlled by the equalizer.
The methods, parameter types and units exposed by the Equalizer implementation are directly mapping those defined by the OpenSL ES 1.0.1 Specification (http://www.khronos.org/opensles/) for the SLEqualizerItf interface. Please refer to this specification for more details.
To attach the Equalizer to a particular AudioTrack or MediaPlayer, specify the audio session ID of this AudioTrack or MediaPlayer when constructing the Equalizer.
NOTE: attaching an Equalizer to the global audio output mix by use of session 0 is deprecated.
See android.media.MediaPlayer#getAudioSessionId() for details on audio sessions.
See android.media.audiofx.AudioEffect class for more details on controlling audio effects.
Java documentation for android.media.audiofx.Equalizer.
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
| Equalizer(Int32, Int32) |
Class constructor. |
| Equalizer(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 |
| ContentTypeMovie |
Obsolete.
Value for |
| ContentTypeMusic |
Obsolete.
Value for |
| ContentTypeVoice |
Obsolete.
Value for |
| 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) |
| ParamBandFreqRange |
Obsolete.
Band frequency range. |
| ParamBandLevel |
Obsolete.
Band level. |
| ParamCenterFreq |
Obsolete.
Band center frequency. |
| ParamCurrentPreset |
Obsolete.
Current preset. |
| ParamGetBand |
Obsolete.
Band for a given frequency. |
| ParamGetNumOfPresets |
Obsolete.
Request number of presets. |
| ParamGetPresetName |
Obsolete.
Request preset name. |
| ParamLevelRange |
Obsolete.
Band level range. |
| ParamNumBands |
Obsolete.
Number of bands. |
| ParamStringSizeMax |
Obsolete.
Maximum size for preset name |
| Success |
Obsolete.
Successful operation. (Inherited from AudioEffect) |
Properties
| Class |
Returns the runtime class of this |
| CurrentPreset |
Gets current preset. |
| 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 | |
| NumberOfBands |
Gets the number of frequency bands supported by the Equalizer engine. |
| NumberOfPresets |
Gets the total number of presets the equalizer supports. |
| PeerReference | (Inherited from Object) |
| Properties |
Gets the equalizer properties. |
| 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) |
| GetBand(Int32) |
Gets the band that has the most effect on the given frequency. |
| GetBandFreqRange(Int16) |
Gets the frequency range of the given frequency band. |
| GetBandLevel(Int16) |
Gets the gain set for the given equalizer band. |
| GetBandLevelRange() |
Gets the level range for use by |
| GetCenterFreq(Int16) |
Gets the center frequency of the given band. |
| GetDescriptor() |
Get the effect descriptor. (Inherited from AudioEffect) |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| GetPresetName(Int16) |
Gets the preset name based on the index. |
| 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) |
| SetBandLevel(Int16, Int16) |
Sets the given equalizer band to the given gain value. |
| 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(Equalizer+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) |
| UsePreset(Int16) |
Sets the equalizer according to the given preset. |
| 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) | |