org.mini2Dx.libgdx.audio

Class LibgdxSound

java.lang.Object

org.mini2Dx.libgdx.audio.LibgdxSound

All Implemented Interfaces:

Sound, org.mini2Dx.gdx.utils.Disposable

public class LibgdxSound
extends java.lang.Object
implements Sound

Field Summary

Fields

Modifier and Type	Field and Description
com.badlogic.gdx.audio.Sound	sound

Constructor Summary

Constructors

Constructor and Description
LibgdxSound(com.badlogic.gdx.audio.Sound sound)

Method Summary

Modifier and Type	Method and Description
void	dispose()
long	loop() Loops the sound at full volume, center panning .
long	loop(float volume) Loops the sound at the specified volume, center panning.
long	loop(float volume, float pitch, float pan) Loops the sound at the specified volume, pitch and panning.
void	pause() Pauses all playing instances of this sound
void	pause(long soundId) Pauses the specific instance of this sound.
long	play() Plays the sound at full volume, center panning.
long	play(float volume) Plays the sound at the specified volume, center panning.
long	play(float volume, float pitch, float pan) Plays the sound at the specified volume, pitch and panning.
void	resume() Resumes all playing instances of this sound
void	resume(long soundId) Resumes the specific instance of this sound.
void	setLooping(long soundId, boolean looping) Sets if the specific instance of this sound should loop.
void	setPan(long soundId, float pan, float volume) Sets the pan and volume of the specific instance of this sound.
void	setPitch(long soundId, float pitch) Sets the pitch of the specific instance of this sound.
void	setVolume(long soundId, float volume) Sets the volume of the specific instance of this sound.
void	stop() Stops all playing instances of this sound
void	stop(long soundId) Stops the specific instance of this sound.

Methods inherited from class java.lang.Object

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

Field Detail

sound

public final com.badlogic.gdx.audio.Sound sound

Constructor Detail

LibgdxSound

public LibgdxSound(com.badlogic.gdx.audio.Sound sound)

Method Detail

play

public long play()

Description copied from interface: Sound

Plays the sound at full volume, center panning. If it is already playing, it will be played again concurrently.

Specified by:

play in interface Sound

Returns:

-1 on failure, otherwise the unique ID of the playing instance.

play

public long play(float volume)

Description copied from interface: Sound

Plays the sound at the specified volume, center panning. If it is already playing, it will be played again concurrently.

Specified by:

play in interface Sound

Parameters:

volume - The volume to play at where 0.0 is silent and 1.0 is full volume

Returns:

-1 on failure, otherwise the unique ID of the playing instance.

play

public long play(float volume,
                 float pitch,
                 float pan)

Description copied from interface: Sound

Plays the sound at the specified volume, pitch and panning. If it is already playing, it will be played again concurrently.

Specified by:

play in interface Sound

Parameters:

volume - The volume to play at where 0.0 is silent and 1.0 is full volume

pitch - The pitch multiplier where 1.0 is default, >1 is faster and <1 is slower. The value range must be between 0.5 and 2.0

pan - The panning where -1.0 is full left, 1.0 is full right and 0.0 is center.

Returns:

-1 on failure, otherwise the unique ID of the playing instance.

loop

public long loop()

Description copied from interface: Sound

Loops the sound at full volume, center panning . If it is already playing, it will be played again concurrently.

Specified by:

loop in interface Sound

Returns:

-1 on failure, otherwise the unique ID of the playing instance.

loop

public long loop(float volume)

Description copied from interface: Sound

Loops the sound at the specified volume, center panning. If it is already playing, it will be played again concurrently.

Specified by:

loop in interface Sound

Parameters:

volume - The volume to play at where 0.0 is silent and 1.0 is full volume

Returns:

-1 on failure, otherwise the unique ID of the playing instance.

loop

public long loop(float volume,
                 float pitch,
                 float pan)

Description copied from interface: Sound

Loops the sound at the specified volume, pitch and panning. If it is already playing, it will be played again concurrently.

Specified by:

loop in interface Sound

Parameters:

volume - The volume to play at where 0.0 is silent and 1.0 is full volume

pitch - The pitch multiplier where 1.0 is default, >1 is faster and <1 is slower. The value range must be between 0.5 and 2.0

pan - The panning where -1.0 is full left, 1.0 is full right and 0.0 is center.

Returns:

-1 on failure, otherwise the unique ID of the playing instance.

stop

public void stop()

Description copied from interface: Sound

Stops all playing instances of this sound

Specified by:

stop in interface Sound

pause

public void pause()

Description copied from interface: Sound

Pauses all playing instances of this sound

Specified by:

pause in interface Sound

resume

public void resume()

Description copied from interface: Sound

Resumes all playing instances of this sound

Specified by:

resume in interface Sound

stop

public void stop(long soundId)

Description copied from interface: Sound

Stops the specific instance of this sound. If it is no longer playing this has no effect.

Specified by:

stop in interface Sound

Parameters:

soundId - The sound ID that was returned when play/loop was called

pause

public void pause(long soundId)

Description copied from interface: Sound

Pauses the specific instance of this sound. If it is no longer playing this has no effect.

Specified by:

pause in interface Sound

Parameters:

soundId - The sound ID that was returned when play/loop was called

resume

public void resume(long soundId)

Description copied from interface: Sound

Resumes the specific instance of this sound. If it is no longer playing this has no effect.

Specified by:

resume in interface Sound

Parameters:

soundId - The sound ID that was returned when play/loop was called

setLooping

public void setLooping(long soundId,
                       boolean looping)

Description copied from interface: Sound

Sets if the specific instance of this sound should loop. If it is no longer playing this has no effect.

Specified by:

setLooping in interface Sound

Parameters:

soundId - The sound ID that was returned when play/loop was called

looping - True if the sound should loop

setPitch

public void setPitch(long soundId,
                     float pitch)

Description copied from interface: Sound

Sets the pitch of the specific instance of this sound. If it is no longer playing this has no effect.

Specified by:

setPitch in interface Sound

Parameters:

soundId - The sound ID that was returned when play/loop was called

pitch - The pitch multiplier where 1.0 is default, >1 is faster and <1 is slower. The value range must be between 0.5 and 2.0

setVolume

public void setVolume(long soundId,
                      float volume)

Description copied from interface: Sound

Sets the volume of the specific instance of this sound. If it is no longer playing this has no effect.

Specified by:

setVolume in interface Sound

Parameters:

soundId - The sound ID that was returned when play/loop was called

volume - The volume to play at where 0.0 is silent and 1.0 is full volume

setPan

public void setPan(long soundId,
                   float pan,
                   float volume)

Description copied from interface: Sound

Sets the pan and volume of the specific instance of this sound. If it is no longer playing this has no effect.

Specified by:

setPan in interface Sound

Parameters:

soundId - The sound ID that was returned when play/loop was called

pan - The panning where -1.0 is full left, 1.0 is full right and 0.0 is center.

volume - The volume to play at where 0.0 is silent and 1.0 is full volume

dispose

public void dispose()

Specified by:

dispose in interface org.mini2Dx.gdx.utils.Disposable