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.speech;
f@0: 
f@0: /**
f@0:  *
f@0:  * The {@code Narrator} interface provides high level methods to make use of text to speech synthesis.  
f@0:  *
f@0:  */
f@0: public interface Narrator {
f@0: 
f@0: 	public void init() throws NarratorException;
f@0: 	
f@0: 	public void setMuted(boolean muted, int voice);
f@0: 	
f@0: 	public boolean isMuted(int voice);
f@0: 
f@0: 	public void setRate(int rate);
f@0: 	
f@0: 	public int getRate();
f@0: 		
f@0: 	public void shutUp();
f@0: 
f@0: 	public void speak(String text, int voice);
f@0: 	
f@0: 	public void speak(String text);
f@0: 	
f@0: 	public void speakWholeText(String text);
f@0: 	
f@0: 	public void speakWholeText(String text,int voice);
f@0: 
f@0: 	public void dispose();
f@0: 
f@0: 	int MIN_RATE = 0;
f@0: 	int MAX_RATE = 20;
f@0: 	int FIRST_VOICE = 1;
f@0: 	int SECOND_VOICE = 2;
f@0: 	
f@0: }