Skip to content

开始合成

方法名

startTts

注意

识别结果在初始化回调中返回

用法

  • 用法如下:
js
let params = {
  //【必需配置】需合成的文本,不可超过 80 字
  text: this.text,
  //【必需配置】TTS 使用场景,可选值:normal、novel
  ttsScenario: "normal",
  //【可选配置】需合成的文本的类型,支持直接传文本(TTS_TEXT_TYPE_PLAIN)和传 SSML 形式(TTS_TEXT_TYPE_SSML)的文本,可选值:plain、ssml、json
  textType: "plain",
  //【可选配置】用于控制 TTS 音频的语速,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
  speed: 10,
  //【可选配置】用于控制 TTS 音频的音量,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
  volume: 10,
  //【可选配置】用于控制 TTS 音频的音高,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
  pitch: 10,
  //【可选配置】是否在文本的每句结尾处添加静音段,单位:毫秒,默认为 0ms
  silenceDuration: 0,
  //【可选配置】是否使用 SDK 内置播放器播放合成出的音频,默认为 true
  enablePlayer: true,
  //【可选配置】是否令 SDK 通过回调返回合成的音频数据,默认不返回。
  // 开启后,SDK 会流式返回音频,收到 MESSAGE_TYPE_TTS_AUDIO_DATA_END 回调表示当次合成所有的音频已经全部返回
  dataCallbackMode: false,
  // ------------------------ 在线合成相关配置 -----------------------
  //【必需配置】在线合成使用的发音人代号
  voiceOnline: "",
  //【必需配置】在线合成使用的音色代号
  voiceTypeOnline: "BV700_V2_streaming",
  //【可选配置】是否打开在线合成的服务端缓存,默认关闭
  enableCache: false,
  //【可选配置】指定在线合成的语种,默认为空,即不指定
  languageOnline: "",
  //【可选配置】是否启用在线合成的情感预测功能
  withIntent: false,
  //【可选配置】指定在线合成的情感,例如 happy, sad 等
  emotion: "",
  //【可选配置】需要返回详细的播放进度时应配置为 1, 否则配置为 0 或不配置
  withFrontend: 1,
  //【可选配置】使用复刻音色
  useVoiceClone: false,
  //【可选配置】在开启前述使用复刻音色的开关后,制定复刻音色所用的后端集群
  backendCluster: "",
  // ------------------------ 离线合成相关配置 -----------------------
  //【必需配置】离线合成使用的发音人代号
  voiceOffline: "",
  //【必需配置】离线合成使用的音色代号
  voiceTypeOffline: "",
  //【可选配置】是否降低离线合成的 CPU 利用率,默认关闭
  // 打开该配置会使离线合成的实时率变大,仅当必要(例如为避免系统主动杀死CPU占用持续过高的进程)时才应开启
  limitCpuUsage: false
};
module.startTts({
  params: params,
  //成功执行的函数
  success: (res) => {
    console.log(res)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数,不管成功还是失败都会返回
  complete: (res) => {
    console.log(res)
  }
})
js
module.startTts({
  params: {
    //【必需配置】需合成的文本,不可超过 80 字
    text: text.value,
    //【必需配置】TTS 使用场景,可选值:normal、novel
    ttsScenario: "normal",
    //【可选配置】需合成的文本的类型,支持直接传文本(TTS_TEXT_TYPE_PLAIN)和传 SSML 形式(TTS_TEXT_TYPE_SSML)的文本,可选值:plain、ssml、json
    textType: "plain",
    //【可选配置】用于控制 TTS 音频的语速,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
    speed: 10,
    //【可选配置】用于控制 TTS 音频的音量,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
    volume: 10,
    //【可选配置】用于控制 TTS 音频的音高,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
    pitch: 10,
    //【可选配置】是否在文本的每句结尾处添加静音段,单位:毫秒,默认为 0ms
    silenceDuration: 0,
    //【可选配置】是否使用 SDK 内置播放器播放合成出的音频,默认为 true
    enablePlayer: true,
    //【可选配置】是否令 SDK 通过回调返回合成的音频数据,默认不返回。
    // 开启后,SDK 会流式返回音频,收到 MESSAGE_TYPE_TTS_AUDIO_DATA_END 回调表示当次合成所有的音频已经全部返回
    dataCallbackMode: false,
    // ------------------------ 在线合成相关配置 -----------------------
    //【必需配置】在线合成使用的发音人代号
    voiceOnline: "",
    //【必需配置】在线合成使用的音色代号
    voiceTypeOnline: "BV700_V2_streaming",
    //【可选配置】是否打开在线合成的服务端缓存,默认关闭
    enableCache: false,
    //【可选配置】指定在线合成的语种,默认为空,即不指定
    languageOnline: "",
    //【可选配置】是否启用在线合成的情感预测功能
    withIntent: false,
    //【可选配置】指定在线合成的情感,例如 happy, sad 等
    emotion: "",
    //【可选配置】需要返回详细的播放进度时应配置为 1, 否则配置为 0 或不配置
    withFrontend: 1,
    //【可选配置】使用复刻音色
    useVoiceClone: false,
    //【可选配置】在开启前述使用复刻音色的开关后,制定复刻音色所用的后端集群
    backendCluster: "",
    // ------------------------ 离线合成相关配置 -----------------------
    //【必需配置】离线合成使用的发音人代号
    voiceOffline: "",
    //【必需配置】离线合成使用的音色代号
    voiceTypeOffline: "",
    //【可选配置】是否降低离线合成的 CPU 利用率,默认关闭
    // 打开该配置会使离线合成的实时率变大,仅当必要(例如为避免系统主动杀死CPU占用持续过高的进程)时才应开启
    limitCpuUsage: false
  },
  //成功执行的函数
  success: (res) => {
    console.log(res)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数,不管成功还是失败都会返回
  // complete: (res) => {
  //   console.log(res)
  // }
} as LevenOptions)
  • 参数说明
    参数名参数类型是否必填默认值参数描述
    paramsObject接口请求参数
    params.textString需合成的文本,不可超过 80 字
    params.ttsScenarioString使用场景,可选值:normal、novel
    params.textTypeString需合成的文本的类型,支持直接传文本(TTS_TEXT_TYPE_PLAIN)和传 SSML 形式(TTS_TEXT_TYPE_SSML)的文本,可选值:plain、ssml、json
    params.speedInteger用于控制 TTS 音频的语速,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
    params.volumeInteger用于控制 TTS 音频的音量,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
    params.pitchInteger用于控制 TTS 音频的音高,支持的配置范围参考火山官网 语音技术/语音合成/离在线语音合成SDK/参数说明 文档
    params.silenceDurationInteger是否在文本的每句结尾处添加静音段,单位:毫秒,默认为 0ms
    params.enablePlayerBoolean是否使用 SDK 内置播放器播放合成出的音频,默认为 true
    params.dataCallbackModeBoolean是否令 SDK 通过回调返回合成的音频数据,默认不返回。开启后,SDK 会流式返回音频,收到 MESSAGE_TYPE_TTS_AUDIO_DATA_END 回调表示当次合成所有的音频已经全部返回
    params.voiceOnlineString在线合成使用的发音人代号
    params.voiceTypeOnlineString在线合成使用的音色代号
    params.enableCacheBoolean是否打开在线合成的服务端缓存,默认关闭
    params.languageOnlineString指定在线合成的语种,默认为空,即不指定
    params.withIntentBoolean是否启用在线合成的情感预测功能
    params.emotionString指定在线合成的情感,例如 happy, sad 等
    params.withFrontendInteger需要返回详细的播放进度时应配置为 1, 否则配置为 0 或不配置
    params.useVoiceCloneBoolean使用复刻音色
    params.voiceOfflineString离线合成使用的发音人代号
    params.voiceTypeOfflineString离线合成使用的音色代号
    params.limitCpuUsageBoolean是否降低离线合成的 CPU 利用率,默认关闭,打开该配置会使离线合成的实时率变大,仅当必要(例如为避免系统主动杀死CPU占用持续过高的进程)时才应开启
    successFunction执行成功的函数
    failFunction执行失败的函数
    completeFunction执行完成的函数,不管成功还是失败都会执行

回调

  • 示例
json
{
    "data": {},
    "message": "",
    "code": 0
}
  • 回调说明:
    参数名参数类型参数描述
    messageString消息提示
    dataObject数据对象
    codeInteger返回类型,0.成功,其他:失败