org.jsfml.audio

Class Sound

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.audio.SoundSource

org.jsfml.audio.Sound

public class Sound
extends SoundSource

Provides functionality to instantiate a SoundBuffer and play a buffered sound.

Nested Class Summary

Nested classes/interfaces inherited from class org.jsfml.audio.SoundSource

SoundSource.Status

Constructor Summary

Constructors

Constructor and Description
Sound() Constructs an empty sound.
Sound(ConstSoundBuffer soundBuffer) Constructs a sound with the specified SoundBuffer
Sound(Sound other) Constructs a sound by copying another sound.

Method Summary

Methods

Modifier and Type	Method and Description
ConstSoundBuffer	getBuffer() Gets the underlying sound buffer that this sound plays from.
Time	getPlayingOffset() Gets the playing offset from where to start playing the underlying buffer.
SoundSource.Status	getStatus() Gets the current state of the sound stream.
boolean	isLoop() Returns whether or not the sound is looping.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
void	pause() Pauses the sound if it is currently playing.
void	play() Starts playing the sound or resumes it if it is currently paused.
void	setBuffer(ConstSoundBuffer soundBuffer) Sets the sound buffer used by this sound.
void	setLoop(boolean loop) Enables or disables repeated looping of the sound.
void	setPlayingOffset(Time offset) Sets the playing offset from where to play the underlying buffer.
void	stop() Stops the sound if it is currently playing or paused.

Methods inherited from class org.jsfml.audio.SoundSource

getAttenuation, getMinDistance, getPitch, getPosition, getVolume, isRelativeToListener, setAttenuation, setMinDistance, setPitch, setPosition, setPosition, setRelativeToListener, setVolume

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize

Methods inherited from class java.lang.Object

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

Constructor Detail

Sound

public Sound()

Constructs an empty sound.

Sound

public Sound(ConstSoundBuffer soundBuffer)

Constructs a sound with the specified SoundBuffer

Parameters:

soundBuffer - the sound buffer to use.

Sound

public Sound(Sound other)

Constructs a sound by copying another sound.

Parameters:

other - the sound to copy.

Method Detail

nativeCreate

@Deprecated
protected long nativeCreate()

Deprecated.

Description copied from class: SFMLNativeObject

Creates a new native SFML object of the represented SFML class in the JVM memory heap.

Specified by:

nativeCreate in class SFMLNativeObject

Returns:

the pointer to the newly created native SFML object.

nativeSetExPtr

@Deprecated
protected void nativeSetExPtr()

Deprecated.

Description copied from class: SFMLNativeObject

This method is expected to fill the extra pointers array, if any.

It is called after the object has been created or wrapped around an already existing pointer.

Specified by:

nativeSetExPtr in class SFMLNativeObject

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Specified by:

nativeDelete in class SFMLNativeObject

play

public void play()

Starts playing the sound or resumes it if it is currently paused.

pause

public void pause()

Pauses the sound if it is currently playing.

stop

public void stop()

Stops the sound if it is currently playing or paused.

setBuffer

public void setBuffer(ConstSoundBuffer soundBuffer)

Sets the sound buffer used by this sound.

Parameters:

soundBuffer - the new sound buffer.

setLoop

public void setLoop(boolean loop)

Enables or disables repeated looping of the sound.

If this is set to true and the sound has finished playing, it will be restarted from the beginning as if setPlayingOffset(Time.ZERO) was called.

Parameters:

loop - true to enable looping, false to disable.

setPlayingOffset

public void setPlayingOffset(Time offset)

Sets the playing offset from where to play the underlying buffer.

Parameters:

offset - the playing offset in the underlaying buffer.

getBuffer

public ConstSoundBuffer getBuffer()

Gets the underlying sound buffer that this sound plays from.

Returns:

the underlying sound buffer that this sound plays from.

isLoop

public boolean isLoop()

Returns whether or not the sound is looping.

Returns:

true if this sound is looping, false if not.

getPlayingOffset

public Time getPlayingOffset()

Gets the playing offset from where to start playing the underlying buffer.

Returns:

the playing offset from where to start playing the underlying buffer.

getStatus

public SoundSource.Status getStatus()

Description copied from class: SoundSource

Gets the current state of the sound stream.

Overrides:

getStatus in class SoundSource

Returns:

the current state of the sound stream.