设置虚拟人参数

方法名

createAvatarParams

用法

用法如下：

uniappuniappx

module.createAvatarParams({
  params: {
    //虚拟人信息
    avatar: {
      avatarId: "201343001",
      bgData: "http://ceph.xfyousheng.com/J9Q7O4EL/uploadResource/20210315/3f8cda6a-3d43-46ff-965a-f34df51b36f0.jpg",
      scale: 0.95,
      moveH: 0,
      moveV: 0,
      width: 1080,
      height: 1920,
      audioFormat: 1,
      maskRegion: "",
      bgType: "url",
      //设置Stream参数
      stream: {
        protocol: "xrtc",
        alpha: false,
        bitrate: 2000,
        fps: 25,
      }
    },
    tts: {
      vcn: "x4_yezi",
      speed: 50,
      pitch: 50,
      volume: 50
    },
    subtitle: {
      enable: false,
      fontColor: "#FFFFFF"
    },
    dispatch: {
      interactiveMode: 0,
      contentAnalysis: 0
    },
    scene: {
      sceneId: "320726603397206016",
      sceneVersion: ""
    },
    vc: {
      vc: 0,
      voiceName: "chongchong"
    },
    stream: "xrtc",
    videoWidth: 1080,
    videoHeight: 1920,
    renderTimeout: 5000
  },
  complete: (res) => {
    // console.log(res)
  }
})

module.createAvatarParams({
  params: {
    //虚拟人信息
    avatar: {
      avatarId: "201343001",
      bgData: "http://ceph.xfyousheng.com/J9Q7O4EL/uploadResource/20210315/3f8cda6a-3d43-46ff-965a-f34df51b36f0.jpg",
      scale: 0.95,
      moveH: 0,
      moveV: 0,
      width: 1080,
      height: 1920,
      audioFormat: 1,
      maskRegion: "",
      bgType: "url",
      //设置Stream参数
      stream: {
        protocol: "xrtc",
        alpha: false,
        bitrate: 2000,
        fps: 25,
      }
    },
    tts: {
      vcn: "x4_yezi",
      speed: 50,
      pitch: 50,
      volume: 50
    },
    subtitle: {
      enable: false,
      fontColor: "#FFFFFF"
    },
    dispatch: {
      interactiveMode: 0,
      contentAnalysis: 0
    },
    scene: {
      sceneId: "320726603397206016",
      sceneVersion: ""
    },
    vc: {
      vc: 0,
      voiceName: "chongchong"
    },
    stream: "xrtc",
    videoWidth: 1080,
    videoHeight: 1920,
    renderTimeout: 5000
  },
  complete: (res : LevenResult) => {
    console.log(res)
  }
} as LevenOptions)

参数说明

