org.jsfml.audio

Class Music

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.audio.SoundSource

org.jsfml.audio.SoundStream

org.jsfml.audio.Music

public class Music
extends SoundStream

Provides functionality to play music streams from common audio file formats.

Audio files can be opened using either the openFromFile(java.nio.file.Path) or openFromStream(java.io.InputStream) methods.

The supported audio file formats are: ogg, wav, flac, aiff, au, raw, paf, svx, nist, voc, ircam, w64, mat4, mat5 pvf, htk, sds, avr, sd2, caf, wve, mpc2k, rf64

Nested Class Summary

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

SoundStream.Chunk

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

SoundSource.Status

Constructor Summary

Constructors

Constructor and Description
Music() Constructs a music.

Method Summary

Methods

Modifier and Type	Method and Description
Time	getDuration() Gets the total duration of the music.
protected void	initialize(int channelCount, int sampleRate) Defines the audio stream parameters.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
protected SoundStream.Chunk	onGetData() Requests a new chunk of audio data.
protected void	onSeek(Time time) Re-positions the stream's current playing offset.
void	openFromFile(Path path) Attempts to open the music from a file.
void	openFromStream(InputStream in) Attempts to open the music from an InputStream.

Methods inherited from class org.jsfml.audio.SoundStream

getChannelCount, getPlayingOffset, getSampleRate, getStatus, isLoop, pause, play, setLoop, setPlayingOffset, stop

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

Music

public Music()

Constructs a music.

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.

Overrides:

nativeCreate in class SoundStream

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.

Overrides:

nativeSetExPtr in class SoundStream

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Overrides:

nativeDelete in class SoundStream

openFromStream

public void openFromStream(InputStream in)
                    throws IOException

Attempts to open the music from an InputStream.

Parameters:

in - the input stream to stream from.

Throws:

IOException - in case an I/O error occurs.

openFromFile

public void openFromFile(Path path)
                  throws IOException

Attempts to open the music from a file.

Parameters:

path - the file to stream from.

Throws:

IOException - in case an I/O error occurs.

getDuration

public Time getDuration()

Gets the total duration of the music.

Returns:

the total duration of the music.

initialize

protected final void initialize(int channelCount,
              int sampleRate)

Description copied from class: SoundStream

Defines the audio stream parameters.

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

Overrides:

initialize in class SoundStream

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 final SoundStream.Chunk onGetData()

Description copied from class: SoundStream

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.

Specified by:

onGetData in class SoundStream

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 SoundStream.isLoop() returns true. To stop playback immediately, null may be returned.

See Also:

SoundStream.Chunk

onSeek

protected final void onSeek(Time time)

Description copied from class: SoundStream

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 SoundStream.setPlayingOffset(org.jsfml.system.Time).

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

Specified by:

onSeek in class SoundStream

Parameters:

time - the time offset to jump to.