Android中使用自带TextToSpeech实现离线语音合成功能

﹏ヽ暗。殇╰゛Y 2023-10-05 13:49 69阅读 0赞

## 场景 ##

需要实现在安卓端将一段文字进行语音合成并播报。

此过程可离线不需要网络，不用借助第三方形如科大讯飞或者百度等语音合成SDK或者相关工具等。

注：

博客：  
[https://blog.csdn.net/badao\_liumang\_qizhi][https_blog.csdn.net_badao_liumang_qizhi]  
关注公众号  
霸道的程序猿  
获取编程相关电子书、教程推送与免费下载。

## 实现 ##

### TextToSpeech ###

TextToSpeech能将一段文字转换为语音。

TextToSpeech是Android系统自带的类，不用导入别的包

### 实现效果 ###

下载地址：

[https://files.cnblogs.com/files/badaoliumangqizhi/%E8%AF%AD%E9%9F%B3%E6%92%AD%E6%8A%A5.rar][https_files.cnblogs.com_files_badaoliumangqizhi_E8_AF_AD_E9_9F_B3_E6_92_AD_E6_8A_A5.rar]

### 页面实现 ###

为了搭建测试demo首先在layout中某页面上添加一个PlainText和一个Button实现页面布局如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70][]

并给这两个组件添加Id属性。

然后在对应的activity中的onCreate方法中

Button button = (Button)findViewById(R.id.button);
      EditText  editText  = (EditText )findViewById(R.id.editTextTextPersonName2);
      button.setOnClickListener(new View.OnClickListener(){
    
       @Override
       public void onClick(View v) {
        SpeechUtils.getInstance(LoginActivity.this).speakText(editText.getText().toString());
       }
      });

获取到两个控件，并获取到PlainText控件的Text和设置Button按钮的点击事件。

可以看到在点击事件中调用了一个工具类SpeechUtils的一个方法speakText。

这个方法就是为了进行语音合成播放方便封装的工具类。只需要给工具类方法中传入要进行语音合成的String字符串内容即可。

这里将工具类设计成单例模式。

在项目某目录下新建一个工具类的包，并新建一个SpeechUtils，代码如下

import android.content.Context;
    import android.speech.tts.TextToSpeech;
    import android.util.Log;
    import android.widget.Toast;
    
    import java.util.Locale;
    
    
    
    public class SpeechUtils {
        private Context context;
    
    
        private static final String TAG = "SpeechUtils";
        private static SpeechUtils singleton;
    
        private TextToSpeech textToSpeech; // TTS对象
    
        public static SpeechUtils getInstance(Context context) {
            if (singleton == null) {
                synchronized (SpeechUtils.class) {
                    if (singleton == null) {
                        singleton = new SpeechUtils(context);
                    }
                }
            }
            return singleton;
        }
    
        public SpeechUtils(Context context) {
            this.context = context;
            textToSpeech = new TextToSpeech(context, new TextToSpeech.OnInitListener() {
                @Override
                public void onInit(int i) {
                    if (i == TextToSpeech.SUCCESS) {
                        //textToSpeech.setLanguage(Locale.US);
                        textToSpeech.setLanguage(Locale.CHINA);
                        textToSpeech.setPitch(1.5f);// 设置音调，值越大声音越尖（女生），值越小则变成男声,1.0是常规
                        textToSpeech.setSpeechRate(0.5f);
    
                    }
                }
            });
        }
    
        public void speakText(String text) {
            if (textToSpeech != null) {
                textToSpeech.speak(text,
                        TextToSpeech.QUEUE_FLUSH, null);
            }
    
        }
    
    }

注意：

1.以上代码设计为单例模式，在调用时直接使用

SpeechUtils.getInstance(LoginActivity.this).speakText(editText.getText().toString());

去调用，其中第一个参数是Context对象，如果是在Activity中，必须使用Activity的名字.this,不能直接使用this。

2.在工具类中

import android.speech.tts.TextToSpeech;

可以看到TextToSpeech是直接在android包下引入的是自带的，没有引入其他第三方的依赖。

3.关于设置语言支持的问题，此前网络上大多说不支持中文，应该是很老的版本不支持中文，修改语言的位置在如下，

可以看到支持的语言种类很多，并且已经支持中文。所以只需要设置

textToSpeech.setLanguage(Locale.CHINA);

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 1][]

4.其他设置的属性

textToSpeech.setPitch(1.5f);// 设置音调，值越大声音越尖（女生），值越小则变成男声,1.0是常规
    textToSpeech.setSpeechRate(0.5f);//设置速度

5.更多属性API可以参照Android官方文档：

[https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech][https_developer.android.google.cn_reference_android_speech_tts_TextToSpeech]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 2][]

官方文档部分：

## TextToSpeech ##

[Kotlin][] |Java

`public class TextToSpeech`  
`extends Object`

<table> 
 <tbody> 
  <tr> 
   <td colspan="2"><a href="https://developer.android.google.cn/reference/java/lang/Object" rel="nofollow">java.lang.Object</a></td> 
  </tr> 
  <tr> 
   <td>&nbsp;&nbsp;&nbsp;↳</td> 
   <td>android.speech.tts.TextToSpeech</td> 
  </tr> 
 </tbody> 
</table>

--------------------

Synthesizes speech from text for immediate playback or to create a sound file.

A TextToSpeech instance can only be used to synthesize text once it has completed its initialization. Implement the `TextToSpeech.OnInitListener` to be notified of the completion of the initialization.  
When you are done using the TextToSpeech instance, call the `shutdown()` method to release the native resources used by the TextToSpeech engine. Apps targeting Android 11 that use text-to-speech should declare `TextToSpeech.Engine#INTENT_ACTION_TTS_SERVICE` in the `queries` elements of their manifest:

### Summary ###

