ch.hevs.gdx2d.components.audio

Class SoundSample

java.lang.Object

ch.hevs.gdx2d.components.audio.SoundSample

All Implemented Interfaces:

Disposable

public class SoundSample
extends Object
implements Disposable

A class to play short samples within gdx2d. The music sample must be short because it is completely loaded into memory. The counterpart is that you can play many many samples at the same time and modify their pitch and volume dynamically (see setPitch(float) and setVolume(float)).

Note that SoundSample differs from MusicPlayer in the sense that a sample is completely loaded into memory before playing. Thus, it makes sense to play short samples but not complete songs (for background music for instance).

Version:

1.4

Author:

Pierre-André Mudry (mui), Nils Chatton (chn)

Field Summary

Fields

Modifier and Type	Field and Description
protected float	pitch
protected Sound	s
protected float	volume

Constructor Summary

Constructors

Constructor and Description
SoundSample(String file) Constructor

Method Summary

Modifier and Type	Method and Description
void	dispose() Release resources when done working with them
protected void	finalize()
long	loop() Plays the song in loop (repeat forever), using the current volume and pitch.
void	modifyPitch(float newPitch, long id) Changes the pitch of a currently playing sound, specified by its id (which is returned by the play() method).
void	mofidyPlayingVolument(float newVolume, long id) Changes the volume of a currently playing sound, specified by its id (which is returned by the play() method).
long	play() Starts playing the sample at the current pitch and volume.
void	setPitch(float p) Changes the speed (pitch) at which the sound is played.
void	setVolume(float v) Changes volume of the song played
void	stop() Stops playing the sample

Methods inherited from class java.lang.Object

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

Field Detail

s

protected Sound s

volume

protected float volume

pitch

protected float pitch

Constructor Detail

SoundSample

public SoundSample(String file)

Constructor

Parameters:

file - the file to be loaded, using internal path representation

Method Detail

setVolume

public void setVolume(float v)

Changes volume of the song played

Parameters:

v - Should be between 0 and 1

setPitch

public void setPitch(float p)

Changes the speed (pitch) at which the sound is played. Valid values are between 0.5 (twice slower) and 2 (twice faster)

Parameters:

p - Speed (pitch) of the sound

modifyPitch

public void modifyPitch(float newPitch,
                        long id)

Changes the pitch of a currently playing sound, specified by its id (which is returned by the play() method). If the sound is no longer playing, nothing happens

Parameters:

newPitch - See setPitch(float)

id - See play()

mofidyPlayingVolument

public void mofidyPlayingVolument(float newVolume,
                                  long id)

Changes the volume of a currently playing sound, specified by its id (which is returned by the play() method). If the sound is no longer playing, nothing happens

Parameters:

newVolume - See setVolume(float)

id - See play()

play

public long play()

Starts playing the sample at the current pitch and volume. If it is already playing, another sample will start, concurrently.

Returns:

The id of the currently playing sample. Can be used to change pitch and volume while playing

stop

public void stop()

Stops playing the sample

loop

public long loop()

Plays the song in loop (repeat forever), using the current volume and pitch.

Returns:

The id of the currently playing sample. Can be used to change pitch and volume while playing

dispose

public void dispose()

Release resources when done working with them

Specified by:

dispose in interface Disposable

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable