Skip to content

发送文本

注意

注意:如使用大模型流式输出结果,请自行实现组句逻辑,writeText只允许传入整句的播放文本,不支持逐字送入

方法名

writeText

用法

  • 用法如下:
    js
    module.writeText({
      params: {
        text: "你好,欢迎来到科大讯飞",
        textParams: {
          tts: {
            vcn: "x4_yezi",
            speed: 50,
            pitch: 50,
            volume: 50
          },
          vc: {
            vc: 0,
            voiceName: "chongchong"
          }
        }
      },
      complete: (res) => {
        console.log(res)
      }
    })
    js
    module.writeText({
      params: {
        text: "你好,欢迎来到科大讯飞",
        textParams: {
          tts: {
            vcn: "x4_yezi",
            speed: 50,
            pitch: 50,
            volume: 50
          },
          vc: {
            vc: 0,
            voiceName: "chongchong"
          }
        }
      },
      complete: (res : LevenResult) => {
        console.log(res)
      }
    } as LevenOptions)
  • 参数说明
    参数名参数类型是否必填默认值参数描述
    paramsObject接口请求参数
    params.textString发送的文本内容
    params.textParamsObject指定textParams,注意单次参数设置仅在本次输入文本生效,后续如不设置,则以全局参数为准
    params.textParams.airObject动作相关参数
    params.textParams.air.airInteger是否开启自动动作,开启后会根据播报文本内容自动选择该虚拟人相应的动作,0-关闭 1-开启,默认关闭
    params.textParams.air.addNonSemanticInteger是否在间隔过长的动作间插入无指向动作,0-关闭 1-开启
    params.textParams.dispatchObject交互模式
    params.textParams.dispatch.audioModeInteger音频类型:0-非实时音频(如文件)1-实时音频,默认实时音频
    params.textParams.dispatch.contentAnalysisInteger文本情感分析,0-关闭 1-开启 ,默认关闭
    params.textParams.dispatch.interactiveModeInteger交互模式:0-追加 1-打断 默认追加模式,当前仅在文本驱动场景生效
    params.textParams.dispatch.targetTypeString官方文档未做说明
    params.textParams.nlpBoolean是否进行语义理解,默认false,指纯文本驱动,打开则会进行语义获取,根据appid所配置语义能力进行获取结果,再进行驱动虚拟人
    params.textParams.vcObject变声相关参数
    params.textParams.vc.vcInteger是否开启变声,0-关闭,1-开启,默认关闭
    params.textParams.vc.voiceNameString开启变声后,需要传入变声发音人
    params.textParams.ttsObject语音合成相关参数
    params.textParams.tts.audioObject语音合成音频信息
    params.textParams.tts.audio.sampleRateInteger语音合成音频采样率,不同的发音人支持不一样,详情请咨询技术支持,默认16000
    params.textParams.tts.volumeInteger语音合成音量,取值0-100,默认50
    params.textParams.tts.engineTypeString官方文档未做说明,可选值:XTTS_MULTI XTTS_PUBLIC
    params.textParams.tts.languageInteger官方文档未做说明
    params.textParams.tts.pitchInteger语音合成语调,取值0-100,默认50
    params.textParams.tts.speedInteger语音合成语速,取值0-100,默认50
    params.textParams.tts.vcnString语音合成发音人,不传时将使用虚拟人对应的默认发音人
    params.textParams.requestIdString单次交互id,此id可作为关联输入使用,在tts_duration、、frame_start、frame_end等事件的附参中会一并返回
    params.textParams.sessionString官方文档未做说明
    params.textParams.statusInteger官方文档未做说明
    successFunction执行成功的函数
    failFunction执行失败的函数
    completeFunction执行完成的函数,不管成功还是失败都会执行

回调

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