<table> 
 <tbody> 
  <tr> 
   <th colspan="2"> <h4>Nested classes</h4> </th> 
  </tr> 
  <tr> 
   <td><code>class</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine" rel="nofollow">TextToSpeech.Engine</a></code> <p>Constants and parameter names for controlling text-to-speech.&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>class</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.EngineInfo" rel="nofollow">TextToSpeech.EngineInfo</a></code> <p>Information about an installed text-to-speech engine.&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>interface</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.OnInitListener" rel="nofollow">TextToSpeech.OnInitListener</a></code> <p>Interface definition of a callback to be invoked indicating the completion of the TextToSpeech engine initialization.&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>interface</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.OnUtteranceCompletedListener" rel="nofollow">TextToSpeech.OnUtteranceCompletedListener</a></code> <p><em>This interface was deprecated in API level 18. Use&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/UtteranceProgressListener" rel="nofollow">UtteranceProgressListener</a></code>&nbsp;instead.</em>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2"> <h4>Constants</h4> </th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a></code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ACTION_TTS_QUEUE_PROCESSING_COMPLETED" rel="nofollow">ACTION_TTS_QUEUE_PROCESSING_COMPLETED</a></code> <p>Broadcast Action: The TextToSpeech synthesizer has completed processing of all the text in the speech queue.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code> <p>Denotes a generic operation failure.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR_INVALID_REQUEST" rel="nofollow">ERROR_INVALID_REQUEST</a></code> <p>Denotes a failure caused by an invalid request.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR_NETWORK" rel="nofollow">ERROR_NETWORK</a></code> <p>Denotes a failure caused by a network connectivity problems.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR_NETWORK_TIMEOUT" rel="nofollow">ERROR_NETWORK_TIMEOUT</a></code> <p>Denotes a failure caused by network timeout.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR_NOT_INSTALLED_YET" rel="nofollow">ERROR_NOT_INSTALLED_YET</a></code> <p>Denotes a failure caused by an unfinished download of the voice data.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR_OUTPUT" rel="nofollow">ERROR_OUTPUT</a></code> <p>Denotes a failure related to the output (audio device or a file).</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR_SERVICE" rel="nofollow">ERROR_SERVICE</a></code> <p>Denotes a failure of a TTS service.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR_SYNTHESIS" rel="nofollow">ERROR_SYNTHESIS</a></code> <p>Denotes a failure of a TTS engine to synthesize the given input.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_AVAILABLE" rel="nofollow">LANG_AVAILABLE</a></code> <p>Denotes the language is available for the language by the locale, but not the country and variant.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_COUNTRY_AVAILABLE" rel="nofollow">LANG_COUNTRY_AVAILABLE</a></code> <p>Denotes the language is available for the language and country specified by the locale, but not the variant.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_COUNTRY_VAR_AVAILABLE" rel="nofollow">LANG_COUNTRY_VAR_AVAILABLE</a></code> <p>Denotes the language is available exactly as specified by the locale.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_MISSING_DATA" rel="nofollow">LANG_MISSING_DATA</a></code> <p>Denotes the language data is missing.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_NOT_SUPPORTED" rel="nofollow">LANG_NOT_SUPPORTED</a></code> <p>Denotes the language is not supported.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_ADD" rel="nofollow">QUEUE_ADD</a></code> <p>Queue mode where the new entry is added at the end of the playback queue.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_FLUSH" rel="nofollow">QUEUE_FLUSH</a></code> <p>Queue mode where all entries in the playback queue (media to be played and text to be synthesized) are dropped and replaced by the new entry.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#STOPPED" rel="nofollow">STOPPED</a></code> <p>Denotes a stop requested by a client.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code> <p>Denotes a successful operation.</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2"> <h4>Public constructors</h4> </th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#TextToSpeech%28android.content.Context,%20android.speech.tts.TextToSpeech.OnInitListener%29" rel="nofollow">TextToSpeech</a>(<a href="https://developer.android.google.cn/reference/android/content/Context" rel="nofollow">Context</a>&nbsp;context,&nbsp;<a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.OnInitListener" rel="nofollow">TextToSpeech.OnInitListener</a>&nbsp;listener)</code> <p>The constructor for the TextToSpeech class, using the default TTS engine.</p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#TextToSpeech%28android.content.Context,%20android.speech.tts.TextToSpeech.OnInitListener,%20java.lang.String%29" rel="nofollow">TextToSpeech</a>(<a href="https://developer.android.google.cn/reference/android/content/Context" rel="nofollow">Context</a>&nbsp;context,&nbsp;<a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.OnInitListener" rel="nofollow">TextToSpeech.OnInitListener</a>&nbsp;listener,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;engine)</code> <p>The constructor for the TextToSpeech class, using the given TTS engine.</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2"> <h4>Public methods</h4> </th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#addEarcon%28java.lang.String,%20java.lang.String,%20int%29" rel="nofollow">addEarcon</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;earcon,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;packagename,&nbsp;int resourceId)</code> <p>Adds a mapping between a string of text and a sound resource in a package.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#addEarcon%28java.lang.String,%20java.lang.String%29" rel="nofollow">addEarcon</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;earcon,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;filename)</code> <p><em>This method was deprecated in API level 21. As of API level 21, replaced by&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#addEarcon%28java.lang.String,%20java.io.File%29" rel="nofollow">addEarcon(java.lang.String, java.io.File)</a></code>.</em></p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#addEarcon%28java.lang.String,%20java.io.File%29" rel="nofollow">addEarcon</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;earcon,&nbsp;<a href="https://developer.android.google.cn/reference/java/io/File" rel="nofollow">File</a>&nbsp;file)</code> <p>Adds a mapping between a string of text and a sound file.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#addSpeech%28java.lang.CharSequence,%20java.io.File%29" rel="nofollow">addSpeech</a>(<a href="https://developer.android.google.cn/reference/java/lang/CharSequence" rel="nofollow">CharSequence</a>&nbsp;text,&nbsp;<a href="https://developer.android.google.cn/reference/java/io/File" rel="nofollow">File</a>&nbsp;file)</code> <p>Adds a mapping between a CharSequence (may be spanned with TtsSpans and a sound file.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#addSpeech%28java.lang.String,%20java.lang.String,%20int%29" rel="nofollow">addSpeech</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;text,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;packagename,&nbsp;int resourceId)</code> <p>Adds a mapping between a string of text and a sound resource in a package.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#addSpeech%28java.lang.CharSequence,%20java.lang.String,%20int%29" rel="nofollow">addSpeech</a>(<a href="https://developer.android.google.cn/reference/java/lang/CharSequence" rel="nofollow">CharSequence</a>&nbsp;text,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;packagename,&nbsp;int resourceId)</code> <p>Adds a mapping between a CharSequence (may be spanned with TtsSpans) of text and a sound resource in a package.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#addSpeech%28java.lang.String,%20java.lang.String%29" rel="nofollow">addSpeech</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;text,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;filename)</code> <p>Adds a mapping between a string of text and a sound file.</p> </td> 
  </tr> 
  <tr> 
   <td><code>boolean</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#areDefaultsEnforced%28%29" rel="nofollow">areDefaultsEnforced</a>()</code> <p>Checks whether the user's settings should override settings requested by the calling application.</p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Set" rel="nofollow">Set</a>&lt;<a href="https://developer.android.google.cn/reference/java/util/Locale" rel="nofollow">Locale</a>&gt;</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getAvailableLanguages%28%29" rel="nofollow">getAvailableLanguages</a>()</code> <p>Query the engine about the set of available languages.</p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a></code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getDefaultEngine%28%29" rel="nofollow">getDefaultEngine</a>()</code> <p>Gets the package name of the default speech synthesis engine.</p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Locale" rel="nofollow">Locale</a></code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getDefaultLanguage%28%29" rel="nofollow">getDefaultLanguage</a>()</code> <p><em>This method was deprecated in API level 21. As of API level 21, use&nbsp;<code>getDefaultVoice().getLocale()</code>&nbsp;(<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getDefaultVoice%28%29" rel="nofollow">getDefaultVoice()</a></code>)</em></p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/Voice" rel="nofollow">Voice</a></code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getDefaultVoice%28%29" rel="nofollow">getDefaultVoice</a>()</code> <p>Returns a Voice instance that's the default voice for the default Text-to-speech language.</p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/List" rel="nofollow">List</a>&lt;<a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.EngineInfo" rel="nofollow">TextToSpeech.EngineInfo</a>&gt;</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getEngines%28%29" rel="nofollow">getEngines</a>()</code> <p>Gets a list of all installed TTS engines.</p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Set" rel="nofollow">Set</a>&lt;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&gt;</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getFeatures%28java.util.Locale%29" rel="nofollow">getFeatures</a>(<a href="https://developer.android.google.cn/reference/java/util/Locale" rel="nofollow">Locale</a>&nbsp;locale)</code> <p><em>This method was deprecated in API level 21. As of API level 21, please use voices. In order to query features of the voice, call&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getVoices%28%29" rel="nofollow">getVoices()</a></code>&nbsp;to retrieve the list of available voices and&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/Voice#getFeatures%28%29" rel="nofollow">Voice#getFeatures()</a></code>&nbsp;to retrieve the set of features.</em></p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Locale" rel="nofollow">Locale</a></code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getLanguage%28%29" rel="nofollow">getLanguage</a>()</code> <p><em>This method was deprecated in API level 21. As of API level 21, please use&nbsp;<code>getVoice().getLocale()</code>&nbsp;(<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getVoice%28%29" rel="nofollow">getVoice()</a></code>).</em></p> </td> 
  </tr> 
  <tr> 
   <td><code>static int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getMaxSpeechInputLength%28%29" rel="nofollow">getMaxSpeechInputLength</a>()</code> <p>Limit of length of input string passed to speak and synthesizeToFile.</p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/Voice" rel="nofollow">Voice</a></code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getVoice%28%29" rel="nofollow">getVoice</a>()</code> <p>Returns a Voice instance describing the voice currently being used for synthesis requests sent to the TextToSpeech engine.</p> </td> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Set" rel="nofollow">Set</a>&lt;<a href="https://developer.android.google.cn/reference/android/speech/tts/Voice" rel="nofollow">Voice</a>&gt;</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getVoices%28%29" rel="nofollow">getVoices</a>()</code> <p>Query the engine about the set of available voices.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#isLanguageAvailable%28java.util.Locale%29" rel="nofollow">isLanguageAvailable</a>(<a href="https://developer.android.google.cn/reference/java/util/Locale" rel="nofollow">Locale</a>&nbsp;loc)</code> <p>Checks if the specified language as represented by the Locale is available and supported.</p> </td> 
  </tr> 
  <tr> 
   <td><code>boolean</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#isSpeaking%28%29" rel="nofollow">isSpeaking</a>()</code> <p>Checks whether the TTS engine is busy speaking.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#playEarcon%28java.lang.String,%20int,%20java.util.HashMap%3Cjava.lang.String,%20java.lang.String%3E%29" rel="nofollow">playEarcon</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;earcon,&nbsp;int queueMode,&nbsp;<a href="https://developer.android.google.cn/reference/java/util/HashMap" rel="nofollow">HashMap</a>&lt;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&gt; params)</code> <p><em>This method was deprecated in API level 21. As of API level 21, replaced by&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#playEarcon%28java.lang.String,%20int,%20android.os.Bundle,%20java.lang.String%29" rel="nofollow">playEarcon(java.lang.String, int, android.os.Bundle, java.lang.String)</a></code>.</em></p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#playEarcon%28java.lang.String,%20int,%20android.os.Bundle,%20java.lang.String%29" rel="nofollow">playEarcon</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;earcon,&nbsp;int queueMode,&nbsp;<a href="https://developer.android.google.cn/reference/android/os/Bundle" rel="nofollow">Bundle</a>&nbsp;params,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;utteranceId)</code> <p>Plays the earcon using the specified queueing mode and parameters.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#playSilence%28long,%20int,%20java.util.HashMap%3Cjava.lang.String,%20java.lang.String%3E%29" rel="nofollow">playSilence</a>(long durationInMs,&nbsp;int queueMode,&nbsp;<a href="https://developer.android.google.cn/reference/java/util/HashMap" rel="nofollow">HashMap</a>&lt;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&gt; params)</code> <p><em>This method was deprecated in API level 21. As of API level 21, replaced by&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#playSilentUtterance%28long,%20int,%20java.lang.String%29" rel="nofollow">playSilentUtterance(long, int, java.lang.String)</a></code>.</em></p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#playSilentUtterance%28long,%20int,%20java.lang.String%29" rel="nofollow">playSilentUtterance</a>(long durationInMs,&nbsp;int queueMode,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;utteranceId)</code> <p>Plays silence for the specified amount of time using the specified queue mode.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setAudioAttributes%28android.media.AudioAttributes%29" rel="nofollow">setAudioAttributes</a>(<a href="https://developer.android.google.cn/reference/android/media/AudioAttributes" rel="nofollow">AudioAttributes</a>&nbsp;audioAttributes)</code> <p>Sets the audio attributes to be used when speaking text or playing back a file.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setEngineByPackageName%28java.lang.String%29" rel="nofollow">setEngineByPackageName</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;enginePackageName)</code> <p><em>This method was deprecated in API level 15. This doesn't inform callers when the TTS engine has been initialized.&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#TextToSpeech%28android.content.Context,%20android.speech.tts.TextToSpeech.OnInitListener,%20java.lang.String%29" rel="nofollow">TextToSpeech(android.content.Context, android.speech.tts.TextToSpeech.OnInitListener, java.lang.String)</a></code>&nbsp;can be used with the appropriate engine name. Also, there is no guarantee that the engine specified will be loaded. If it isn't installed or disabled, the user / system wide defaults will apply.</em></p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setLanguage%28java.util.Locale%29" rel="nofollow">setLanguage</a>(<a href="https://developer.android.google.cn/reference/java/util/Locale" rel="nofollow">Locale</a>&nbsp;loc)</code> <p>Sets the text-to-speech language.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setOnUtteranceCompletedListener%28android.speech.tts.TextToSpeech.OnUtteranceCompletedListener%29" rel="nofollow">setOnUtteranceCompletedListener</a>(<a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.OnUtteranceCompletedListener" rel="nofollow">TextToSpeech.OnUtteranceCompletedListener</a>&nbsp;listener)</code> <p><em>This method was deprecated in API level 15. Use&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setOnUtteranceProgressListener%28android.speech.tts.UtteranceProgressListener%29" rel="nofollow">setOnUtteranceProgressListener(android.speech.tts.UtteranceProgressListener)</a></code>&nbsp;instead.</em></p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setOnUtteranceProgressListener%28android.speech.tts.UtteranceProgressListener%29" rel="nofollow">setOnUtteranceProgressListener</a>(<a href="https://developer.android.google.cn/reference/android/speech/tts/UtteranceProgressListener" rel="nofollow">UtteranceProgressListener</a>&nbsp;listener)</code> <p>Sets the listener that will be notified of various events related to the synthesis of a given utterance.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setPitch%28float%29" rel="nofollow">setPitch</a>(float pitch)</code> <p>Sets the speech pitch for the TextToSpeech engine.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setSpeechRate%28float%29" rel="nofollow">setSpeechRate</a>(float speechRate)</code> <p>Sets the speech rate.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#setVoice%28android.speech.tts.Voice%29" rel="nofollow">setVoice</a>(<a href="https://developer.android.google.cn/reference/android/speech/tts/Voice" rel="nofollow">Voice</a>&nbsp;voice)</code> <p>Sets the text-to-speech voice.</p> </td> 
  </tr> 
  <tr> 
   <td><code>void</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#shutdown%28%29" rel="nofollow">shutdown</a>()</code> <p>Releases the resources used by the TextToSpeech engine.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#speak%28java.lang.CharSequence,%20int,%20android.os.Bundle,%20java.lang.String%29" rel="nofollow">speak</a>(<a href="https://developer.android.google.cn/reference/java/lang/CharSequence" rel="nofollow">CharSequence</a>&nbsp;text,&nbsp;int queueMode,&nbsp;<a href="https://developer.android.google.cn/reference/android/os/Bundle" rel="nofollow">Bundle</a>&nbsp;params,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;utteranceId)</code> <p>Speaks the text using the specified queuing strategy and speech parameters, the text may be spanned with TtsSpans.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#speak%28java.lang.String,%20int,%20java.util.HashMap%3Cjava.lang.String,%20java.lang.String%3E%29" rel="nofollow">speak</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;text,&nbsp;int queueMode,&nbsp;<a href="https://developer.android.google.cn/reference/java/util/HashMap" rel="nofollow">HashMap</a>&lt;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&gt; params)</code> <p><em>This method was deprecated in API level 21. As of API level 21, replaced by&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#speak%28java.lang.CharSequence,%20int,%20android.os.Bundle,%20java.lang.String%29" rel="nofollow">speak(java.lang.CharSequence, int, android.os.Bundle, java.lang.String)</a></code>.</em></p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#stop%28%29" rel="nofollow">stop</a>()</code> <p>Interrupts the current utterance (whether played or rendered to file) and discards other utterances in the queue.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#synthesizeToFile%28java.lang.CharSequence,%20android.os.Bundle,%20android.os.ParcelFileDescriptor,%20java.lang.String%29" rel="nofollow">synthesizeToFile</a>(<a href="https://developer.android.google.cn/reference/java/lang/CharSequence" rel="nofollow">CharSequence</a>&nbsp;text,&nbsp;<a href="https://developer.android.google.cn/reference/android/os/Bundle" rel="nofollow">Bundle</a>&nbsp;params,&nbsp;<a href="https://developer.android.google.cn/reference/android/os/ParcelFileDescriptor" rel="nofollow">ParcelFileDescriptor</a>&nbsp;fileDescriptor,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;utteranceId)</code> <p>Synthesizes the given text to a ParcelFileDescriptor using the specified parameters.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#synthesizeToFile%28java.lang.CharSequence,%20android.os.Bundle,%20java.io.File,%20java.lang.String%29" rel="nofollow">synthesizeToFile</a>(<a href="https://developer.android.google.cn/reference/java/lang/CharSequence" rel="nofollow">CharSequence</a>&nbsp;text,&nbsp;<a href="https://developer.android.google.cn/reference/android/os/Bundle" rel="nofollow">Bundle</a>&nbsp;params,&nbsp;<a href="https://developer.android.google.cn/reference/java/io/File" rel="nofollow">File</a>&nbsp;file,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;utteranceId)</code> <p>Synthesizes the given text to a file using the specified parameters.</p> </td> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#synthesizeToFile%28java.lang.String,%20java.util.HashMap%3Cjava.lang.String,%20java.lang.String%3E,%20java.lang.String%29" rel="nofollow">synthesizeToFile</a>(<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;text,&nbsp;<a href="https://developer.android.google.cn/reference/java/util/HashMap" rel="nofollow">HashMap</a>&lt;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&gt; params,&nbsp;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&nbsp;filename)</code> <p><em>This method was deprecated in API level 21. As of API level 21, replaced by&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#synthesizeToFile%28java.lang.CharSequence,%20android.os.Bundle,%20java.io.File,%20java.lang.String%29" rel="nofollow">synthesizeToFile(java.lang.CharSequence, android.os.Bundle, java.io.File, java.lang.String)</a></code>.</em></p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th> <h4>Inherited methods</h4> </th> 
  </tr> 
  <tr> 
   <td colspan="2">From class&nbsp;<code><a href="https://developer.android.google.cn/reference/java/lang/Object" rel="nofollow">java.lang.Object</a></code></td> 
  </tr> 
 </tbody> 
</table>

### Constants ###

#### ACTION\_TTS\_QUEUE\_PROCESSING\_COMPLETED ####

Added in [API level 4][]

public static final String ACTION_TTS_QUEUE_PROCESSING_COMPLETED

Broadcast Action: The TextToSpeech synthesizer has completed processing of all the text in the speech queue. Note that this notifies callers when the **engine** has finished has processing text data. Audio playback might not have completed (or even started) at this point. If you wish to be notified when this happens, see `OnUtteranceCompletedListener`.

Constant Value: "android.speech.tts.TTS\_QUEUE\_PROCESSING\_COMPLETED"

#### ERROR ####

Added in [API level 4][]

public static final int ERROR

Denotes a generic operation failure.

Constant Value: -1 (0xffffffff)

#### ERROR\_INVALID\_REQUEST ####

Added in [API level 21][API level 4]

public static final int ERROR_INVALID_REQUEST

Denotes a failure caused by an invalid request.

Constant Value: -8 (0xfffffff8)

#### ERROR\_NETWORK ####

Added in [API level 21][API level 4]

public static final int ERROR_NETWORK

Denotes a failure caused by a network connectivity problems.

Constant Value: -6 (0xfffffffa)

#### ERROR\_NETWORK\_TIMEOUT ####

Added in [API level 21][API level 4]

public static final int ERROR_NETWORK_TIMEOUT

Denotes a failure caused by network timeout.

Constant Value: -7 (0xfffffff9)

#### ERROR\_NOT\_INSTALLED\_YET ####

Added in [API level 21][API level 4]

public static final int ERROR_NOT_INSTALLED_YET

Denotes a failure caused by an unfinished download of the voice data.

**See also:**

*  `TextToSpeech.Engine.KEY_FEATURE_NOT_INSTALLED`

Constant Value: -9 (0xfffffff7)

#### ERROR\_OUTPUT ####

Added in [API level 21][API level 4]

public static final int ERROR_OUTPUT

Denotes a failure related to the output (audio device or a file).

Constant Value: -5 (0xfffffffb)

#### ERROR\_SERVICE ####

Added in [API level 21][API level 4]

public static final int ERROR_SERVICE

Denotes a failure of a TTS service.

Constant Value: -4 (0xfffffffc)

#### ERROR\_SYNTHESIS ####

Added in [API level 21][API level 4]

public static final int ERROR_SYNTHESIS

Denotes a failure of a TTS engine to synthesize the given input.

Constant Value: -3 (0xfffffffd)

#### LANG\_AVAILABLE ####

Added in [API level 4][]

public static final int LANG_AVAILABLE

Denotes the language is available for the language by the locale, but not the country and variant.

Constant Value: 0 (0x00000000)

#### LANG\_COUNTRY\_AVAILABLE ####

Added in [API level 4][]

public static final int LANG_COUNTRY_AVAILABLE

Denotes the language is available for the language and country specified by the locale, but not the variant.

Constant Value: 1 (0x00000001)

#### LANG\_COUNTRY\_VAR\_AVAILABLE ####

Added in [API level 4][]

public static final int LANG_COUNTRY_VAR_AVAILABLE

Denotes the language is available exactly as specified by the locale.

Constant Value: 2 (0x00000002)

#### LANG\_MISSING\_DATA ####

Added in [API level 4][]

public static final int LANG_MISSING_DATA

Denotes the language data is missing.

Constant Value: -1 (0xffffffff)

#### LANG\_NOT\_SUPPORTED ####

Added in [API level 4][]

public static final int LANG_NOT_SUPPORTED

Denotes the language is not supported.

Constant Value: -2 (0xfffffffe)

#### QUEUE\_ADD ####

Added in [API level 4][]

public static final int QUEUE_ADD

Queue mode where the new entry is added at the end of the playback queue.

Constant Value: 1 (0x00000001)

#### QUEUE\_FLUSH ####

Added in [API level 4][]

public static final int QUEUE_FLUSH

Queue mode where all entries in the playback queue (media to be played and text to be synthesized) are dropped and replaced by the new entry. Queues are flushed with respect to a given calling app. Entries in the queue from other callees are not discarded.

Constant Value: 0 (0x00000000)

#### STOPPED ####

Added in [API level 21][API level 4]

public static final int STOPPED

Denotes a stop requested by a client. It's used only on the service side of the API, client should never expect to see this result code.

Constant Value: -2 (0xfffffffe)

#### SUCCESS ####

Added in [API level 4][]

public static final int SUCCESS

Denotes a successful operation.

Constant Value: 0 (0x00000000)

### Public constructors ###

#### TextToSpeech ####

Added in [API level 4][]

public TextToSpeech (Context context, 
                    TextToSpeech.OnInitListener listener)

The constructor for the TextToSpeech class, using the default TTS engine. This will also initialize the associated TextToSpeech engine if it isn't already running.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>context</code></td> 
   <td><code>Context</code>: The context this instance is running in. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>listener</code></td> 
   <td><code>TextToSpeech.OnInitListener</code>: The&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.OnInitListener" rel="nofollow">TextToSpeech.OnInitListener</a></code>&nbsp;that will be called when the TextToSpeech engine has initialized. In a case of a failure the listener may be called immediately, before TextToSpeech instance is fully constructed. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### TextToSpeech ####

Added in [API level 14][API level 4]

public TextToSpeech (Context context, 
                    TextToSpeech.OnInitListener listener, 
                    String engine)

The constructor for the TextToSpeech class, using the given TTS engine. This will also initialize the associated TextToSpeech engine if it isn't already running.

### Public methods ###

#### addEarcon ####

Added in [API level 4][]

public int addEarcon (String earcon, 
                    String packagename, 
                    int resourceId)

Adds a mapping between a string of text and a sound resource in a package. Use this to add custom earcons.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>earcon</code></td> 
   <td><code>String</code>: The name of the earcon. Example:&nbsp;<code>"[tick]"</code> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>packagename</code></td> 
   <td><code>String</code>: the package name of the application that contains the resource. This can for instance be the package name of your own application. Example:&nbsp;<strong>"com.google.marvin.compass"</strong><br> The package name can be found in the AndroidManifest.xml of the application containing the resource. <p><code>&lt;manifest xmlns:android="..." package="<strong>com.google.marvin.compass</strong>"&gt;</code></p> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>resourceId</code></td> 
   <td><code>int</code>: Example:&nbsp;<code>R.raw.tick_snd</code> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td>Code indicating success or failure. See&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;and&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

**See also:**

*  `playEarcon(String, int, HashMap)`

#### addEarcon ####

Added in [API level 4][]  
Deprecated in [API level 21][API level 4]

public int addEarcon (String earcon, 
                    String filename)

**This method was deprecated in API level 21.**  
As of API level 21, replaced by `addEarcon(java.lang.String, java.io.File)`.

Adds a mapping between a string of text and a sound file. Use this to add custom earcons.

**See also:**

*  `playEarcon(String, int, HashMap)`

#### addEarcon ####

Added in [API level 21][API level 4]

public int addEarcon (String earcon, 
                    File file)

Adds a mapping between a string of text and a sound file. Use this to add custom earcons.

**See also:**

*  `playEarcon(String, int, HashMap)`

#### addSpeech ####

Added in [API level 21][API level 4]

public int addSpeech (CharSequence text, 
                    File file)

Adds a mapping between a CharSequence (may be spanned with TtsSpans and a sound file. Using this, it is possible to add custom pronounciations for a string of text. After a call to this method, subsequent calls to `speak(java.lang.CharSequence, int, android.os.Bundle, java.lang.String)` will play the specified sound resource if it is available, or synthesize the text it is missing.

#### addSpeech ####

Added in [API level 4][]

public int addSpeech (String text, 
                    String packagename, 
                    int resourceId)

Adds a mapping between a string of text and a sound resource in a package. After a call to this method, subsequent calls to `speak(java.lang.CharSequence, int, android.os.Bundle, java.lang.String)` will play the specified sound resource if it is available, or synthesize the text it is missing.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>text</code></td> 
   <td><code>String</code>: The string of text. Example:&nbsp;<code>"south_south_east"</code> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>packagename</code></td> 
   <td><code>String</code>: Pass the packagename of the application that contains the resource. If the resource is in your own application (this is the most common case), then put the packagename of your application here.<br> Example:&nbsp;<strong>"com.google.marvin.compass"</strong><br> The packagename can be found in the AndroidManifest.xml of your application. <p><code>&lt;manifest xmlns:android="..." package="<strong>com.google.marvin.compass</strong>"&gt;</code></p> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>resourceId</code></td> 
   <td><code>int</code>: Example:&nbsp;<code>R.raw.south_south_east</code> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### addSpeech ####

Added in [API level 21][API level 4]

public int addSpeech (CharSequence text, 
                    String packagename, 
                    int resourceId)

Adds a mapping between a CharSequence (may be spanned with TtsSpans) of text and a sound resource in a package. After a call to this method, subsequent calls to `speak(java.lang.CharSequence, int, android.os.Bundle, java.lang.String)` will play the specified sound resource if it is available, or synthesize the text it is missing.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>text</code></td> 
   <td><code>CharSequence</code>: The string of text. Example:&nbsp;<code>"south_south_east"</code> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>packagename</code></td> 
   <td><code>String</code>: Pass the packagename of the application that contains the resource. If the resource is in your own application (this is the most common case), then put the packagename of your application here.<br> Example:&nbsp;<strong>"com.google.marvin.compass"</strong><br> The packagename can be found in the AndroidManifest.xml of your application. <p><code>&lt;manifest xmlns:android="..." package="<strong>com.google.marvin.compass</strong>"&gt;</code></p> <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>resourceId</code></td> 
   <td><code>int</code>: Example:&nbsp;<code>R.raw.south_south_east</code> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### addSpeech ####

Added in [API level 4][]

public int addSpeech (String text, 
                    String filename)

Adds a mapping between a string of text and a sound file. Using this, it is possible to add custom pronounciations for a string of text. After a call to this method, subsequent calls to `speak(java.lang.CharSequence, int, android.os.Bundle, java.lang.String)` will play the specified sound resource if it is available, or synthesize the text it is missing.

#### areDefaultsEnforced ####

Added in [API level 8][API level 4]  
Deprecated in [API level 21][API level 4]

public boolean areDefaultsEnforced ()

Checks whether the user's settings should override settings requested by the calling application. As of the Ice cream sandwich release, user settings never forcibly override the app's settings.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>boolean</code></td> 
   <td> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### getAvailableLanguages ####

Added in [API level 21][API level 4]

public Set<Locale> getAvailableLanguages ()

Query the engine about the set of available languages.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Set" rel="nofollow">Set</a>&lt;<a href="https://developer.android.google.cn/reference/java/util/Locale" rel="nofollow">Locale</a>&gt;</code></td> 
   <td> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### getDefaultEngine ####

Added in [API level 8][API level 4]

public String getDefaultEngine ()

Gets the package name of the default speech synthesis engine.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a></code></td> 
   <td>Package name of the TTS engine that the user has chosen as their default. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### getDefaultLanguage ####

Added in [API level 18][API level 4]  
Deprecated in [API level 21][API level 4]

public Locale getDefaultLanguage ()

**This method was deprecated in API level 21.**  
As of API level 21, use `getDefaultVoice().getLocale()` (`getDefaultVoice()`)

Returns a Locale instance describing the language currently being used as the default Text-to-speech language. The locale object returned by this method is NOT a valid one. It has identical form to the one in `getLanguage()`. Please refer to `getLanguage()` for more information.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Locale" rel="nofollow">Locale</a></code></td> 
   <td>language, country (if any) and variant (if any) used by the client stored in a Locale instance, or&nbsp;<code>null</code>&nbsp;on error. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### getDefaultVoice ####

Added in [API level 21][API level 4]

public Voice getDefaultVoice ()

Returns a Voice instance that's the default voice for the default Text-to-speech language.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/Voice" rel="nofollow">Voice</a></code></td> 
   <td>The default voice instance for the default language, or&nbsp;<code>null</code>&nbsp;if not set or on error. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### getEngines ####

Added in [API level 14][API level 4]

public List<TextToSpeech.EngineInfo> getEngines ()

Gets a list of all installed TTS engines.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/List" rel="nofollow">List</a>&lt;<a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.EngineInfo" rel="nofollow">TextToSpeech.EngineInfo</a>&gt;</code></td> 
   <td>A list of engine info objects. The list can be empty, but never&nbsp;<code>null</code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### getFeatures ####

Added in [API level 15][API level 4]  
Deprecated in [API level 21][API level 4]

public Set<String> getFeatures (Locale locale)

**This method was deprecated in API level 21.**  
As of API level 21, please use voices. In order to query features of the voice, call `getVoices()` to retrieve the list of available voices and `Voice#getFeatures()` to retrieve the set of features.

Queries the engine for the set of features it supports for a given locale. Features can either be framework defined, e.g. `TextToSpeech.Engine#KEY_FEATURE_NETWORK_SYNTHESIS` or engine specific. Engine specific keys must be prefixed by the name of the engine they are intended for. These keys can be used as parameters to `TextToSpeech#speak(String, int, java.util.HashMap)` and `TextToSpeech#synthesizeToFile(String, java.util.HashMap, String)`. Features values are strings and their values must meet restrictions described in their documentation.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>locale</code></td> 
   <td><code>Locale</code>: The locale to query features for. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Set" rel="nofollow">Set</a>&lt;<a href="https://developer.android.google.cn/reference/java/lang/String" rel="nofollow">String</a>&gt;</code></td> 
   <td>Set instance. May return&nbsp;<code>null</code>&nbsp;on error. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### getLanguage ####

Added in [API level 4][]  
Deprecated in [API level 21][API level 4]

public Locale getLanguage ()

**This method was deprecated in API level 21.**  
As of API level 21, please use `getVoice().getLocale()` (`getVoice()`).

Returns a Locale instance describing the language currently being used for synthesis requests sent to the TextToSpeech engine. In Android 4.2 and before (API <= 17) this function returns the language that is currently being used by the TTS engine. That is the last language set by this or any other client by a `TextToSpeech#setLanguage` call to the same engine. In Android versions after 4.2 this function returns the language that is currently being used for the synthesis requests sent from this client. That is the last language set by a `TextToSpeech#setLanguage` call on this instance. If a voice is set (by `setVoice(android.speech.tts.Voice)`), getLanguage will return the language of the currently set voice. Please note that the Locale object returned by this method is NOT a valid Locale object. Its language field contains a three-letter ISO 639-2/T code (where a proper Locale would use a two-letter ISO 639-1 code), and the country field contains a three-letter ISO 3166 country code (where a proper Locale would use a two-letter ISO 3166-1 code).

#### getMaxSpeechInputLength ####

Added in [API level 18][API level 4]

public static int getMaxSpeechInputLength ()

Limit of length of input string passed to speak and synthesizeToFile.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

**See also:**

*  `speak(CharSequence, int, Bundle, String)`
 *  `synthesizeToFile(CharSequence, Bundle, ParcelFileDescriptor, String)`

#### getVoice ####

Added in [API level 21][API level 4]

public Voice getVoice ()

Returns a Voice instance describing the voice currently being used for synthesis requests sent to the TextToSpeech engine.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/Voice" rel="nofollow">Voice</a></code></td> 
   <td>Voice instance used by the client, or&nbsp;<code>null</code>&nbsp;if not set or on error. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

**See also:**

*  `getVoices()`
 *  `setVoice(Voice)`
 *  `Voice`

#### getVoices ####

Added in [API level 21][API level 4]

public Set<Voice> getVoices ()

Query the engine about the set of available voices. Each TTS Engine can expose multiple voices for each locale, each with a different set of features.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code><a href="https://developer.android.google.cn/reference/java/util/Set" rel="nofollow">Set</a>&lt;<a href="https://developer.android.google.cn/reference/android/speech/tts/Voice" rel="nofollow">Voice</a>&gt;</code></td> 
   <td> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

**See also:**

*  `setVoice(Voice)`
 *  `Voice`

#### isLanguageAvailable ####

Added in [API level 4][]

public int isLanguageAvailable (Locale loc)

Checks if the specified language as represented by the Locale is available and supported.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>loc</code></td> 
   <td><code>Locale</code>: The Locale describing the language to be used. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td>Code indicating the support status for the locale. See&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_AVAILABLE" rel="nofollow">LANG_AVAILABLE</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_COUNTRY_AVAILABLE" rel="nofollow">LANG_COUNTRY_AVAILABLE</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_COUNTRY_VAR_AVAILABLE" rel="nofollow">LANG_COUNTRY_VAR_AVAILABLE</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_MISSING_DATA" rel="nofollow">LANG_MISSING_DATA</a></code>&nbsp;and&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#LANG_NOT_SUPPORTED" rel="nofollow">LANG_NOT_SUPPORTED</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### isSpeaking ####

Added in [API level 4][]

public boolean isSpeaking ()

Checks whether the TTS engine is busy speaking. Note that a speech item is considered complete once it's audio data has been sent to the audio mixer, or written to a file. There might be a finite lag between this point, and when the audio hardware completes playback.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>boolean</code></td> 
   <td><code>true</code>&nbsp;if the TTS engine is speaking. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### playEarcon ####

Added in [API level 4][]  
Deprecated in [API level 21][API level 4]

public int playEarcon (String earcon, 
                    int queueMode, 
                    HashMap<String, String> params)

**This method was deprecated in API level 21.**  
As of API level 21, replaced by `playEarcon(java.lang.String, int, android.os.Bundle, java.lang.String)`.

Plays the earcon using the specified queueing mode and parameters. The earcon must already have been added with `addEarcon(java.lang.String, java.lang.String)` or `addEarcon(java.lang.String, java.lang.String, int)`. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see `setOnUtteranceProgressListener(UtteranceProgressListener)`) and using the `Engine#KEY_PARAM_UTTERANCE_ID` parameter.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>earcon</code></td> 
   <td><code>String</code>: The earcon that should be played <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>queueMode</code></td> 
   <td><code>int</code>:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_ADD" rel="nofollow">QUEUE_ADD</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_FLUSH" rel="nofollow">QUEUE_FLUSH</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>params</code></td> 
   <td><code>HashMap</code>: Parameters for the request. Can be null. Supported parameter names:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_STREAM" rel="nofollow">Engine#KEY_PARAM_STREAM</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_UTTERANCE_ID" rel="nofollow">Engine#KEY_PARAM_UTTERANCE_ID</a></code>. Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>&nbsp;of&nbsp;<strong>queuing</strong>&nbsp;the playEarcon operation. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### playEarcon ####

Added in [API level 21][API level 4]

public int playEarcon (String earcon, 
                    int queueMode, 
                    Bundle params, 
                    String utteranceId)

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>earcon</code></td> 
   <td><code>String</code>: The earcon that should be played <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>queueMode</code></td> 
   <td><code>int</code>:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_ADD" rel="nofollow">QUEUE_ADD</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_FLUSH" rel="nofollow">QUEUE_FLUSH</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>params</code></td> 
   <td><code>Bundle</code>: Parameters for the request. Can be null. Supported parameter names:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_STREAM" rel="nofollow">Engine#KEY_PARAM_STREAM</a></code>, Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>utteranceId</code></td> 
   <td><code>String</code> <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### playSilence ####

Added in [API level 4][]  
Deprecated in [API level 21][API level 4]

public int playSilence (long durationInMs, 
                    int queueMode, 
                    HashMap<String, String> params)

**This method was deprecated in API level 21.**  
As of API level 21, replaced by `playSilentUtterance(long, int, java.lang.String)`.

Plays silence for the specified amount of time using the specified queue mode. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see `setOnUtteranceProgressListener(UtteranceProgressListener)`) and using the `Engine#KEY_PARAM_UTTERANCE_ID` parameter.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>durationInMs</code></td> 
   <td><code>long</code>: The duration of the silence. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>queueMode</code></td> 
   <td><code>int</code>:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_ADD" rel="nofollow">QUEUE_ADD</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_FLUSH" rel="nofollow">QUEUE_FLUSH</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>params</code></td> 
   <td><code>HashMap</code>: Parameters for the request. Can be null. Supported parameter names:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_UTTERANCE_ID" rel="nofollow">Engine#KEY_PARAM_UTTERANCE_ID</a></code>. Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>&nbsp;of&nbsp;<strong>queuing</strong>&nbsp;the playSilence operation. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### playSilentUtterance ####

Added in [API level 21][API level 4]

public int playSilentUtterance (long durationInMs, 
                    int queueMode, 
                    String utteranceId)

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>&nbsp;of&nbsp;<strong>queuing</strong>&nbsp;the playSilentUtterance operation. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### setAudioAttributes ####

Added in [API level 21][API level 4]

public int setAudioAttributes (AudioAttributes audioAttributes)

Sets the audio attributes to be used when speaking text or playing back a file.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>audioAttributes</code></td> 
   <td><code>AudioAttributes</code>: Valid AudioAttributes instance. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### setEngineByPackageName ####

Added in [API level 8][API level 4]  
Deprecated in [API level 15][API level 4]

public int setEngineByPackageName (String enginePackageName)

**This method was deprecated in API level 15.**  
This doesn't inform callers when the TTS engine has been initialized. `TextToSpeech(android.content.Context, android.speech.tts.TextToSpeech.OnInitListener, java.lang.String)` can be used with the appropriate engine name. Also, there is no guarantee that the engine specified will be loaded. If it isn't installed or disabled, the user / system wide defaults will apply.

Sets the TTS engine to use.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>enginePackageName</code></td> 
   <td><code>String</code>: The package name for the synthesis engine (e.g. "com.svox.pico") <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### setLanguage ####

Added in [API level 4][]

public int setLanguage (Locale loc)

Sets the text-to-speech language. The TTS engine will try to use the closest match to the specified language as represented by the Locale, but there is no guarantee that the exact same Locale will be used. Use `isLanguageAvailable(java.util.Locale)` to check the level of support before choosing the language to use for the next utterances. This method sets the current voice to the default one for the given Locale; `getVoice()` can be used to retrieve it.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>loc</code></td> 
   <td><code>Locale</code>: The locale describing the language to be used. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### setOnUtteranceCompletedListener ####

Added in [API level 4][]  
Deprecated in [API level 15][API level 4]

public int setOnUtteranceCompletedListener (TextToSpeech.OnUtteranceCompletedListener listener)

**This method was deprecated in API level 15.**  
Use `setOnUtteranceProgressListener(android.speech.tts.UtteranceProgressListener)` instead.

Sets the listener that will be notified when synthesis of an utterance completes.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>listener</code></td> 
   <td><code>TextToSpeech.OnUtteranceCompletedListener</code>: The listener to use. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### setOnUtteranceProgressListener ####

Added in [API level 15][API level 4]

public int setOnUtteranceProgressListener (UtteranceProgressListener listener)

Sets the listener that will be notified of various events related to the synthesis of a given utterance. See `UtteranceProgressListener` and `TextToSpeech.Engine#KEY_PARAM_UTTERANCE_ID`.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>listener</code></td> 
   <td><code>UtteranceProgressListener</code>: the listener to use. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### setPitch ####

Added in [API level 4][]

public int setPitch (float pitch)

Sets the speech pitch for the TextToSpeech engine. This has no effect on any pre-recorded speech.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>pitch</code></td> 
   <td><code>float</code>: Speech pitch.&nbsp;<code>1.0</code>&nbsp;is the normal pitch, lower values lower the tone of the synthesized voice, greater values increase it. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### setSpeechRate ####

Added in [API level 4][]

public int setSpeechRate (float speechRate)

Sets the speech rate. This has no effect on any pre-recorded speech.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>speechRate</code></td> 
   <td><code>float</code>: Speech rate.&nbsp;<code>1.0</code>&nbsp;is the normal speech rate, lower values slow down the speech (<code>0.5</code>&nbsp;is half the normal speech rate), greater values accelerate it (<code>2.0</code>&nbsp;is twice the normal speech rate). <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### setVoice ####

Added in [API level 21][API level 4]

public int setVoice (Voice voice)

Sets the text-to-speech voice.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>voice</code></td> 
   <td><code>Voice</code>: One of objects returned by&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getVoices%28%29" rel="nofollow">getVoices()</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

**See also:**

*  `getVoices()`
 *  `Voice`

#### shutdown ####

Added in [API level 4][]

public void shutdown ()

Releases the resources used by the TextToSpeech engine. It is good practice for instance to call this method in the onDestroy() method of an Activity so the TextToSpeech engine can be cleanly stopped.

#### speak ####

Added in [API level 21][API level 4]

public int speak (CharSequence text, 
                    int queueMode, 
                    Bundle params, 
                    String utteranceId)

Speaks the text using the specified queuing strategy and speech parameters, the text may be spanned with TtsSpans. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see `setOnUtteranceProgressListener(UtteranceProgressListener)`) and using the `Engine#KEY_PARAM_UTTERANCE_ID` parameter.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>text</code></td> 
   <td><code>CharSequence</code>: The string of text to be spoken. No longer than&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getMaxSpeechInputLength%28%29" rel="nofollow">getMaxSpeechInputLength()</a></code>&nbsp;characters. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>queueMode</code></td> 
   <td><code>int</code>: The queuing strategy to use,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_ADD" rel="nofollow">QUEUE_ADD</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_FLUSH" rel="nofollow">QUEUE_FLUSH</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>params</code></td> 
   <td><code>Bundle</code>: Parameters for the request. Can be null. Supported parameter names:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_STREAM" rel="nofollow">Engine#KEY_PARAM_STREAM</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_VOLUME" rel="nofollow">Engine#KEY_PARAM_VOLUME</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_PAN" rel="nofollow">Engine#KEY_PARAM_PAN</a></code>. Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>utteranceId</code></td> 
   <td><code>String</code>: An unique identifier for this request. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>&nbsp;of&nbsp;<strong>queuing</strong>&nbsp;the speak operation. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### speak ####

