APIdia Launch Partner
Top Description Fields Constructors Methods
javax.sound.sampled

public Class ReverbType

extends Object
Class Inheritance

The ReverbType class provides methods for accessing various reverberation settings to be applied to an audio signal.

Reverberation simulates the reflection of sound off of the walls, ceiling, and floor of a room. Depending on the size of the room, and how absorbent or reflective the materials in the room's surfaces are, the sound might bounce around for a long time before dying away.

The reverberation parameters provided by ReverbType consist of the delay time and intensity of early reflections, the delay time and intensity of late reflections, and an overall decay time. Early reflections are the initial individual low-order reflections of the direct signal off the surfaces in the room. The late reflections are the dense, high-order reflections that characterize the room's reverberation. The delay times for the start of these two reflection types give the listener a sense of the overall size and complexity of the room's shape and contents. The larger the room, the longer the reflection delay times. The early and late reflections' intensities define the gain (in decibels) of the reflected signals as compared to the direct signal. These intensities give the listener an impression of the absorptive nature of the surfaces and objects in the room. The decay time defines how long the reverberation takes to exponentially decay until it is no longer perceptible ("effective zero"). The larger and less absorbent the surfaces, the longer the decay time.

The set of parameters defined here may not include all aspects of reverberation as specified by some systems. For example, the Midi Manufacturer's Association (MMA) has an Interactive Audio Special Interest Group (IASIG), which has a 3-D Working Group that has defined a Level 2 Spec (I3DL2). I3DL2 supports filtering of reverberation and control of reverb density. These properties are not included in the JavaSound 1.0 definition of a reverb control. In such a case, the implementing system should either extend the defined reverb control to include additional parameters, or else interpret the system's additional capabilities in a way that fits the model described here.

If implementing JavaSound on a I3DL2-compliant device:

The following table shows what parameter values an implementation might use for a representative set of reverberation settings.

Reverb types and params: decay time, late intensity, late delay, early intensity, and early delay
Type Decay Time (ms) Late Intensity (dB) Late Delay (ms) Early Intensity (dB) Early Delay(ms)
Cavern 2250 -2.0 41.3 -1.4 10.3
Dungeon 1600 -1.0 10.3 -0.7 2.6
Garage 900 -6.0 14.7 -4.0 3.9
Acoustic Lab 280 -3.0 8.0 -2.0 2.0
Closet 150 -10.0 2.5 -7.0 0.6
Author
Kara Kytle
Since
1.3

Field Summary

Modifier and TypeField and Description
private final int
decayTime

Total decay time.

private final int
earlyReflectionDelay

Early reflection delay in microseconds.

private final float
earlyReflectionIntensity

Early reflection intensity.

private final int
lateReflectionDelay

Late reflection delay in microseconds.

private final float
lateReflectionIntensity

Late reflection intensity.

private final String
name

Descriptive name of the reverb type.

Constructor Summary

AccessConstructor and Description
protected
ReverbType(String
the name of the new reverb type, or a zero-length String
name
,
int
the new type's early reflection delay time in microseconds
earlyReflectionDelay
,
float
the new type's early reflection intensity in dB
earlyReflectionIntensity
,
int
the new type's late reflection delay time in microseconds
lateReflectionDelay
,
float
the new type's late reflection intensity in dB
lateReflectionIntensity
,
int
the new type's decay time in microseconds
decayTime
)

Constructs a new reverb type that has the specified reverberation parameter values.

Method Summary

Modifier and TypeMethod and Description
public final boolean

Returns:

true if the specified object is equal to this reverb type; false otherwise
equals
(Object
the reference object with which to compare
obj
)

Overrides java.lang.Object.equals.

Indicates whether the specified object is equal to this reverb type, returning true if the objects are the same.

public final int

Returns:

the decay time of the late reflections, in microseconds
getDecayTime
()

Obtains the decay time, which is the amount of time over which the late reflections attenuate to effective zero.

public final int

Returns:

early reflection delay time for this reverb type, in microseconds
getEarlyReflectionDelay
()

Returns the early reflection delay time in microseconds.

public final float

