view java/src/uk/ac/qmul/eecs/ccmi/speech/Narrator.java @ 1:e3935c01cde2 tip

moved license of PdPersistenceManager to the beginning of the file

/*  
 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
  
 Copyright (C) 2011  Queen Mary University of London (http://ccmi.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.ccmi.speech;

/**
 *
 * The {@code Narrator} interface provides high level methods to make use of text to speech synthesis.  
 *
 */
public interface Narrator {

	public void init() throws NarratorException;
	
	public void setMuted(boolean muted, int voice);
	
	public boolean isMuted(int voice);

	public void setRate(int rate);
	
	public int getRate();
		
	public void shutUp();

	public void speak(String text, int voice);
	
	public void speak(String text);
	
	public void speakWholeText(String text);
	
	public void speakWholeText(String text,int voice);

	public void dispose();

	int MIN_RATE = 0;
	int MAX_RATE = 20;
	int FIRST_VOICE = 1;
	int SECOND_VOICE = 2;
	
}