org.jsfml.audio

Interface ConstSoundBuffer

All Superinterfaces:

Const

All Known Implementing Classes:

SoundBuffer

public interface ConstSoundBuffer
extends Const

Read-only interface for sound buffers.

It provides methods to can gain information from a sound buffer (such as the duration) and save it to a file.

Note that this interface is expected to be implemented by a SoundBuffer. It is not recommended to be implemented outside of the JSFML API.

See Also:

Const

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	saveToFile(Path path) Attempts to save the sound buffer to a file.

Method Detail

saveToFile

void saveToFile(Path path)
                throws IOException

Attempts to save the sound buffer to a file.

Parameters:

path - the path to the file to write.

Throws:

IOException - in case saving failed.

getSamples

short[] getSamples()

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

Returns:

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

getSampleCount

int getSampleCount()

Retrieves the amount of samples stored in the buffer.

Returns:

the amount of samples stored in the buffer.

getSampleRate

int getSampleRate()

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

Returns:

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

getChannelCount

int getChannelCount()

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

Returns:

the amount of audio channels in the buffer.

getDuration

Time getDuration()

Gets the duration of the sound.

Returns:

the duration of the sound.