f@0: /*  
f@0:  CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
f@0:   
f@0:  Copyright (C) 2011  Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
f@0: 
f@0:  This program is free software: you can redistribute it and/or modify
f@0:  it under the terms of the GNU General Public License as published by
f@0:  the Free Software Foundation, either version 3 of the License, or
f@0:  (at your option) any later version.
f@0: 
f@0:  This program is distributed in the hope that it will be useful,
f@0:  but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0:  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
f@0:  GNU General Public License for more details.
f@0: 
f@0:  You should have received a copy of the GNU General Public License
f@0:  along with this program.  If not, see <http://www.gnu.org/licenses/>.
f@0: */  
f@0: 
f@0: package uk.ac.qmul.eecs.ccmi.sound;
f@0: 
f@0: import java.io.InputStream;
f@0: 
f@0: /**
f@0:  * An object implementing the {@code Sound} interface can be used to play sound 
f@0:  * samples either just once or in a continuous loop. The client class needs to provide 
f@0:  * a reference to an {@code InputStream} to the sample source.
f@0:  * Furthermore, prebuilt sounds
f@0:  * associated to the events defined by the {@code SoundEvent} enumeration can be played.
f@0:  *
f@0:  */
f@0: public interface Sound {
f@0: 
f@0: 	public void play(SoundEvent evt);
f@0: 
f@0: 	public void play(SoundEvent evt, PlayerListener listener);
f@0: 
f@0: 	public void play(InputStream sound);
f@0: 
f@0: 	public void play(InputStream sound, PlayerListener listener);
f@0: 	
f@0: 	public void stop();
f@0: 	
f@0: 	public void setMuted(boolean mute);
f@0: 
f@0: 	public void loadSound(InputStream sound);
f@0: 
f@0: 	public void startLoop(SoundEvent evt);
f@0: 
f@0: 	public void stopLoop(SoundEvent evt);
f@0: 
f@0: 	public void setDefaultPlayerListener(PlayerListener listener,
f@0: 			SoundEvent type);
f@0: 
f@0: 	public void dispose();
f@0: 
f@0: }