Audio - UQdeco2800/2022-studio-2 GitHub Wiki
Introduction
Audio, e.g. Sounds and music files, can be easily added into the game using libgdx Sound and Music. There is no single audio service, instead audio can be played when and where needed once loaded by the ResourceService
.
Usage
Example: Sound Effect
- Load sound: Ensure the sound file has been loaded in an active resource batch by the
Resource Service
usingloadSounds()
.
private static final String[] soundsToLoad = {"sounds/sound.ogg"};
resourceService.loadSounds(soundsToLoad);
- Play sound: Retrieve the sound from the
Resource Service
usinggetAsset()
. Configure the playback settings, then useplay()
to play the file.
Sound sound = ServiceLocator.getResourceService().getAsset("sounds/sound.ogg", Sound.class);
sound.play();
Example: Background Music
- Load music: Ensure the music file has been loaded in an active resource batch by the
Resource Service
usingloadMusic()
.
private static final String[] musicToLoad = {"sounds/music.mp3"};
resourceService.loadMusic(musicToLoad );
- Play music: Retrieve the music from the
Resource Service
usinggetAsset()
. Configure the playback settings, then useplay()
to play the music. The following example is set to loop, and to play with volume at 30%.
Music music = ServiceLocator.getResourceService().getAsset("sounds/music.mp3", Music.class);
music.setLooping(true);
music.setVolume(0.3f);
music.play();