语音合成 Android SDK

1. 文档说明

2. 版本说明

2.1 版本升级改动点说明：

• 提升SDK稳定性
• 离线发音人听感调优
• 支持更多授权方式

3. SDK说明

4. Demo运行

从百度云控制台下载Demo，下载完成后解压demo，并用android stdio打开该项目

4.1 配置包名和签名

从百度云控制台下载Demo之后，需要在build.gradle中配置好包名,且包名和控制台应用包名一致。

4.2 修改鉴权

4.2.1 离线SDK鉴权

若AppId、包名、序列号SN 3个信息完全正确，SDK将自动下载鉴权文件，否则会有-102或-109错误。

在百度云网站上申请自己的语音合成的应用后，能够获取AppId、AppKey、AppSecret及Android包名 4个鉴权信息 , 序列号SN申请的具体流程参考语音技术 (baidu.com)。 申请成功后在 MainActivity 中的 setOfflineParam 方法处填写 AppId 和 SN:

4.2.2 在线SDK鉴权

在线sdk分为4种激活方式，实际使用种选择其中一种方式进行激活，4种激活方法详细描述如下：

1. 临时accessToken和临时iam key激活方式：

accessToken和临时iamKey为相同接口，接口会随时间失效，客户需要在callback中创建http请求获取到对应token返回给sdk,sdk会在过期前3分钟通过callback重新向客户端获取最新token。

accessToken获取地址：https://ai.baidu.com/ai-doc/REFERENCE/Ck3dwjhhu

iamKey获取地址：https://cloud.baidu.com/doc/AI_REFERENCE/s/Hm5us339w

• 将accessToken或iamKey 还有过期时间返回给sdk

• 将callback传递到sdk中

2. 永久iamKey激活方式：

“永久iamKey激活”方式细节如下：

• 将官网申请的永久iamKey放到项目中
• 将iamKey传入接口，此步骤需要使用AipeSpeechSynthesizer类，不能使用SpeechSynthesizer进行设置

5. SDK集成

TTS SDK在线版本为com.baidu.aipd.tts_6.2.7.53b015e_20250704180845.aar 库，离线版本为com.baidu.tts_6.2.7.53b015e_20250704180845.aar。

将app/libs/com.baidu.aipd.tts_6.2.7.fb21735_20250613180318.aar复制到您的项目的同名目录中，确认在build.gradle文件中引入。

build.gradle 文件及包名确认

1. 根目录下build.gradle确认下gradle的版本。
2. app/build.gradle 确认下 applicationId 包名是否与官网申请应用时相一致（离线功能需要）。 demo的包名是"com.baidu.tts.sample"。

DEMO压缩包说明

DEMO压缩包下载即可运行，其中DEMO内已经附带了SDK的库。

com.baidu.aipd.tts_6.2.7.53b015e_20250704180845.aar 位于 app/libs 目录下。

6. 授权文件、离线资源文件

请选择激活方式(离线、iamKey、accessToken)，并将百度云控制台创建应用时获取的语音(APPID) SN、APPKEY/SECRET KEY 、accessToken或iamKey填写到项目 并填写包名。

离线资源文件--发音人（支持16个不同发音人）

离线合成SDK默认自带4个普通音库资源文件，精品音库资源文件需单独下载。若您在2025年11月27日之前购买或申请序列号，请点击下载往期音库资源文件：https://platform-new.cdn.bcebos.com/sdk/tts/Quality_Speaker_202211.zip

SDK默认自带离线资源文件

注：2025年11月28日及以后控制台申请与购买的序列号仅支持4.9及以上版本。为保证使用新旧序列号的用户均可正常使用，SDK基础音库同时包含4.6音库与4.9音库，按文档配置即可正常使用。

需要单独下载的精品音库资源文件

往期精品音库资源文件

在线时支持11种发音

普通音库：普通女声 普通男声 情感男声<度逍遥> 情感儿童声<度丫丫>

精品音库： 度逍遥-磁性男声 度博文-情感男声 度小童-活泼男童 度小鹿-甜美女声 度小娇-情感女声 度米朵-可爱女童 度小萌-可爱女童

具体效果可以在在线合成体验窗口上测试。

7. 语音合成相关接口

7.1 初始化初接口

设置合成结果的回调

如合成成功后，SDK会调用用户设置的SpeechSynthesizerListener 里的回调方法

mSpeechSynthesizer.setSpeechSynthesizerListener(listener); //listener是SpeechSynthesizerListener 的实现类，需要实现您自己的业务逻辑。SDK合成后会对这个类的方法进行回调。

