com.thekeirs.games.engine

Class Audio

java.lang.Object

com.thekeirs.games.engine.Audio

public class Audio
extends java.lang.Object

A simple but high-performance audio clip player

To play a sound in your game, use the following steps:

• Create a .wav, .m4a, or .mp3 file with your audio clip. You may find the Windows Voice Recorder utility handy for this, or the program Audacity
• Make sure your file has a simple name consisting only of lower case letters, digits, and underscore, with no spaces. eg {code monster_roar1.m4a}
• Copy your audio file into the "raw" folder in your Android Studio Project
• When you want the sound to be played, simply call Audio.play(R.raw.monster_roar1)

/* Implementation notes: Wraps https://github.com/delight-im/Android-Audio with a simple wrapper to keep track of what sounds have been loaded previously so we don't have to call load before every play. If the game activity is destroyed, we can preload all the previously-loaded sounds also, though whether this is a good idea is debatable (eg, if player has gone up a few levels, some old sounds may not be used on later levels.)

Constructor Summary

Constructors

Constructor and Description
Audio()

Method Summary

Modifier and Type	Method and Description
static void	onPause() Called by the game engine to pause sound playing.
static void	onResume(android.content.Context context) Called by the game engine to resume sound playing after a pause.
static void	play(int id) Request that a sound be played.

Methods inherited from class java.lang.Object

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

Constructor Detail

Audio

public Audio()

Method Detail

onResume

public static void onResume(android.content.Context context)

Called by the game engine to resume sound playing after a pause. Do not call directly.

onPause

public static void onPause()

Called by the game engine to pause sound playing. Do not call directly.

play

public static void play(int id)

Request that a sound be played.

The sound will play exactly once (no looping yet). You may request up to six sounds playing simultaneously. If this is not enough, we can up that limit.

Parameters:

id - resource ID of the .wav, .m4a, or .mp3 file with your audio clip, for example R.raw.monster_roar1