语音合成 Android SDK

1. 文档说明

2. 版本说明

2.1 版本升级改动点说明：

• 提升SDK稳定性；
• 离线发音人听感调优

3. SDK说明

4. Demo运行

4.1 配置包名和签名

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

4.2 修改鉴权

AppId AppKey SecretKey 包名 序列号SN 5个信息必须完全正确后，SDK会自动下载鉴权文件。否则会有-102或-109错误。

可以在百度云网站上申请自己语音合成的应用后，会有appId、appKey、appSecret及android包名 4个鉴权信息， 修改app/src/main/assets/auth.properties 里的4个字段 , 并修改app/build.gradle里 defaultConfig.applicationId与applicationId一致:

5. SDK集成

com.baidu.tts_2.6.*.jar 库 将app/libs/com.baidu.tts_2.6.xxxxxx.jar复制到您的项目的同名目录中。确认在build.gradle文件中引入。

复制NDK 架构目录

1. 将 app/src/main/jniLibs 下armeabi等5个目录，复制到您的项目的同名目录中。
2. 如与第三方库集成，至少要保留armeabi目录。如第三方库有7个架构目录，比语音合成SDK多出2个目录 mips和mips64，请将mips和mips64目录删除，剩下5个同名目录合并。
3. 如第三方库仅有armeabi这一个目录，请将语音合成SDK的额外4个目录如armeabi-v7a删除,合并armeabi目录下的so。 即目录取交集，so文件不可随意更改所属目录。
4. 打包成apk文件，按照zip格式解压出libs目录可以验证。
5. 运行时 getApplicationInfo().nativeLibraryDir 目录下查看是否有完整so文件。 特别是系统app需要手动push so文件到这个目录下。

build.gradle 文件及包名确认

1. 根目录下build.gradle确认下gradle的版本。
2. app/build.gradle 确认下 applicationId 包名是否与官网申请应用时相一致（离线功能需要）。 demo的包名是"com.baidu.tts.sample"。
3. 确认 compileSdkVersion buildToolsVersion 及 targetSdkVersion, API LEVEL 28的编译产物在android 9.0系统上运行需要在app/src/main/AndroidManifest.xml 里添加 <uses-library android:name="org.apache.http.legacy" android:required="false"/>

DEMO压缩包说明

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

• com.baidu.tts_x.x.x.xxxxx_xxxxx.jar 位于 app/libs 目录下。

• armeabi-v7a，arm64-v8a，x86，x86_64 4个架构目录位于app\src\main\jniLibs 目录下

  官方demo内 doc_integration_DOCUMENT文件夹下有Integration-OFFLINETTS-INTO-Helloworld V3.2.docx 文件，helloworld 集成sdk的完整图示实例。

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

请将百度云控制台创建应用时获取的语音(APPID)、API/SECRET KEY 并填写包名。

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

离线合成SDK默认自带4个普通音库资源文件，精品音库资源文件需单独下载。2.6.2及之前版本SDK暂不支持兼容当前版本资源文件，需配合旧版本资源文件使用。

SDK默认自带离线资源文件

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

在线时支持11种发音

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

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

具体效果可以在http://ai.baidu.com/tech/speech/tts_online上测试

7. 语音合成相关接口

7.1 初始化初接口

设置当前的Context

mSpeechSynthesizer.setContext(this); // this 是Context的之类，如Activity

注意 setContext只要在SpeechSynthesizer.getInstance();设置一次即可，不必切换Context时重复设置。

设置合成结果的回调

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

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

设置 App Id和 App Key 及 App Secret

在语音官网或者百度云网站上申请语音合成的应用后，会有appId、appKey、appSecret及android包名 4个鉴权信息

mSpeechSynthesizer.setAppId("8535996"/*这里只是为了让Demo运行使用的APPID,请替换成自己的id。*/);
mSpeechSynthesizer.setApiKey("MxPpf3nF5QX0pnd******cB",         "7226e84664474aa09********b2aa434"/*这里只是为了让Demo正常运行使用APIKey,请替换成自己的APIKey*/);
// 包名填写在 app/build.gradle

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

设置合成参数

可以在初始化设置，也可以在合成前设置。 示例：

mSpeechSynthesizer.setParam(SpeechSynthesizer.PARAM_SPEAKER, "0"); // 设置发声的人声音，在线生效

合成参数

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

初始化合成引擎

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

mSpeechSynthesizer.initTts(TtsMode.OFFLINE); // 初始化离线混合模式，如果需要在线合成功能，使用离在线混合模式TtsMode.MIX

控制接口

合成及播放接口

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

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

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

speak方法示例：

 int speak(String text);
 int speak(String text, String utteranceId); // utteranceId在SpeechSynthesizerListener 相关事件方法中回调

speechSynthesizer.speak("百度一下");