设置 激活参数

在语音官网或者百度云网站上申请语音合成的应用后，会有appId、appKey、appSecret及android包名 4个鉴权信息，可选择离线激活、在线激活、正式iamKey激活和临时tocken激活4种激活方式

        /* 离线激活方式 */
        // 设置离线需要的app_id,在开放平台注册app时获取
        speechSynthesizer.setParam(SpeechSynthesizer.PARAM_APP_ID, "填入您的appid");
        // 设置离线需要的认证参数，产品序列号SN
        speechSynthesizer.setParam(SpeechSynthesizer.PARAM_AUTH_SN, "输入您的sn");

        /* 临时token激活方法 */
        // 设置在线需要的临时token callback
         speechSynthesizer.setParam(new TokenCallback() {
            @Override
            public TemporaryToken getToken() {
                .../*通过网络请求获取临时accessTocken或临时iamKey*/
                return "临时accessTocken或临时iamKey";
            }
        });
        

        /* 永久iam key激活方式 */
        // 设置在线需要的正式iam key 
         speechSynthesizer.setParam(SpeechSynthesizer.PARAM_ACCESS_TOKEN, "输入您的永久iam key");
         

如果需要使用离线合成功能的话，请在申请的语音合成的应用填写您自己的包名，若使用demo的包名是“com.baidu.tts.sample"， 定义在build.gradle中。

合成参数

在SpeechSynthesizer类中setParam 方法中使用的参数及值。 填入的值如果不在范围内，相当于没有填写使用默认值。

初始化合成引擎

设置合成的参数后，需要调用此方法初始化。

• 在线激活初始化方法如下

// 初始化在线tts服务，服务会读取相应资源进行加载，此过程是耗时操作
 ITtsError ttsError = speechSynthesizer.loadOnlineTts();

• 离线激活初始化方法如下

 // 初始化离线tts服务，服务会读取相应离线资源进行加载，此过程是耗时操作
 ITtsError ttsError = speechSynthesizer.loadOfflineTts();

控制接口

合成及播放接口

如果需要合成后立即播放的请调用speak方法，如果只需要合成请调用synthesize方法。

该接口线程安全，可以快速多次调用。内部采用排队策略，调用后将自动加入队列，SDK会按照队列的顺序进行合成及播放。 注意需要合成的每个文本text不超过120的GBK字节，即60个汉字或英文字母数字。超过请自行按照句号问号等标点切分，调用多次合成接口。

返回结果不为0，表示出错。错误码请参见“错误码及解决方法”一节

speak方法示例：

    ITtsError speak(TtsEntity ttsEntity)// utteranceId在SpeechSynthesizerListener 相关事件方法中回调

    TtsEntity ttsEntity = new TtsEntity(text, TtsMode.MIX);
    ITtsError ttsError = speechSynthesizer.speak(ttsEntity);

synthesize方法示例：

    ITtsError synthesize(TtsEntity ttsEntity) // utteranceId在SpeechSynthesizerListener 相关事件方法中回调

    ITtsError ttsError = speechSynthesizer.synthesize(new TtsEntity(text, TtsMode.MIX));

调用这两个方法后，SDK会回调SpeechSynthesizerListener中的onSynthesizeResponse方法。 音频数据在SynthesizerResponse参数的getAudioData方法中格式为byte[]，采样率16K 16bits编码 单声道。连续将audioData写入一个文件，即可作为一个可以播放的pcm文件（采样率16K 16bits编码 单声道）。

批量合成并播放接口

推荐连续调用speak方法，sdk内部有队列缓冲。 可以循环Speak方法传入多个文本并进行排队合成并播放。 注意需要合成的每个文本text不超过120的GBK字节，即60个汉字或英文字母数字。(默认限制队列最多支持合成5条，如需增加可通过PARAM_MAX_QUEUE_SIZE修改，) 以下为批量调用示例：

String[] a = {
                "123456",
                "你好",
                "使用百度语音合成SDK",
                "hello",
                "hello",
                "这是一个demo工程"};
for (int i = 0 ; i < a.length ;i++) {
    TtsEntity ttsEntity = new TtsEntity(a[i], TtsMode.MIX);
    ITtsError ttsError = mSpeechSynthesizer.speak(ttsEntity);
    LoggerProxy.d(TAG, "sn = " + ttsEntity.getSn() + " , synthesize = " + ttsError.getDetailCode());
}

