annotate src/uk/ac/qmul/eecs/depic/daw/Wave.java @ 4:473da40f3d39 tip

added html formatting to Daw/package-info.java

/*  
 Cross-Modal DAW Prototype - Prototype of a simple Cross-Modal Digital Audio Workstation.

 Copyright (C) 2015  Queen Mary University of London (http://depic.eecs.qmul.ac.uk/)
	
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
package uk.ac.qmul.eecs.depic.daw;

import uk.ac.qmul.eecs.depic.patterns.Sequence;

/**
 * 
 * An abstract wave  
 *
 */
public interface Wave {
	public int getChunkNum();
	
	public Chunk getChunkAt(int i);
	
	/**
	 * Sets the new scale factor. 
	 * 
	 * Registered {@code SoundWaveListener} objects are notified with a 
	 * {@code SCALE_FACTOR_CHANGED} event. 
	 * 
	 * @param scaleFactor the new scale factor 
	 */
	public void setScaleFactor(int scaleFactor);
	
	public int getScaleFactor();
	
	public int getMaxScaleFactor();
	
	public float getWaveTime();
	
	public float getMillisecPerChunk();
	
	public Sequence getSequence();
	
	public boolean hasSequence();
}