IPresetReverb
implements IAudioEffect| com.h6ah4i.android.media.audiofx.IPresetReverb |
 Known Indirect Subclasses
|
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| interface | IPresetReverb.OnParameterChangeListener | The OnParameterChangeListener interface defines a method called by the PresetReverb when a parameter value has changed. | |||||||||
| class | IPresetReverb.Settings | The Settings class regroups all preset reverb parameters. | |||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | PARAM_PRESET | Preset. | |||||||||
| short | PRESET_LARGEHALL | Reverb preset representing a large-sized hall suitable for a full orchestra | |||||||||
| short | PRESET_LARGEROOM | Reverb preset representing a large-sized room suitable for live performances | |||||||||
| short | PRESET_MEDIUMHALL | Reverb preset representing a medium-sized hall | |||||||||
| short | PRESET_MEDIUMROOM | Reverb preset representing a medium room with a length of ten meters or less | |||||||||
| short | PRESET_NONE | No reverb or reflections | |||||||||
| short | PRESET_PLATE | Reverb preset representing a synthesis of the traditional plate reverb | |||||||||
| short | PRESET_SMALLROOM | Reverb preset representing a small room less than five meters in length | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.h6ah4i.android.media.audiofx.IAudioEffect
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract short |
getPreset()
Gets current reverb preset.
| ||||||||||
| abstract IPresetReverb.Settings |
getProperties()
Gets the preset reverb properties.
| ||||||||||
| abstract void |
setParameterListener(IPresetReverb.OnParameterChangeListener listener)
Registers an OnParameterChangeListener interface.
| ||||||||||
| abstract void |
setPreset(short preset)
Enables a preset on the reverb.
| ||||||||||
| abstract void |
setProperties(IPresetReverb.Settings settings)
Sets the preset reverb properties.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.h6ah4i.android.media.IReleasable
| |||||||||||
|
From interface
com.h6ah4i.android.media.audiofx.IAudioEffect
| |||||||||||
Constants
public static final int PARAM_PRESET
Preset. Parameter ID for android.media.audiofx.PresetReverb.OnParameterChangeListener
public static final short PRESET_LARGEHALL
Reverb preset representing a large-sized hall suitable for a full orchestra
public static final short PRESET_LARGEROOM
Reverb preset representing a large-sized room suitable for live performances
public static final short PRESET_MEDIUMHALL
Reverb preset representing a medium-sized hall
public static final short PRESET_MEDIUMROOM
Reverb preset representing a medium room with a length of ten meters or less
public static final short PRESET_NONE
No reverb or reflections
public static final short PRESET_PLATE
Reverb preset representing a synthesis of the traditional plate reverb
public static final short PRESET_SMALLROOM
Reverb preset representing a small room less than five meters in length
Public Methods
public abstract short getPreset ()
Gets current reverb preset.
Returns
- the preset that is set at the moment.
Throws
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalArgumentException | |
| IllegalStateException |
public abstract IPresetReverb.Settings getProperties ()
Gets the preset reverb properties. This method is useful when a snapshot of current preset reverb settings must be saved by the application.
Returns
- a IPresetReverb.Settings object containing all current parameters values
Throws
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalArgumentException | |
| IllegalStateException |
public abstract void setParameterListener (IPresetReverb.OnParameterChangeListener listener)
Registers an OnParameterChangeListener interface.
Parameters
| listener | OnParameterChangeListener interface registered |
|---|
public abstract void setPreset (short preset)
Enables a preset on the reverb.
The reverb PRESET_NONE disables any reverb from the current output but does not free the resources associated with the reverb. For an application to signal to the implementation to free the resources, it must call the release() method.
Parameters
| preset | this must be one of the the preset constants defined in
this class. e.g. PRESET_SMALLROOM |
|---|
Throws
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalArgumentException | |
| IllegalStateException |
public abstract void setProperties (IPresetReverb.Settings settings)
Sets the preset reverb properties. This method is useful when preset reverb settings have to be applied from a previous backup.
Parameters
| settings | a IPresetReverb.Settings object containing the properties to apply |
|---|
Throws
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalArgumentException | |
| IllegalStateException |