语音合成 HarmonyOS SDK

"dependencies": {
  "@package/baidutts": "file:./libs/xxxx.har" // 替换“xxxx.har”为实际har包文件名
}

"requestPermissions": [
  {
    "name": "ohos.permission.INTERNET" // 在线授权、离线授权文件下载必需
  },
  {
    "name": "ohos.permission.READ_EXTERNAL_STORAGE" // 读取离线资源文件必需
  },
  {
    "name": "ohos.permission.WRITE_EXTERNAL_STORAGE" // 存储离线授权文件、资源文件必需
  }
]

  // SDK初始化
  private initialTts(): void {
    LoggerProxy.printable(true);
    LoggerProxy.saveNativeLogFile("PRINTF:0");
    this.printEngineInfo();
    // TODO 代码中的所有参数与文件均是测试demo使用，集成自己工程时，请使用自己的参数
    this.addDebugSpeechSynthesizer();
  }
  private addDebugSpeechSynthesizer(): void {
    // 公共参数设置
    this.setPublicParam(this.speechSynthesizer);
    // 如果需要离线，设置离线资源
    this.setOfflineParam(this.speechSynthesizer);
    // 如果需要在线，设置在线离线资源
    this.setOnlineParam(this.speechSynthesizer);
  }
  
    // 设置公共参数
  private setPublicParam(speechSynthesizer: SpeechSynthesizer): void {
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_APP_ID, "APPID");
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_PLAYER_USAGE, audio.StreamUsage.STREAM_USAGE_UNKNOWN + "");
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_PLAYER_VOLUME_MODE, audio.AudioVolumeMode.APP_INDIVIDUAL + "");
    // speechSynthesizer.setParam(SpeechSynthesizer.PARAM_PLAYER_INTERRUPT_MODE, audio.InterruptMode.INDEPENDENT_MODE + "");
  }
  
 // 在线语音合成
 private setOnlineParam(speechSynthesizer: SpeechSynthesizer): void {
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_ACCESS_TOKEN, "IAMKEY或TOKEN");
    // 请初始化您的在线发音人
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_ONLINE_SPEAKER, "4100");
    // 在线超时时间，MIX模式超时会切换至离线，ONLINE模式会超时
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_ONLINE_TIMEOUT, "6000");
    // 初始化在线tts服务，服务会读取相应资源进行加载，此过程是耗时操作
    speechSynthesizer.loadOnlineTts().then(
      (ttsError: ITtsError) => {
        hilog.info(0x0000, 'index', 'loadOnlineTts ttsError errorCode= %{public}d , errorMessage = %{public}s',
          ttsError.getDetailCode(),
          ttsError.getDetailMessage());
      }
    );
  }
  
  // 离线语音合成
  private setOfflineParam(speechSynthesizer: SpeechSynthesizer): void {
    // 设置离线需要的认证参数，产品SN
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_AUTH_SERIAL_NUMBER, "填写申请的SN");
    // 离线资源库路径，设置需要的离线发音人
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_OFFLINE_MODEL, this.setOfflineModel());
    // 初始化离线tts服务，服务会读取相应离线资源进行加载，此过程是耗时操作
    speechSynthesizer.loadOfflineTts().then(
      (ttsError: ITtsError) => {
        hilog.info(0x0000, 'index', 'loadOfflineTts ttsError errorCode= %{public}d , errorMessage = %{public}s',
          ttsError.getDetailCode(),
          ttsError.getDetailMessage());
      }
    );
  }

  // SDK初始化
  private initialTts(): void {
    LoggerProxy.printable(true);
    LoggerProxy.saveNativeLogFile("PRINTF:0");
    this.printEngineInfo();
    // TODO 代码中的所有参数与文件均是测试demo使用，集成自己工程时，请使用自己的参数
    this.addDebugSpeechSynthesizer();
  }
  private addDebugSpeechSynthesizer(): void {
    // 公共参数设置
    this.setPublicParam(this.speechSynthesizer);
    // 如果需要离线，设置离线资源
    this.setOfflineParam(this.speechSynthesizer);
    // 如果需要在线，设置在线离线资源
    this.setOnlineParam(this.speechSynthesizer);
  }
  
    // 设置公共参数
  private setPublicParam(speechSynthesizer: SpeechSynthesizer): void {
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_APP_ID, "APPID");
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_PLAYER_USAGE, audio.StreamUsage.STREAM_USAGE_UNKNOWN + "");
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_PLAYER_VOLUME_MODE, audio.AudioVolumeMode.APP_INDIVIDUAL + "");
    // speechSynthesizer.setParam(SpeechSynthesizer.PARAM_PLAYER_INTERRUPT_MODE, audio.InterruptMode.INDEPENDENT_MODE + "");
  }
  
 // 在线语音合成
 private setOnlineParam(speechSynthesizer: SpeechSynthesizer): void {
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_ACCESS_TOKEN, "IAMKEY或TOKEN");
    // 请初始化您的在线发音人
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_ONLINE_SPEAKER, "4100");
    // 在线超时时间，MIX模式超时会切换至离线，ONLINE模式会超时
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_ONLINE_TIMEOUT, "6000");
    // 初始化在线tts服务，服务会读取相应资源进行加载，此过程是耗时操作
    speechSynthesizer.loadOnlineTts().then(
      (ttsError: ITtsError) => {
        hilog.info(0x0000, 'index', 'loadOnlineTts ttsError errorCode= %{public}d , errorMessage = %{public}s',
          ttsError.getDetailCode(),
          ttsError.getDetailMessage());
      }
    );
  }
  
  // 离线语音合成
  private setOfflineParam(speechSynthesizer: SpeechSynthesizer): void {
    // 设置离线需要的认证参数，产品SN
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_AUTH_SERIAL_NUMBER, "填写申请的SN");
    // 离线资源库路径，设置需要的离线发音人
    speechSynthesizer.setParam(SpeechSynthesizer.PARAM_OFFLINE_MODEL, this.setOfflineModel());
    // 初始化离线tts服务，服务会读取相应离线资源进行加载，此过程是耗时操作
    speechSynthesizer.loadOfflineTts().then(
      (ttsError: ITtsError) => {
        hilog.info(0x0000, 'index', 'loadOfflineTts ttsError errorCode= %{public}d , errorMessage = %{public}s',
          ttsError.getDetailCode(),
          ttsError.getDetailMessage());
      }
    );
  }

