de.bitbrain.braingdx.audio

Class AudioManagerImpl

java.lang.Object

de.bitbrain.braingdx.audio.AudioManagerImpl

All Implemented Interfaces:

AudioManager

public class AudioManagerImpl
extends Object
implements AudioManager

This audio manager implementation provides utility methods to fade between different music and sounds.

Since:

1.0

Version:

1.0

Author:

Miguel Gonzalez Sanchez

Constructor Summary

Constructors

Constructor and Description
AudioManagerImpl(GameCamera gameCamera, aurelienribon.tweenengine.TweenManager tweenManager, GameWorld gameWorld, BehaviorManager behaviorManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears all audio.
void	clearMusic() Clears all music and removes all related objects from the GameWorld.
void	clearSounds() Clears all sounds and removed all related objects from the GameWorld.
void	crossFadeMusic(com.badlogic.gdx.audio.Music from, com.badlogic.gdx.audio.Music to, float duration) Fades music from one music to another
void	crossFadeMusic(String fromPath, String toPath) Fades music from one music to another
void	crossFadeMusic(String fromPath, String toPath, float duration) Fades music from one music to another
void	fadeInMusic(com.badlogic.gdx.audio.Music music, float duration) Fades in music
void	fadeInMusic(String path) Fades in music
void	fadeInMusic(String path, float duration) Fades in music
void	fadeOutMusic(com.badlogic.gdx.audio.Music music, float duration) Fades out music
void	fadeOutMusic(String path) Fades out music
void	fadeOutMusic(String path, float duration) Fades out music
void	pauseMusic(String path) Pauses given music.
void	playMusic(String path) Plays a given music.
void	setMasterVolume(float volume) Sets a new master volume.
void	spawnMusic(String path, float x, float y, float volume, float hearingRange) Spawns a Music in the world.
void	spawnSound(String path, float x, float y, float pitch, float volume, float hearingRange) plays a sound in the GameWorld relative to the GameCamera.
void	spawnSoundLooped(String path, float x, float y, float pitch, float volume, float hearingRange) Spawns a Sound in the GameWorld relative to the GameCamera.
void	spawnSoundLooped(String path, GameObject target, float pitch, float volume, float hearingRange) Spawns a Sound in the GameWorld relative to the GameCamera.
void	stopMusic(String path) Stops given music.

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioManagerImpl

public AudioManagerImpl(GameCamera gameCamera,
                aurelienribon.tweenengine.TweenManager tweenManager,
                GameWorld gameWorld,
                BehaviorManager behaviorManager)

Method Detail

spawnSound

public void spawnSound(String path,
              float x,
              float y,
              float pitch,
              float volume,
              float hearingRange)

Description copied from interface: AudioManager

plays a sound in the GameWorld relative to the GameCamera.

Specified by:

spawnSound in interface AudioManager

Parameters:

path - the path of the audio file

x - the horizontal position in the world

y - the vertical position in the world

pitch - the audio pitch

volume - the audio volume. FinalVolume=MasterVolume*volume*directionalVolume

hearingRange - the hearing range where the audio is hearable from

spawnSoundLooped

public void spawnSoundLooped(String path,
                    float x,
                    float y,
                    float pitch,
                    float volume,
                    float hearingRange)

Description copied from interface: AudioManager

Spawns a Sound in the GameWorld relative to the GameCamera. The sound object is removed as soon the sound has stopped playing.

Specified by:

spawnSoundLooped in interface AudioManager

Parameters:

path - the path of the audio file

x - the horizontal position in the world

y - the vertical position in the world

pitch - the audio pitch

volume - the audio volume. FinalVolume=MasterVolume*volume*directionalVolume

hearingRange - the hearing range where the audio is hearable from

spawnSoundLooped

public void spawnSoundLooped(String path,
                    GameObject target,
                    float pitch,
                    float volume,
                    float hearingRange)

Description copied from interface: AudioManager

Spawns a Sound in the GameWorld relative to the GameCamera. The sound object is removed as soon the sound has stopped playing.

Specified by:

spawnSoundLooped in interface AudioManager

Parameters:

path - the path of the audio file

target - the target to attach the sound to

pitch - the audio pitch

volume - the audio volume. FinalVolume=MasterVolume*volume*directionalVolume

hearingRange - the hearing range where the audio is hearable from

spawnMusic

public void spawnMusic(String path,
              float x,
              float y,
              float volume,
              float hearingRange)

Description copied from interface: AudioManager

Spawns a Music in the world. The music persists until it is deleted via clearMusic.

Specified by:

spawnMusic in interface AudioManager

Parameters:

path - the path of the audio file

x - the horizontal position in the world

y - the vertical position in the world

volume - the audio volume. FinalVolume=MasterVolume*volume*directionalVolume

hearingRange - the hearing range where the audio is hearable from

clearMusic

public void clearMusic()

Description copied from interface: AudioManager

Clears all music and removes all related objects from the GameWorld.

Specified by:

clearMusic in interface AudioManager

clearSounds

public void clearSounds()

Description copied from interface: AudioManager

Clears all sounds and removed all related objects from the GameWorld.

Specified by:

clearSounds in interface AudioManager

clear

public void clear()

Description copied from interface: AudioManager

Clears all audio.

Specified by:

clear in interface AudioManager

setMasterVolume

public void setMasterVolume(float volume)

Description copied from interface: AudioManager

Sets a new master volume. Master volume is by default set to 1.0

Specified by:

setMasterVolume in interface AudioManager

Parameters:

volume - the master volume

crossFadeMusic

public void crossFadeMusic(String fromPath,
                  String toPath)

Description copied from interface: AudioManager

Fades music from one music to another

Specified by:

crossFadeMusic in interface AudioManager

Parameters:

fromPath - the source audio

toPath - the target audio

crossFadeMusic

public void crossFadeMusic(String fromPath,
                  String toPath,
                  float duration)

Description copied from interface: AudioManager

Fades music from one music to another

Specified by:

crossFadeMusic in interface AudioManager

Parameters:

fromPath - the source audio

toPath - the target audio

duration - the duration in seconds

crossFadeMusic

public void crossFadeMusic(com.badlogic.gdx.audio.Music from,
                  com.badlogic.gdx.audio.Music to,
                  float duration)

Description copied from interface: AudioManager

Fades music from one music to another

Specified by:

crossFadeMusic in interface AudioManager

duration - the duration in seconds

fadeOutMusic

public void fadeOutMusic(String path)

Description copied from interface: AudioManager

Fades out music

Specified by:

fadeOutMusic in interface AudioManager

Parameters:

path - the path to the music file

fadeOutMusic

public void fadeOutMusic(String path,
                float duration)

Description copied from interface: AudioManager

Fades out music

Specified by:

fadeOutMusic in interface AudioManager

Parameters:

path - the path to the music file

duration - the duration in seconds

fadeOutMusic

public void fadeOutMusic(com.badlogic.gdx.audio.Music music,
                float duration)

Description copied from interface: AudioManager

Fades out music

Specified by:

fadeOutMusic in interface AudioManager

duration - the duration in seconds

fadeInMusic

public void fadeInMusic(String path)

Description copied from interface: AudioManager

Fades in music

Specified by:

fadeInMusic in interface AudioManager

Parameters:

path - the path to the music file

fadeInMusic

public void fadeInMusic(String path,
               float duration)

Description copied from interface: AudioManager

Fades in music

Specified by:

fadeInMusic in interface AudioManager

Parameters:

path - the path to the music file

duration - the duration in seconds

fadeInMusic

public void fadeInMusic(com.badlogic.gdx.audio.Music music,
               float duration)

Description copied from interface: AudioManager

Fades in music

Specified by:

fadeInMusic in interface AudioManager

duration - the duration in seconds

playMusic

public void playMusic(String path)

Description copied from interface: AudioManager

Plays a given music.

Specified by:

playMusic in interface AudioManager

Parameters:

path - the path to the audio file

stopMusic

public void stopMusic(String path)

Description copied from interface: AudioManager

Stops given music.

Specified by:

stopMusic in interface AudioManager

Parameters:

path - the path to the audio file

pauseMusic

public void pauseMusic(String path)

Description copied from interface: AudioManager

Pauses given music.

Specified by:

pauseMusic in interface AudioManager

Parameters:

path - the path to the audio file