org.jsfml.audio

Class SoundBuffer

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.audio.SoundBuffer

All Implemented Interfaces:

ConstSoundBuffer, Const

public class SoundBuffer
extends SFMLNativeObject
implements ConstSoundBuffer

Buffer of audio samples, providing an audio data source for a Sound.

Constructor Summary

Constructors

Constructor and Description
SoundBuffer() Constructs a sound buffer.
SoundBuffer(ConstSoundBuffer other) Constructs a sound buffer by copying another sound buffer.

Method Summary

Methods

Modifier and Type	Method and Description
int	getChannelCount() Gets the amount of audio channels in the buffer (e.g.
Time	getDuration() Gets the duration of the sound.
int	getSampleCount() Retrieves the amount of samples stored in the buffer.
int	getSampleRate() Gets the sound buffer's sample rate in samples per second.
short[]	getSamples() Retrieves the raw 16-bit audio samples stored in the buffer.
void	loadFromFile(Path path) Attempts to load the sound buffer from a file.
void	loadFromSamples(short[] samples, int channelCount, int sampleRate) Attempts to load the sound buffer from an array of raw 16-bit audio samples.
void	loadFromStream(InputStream in) Fully loads all available bytes from the specified InputStream and attempts to load the sound buffer from it.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
void	saveToFile(Path path) Attempts to save the sound buffer to a file.

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

SoundBuffer

public SoundBuffer()

Constructs a sound buffer.

SoundBuffer

public SoundBuffer(ConstSoundBuffer other)

Constructs a sound buffer by copying another sound buffer.

Parameters:

other - the sound buffer 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

loadFromStream

public void loadFromStream(InputStream in)
                    throws IOException

Fully loads all available bytes from the specified InputStream and attempts to load the sound buffer from it.

Parameters:

in - the input stream to read from.

Throws:

IOException - in case an I/O error occurs.

loadFromFile

public void loadFromFile(Path path)
                  throws IOException

Attempts to load the sound buffer from a file.

Parameters:

path - the path to the file to load the sound buffer from.

Throws:

IOException - in case an I/O error occurs.

loadFromSamples

public void loadFromSamples(short[] samples,
                   int channelCount,
                   int sampleRate)
                     throws IOException

Attempts to load the sound buffer from an array of raw 16-bit audio samples.

Parameters:

samples - the samples data.

channelCount - the amount of audio channels.

sampleRate - the sample rate in samples per second.

Throws:

IOException - in case an I/O error occurs.

saveToFile

public void saveToFile(Path path)
                throws IOException

Description copied from interface: ConstSoundBuffer

Attempts to save the sound buffer to a file.

Specified by:

saveToFile in interface ConstSoundBuffer

Parameters:

path - the path to the file to write.

Throws:

IOException - in case saving failed.

getSamples

public short[] getSamples()

Description copied from interface: ConstSoundBuffer

Retrieves the raw 16-bit audio samples stored in the buffer.

Specified by:

getSamples in interface ConstSoundBuffer

Returns:

the raw audio 16-bit samples stored in the buffer.

getSampleCount

public int getSampleCount()

Description copied from interface: ConstSoundBuffer

Retrieves the amount of samples stored in the buffer.

Specified by:

getSampleCount in interface ConstSoundBuffer

Returns:

the amount of samples stored in the buffer.

getSampleRate

public int getSampleRate()

Description copied from interface: ConstSoundBuffer

Gets the sound buffer's sample rate in samples per second.

Specified by:

getSampleRate in interface ConstSoundBuffer

Returns:

the sound buffer's sample rate in samples per second.

getChannelCount

public int getChannelCount()

Description copied from interface: ConstSoundBuffer

Gets the amount of audio channels in the buffer (e.g. 1 for mono, 2 for stereo etc).

Specified by:

getChannelCount in interface ConstSoundBuffer

Returns:

the amount of audio channels in the buffer.

getDuration

public Time getDuration()

Description copied from interface: ConstSoundBuffer

Gets the duration of the sound.

Specified by:

getDuration in interface ConstSoundBuffer

Returns:

the duration of the sound.