annotate java/src/uk/ac/qmul/eecs/ccmi/sound/Sound.java @ 1:e3935c01cde2 tip

moved license of PdPersistenceManager to the beginning of the file
author Fiore Martin <f.martin@qmul.ac.uk>
date Tue, 08 Jul 2014 19:52:03 +0100
parents 78b7fc5391a2
children
rev   line source
f@0 1 /*
f@0 2 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
f@0 3
f@0 4 Copyright (C) 2011 Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
f@0 5
f@0 6 This program is free software: you can redistribute it and/or modify
f@0 7 it under the terms of the GNU General Public License as published by
f@0 8 the Free Software Foundation, either version 3 of the License, or
f@0 9 (at your option) any later version.
f@0 10
f@0 11 This program is distributed in the hope that it will be useful,
f@0 12 but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f@0 14 GNU General Public License for more details.
f@0 15
f@0 16 You should have received a copy of the GNU General Public License
f@0 17 along with this program. If not, see <http://www.gnu.org/licenses/>.
f@0 18 */
f@0 19
f@0 20 package uk.ac.qmul.eecs.ccmi.sound;
f@0 21
f@0 22 import java.io.InputStream;
f@0 23
f@0 24 /**
f@0 25 * An object implementing the {@code Sound} interface can be used to play sound
f@0 26 * samples either just once or in a continuous loop. The client class needs to provide
f@0 27 * a reference to an {@code InputStream} to the sample source.
f@0 28 * Furthermore, prebuilt sounds
f@0 29 * associated to the events defined by the {@code SoundEvent} enumeration can be played.
f@0 30 *
f@0 31 */
f@0 32 public interface Sound {
f@0 33
f@0 34 public void play(SoundEvent evt);
f@0 35
f@0 36 public void play(SoundEvent evt, PlayerListener listener);
f@0 37
f@0 38 public void play(InputStream sound);
f@0 39
f@0 40 public void play(InputStream sound, PlayerListener listener);
f@0 41
f@0 42 public void stop();
f@0 43
f@0 44 public void setMuted(boolean mute);
f@0 45
f@0 46 public void loadSound(InputStream sound);
f@0 47
f@0 48 public void startLoop(SoundEvent evt);
f@0 49
f@0 50 public void stopLoop(SoundEvent evt);
f@0 51
f@0 52 public void setDefaultPlayerListener(PlayerListener listener,
f@0 53 SoundEvent type);
f@0 54
f@0 55 public void dispose();
f@0 56
f@0 57 }