com.sun.media.jfxmedia.effects

Interface AudioSpectrum

public interface AudioSpectrum

Method Summary

Modifier and Type	Method and Description
int	getBandCount() Gets the number of bands in the audio spectrum
boolean	getEnabled() Returns whether audio spectrum is enabled or not.
double	getInterval() Returns the interval between AudioSpectrumEvents in seconds.
float[]	getMagnitudes(float[] magnitudes) Returns an array of the last available magnitudes.
float[]	getPhases(float[] phases) Returns an array of the last available phases.
int	getSensitivityThreshold() Returns sensitivity threshold in dB.
void	setBandCount(int bands) Sets the number of bands in the audio spectrum
void	setEnabled(boolean enabled) Turns on or off audio spectrum support.
void	setInterval(double interval) Set the interval between AudioSpectrumEvents in seconds.
void	setSensitivityThreshold(int threshold) Sets sensitivity threshold in dB.

Method Detail

getEnabled

boolean getEnabled()

Returns whether audio spectrum is enabled or not.

Returns:

boolean value

setEnabled

void setEnabled(boolean enabled)

Turns on or off audio spectrum support.

Parameters:

enable - boolean value

getBandCount

int getBandCount()

Gets the number of bands in the audio spectrum

Returns:

int value

setBandCount

void setBandCount(int bands)

Sets the number of bands in the audio spectrum

Parameters:

bands - integer value

getInterval

double getInterval()

Returns the interval between AudioSpectrumEvents in seconds.

Returns:

double value

setInterval

void setInterval(double interval)

Set the interval between AudioSpectrumEvents in seconds.

Parameters:

interval - double value

getSensitivityThreshold

int getSensitivityThreshold()

Returns sensitivity threshold in dB. All lower values will be set to this.

Returns:

int value

setSensitivityThreshold

void setSensitivityThreshold(int threshold)

Sets sensitivity threshold in dB. All lower values will be set to this. Allowed values: <= 0

Parameters:

threshold - int value

getMagnitudes

float[] getMagnitudes(float[] magnitudes)

Returns an array of the last available magnitudes. The size of the array equals the number of bands set by the setBandCount(int) method. A newly created array contains Float.NEGATIVE_INFINITY values. When the number of bands is 0 this method returns an empty array. If a non-null array large enough to hold the values is passed in, it will be used; otherwise a newly allocated array will be returned.

Parameters:

magnitudes - An optionally preallocated double array.

Returns:

array of float values.

getPhases

float[] getPhases(float[] phases)

Returns an array of the last available phases. The size of the array equals the number of bands set by the setBandCount(int) method. A newly created array contains 0.0 values. When the number of bands is 0 this method returns an empty array. If a non-null array large enough to hold the values is passed in, it will be used; otherwise a newly allocated array will be returned.

Parameters:

phases - An optionally preallocated double array.

Returns:

array of float values.