Returns:

early reflection intensity for this reverb type, in dB
getEarlyReflectionIntensity
()

Returns the early reflection intensity in decibels.

public final int

Returns:

late reflection delay time for this reverb type, in microseconds
getLateReflectionDelay
()

Returns the late reflection delay time in microseconds.

public final float

Returns:

late reflection intensity for this reverb type, in dB
getLateReflectionIntensity
()

Returns the late reflection intensity in decibels.

public String

Returns:

the name of this reverb type
getName
()

Obtains the name of this reverb type.

public final int

Returns:

a hash code value for this reverb type
hashCode
()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this reverb type.

public final String

Returns:

a string representation of the reverb type
toString
()

Overrides java.lang.Object.toString.

Returns a string representation of the reverb type, including its name and its parameter settings.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

decayTimeback to summary
private final int decayTime

Total decay time.

earlyReflectionDelayback to summary
private final int earlyReflectionDelay

Early reflection delay in microseconds.

earlyReflectionIntensityback to summary
private final float earlyReflectionIntensity

Early reflection intensity.

lateReflectionDelayback to summary
private final int lateReflectionDelay

Late reflection delay in microseconds.

lateReflectionIntensityback to summary
private final float lateReflectionIntensity

Late reflection intensity.

nameback to summary
private final String name

Descriptive name of the reverb type.

Constructor Detail

ReverbTypeback to summary
protected ReverbType(String name, int earlyReflectionDelay, float earlyReflectionIntensity, int lateReflectionDelay, float lateReflectionIntensity, int decayTime)

Constructs a new reverb type that has the specified reverberation parameter values.

Parameters
name:String

the name of the new reverb type, or a zero-length String

earlyReflectionDelay:int

the new type's early reflection delay time in microseconds

earlyReflectionIntensity:float

the new type's early reflection intensity in dB

lateReflectionDelay:int

the new type's late reflection delay time in microseconds

lateReflectionIntensity:float

the new type's late reflection intensity in dB

decayTime:int

the new type's decay time in microseconds

Method Detail

equalsback to summary
public final boolean equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether the specified object is equal to this reverb type, returning true if the objects are the same.

Parameters
obj:Object

the reference object with which to compare

Returns:boolean

true if the specified object is equal to this reverb type; false otherwise

Annotations
@Override
getDecayTimeback to summary
public final int getDecayTime()

Obtains the decay time, which is the amount of time over which the late reflections attenuate to effective zero. The effective zero value is implementation-dependent.

Returns:int

the decay time of the late reflections, in microseconds

getEarlyReflectionDelayback to summary
public final int getEarlyReflectionDelay()

Returns the early reflection delay time in microseconds. This is the amount of time between when the direct signal is heard and when the first early reflections are heard.

Returns:int

early reflection delay time for this reverb type, in microseconds

getEarlyReflectionIntensityback to summary
public final float getEarlyReflectionIntensity()

Returns the early reflection intensity in decibels. This is the amplitude attenuation of the first early reflections relative to the direct signal.

Returns:float

early reflection intensity for this reverb type, in dB

getLateReflectionDelayback to summary
public final int getLateReflectionDelay()

Returns the late reflection delay time in microseconds. This is the amount of time between when the first early reflections are heard and when the first late reflections are heard.

Returns:int

late reflection delay time for this reverb type, in microseconds

getLateReflectionIntensityback to summary
public final float getLateReflectionIntensity()

Returns the late reflection intensity in decibels. This is the amplitude attenuation of the first late reflections relative to the direct signal.

Returns:float

late reflection intensity for this reverb type, in dB

getNameback to summary
public String getName()

Obtains the name of this reverb type.

Returns:String

the name of this reverb type

Since
1.5
hashCodeback to summary
public final int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this reverb type.

Returns:int

a hash code value for this reverb type

Annotations
@Override
toStringback to summary
public final String toString()

Overrides java.lang.Object.toString.

Returns a string representation of the reverb type, including its name and its parameter settings. The exact contents of the string may vary between implementations of Java Sound.

Returns:String

a string representation of the reverb type

Annotations
@Override