aboutsummaryrefslogtreecommitdiff
path: root/src/esieequest/engine/audioplayer/AudioPlayer.java
blob: 3b65ec5f2e87498a4b59d8ef3b823db1d429cade (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package esieequest.engine.audioplayer;

/**
 * The audio player adapter interface.
 * 
 * @author Pacien TRAN-GIRARD
 */
public interface AudioPlayer {

	public static final String SOUND_DIR = "resources/audio/";
	public static final String SOUND_EXT = ".ogg";

	/**
	 * Sets the current music playing.
	 * 
	 * @param fileName
	 *            the URL of the audio file
	 */
	public void play(final String fileName);

	/**
	 * Stops the music currently playing.
	 */
	public void stop();

	/**
	 * Toggles the sound.
	 */
	public void toggleMute();

}