Package games.stendhal.client.sound.system.processors

Class VolumeAdjustor

java.lang.Object

games.stendhal.client.sound.system.SignalProcessor

games.stendhal.client.sound.system.processors.VolumeAdjustor

public class VolumeAdjustor
extends SignalProcessor

Adjust the volume of a PCM audio signal.

Author:

silvio

Constructor Summary

Constructors

Constructor	Description
VolumeAdjustor()
VolumeAdjustor(float volume)

Method Summary

Modifier and Type	Method	Description
float	getVolume()
protected void	modify(float[] data, int frames, int channels, int rate)	This function should be overwritten by all classes that want to modify an PCM audio stream.
void	setVolume(float volume)
void	startFading(float volume, Time duration)
void	startFading(Time duration)

Methods inherited from class games.stendhal.client.sound.system.SignalProcessor

connectTo, createChain, disconnect, finished, generate, insert, propagate, quit, replace, request, split

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VolumeAdjustor

public VolumeAdjustor()

VolumeAdjustor

public VolumeAdjustor(float volume)

Method Details

setVolume

public void setVolume(float volume)

getVolume

public float getVolume()

startFading

public void startFading(float volume,
 Time duration)

startFading

public void startFading(Time duration)

modify

protected void modify(float[] data,
 int frames,
 int channels,
 int rate)

Description copied from class: SignalProcessor

This function should be overwritten by all classes that want to modify an PCM audio stream. The audio data is uniform and interleaved. uniform: Each sample has a value between -1.0 and 1.0 interleaved: The channels are not separated. They are bundled in frames e.g. if there is stereo PCM data: data[0] and data[1] are the left and right channels of sample 0 data[2] and data[3] are the left and right channels of sample 1 data[4] and data[5] are the left and right channels of sample 2 and so on ... The number of samples can be calculated by: frames * channels

Overrides:

modify in class SignalProcessor

Parameters:

data - the audio data

frames - the number of sample frames contained in "data"

channels - number of channels

rate - the sample rate