Package org.collebol.engine.audio

Class SoundPlayer.ModifySound

java.lang.Object

org.collebol.engine.audio.Sound

org.collebol.engine.audio.SoundPlayer.ModifySound

Enclosing class:

SoundPlayer

public static class SoundPlayer.ModifySound
extends Sound

The ModifySound class is used to modify sound properties before playing.

Nested Class Summary

Nested classes/interfaces inherited from class org.collebol.engine.audio.Sound

Sound.SoundBuilder

Constructor Summary

Constructors

Constructor	Description
ModifySound(int id, SoundPlayer soundPlayer)

Method Summary

Modifier and Type	Method	Description
SoundPlayer.ModifySound	pitch(float pitch)
SoundPlayer.ModifySound	position(Vector2D position)
SoundPlayer.ModifySound	refDistance(float distance)
SoundPlayer.ModifySound	rollOffFactor(float factor)
SoundPlayer.ModifySound	volume(float volume)

Methods inherited from class org.collebol.engine.audio.Sound

getId, getPath, getPitch, getPosition, getRefDistance, getRollOffFactor, getSource, getVolume, setPitch, setPosition, setRefDistance, setRollOffFactor, setVolume

Methods inherited from class java.lang.Object

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

Constructor Details

ModifySound

public ModifySound(int id,
 SoundPlayer soundPlayer)

Method Details

position

public SoundPlayer.ModifySound position(Vector2D position)

volume

public SoundPlayer.ModifySound volume(float volume)

Parameters:

volume - modified volume of the source.

Returns:

instance

pitch

public SoundPlayer.ModifySound pitch(float pitch)

Parameters:

pitch - modified pitch of the source.

Returns:

instance

refDistance

public SoundPlayer.ModifySound refDistance(float distance)

Parameters:

distance - modified max distance where you can hear the source.

Returns:

instance

rollOffFactor

public SoundPlayer.ModifySound rollOffFactor(float factor)

Parameters:

factor - modified float how fast the volume decreases.

Returns:

instance