org.jsfml.audio

Class SoundStream

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.audio.SoundSource

org.jsfml.audio.SoundStream

Direct Known Subclasses:

Music

public abstract class SoundStream
extends SoundSource

Abstract base class for streamed sound sources.

Unlike buffered sounds, streamed sounds are not held in memory in their entirety, but only a certain amount of sound chunks. When the currently buffered chunk is done being played, the next chunk is requested from the stream's source.

This approach should be preferred for long sounds that do not need to be sought around in often, such as music or procedurally generated sounds.

See Also:

SoundStream.Chunk

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoundStream.Chunk Represents a chunk of audio data provided by a SoundStream when new data is requested.

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

SoundSource.Status

Constructor Summary

Constructors

Constructor and Description
SoundStream() Constructs a sound stream.

Method Summary

Methods

Modifier and Type	Method and Description
int	getChannelCount() Gets the amount of audio channels of this stream.
Time	getPlayingOffset() Gets the playing offset at which to play from the stream.
int	getSampleRate() Gets the sample rate of this stream.
SoundSource.Status	getStatus() Gets the current state of the sound stream.
protected void	initialize(int channelCount, int sampleRate) Defines the audio stream parameters.
boolean	isLoop() Returns whether or not the sound stream playback is looping.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
protected abstract SoundStream.Chunk	onGetData() Requests a new chunk of audio data.
protected abstract void	onSeek(Time time) Re-positions the stream's current playing offset.
void	pause() Pauses playback of the stream if it is currently playing.
void	play() Starts playing the stream or resumes it if it is currently paused.
void	setLoop(boolean loop) Enables or disables repeated looping of the sound stream playback.
void	setPlayingOffset(Time offset) Sets the current playing offset at which to play from the stream.
void	stop() Stops playing the stream.

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

SoundStream

public SoundStream()

Constructs a sound stream.

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 stream or resumes it if it is currently paused.

pause

public void pause()

Pauses playback of the stream if it is currently playing.

stop

public void stop()

Stops playing the stream.

getChannelCount

public int getChannelCount()

Gets the amount of audio channels of this stream.

Returns:

the amount of audio channels of this stream.

getSampleRate

public int getSampleRate()

Gets the sample rate of this stream.

Returns:

the sample rate of this stream in samples per second.

setPlayingOffset

public final void setPlayingOffset(Time offset)

Sets the current playing offset at which to play from the stream.

Parameters:

offset - the playing offset at which to play from the stream.

getPlayingOffset

public Time getPlayingOffset()

Gets the playing offset at which to play from the stream.

Returns:

the playing offset at which to play from the stream.

setLoop

public void setLoop(boolean loop)

Enables or disables repeated looping of the sound stream playback.

If a looping sound stream has finished playing its last audio chunk, it will restart playing from the first chunk as if setPlayingOffset(Time.ZERO) was invoked.

Parameters:

loop - true to enable looping, false to disable.

isLoop

public boolean isLoop()

Returns whether or not the sound stream playback is looping.

If a looping sound stream has finished playing its last audio chunk, it will restart playing from the first chunk as if setPlayingOffset(Time.ZERO) was invoked.

Returns:

true if it is looping, false if not.

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.

initialize

protected void initialize(int channelCount,
              int sampleRate)

Defines the audio stream parameters.

Before the stream can be played, the implementing class must call this method.

Parameters:

channelCount - the amount of audio channels (e.g. 1 for mono, 2 for stereo).

sampleRate - the sample rate in samples per second.

onGetData

protected abstract SoundStream.Chunk onGetData()

Requests a new chunk of audio data.

This method is called when the audio stream has played all buffered samples and needs new samples to continue playing.

Note that this method will be called within a separate playback thread.

Returns:

the next chunk of audio data. If the chunk is marked as the last chunk, the stream will either stop playing after playing this chunk, or restart from the beginning if isLoop() returns true. To stop playback immediately, null may be returned.

See Also:

SoundStream.Chunk

onSeek

protected abstract void onSeek(Time time)

Re-positions the stream's current playing offset.

This method is called when the stream is reset or a re-positioning has been requested via setPlayingOffset(org.jsfml.system.Time).

Note that this method will be called within a separate playback thread.

Parameters:

time - the time offset to jump to.