Added in [API level 4][]  
Deprecated in [API level 21][API level 4]

public int speak (String text, 
                    int queueMode, 
                    HashMap<String, String> params)

**This method was deprecated in API level 21.**  
As of API level 21, replaced by `speak(java.lang.CharSequence, int, android.os.Bundle, java.lang.String)`.

Speaks the string using the specified queuing strategy and speech parameters. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see `setOnUtteranceProgressListener(UtteranceProgressListener)`) and using the `Engine#KEY_PARAM_UTTERANCE_ID` parameter.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>text</code></td> 
   <td><code>String</code>: The string of text to be spoken. No longer than&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getMaxSpeechInputLength%28%29" rel="nofollow">getMaxSpeechInputLength()</a></code>&nbsp;characters. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>queueMode</code></td> 
   <td><code>int</code>: The queuing strategy to use,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_ADD" rel="nofollow">QUEUE_ADD</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#QUEUE_FLUSH" rel="nofollow">QUEUE_FLUSH</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>params</code></td> 
   <td><code>HashMap</code>: Parameters for the request. Can be null. Supported parameter names:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_STREAM" rel="nofollow">Engine#KEY_PARAM_STREAM</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_UTTERANCE_ID" rel="nofollow">Engine#KEY_PARAM_UTTERANCE_ID</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_VOLUME" rel="nofollow">Engine#KEY_PARAM_VOLUME</a></code>,&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_PAN" rel="nofollow">Engine#KEY_PARAM_PAN</a></code>. Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>&nbsp;of&nbsp;<strong>queuing</strong>&nbsp;the speak operation. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### stop ####