synthesize方法示例：

int synthesize(String text);
int synthesize(String text, String utteranceId); // utteranceId在SpeechSynthesizerListener 相关事件方法中回调

speechSynthesizer.synthesize("百度一下");

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

批量合成并播放接口

效果同连续调用speak 方法。推荐连续调用speak方法，sdk内部有队列缓冲。 该接口可以批量传入多个文本并进行排队合成并播放（如果没有设置utteranceId，则使用list的索引值作为utteranceId）。 注意需要合成的每个文本text不超过120的GBK字节，即60个汉字或英文字母数字。超过请自行按照句号问号等标点切分，放入多个SpeechSynthesizeBag

int batchSpeak(java.util.List<SpeechSynthesizeBag> speechSynthesizeBags)

以下为批量调用示例

List<SpeechSynthesizeBag> bags = new ArrayList<SpeechSynthesizeBag>();
bags.add(getSpeechSynthesizeBag("123456", "0"));
bags.add(getSpeechSynthesizeBag("你好", "1"));
bags.add(getSpeechSynthesizeBag("使用百度语音合成SDK", "2"));
bags.add(getSpeechSynthesizeBag("hello", "3"));
bags.add(getSpeechSynthesizeBag("这是一个demo工程", "4"));
int result = mSpeechSynthesizer.batchSpeak(bags);
 
 private SpeechSynthesizeBag getSpeechSynthesizeBag(String text, String utteranceId) {
        SpeechSynthesizeBag speechSynthesizeBag = new SpeechSynthesizeBag();
        //需要合成的文本text的长度不能超过120个GBK字节。
        speechSynthesizeBag.setText(text);
        speechSynthesizeBag.setUtteranceId(utteranceId);
        return speechSynthesizeBag;
    }
 

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

播放过程中的暂停及继续

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

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

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

停止合成并停止播放

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

int result = mSpeechSynthesizer.stop();

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

其它接口

打开调试日志（重要）

LoggerProxy.printable(true); // 日志打印在logcat中

开启成功后会看见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 之后。

int result = mSpeechSynthesizer.loadModel(speechModelPath,  textModelPath);

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

设置音量

该接口用来设置播放器的音量，即使用speak 播放音量时生效。范围为[0.0f-1.0f]。

int result = mSpeechSynthesizer.setStereoVolume (leftVolume, rightVolume);

此接口与PARAM_VOLUME参数的设置不同，PARAM_VOLUME设置的是服务器合成音频时的音量，而该接口设置的是播放时Android系统的音量。 返回结果不为0，表示出错。错误码请参见“错误码及解决方法”一节

音频流类型

   public int setAudioAttributes(int usage, int contentType)

该接口用来设置播放器的音频流类型， 默认值为AudioAttributes.USAGE_MEDIA, AudioAttributes.CONTENT_TYPE_MUSIC，指的是用与音乐播放的音频流。 具体可以参考android官方文档 https://source.android.google.cn/devices/audio/attributes

授权检验接口（测试使用，上线可以忽略）

一般情况下，不需要使用该方法。

测试您的AppId，AppKey AppSecret填写正确，语音合成服务是否开通。

• 离在线混合模式下，自动下载正式授权文件。每次调用时，可能会更新正式授权文件。

离在线混合模式下 ，检验应用里包名是否填写正确，如果正确，自动下载正式授权文件。如果不正确，请在应用管理页面检查合成服务是否开通，包名是否填写正确。

​

mSpeechSynthesizer.auth(TtsMode.ONLINE);  // 纯在线
//或 mSpeechSynthesizer.auth(TtsMode.MIX); // 离在线混合
//或  mSpeechSynthesizer.auth(TtsMode.OFFLINE)// 纯离线

注意 demo的包名是com.baidu.tts.sample，定义在build.gradle文件中。

SpeechSynthesizerListener回调方法

 // @param engineType 1: 音频数据由离线引擎合成； 0：音频数据由在线引擎（百度服务器）合成。

 void onSynthesizeDataArrived(String utteranceId, byte[] bytes, int progress, int engineType);

8. 错误码及解决方法

生成错误码共2处位置：

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

鉴权错误码

鉴权错误错误的原因可能是appkey，secretkey填错。或者这个应用的配额超限。

示例：

(-8)access token is null, please check your apikey and secretkey or product id，
(-7)request result contains error message[(502)110: Access token invalid or no longer valid]，
// 110 是子错误

常见错误码及解决方案

9. 代码混淆

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

10. 权限

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

不使用离线合成，只使用在线合成，可以单独下载纯在线合成sdk https://ai.baidu.com/download?sdkId=116

删除离线音库文件，并且设置合成模式为online在线模式 ，TtsMode DEFAULT_SDK_TTS_MODE = TtsMode.ONLINE;