参数名	参数类型	是否必填	默认值	参数描述
params	Object	是	无	接口请求参数
params.avatar	Object	是	无	虚拟人信息
params.avatar.avatarId	String	是	无	虚拟人id
params.avatar.avatarImgUrl	String	否	无	`官方文档未做说明`
params.avatar.avatarImgEncode	String	否	无	`官方文档未做说明`
params.avatar.anchorType	String	否	无	`官方文档未做说明`
params.avatar.bgType	String	否	无	背景类型，当前仅支持`res_key`
params.avatar.bgData	String	否	无	背景数据，type为`res_key`，data传入图片id，背景可在虚拟人交互平台-素材管理中进行上传，上传后生成`res_id` 。地址：https://virtual-man.xfyun.cn/console/assetsManagement
params.avatar.audioFormat	Integer	否	1	音频驱动或交互时输入音频格式，1-采样率16000，2-采样率24000，默认1
params.avatar.bgScaleType	String	否	无	背景裁剪类型，可选值：`FIT_XY` `FIT_CENTER`
params.avatar.bsDim	Integer	否	无	`官方文档未做说明`
params.avatar.height	Integer	否	无	视频高，默认1080，需是4的倍数
params.avatar.width	Integer	否	无	视频宽，默认720，需是4的倍数
params.avatar.maskRegion	String	否	无	虚拟人裁剪信息，形式：【x，y，m，n】
params.avatar.moveH	Integer	否	无	水平位移，相对于中心位置，默认0
params.avatar.moveV	Integer	否	无	竖直位移，相对于中心位置，默认0
params.avatar.scale	Float	否	无	虚拟人缩放比例，默认1.0 ，取值范围（0-1.0】
params.avatar.stream	Object	否	无	视频流信息
params.avatar.stream.protocol	String	否	无	视频流协议，目前支持xrtc
params.avatar.stream.alpha	Integer	否	无	是否带透明通道，0-无，1-开启，设置为1的时候，背景设置将不起作用
params.avatar.stream.bitrate	Integer	否	无	视频码率，单位kbps，默认2000
params.avatar.stream.fps	Integer	否	无	视频帧率，目前支持15,20,25；默认25
params.avatar.vadMode	Integer	否	无	`官方文档未做说明`
params.tts	Object	否	无	语音合成相关参数
params.tts.audio	Object	否	无	语音合成音频信息
params.tts.audio.sampleRate	Integer	否	无	语音合成音频采样率，不同的发音人支持不一样，详情请咨询技术支持，默认16000
params.tts.volume	Integer	否	无	语音合成音量，取值0-100，默认50
params.tts.engineType	String	否	无	`官方文档未做说明`，可选值：`XTTS_MULTI` `XTTS_PUBLIC`
params.tts.language	Integer	否	无	`官方文档未做说明`
params.tts.pitch	Integer	否	无	语音合成语调，取值0-100，默认50
params.tts.speed	Integer	否	无	语音合成语速，取值0-100，默认50
params.tts.vcn	String	否	无	语音合成发音人，不传时将使用虚拟人对应的默认发音人
params.vc	Object	否	无	变声相关参数
params.vc.vc	Integer	否	无	是否开启变声，0-关闭，1-开启，默认关闭
params.vc.voiceName	String	否	无	开启变声后，需要传入变声发音人
params.subtitle	Object	否	无	字幕相关参数
params.subtitle.enable	Integer	否	无	是否字幕，0-关闭，1-开启，默认关闭
params.subtitle.fontColor	String	否	无	字幕颜色，默认#ffffff
params.scene	Object	否	无	场景参数
params.scene.sceneId	String	否	是	场景id，来自虚拟人交互平台配置系统
params.scene.sceneVersion	String	否	无	场景版本，来自虚拟人交互平台配置系统
params.dispatch	Object	否	无	交互模式
params.dispatch.audioMode	Integer	否	无	音频类型：0-非实时音频（如文件）1-实时音频，默认实时音频
params.dispatch.contentAnalysis	Integer	否	无	文本情感分析，0-关闭 1-开启，默认关闭
params.dispatch.interactiveMode	Integer	否	无	交互模式：0-追加 1-打断默认追加模式，当前仅在文本驱动场景生效
params.dispatch.targetType	String	否	无	`官方文档未做说明`
params.asr	Object	否	无	识别相关参数
params.asr.fullDuplex	Integer	否	无	是否为全双工交互，0-否 1-是，默认否，如需使用手机自带的AEC功能进行回声消除，需要将播放器音频播放类型设置为`AudioManager.STREAM_VOICE_CALL`，同时录音源设置为`MediaRecorder.AudioSource.VOICE_COMMUNICATION`，同时将录音器的`SessionId`设置到播放器中
params.air	Object	否	无	动作相关参数
params.air.air	Integer	否	无	是否开启自动动作，开启后会根据播报文本内容自动选择该虚拟人相应的动作，0-关闭 1-开启，默认关闭
params.air.addNonSemantic	Integer	否	无	是否在间隔过长的动作间插入无指向动作，0-关闭 1-开启
success	Function	否	无	执行成功的函数
fail	Function	否	无	执行失败的函数
complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

回调

示例

json

{
  "data": {
    "type": "onCreate"
  },
  "message": "",
  "code": 0
}

回调说明：

参数名	参数类型	参数描述
message	String	消息提示
data	Object	数据对象
data.type	String	操作类型：具体类型如下： `onCreate`：接口调用成功 `onResult`：监听结果 `onEvent`：监听事件 `onError`：错误事件
data.dataType	String	数据类型，具体可参考官方文档，`onResult`类型中返回
data.extra	String	数据附加信息
data.eventType	String	事件类型，`onEvent`类型中返回
data.errorCode	String	错误码，`onError`类型中返回
data.errorDesc	String	错误描述，`onError`类型中返回
code	Integer	返回类型，0.成功，其他：失败

设置虚拟人参数 ​

方法名 ​

用法 ​

回调 ​

设置虚拟人参数

方法名

用法

回调