File	Doc	Category	Size	Date	Package
PresetReverb.java	API Doc	Android 5.1 API	12566	Thu Mar 12 22:22:30 GMT 2015	android.media.audiofx

PresetReverb

• java.lang.Object
  • android.media.audiofx.AudioEffect

Fields Summary
private static final String	TAG
public static final int	PARAM_PRESET Preset. Parameter ID for {@link android.media.audiofx.PresetReverb.OnParameterChangeListener}
public static final short	PRESET_NONE No reverb or reflections
public static final short	PRESET_SMALLROOM Reverb preset representing a small room less than five meters in length
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_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_LARGEHALL Reverb preset representing a large-sized hall suitable for a full orchestra
public static final short	PRESET_PLATE Reverb preset representing a synthesis of the traditional plate reverb
private OnParameterChangeListener	mParamListener Registered listener for parameter changes.
private BaseParameterListener	mBaseParamListener Listener used internally to to receive raw parameter change event from AudioEffect super class
private final Object	mParamListenerLock Lock for access to mParamListener

Constructors Summary

public PresetReverb(int priority, int audioSession) Class constructor. param priority the priority level requested by the application for controlling the PresetReverb 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. param audioSession system wide unique audio session identifier. If audioSession is not 0, the PresetReverb will be attached to the MediaPlayer or AudioTrack in the same audio session. Otherwise, the PresetReverb will apply to the output mix. As the PresetReverb is an auxiliary effect it is recommended to instantiate it on audio session 0 and to attach it to the MediaPLayer auxiliary output. throws java.lang.IllegalArgumentException throws java.lang.UnsupportedOperationException throws java.lang.RuntimeException super(EFFECT_TYPE_PRESET_REVERB, EFFECT_TYPE_NULL, priority, audioSession);

Methods Summary
public short	getPreset() Gets current reverb preset. return the preset that is set at the moment. throws IllegalStateException throws IllegalArgumentException throws UnsupportedOperationException short[] value = new short[1]; checkStatus(getParameter(PARAM_PRESET, value)); return value[0];
public android.media.audiofx.PresetReverb$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. return a PresetReverb.Settings object containing all current parameters values throws IllegalStateException throws IllegalArgumentException throws UnsupportedOperationException Settings settings = new Settings(); short[] value = new short[1]; checkStatus(getParameter(PARAM_PRESET, value)); settings.preset = value[0]; return settings;
public void	setParameterListener(android.media.audiofx.PresetReverb$OnParameterChangeListener listener) Registers an OnParameterChangeListener interface. param listener OnParameterChangeListener interface registered synchronized (mParamListenerLock) { if (mParamListener == null) { mParamListener = listener; mBaseParamListener = new BaseParameterListener(); super.setParameterListener(mBaseParamListener); } }
public 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. param preset this must be one of the the preset constants defined in this class. e.g. {@link #PRESET_SMALLROOM} throws IllegalStateException throws IllegalArgumentException throws UnsupportedOperationException checkStatus(setParameter(PARAM_PRESET, preset));
public void	setProperties(android.media.audiofx.PresetReverb$Settings settings) Sets the preset reverb properties. This method is useful when preset reverb settings have to be applied from a previous backup. param settings a PresetReverb.Settings object containing the properties to apply throws IllegalStateException throws IllegalArgumentException throws UnsupportedOperationException checkStatus(setParameter(PARAM_PRESET, settings.preset));