Press on the image to return to the main documentation page.

Reverb

Written by GTR

List of types:

ReverbLib

Permissions:

android.permission.MODIFY_AUDIO_SETTINGS

Events:

None

Members:

Enable (enable As Boolean) As Int

GetDecayHFRatio As Short

GetEnabled As Boolean

GetID As Int

GetProperties As String

GetRoomLevel As Short

HasControl As Boolean

Initialize As Boolean

IsAvailable As Boolean

IsInitialized As Boolean

Release

SetDecayHFRatio (decayHFRatio As Short)

SetDecayTime (decayTime As Short)

SetDensity (density As Short)

SetDiffusion (diffusion As Short)

SetProperties (settingsStr As String)

SetReflectionsDelay (reflectionsDelay As Int)

SetReflectionsLevel (reflectionsLevel As Short)

SetReverbDelay (reverbDelay As Int)

SetReverbLevel (reverbLevel As Short)

SetRoomHFLevel (roomHF As Short)

SetRoomLevel (room As Short)

Members description:

GetProperties As String

GetRoomLevel As Short

HasControl As Boolean

Checks if this AudioEffect object is controlling the effect engine

Initialize As Boolean

Checks whether the Reverb is available and Initializes the object,
only for all output and not for specific media players.
For backwards compatibility, the library will not throw an exception
on failure to initialize the Equalizer, but will return true or false
and set the IsInitialized flag appropriately if it fails for any reason.
check either of these before running the other methods as if the equalizer
is not initialized, you will get a runtime error.
Dim RV As ReverbLib
RV.Initialize
End if

IsAvailable As Boolean

Returns the availability of the ReverbLib object, it must be available for
the devices API level (9 or later)

IsInitialized As Boolean

Returns the status of the ReverbLib object, it must be available for
the devices API level and initialized

Dim RV As EQlib
RV.Initialize
If RV.IsInitialized Then
RV.Enable(True)
End if

Release

Releases the native AudioEffect resources.
It is a good practice to release the effect engine when not
in use as control can be returned to other
applications or the native resources released.

SetDecayHFRatio (decayHFRatio As Short)

Sets the ratio of high frequency decay time (at 5 kHz) relative to the decay time at low
frequencies.
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.

SetDecayTime (decayTime As Short)

Sets the time taken for the level of reverberation to decay by 60 dB.
decayTime: decay time in milliseconds. The valid range is [100, 20000].

SetDensity (density As Short)

Controls the modal density of the late reverberation decay.
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.

SetDiffusion (diffusion As Short)

Sets the echo density in the late reverberation decay.
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.

SetProperties (settingsStr As String)

SetReflectionsDelay (reflectionsDelay As Int)

Sets the delay time for the early reflections.
reflectionsDelay: reflections delay in milliseconds. The valid range is [0, 300].

SetReflectionsLevel (reflectionsLevel As Short)

Sets the volume level of the early reflections.
reflectionsLevel: reflection level in millibels. The valid range is [-9000, 1000].

SetReverbDelay (reverbDelay As Int)

Sets the time between the first reflection and the reverberation.
reverbDelay: reverb delay in milliseconds. The valid range is [0, 100].

SetReverbLevel (reverbLevel As Short)

Sets the time between the first reflection and the reverberation.
reverbDelay: reverb delay in milliseconds. The valid range is [-9000, 2000].

SetRoomHFLevel (roomHF As Short)

Sets the volume level at 5 kHz relative to the volume level at low frequencies of the
roomHF: high frequency attenuation level in millibels. The valid range is [-9000, 0].

SetRoomLevel (room As Short)

Sets the master volume level of the environmental reverb effect.
room: room level in millibels. The valid range is [-9000, 0].

Top