speechSynthesizer.setParam("设置相应的参数key", "设置相应的参数value");
// 如果需要在线合成，加载在线模型
auto ttsResult = await speechSynthesizer.loadOnlineTts();
// 如果需要离线合成，加载离线模型
auto ttsResult = await speechSynthesizer.loadOfflineTts();

//合成
speechSynthesizer.synthesize(TtsEntity): Promise<ITtsError>;

//合成并播报
speechSynthesizer.speak(TtsEntity): Promise<ITtsError>;

onSynthesizeResponse(SynthesizerResponse synthesizerResponse):void;
let sn = synthesizerResponse.getSn(); // 此次SDK侧传递的文本合成标识，建议保存，后续排查服务器问题时使用
let utteranceId = synthesizerResponse.getUtteranceId(); // 此次业务侧传递的文本合成标识，用于业务逻辑判断

synthesizerResponse.getSynthesizeType() === SYNTHESIZE_START

synthesizerResponse.getSynthesizeType() === SYNTHESIZE_DATA_ARRIVED
let progress = synthesizerResponse.getAudioProgress();
let engineType = synthesizerResponse.getEngineType();
let sampleRate = synthesizerResponse.getAudioSampleRate();
let audioData = synthesizerResponse.getAudioData();

synthesizerResponse.getSynthesizeType() == PLAY_ERROR
synthesizerResponse.getErrorCode();
synthesizerResponse.getErrorMessage();

synthesizerResponse.getSynthesizeType() == PLAY_ERROR
synthesizerResponse.getErrorCode();
synthesizerResponse.getErrorMessage();

public static verifyModelFile(filePath:string):Promise<ITtsError>

public static getEngineInfo():string

1 public static getEngineVersion():number

/**
 * 校验模型文件是否与当前离线引擎版本兼容（避免因版本不匹配导致合成失败）
 * @param filePath 模型文件绝对路径
 * @return 数字：0=匹配，1=模型版本过高，-1=模型版本过低，-2=文件不存在
 */
let matchResult = SynthesizerTool.matchResEngine("/data/storage/el2/base/haps/entry/files/bd_etts_navi_speech_f7_mand_eng_high_am-style24k_v4.6.0_20210721.dat");
switch (matchResult) {
  case 0:
    console.log("模型文件与引擎版本匹配");
    break;
  case 1:
    console.error("模型版本过高，请升级离线引擎");
    break;
  case -1:
    console.error("模型版本过低，请下载最新模型文件");
    break;
  case -2:
    console.error("模型文件不存在，请检查路径");
    break;
}

/**
 * 获取离线发音人模型（speech.dat）的音频采样率（用于自定义音频播放配置）
 * @param filePath 发音人模型文件绝对路径
 * @return 数字：采样率（如16000、24000，单位Hz；返回-1表示文件无效）
 */
let sampleRate = SynthesizerTool.getSpeechSampleRate("/data/storage/el2/base/haps/entry/files/bd_etts_navi_speech_f7_mand_eng_high_am-style24k_v4.6.0_20210721.dat");
if (sampleRate !== -1) {
  console.log("发音人模型采样率：" + sampleRate + "Hz");
}

public static getDomainSampleRate(filePath:string):number

public static checkDomainFile(filePath:string):number

// 建议在new Synthesizer()之后调用
public static getCuid(): string

LoggerProxy.printable(true);

LoggerProxy.saveNativeLogFile("FPRINTF:0:" + File.separator + context.getExternalFilesDir(null).getPath() + File.separator + "tts_engine.log");

LoggerProxy.saveNativeLogFile("PRINTF:0");

String engineInfo = SynthesizerTool.getEngineInfo();

String textModelInfo = SynthesizerTool.getModelInfo(初始化离线TTS引擎使用的文本资源绝对路径);

String speechModelInfo = SynthesizerTool.getModelInfo(初始化离线TTS引擎使用的音库资源绝对路径);

# 查看TTS SDK版本
strings -a libBDSpeechClientSDK.so | grep TTS_SDK_VERSION
# 查看ETTS唯一标识
strings -a libBDSpeechClientSDK.so | grep ETTS_UNIQUE