org.jsfml.audio

Class SoundSource

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.audio.SoundSource

Direct Known Subclasses:

Sound, SoundStream

public abstract class SoundSource
extends SFMLNativeObject

Abstract base class for playable sound sources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoundSource.Status Enumeration of possible sound source states.

Constructor Summary

Constructors

Constructor and Description
SoundSource() Constructs a sound source.

Method Summary

Methods

Modifier and Type	Method and Description
float	getAttenuation() Gets the sound's attenuation factor.
float	getMinDistance() Gets the sound's minimum distance from the Listener before attenuation sets in.
float	getPitch() Gets the sound's current pitch factor.
Vector3f	getPosition() Gets the sound's current position in the scene.
protected SoundSource.Status	getStatus() Gets the current state of the sound stream.
float	getVolume() Gets the sound's current volume.
boolean	isRelativeToListener() Returns whether the sound's position is relative to the Listener.
void	setAttenuation(float att) Sets the sound's attenuation factor.
void	setMinDistance(float distance) Sets the minimum distance of the sound before attenuation kicks in.
void	setPitch(float pitch) Sets the pitch factor of the sound.
void	setPosition(float x, float y, float z) Sets the position of the sound in the scene.
void	setPosition(Vector3f v) Sets the position of the sound in the scene.
void	setRelativeToListener(boolean relative) Determines whether the sound position is bound to be relative to the Listener or whether it is positioned absolutely in the scene.
void	setVolume(float volume) Sets the volume of the sound.

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize, nativeCreate, nativeDelete, nativeSetExPtr

Methods inherited from class java.lang.Object

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

Constructor Detail

SoundSource

public SoundSource()

Constructs a sound source.

Method Detail

setPitch

public void setPitch(float pitch)

Sets the pitch factor of the sound.

This factor is used to scale the sound's original pitch. This means that the default value of 1 will not affect the pitch at all. Values between 0 and 1 will pitch down the sound, while values greater than 1 will pitch it up.

Parameters:

pitch - the new pitch factor of the sound.

setVolume

public void setVolume(float volume)

Sets the volume of the sound.

The sound volume is a percentages and ranges between 0 (silence) and 100 (full volume). The default volume of a sound is 100.

Parameters:

volume - the new volume of the sound, ranging between 0 and 100.

setPosition

public final void setPosition(float x,
               float y,
               float z)

Sets the position of the sound in the scene.

This allows for sound spatialization, also involving the Listener. The sound position is set either absolutely in the scene or relatively to the Listener, depending on whether isRelativeToListener() is true or false.

By default, a sound is located at the origin (0, 0, 0).

Note that only mono sounds (ie 1 audio channel) can be spatialized.

Parameters:

x - the sound's new X coordinate.

y - the sound's new Y coordinate.

z - the sound's new Z coordinate.

See Also:

setRelativeToListener(boolean)

setPosition

public void setPosition(Vector3f v)

Sets the position of the sound in the scene.

This allows for sound spatialization, also involving the Listener. The sound position is set either absolutely in the scene or relatively to the Listener, depending on whether isRelativeToListener() is true or false.

By default, a sound is located at the origin (0, 0, 0).

Note that only mono sounds (ie 1 audio channel) can be spatialized.

Parameters:

v - the sound's new position.

See Also:

setRelativeToListener(boolean)

setRelativeToListener

public void setRelativeToListener(boolean relative)

Determines whether the sound position is bound to be relative to the Listener or whether it is positioned absolutely in the scene.

By default, the sound's position in the scene is absolute.

Parameters:

relative - true to make the sound position relative to the listener, false to make it absolute.

See Also:

setPosition(float, float, float)

setMinDistance

public void setMinDistance(float distance)

Sets the minimum distance of the sound before attenuation kicks in.

If the distance between the sound and the Listener is less or equal to this value, the sound will be heard at its maximum volume. As the distance becomes larger, the sound is attenuated (ie become more quiet) according to its attenuation factor.

The default minimum distance is 1.

Parameters:

distance - the minimum distance before attenuation in world units.

See Also:

setAttenuation(float)

setAttenuation

public void setAttenuation(float att)

Sets the sound's attenuation factor.

As the distance between the sound and the Listener becomes higher than the minimum distance, the sound volume will decrease according to this factor.

The attenuation factor ranges between 0 (no attenuation) and 100 (instant attenuation), where the default value is 1.

Parameters:

att - the new attenuation factor, ranging between 0 (no attenuation) and 100 (instant attenuation).

See Also:

setMinDistance(float)

getPitch

public float getPitch()

Gets the sound's current pitch factor.

A value of 1 means that the sound is not pitched, a value between 0 and 1 means that the sound is pitched down, a value greater than 1 means that the sound is pitched up.

Returns:

the sound's current pitch factor.

getVolume

public float getVolume()

Gets the sound's current volume.

The volume level ranges between 0 (silence) and 100 (full volume).

Returns:

the sound's current volume, ranging between 0 (silence) and 100 (full volume).

getPosition

public Vector3f getPosition()

Gets the sound's current position in the scene.

Returns:

the sound's current position in the scene.

isRelativeToListener

public boolean isRelativeToListener()

Returns whether the sound's position is relative to the Listener.

Returns:

true if the sound's position is relative to the listener, false if it is absolute.

See Also:

setRelativeToListener(boolean)

getMinDistance

public float getMinDistance()

Gets the sound's minimum distance from the Listener before attenuation sets in.

Returns:

the sound's minimum distance before attenuation sets in.

See Also:

setMinDistance(float)

getAttenuation

public float getAttenuation()

Gets the sound's attenuation factor.

The attenuation factor ranges between 0 (no attenuation) and 100 (instant attenuation), where the default value is 1.

Returns:

the sound's attenuation factor.

See Also:

setAttenuation(float)

getStatus

protected SoundSource.Status getStatus()

Gets the current state of the sound stream.

Returns:

the current state of the sound stream.