Added in [API level 4][]

public int stop ()

Interrupts the current utterance (whether played or rendered to file) and discards other utterances in the queue.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### synthesizeToFile ####

Added in [API level 30][API level 4]

public int synthesizeToFile (CharSequence text, 
                    Bundle params, 
                    ParcelFileDescriptor fileDescriptor, 
                    String utteranceId)

Synthesizes the given text to a ParcelFileDescriptor using the specified parameters. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see `setOnUtteranceProgressListener(UtteranceProgressListener)`).

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>text</code></td> 
   <td><code>CharSequence</code>: The text that should be synthesized. No longer than&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getMaxSpeechInputLength%28%29" rel="nofollow">getMaxSpeechInputLength()</a></code>&nbsp;characters. This value cannot be&nbsp;<code>null</code>. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>params</code></td> 
   <td><code>Bundle</code>: Parameters for the request. Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used. This value cannot be&nbsp;<code>null</code>. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>fileDescriptor</code></td> 
   <td><code>ParcelFileDescriptor</code>: ParcelFileDescriptor to write the generated audio data to. This value cannot be&nbsp;<code>null</code>. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>utteranceId</code></td> 
   <td><code>String</code>: An unique identifier for this request. This value cannot be&nbsp;<code>null</code>. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>&nbsp;of&nbsp;<strong>queuing</strong>&nbsp;the synthesizeToFile operation. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### synthesizeToFile ####

