org.mini2Dx.core.audio

Interface Sound

All Superinterfaces:

org.mini2Dx.gdx.utils.Disposable

All Known Implementing Classes:

LibgdxSound

public interface Sound
extends org.mini2Dx.gdx.utils.Disposable

Base interface for sound effect playback

Method Summary

Modifier and Type	Method and Description
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 interface org.mini2Dx.gdx.utils.Disposable

dispose

Method Detail

play

long play()

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

Returns:

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

play

long play(float volume)

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

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

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

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

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

long loop()

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

Returns:

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

loop

long loop(float volume)

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

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

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

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

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

void stop()

Stops all playing instances of this sound

pause

void pause()

Pauses all playing instances of this sound

resume

void resume()

Resumes all playing instances of this sound

stop

void stop(long soundId)

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

Parameters:

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

pause

void pause(long soundId)

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

Parameters:

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

resume

void resume(long soundId)

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

Parameters:

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

setLooping

void setLooping(long soundId,
                boolean looping)

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

Parameters:

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

looping - True if the sound should loop

setPitch

void setPitch(long soundId,
              float pitch)

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

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

void setVolume(long soundId,
               float volume)

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

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

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

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

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