ITtsError.getDetailCode()返回结果不为0，表示出错。错误码请参见“错误码及解决方法”一节。

批量合成切换发音人

sdk批量合成支持每个文本使用不同发音人播报的功能，将每个文本的发音人信息放到map中传递给TTSEntity进行播报，以下为调用示例：

String[] a = {
             "123456",
            "你好",
};
for (int i = 0 ; i < a.length ;i++) {
    HashMap<String, String> ttsParams = new HashMap<>();
    JSONObject jsonObject = new JSONObject();
    try {
        jsonObject.put(SpeechSynthesizer.PARAM_TTS_TEXT_MODEL_FILE,"文本资源路径");
        jsonObject.put(SpeechSynthesizer.PARAM_TTS_SPEECH_MODEL_FILE,"发音人路径");
        ttsParams.put(SpeechSynthesizer.PARAM_OFFLINE_MODEL, jsonObject.toString());
        TtsEntity ttsEntity = new TtsEntity(a[i], TtsMode.MIX , ttsParams);
        ITtsError ttsError = mSpeechSynthesizer.speak(ttsEntity);
    } catch (JSONException e) {
        throw new RuntimeException(e);
    }
}

播放过程中的暂停及继续

仅speak方法调用后有效。可以使用pause暂停当前的播放。pause暂停后，可使用resume进行播放。

int result = mSpeechSynthesizer.pause();
int result = mSpeechSynthesizer.resume();

返回结果不为0，表示出错。错误码请参见“错误码及解决方法”一节

停止合成并停止播放

取消当前的合成。并停止播放。

int result = mSpeechSynthesizer.stop();

返回结果不为0，表示出错。错误码请参见“错误码及解决方法”一节

其它接口

打开调试日志（重要）

  LoggerProxy.printable(true); // 日志打印在logcat中
  LoggerProxy.saveNativeLogFile("PRINTF:0"); // 设置日志级别 0：debug级别 ；1：trace级别；2：fatal级别。

开启成功后会看见bdtts-开头的tag日志，建议上线后完全没问题再由服务端控制关闭。

日志输出截图：

判断模型文件是否有效(重要)

SynthesizerTool.verifyModelFile(“/path/to/bd_etts_eng_common_text_all_xxxx.dat”) ;//判断文本资源
SynthesizerTool.verifyModelFile(“/path/to/bd_etts_common_speech_xxxx.dat”) ;//判断音库资源

释放资源

不再使用后，请释放资源，并将mSpeechSynthesizer设为null。如果需要再次使用，可以通过SpeechSynthesizer.getInstance() 获取，并重复上述流程。

int result = mSpeechSynthesizer.release();

返回结果不为0，表示出错。错误码请参见“错误码及解决方法”一节

切换离线发音

切换离线发音人接口。 SDK默认只有4种离线，用这个方法可以切换离线发音人。 离线合成时的参数，填入两个资源文件的路径。如果切换的话，也是使用这两个文件路径。

注意：必须在引擎空闲的时候调用这个方法，否则有不为0的错误码返回。空闲是指最后一个合成回调onSynthesizeFinish 之后。

try {
    JSONObject jsonObject = new JSONObject();
    jsonObject.put(SpeechSynthesizer.PARAM_TTS_TEXT_MODEL_FILE,"文本资源路径");
    jsonObject.put(SpeechSynthesizer.PARAM_TTS_SPEECH_MODEL_FILE,"音库资源路径");
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_OFFLINE_MODEL, jsonObject.toString());
 } catch (JSONException e) {
    e.printStackTrace();
 }

SpeechSynthesizerListener回调方法

public void onSynthesizeResponse(SynthesizerResponse synthesizerResponse)

SynthesizerResponse 输出参数

合成回调事件统一由 public void onSynthesizeResponse(SynthesizerResponse synthesizerResponse) 该方法回调。其中SynthesizerResponse对象包含合成进度 、音频数据、合成状态等，方法以及说明如下：

8. 错误码及解决方法

生成错误码共2处位置：

• 调用接口的方法时的返回，如initTTs方法的返回
• onError(String utteranceId，SpeechError error); SpeechError 中的code

常见错误码及解决方案

9. 代码混淆

    -keep class com.baidu.tts.**{*;}
    -keep class com.baidu.speechsynthesizer.**{*;}

10. 权限

11. 不使用离线合成，只使用在线合成

删除离线音库文件，并且设置合成模式为online在线模式 ，speechSynthesizer.speak(new TtsEntity(text, TtsMode.ONLINE));