Added in [API level 21][API level 4]

public int synthesizeToFile (CharSequence text, 
                    Bundle params, 
                    File file, 
                    String utteranceId)

Synthesizes the given text to a file using the specified parameters. This method is asynchronous, i.e. the method just adds the request to the queue of TTS requests and then returns. The synthesis might not have finished (or even started!) at the time when this method returns. In order to reliably detect errors during synthesis, we recommend setting an utterance progress listener (see `setOnUtteranceProgressListener(UtteranceProgressListener)`).

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>text</code></td> 
   <td><code>CharSequence</code>: The text that should be synthesized. No longer than&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getMaxSpeechInputLength%28%29" rel="nofollow">getMaxSpeechInputLength()</a></code>&nbsp;characters. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>params</code></td> 
   <td><code>Bundle</code>: Parameters for the request. Cannot be null. Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>file</code></td> 
   <td><code>File</code>: File to write the generated audio data to. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>utteranceId</code></td> 
   <td><code>String</code>: An unique identifier for this request. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>&nbsp;of&nbsp;<strong>queuing</strong>&nbsp;the synthesizeToFile operation. <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

#### synthesizeToFile ####

Added in [API level 4][]  
Deprecated in [API level 21][API level 4]

public int synthesizeToFile (String text, 
                    HashMap<String, String> params, 
                    String filename)

**This method was deprecated in API level 21.**  
As of API level 21, replaced by `synthesizeToFile(java.lang.CharSequence, android.os.Bundle, java.io.File, java.lang.String)`.

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Parameters</th> 
  </tr> 
  <tr> 
   <td><code>text</code></td> 
   <td><code>String</code>: The text that should be synthesized. No longer than&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#getMaxSpeechInputLength%28%29" rel="nofollow">getMaxSpeechInputLength()</a></code>&nbsp;characters. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>params</code></td> 
   <td><code>HashMap</code>: Parameters for the request. Cannot be null. Supported parameter names:&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech.Engine#KEY_PARAM_UTTERANCE_ID" rel="nofollow">Engine#KEY_PARAM_UTTERANCE_ID</a></code>. Engine specific parameters may be passed in but the parameter keys must be prefixed by the name of the engine they are intended for. For example the keys "com.svox.pico_foo" and "com.svox.pico:bar" will be passed to the engine named "com.svox.pico" if it is being used. <p>&nbsp;</p> </td> 
  </tr> 
  <tr> 
   <td><code>filename</code></td> 
   <td><code>String</code>: Absolute file filename to write the generated audio data to.It should be something like "/sdcard/myappsounds/mysound.wav". <p>&nbsp;</p> </td> 
  </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
  <tr> 
   <th colspan="2">Returns</th> 
  </tr> 
  <tr> 
   <td><code>int</code></td> 
   <td><code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#ERROR" rel="nofollow">ERROR</a></code>&nbsp;or&nbsp;<code><a href="https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech#SUCCESS" rel="nofollow">SUCCESS</a></code>&nbsp;of&nbsp;<strong>queuing</strong>&nbsp;the synthesizeToFile operation.</td> 
  </tr> 
 </tbody> 
</table>

[https_blog.csdn.net_badao_liumang_qizhi]: https://blog.csdn.net/badao_liumang_qizhi
[https_files.cnblogs.com_files_badaoliumangqizhi_E8_AF_AD_E9_9F_B3_E6_92_AD_E6_8A_A5.rar]: https://files.cnblogs.com/files/badaoliumangqizhi/%E8%AF%AD%E9%9F%B3%E6%92%AD%E6%8A%A5.rar
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201117233637114.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201117233735302.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[https_developer.android.google.cn_reference_android_speech_tts_TextToSpeech]: https://developer.android.google.cn/reference/android/speech/tts/TextToSpeech
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201117233748304.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[Kotlin]: https://developer.android.google.cn/reference/kotlin/android/speech/tts/TextToSpeech
[API level 4]: https://developer.android.google.cn/guide/topics/manifest/uses-sdk-element#ApiLevels