# 公共素材获取

视频合成服务为您提供输入选择2D数字人形象模型，添加文本或音频合成为2D虚拟数字人mp4的视频。平台针对入驻平台的用户提供公共素材内容，助力用户快速生成内容，公共素材包括若干数字人人物形象模型，TTS个人音色模型以及视频模板。

# 素材介绍

  • 数字人人物形象模型
    • 视频合成阶段需要使用的2D数字人形象，平台提供若干个公共的2D数字人形象模型，供用户获取后选择。具体可联系运营开通账号后查看。
  • TTS个人音色模型
    • 个人音色模型包含发音人音色，以及声音的语速、音调、音量等信息，平台提供多个默认的TTS个人音色模型，供用户选择，将使用指定的音色朗读对应的文本内容，最终将此音频用于视频合成。
  • 视频模板
    • 视频模板即为最终合成的视频中除了人物和声音之外，人物所处的背景，人物身前展示的前景内容，视频中出现的文字位置、字体、字号等信息都统一记录在视频模板中。

# API说明

用户调用平台全部API服务，皆需要访问服务接入点：aigc.softsugar.com，并在请求头中加上token信息。

# 获取全量公共人物形象模型

# 接口描述

分页返回全量公共人物形象模型列表。

# 请求地址

POST /api/2dvh/v1/material/appearance/list

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
pageNo Integer False 当前页码 (默认 1)
pageSize Integer False 每页条数 (默认 10)
sortName String False 排序字段名
sortValue String False 排序顺序: asc, desc

# 请求样例

{
  "pageNo": 1,
  "pageSize": 10
}

# 响应元素

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Object False data object ，异常时通常为空
- pagination Pagination True 分页信息(参照共通说明)
- result Array False 公共人物形象模型（参照下面说明）

公共人物形象模型

字段 类型 必填 描述
id Long True 模型id
materialName String True 素材名称
thumbnailUrl String True 缩略图 Url
pkgUrl String True 模型素材包 url
extendParam String False 人物形象参数配置，Json格式（参照下面说明）
desc String False 备注
createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

extendParam中人物形象模型参数信息

字段 类型 必填 描述
faceFeatureId String True faceFeatureId，用于短视频合成和直播等场景中的ffid字段
gender Integer False 性别，0为未知，1为女性，2为男性
avatarType Integer False 数字人类型，1为普通数字人，2为快速数字人，3为动静数字人，4为动作编辑数字人

# 响应样例

{
    "code": 0,
    "message": "success",
    "data": {
        "pagination": {
                "pageNo": 1,
                "numberPages": 1,
                "numberRecords": 10,
                "pageSize": 10,
                "startIndex": 0
            },
        "result": [{
            "id": 2221738,
            "materialName": "公共人物形象1",
            "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
            "pkgUrl": "https://oss/folderPath/test_2023011312230521517.zip",
            "extendParam": "{\"faceFeatureId\": \"123\"}",
            "desc": null,
            "createTime": "2023-01-13 12:31:13",
            "updateTime": "2023-01-13 12:31:13"
        }, {
            "id": 1112226,
            "materialName": "公共人物形象2",
            "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
            "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.zip",
            "extendParam": "{\"gender\": 2, \"avatarType\": 1,\"faceFeatureId\": \"123\"}",
            "desc": null,
            "createTime": "2022-09-06 19:10:09",
            "updateTime": "2022-10-28 16:59:18"
        }]
    }
}

# 获取指定公共人物形象模型

# 接口描述

根据输入参数返回指定公共人物形象模型列表。

# 请求地址

POST /api/2dvh/v1/material/appearance

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
ids Long[] True 人物形象模型id数组

# 请求样例

{
  "ids": [13,16]
}

# 响应参数

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Array False 异常时通常为空
- id Long True 模型id
- materialName String True 素材名称
- thumbnailUrl String True 缩略图 Url
- pkgUrl String True 模型素材包 url
- extendParam String False 人物形象参数配置，Json格式（参照下面说明）
- desc String False 备注
- createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
- updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

extendParam中人物形象模型参数信息

字段 类型 必填 描述
faceFeatureId String True Face Feature Id
gender Integer False 性别，0为未知，1为女性，2为男性
avatarType Integer False 数字人类型，1为普通数字人，2为快速数字人，3为动静数字人，4为动作编辑数字人

# 响应样例

{
  "code": 0,
  "message": "success",
  "data": [{
    "id": 13,
    "materialName": "公共人物形象1",
    "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
    "pkgUrl": "https://oss/folderPath/test_2023011312230521517.zip",
    "extendParam": "{\"faceFeatureId\": \"123\"}",
    "desc": null,
    "createTime": "2023-01-13 12:31:13",
    "updateTime": "2023-01-13 12:31:13"
  }, {
    "id": 16,
    "materialName": "公共人物形象2",
    "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
    "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.zip",
    "extendParam": "{\"gender\": 2, \"avatarType\": 1,\"faceFeatureId\": \"123\"}",
    "desc": null,
    "createTime": "2022-09-06 19:10:09",
    "updateTime": "2022-10-28 16:59:18"
  }]
}

# 获取全量公共TTS个人音色模型-Qid

# 接口描述

分页返回全量公共TTS个人音色模型-Qid列表。

# 请求地址

POST /api/2dvh/v3/material/tts/list

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
pageNo int False 当前页码 (默认 1)
pageSize int False 每页条数 (默认 10)
sortName String False 排序字段名
sortValue String False 排序顺序: asc, desc

# 请求样例

{
  "pageNo": 1,
  "pageSize": 10
}

# 响应元素

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Object False data object ，异常时通常为空
- pagination Pagination True 分页信息(参照共通说明)
- result Array False 公共TTS个人音色模型（参照下面说明）

公共TTS个人音色模型

字段 类型 必填 描述
id Long True 模型id
extendParam String True ttsConfig的Json串，记录tts参数信息（参照下面说明）
materialName String True 素材名称
thumbnailUrl String True 缩略图 Url
desc String False 备注
createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

extendParam中tts参数信息

字段 类型 必填 描述
qid String True 音色id
voiceName String True 音色名称
languages Array True 语言
speedRatio Integer True 语速
pitchOffset Integer True 语调
volume Integer True 音量
sampleUrl String False 试听url
gender Integer False 性别，0为未知，1为女性，2为男性

# 响应样例

{
  "code": 0,
  "message": "success",
  "data": {
    "pagination": {
      "pageNo": 1,
      "numberPages": 1,
      "numberRecords": 10,
      "pageSize": 10,
      "startIndex": 0
    },
    "result": [
      {
        "id": 2221738,
        "extendParam": {
          "qid": "ttsId1",
          "languages": ["zh-CN"],
          "speedRatio": 4,
          "pitchOffset": 1,
          "volume": 100
        },
        "materialName": "公共TTS个人音色模型1",
        "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
        "desc": null,
        "createTime": "2023-01-13 12:31:13",
        "updateTime": "2023-01-13 12:31:13"
      },
      {
        "id": 1112226,
        "extendParam": {
          "qid": "ttsId2",
          "languages": ["zh-CN"],
          "speedRatio": 4,
          "pitchOffset": 1,
          "gender": 1,
          "volume": 100
        },
        "materialName": "公共TTS个人音色模型2",
        "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
        "desc": null,
        "createTime": "2022-09-06 19:10:09",
        "updateTime": "2022-10-28 16:59:18"
      }
    ]
  }
}

# 获取指定公共TTS个人音色模型-Qid

# 接口描述

根据输入参数返回指定公共TTS个人音色模型-Qid。

# 请求地址

POST /api/2dvh/v3/material/tts

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
ids Long[] True 模型id数组

# 请求样例

{
  "ids": [13,16]
}

# 响应参数

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Array False 异常时通常为空
- id Long True 模型id
- extendParam String True ttsConfig的Json串，记录tts参数信息（参照下面说明）
- materialName String True 素材名称
- thumbnailUrl String True 缩略图 Url
- desc String False 备注
- createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
- updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

extendParam中tts参数信息

字段 类型 必填 描述
qid String True 音色id
voiceName String True 音色名称
languages Array True 语言
speedRatio Integer True 语速
pitchOffset Integer True 语调
volume Integer True 音量
sampleUrl String False 试听url
gender Integer False 性别，0为未知，1为女性，2为男性

# 响应样例

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 13,
      "extendParam": {
        "qid": "ttsId1",
        "languages": ["zh-CN"],
        "speedRatio": 4,
        "pitchOffset": 1,
        "volume": 100
      },
      "materialName": "公共角色TTS音色模型1",
      "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
      "desc": null,
      "createTime": "2023-01-13 12:31:13",
      "updateTime": "2023-01-13 12:31:13"
    },
    {
      "id": 16,
      "extendParam": {
        "qid": "ttsId2",
        "languages": ["zh-CN"],
        "speedRatio": 4,
        "pitchOffset": 1,
        "gender": 1,
        "volume": 100
      },
      "materialName": "公共TTS个人音色模型2",
      "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
      "desc": null,
      "createTime": "2022-09-06 19:10:09",
      "updateTime": "2022-10-28 16:59:18"
    }
  ]
}

# 获取全量公共TTS个人音色模型（旧）

# 接口描述

分页返回全量公共TTS个人音色模型列表。

# 请求地址

POST /api/2dvh/v1/material/tts/list

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
pageNo int False 当前页码 (默认 1)
pageSize int False 每页条数 (默认 10)
sortName String False 排序字段名
sortValue String False 排序顺序: asc, desc

# 请求样例

{
  "pageNo": 1,
  "pageSize": 10
}

# 响应元素

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Object False data object ，异常时通常为空
- pagination Pagination True 分页信息(参照共通说明)
- result Array False 公共TTS个人音色模型（参照下面说明）

公共TTS个人音色模型

字段 类型 必填 描述
id Long True 模型id
extendParam String True ttsConfig的Json串，记录tts参数信息（参照下面说明）
materialName String True 素材名称
thumbnailUrl String True 缩略图 Url
desc String False 备注
createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

extendParam中tts参数信息

字段 类型 必填 描述
vendorId Integer True vendorId
voiceId String True 音色id
voiceName String True 音色名称
language String True 语言
speedRatio Integer True 语速
pitchOffset Integer True 语调
volume Integer True 音量

# 响应样例

{
  "code": 0,
  "message": "success",
  "data": {
    "pagination": {
      "pageNo": 1,
      "numberPages": 1,
      "numberRecords": 10,
      "pageSize": 10,
      "startIndex": 0
    },
    "result": [
      {
        "id": 2221738,
        "extendParam": {
          "voiceId": "ttsId1",
          "speedRatio": 4,
          "pitchOffset": 1,
          "volume": 100
        },
        "materialName": "公共TTS个人音色模型1",
        "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
        "desc": null,
        "createTime": "2023-01-13 12:31:13",
        "updateTime": "2023-01-13 12:31:13"
      },
      {
        "id": 1112226,
        "extendParam": {
          "voiceId": "ttsId2",
          "speedRatio": 4,
          "pitchOffset": 1,
          "volume": 100
        },
        "materialName": "公共TTS个人音色模型2",
        "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
        "desc": null,
        "createTime": "2022-09-06 19:10:09",
        "updateTime": "2022-10-28 16:59:18"
      }
    ]
  }
}

# 获取指定公共TTS个人音色模型（旧）

# 接口描述

根据输入参数返回指定公共TTS个人音色模型。

# 请求地址

POST /api/2dvh/v1/material/tts

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
ids Long[] True 模型id数组

# 请求样例

{
  "ids": [13,16]
}

# 响应参数

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Array False 异常时通常为空
- id Long True 模型id
- extendParam String True ttsConfig的Json串，记录tts参数信息（参照下面说明）
- materialName String True 素材名称
- thumbnailUrl String True 缩略图 Url
- desc String False 备注
- createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
- updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

extendParam中tts参数信息

字段 类型 必填 描述
vendorId Integer True vendorId
voiceId String True 音色id
voiceName String True 音色名称
language String True 语言
speedRatio Integer True 语速
pitchOffset Integer True 语调
volume Integer True 音量

# 响应样例

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 13,
      "extendParam": {
        "voiceId": "ttsId1",
        "speedRatio": 4,
        "pitchOffset": 1,
        "volume": 100
      },
      "materialName": "公共角色TTS音色模型1",
      "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
      "desc": null,
      "createTime": "2023-01-13 12:31:13",
      "updateTime": "2023-01-13 12:31:13"
    },
    {
      "id": 16,
      "extendParam": {
        "voiceId": "ttsId2",
        "speedRatio": 4,
        "pitchOffset": 1,
        "volume": 100
      },
      "materialName": "公共TTS个人音色模型2",
      "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
      "desc": null,
      "createTime": "2022-09-06 19:10:09",
      "updateTime": "2022-10-28 16:59:18"
    }
  ]
}

# 获取全量公共视频模板

# 接口描述

分页返回全量公共视频模板列表。

# 请求地址

POST /api/2dvh/v1/material/video/template/list

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
pageNo Integer False 当前页码 (默认 1)
pageSize Integer False 每页条数 (默认 10)
sortName String False 排序字段名
sortValue String False 排序顺序: asc, desc

# 请求样例

{
  "pageNo": 1,
  "pageSize": 10
}

# 响应元素

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Object False data object ，异常时通常为空
- pagination Pagination True 分页信息(参照共通说明)
- result Array False 公共视频模板（参照下面说明）

公共视频模板

字段 类型 必填 描述
id Long True 模板id
materialName String True 模板名称
thumbnailUrl String True 缩略图 Url
pkgUrl String True 模板 url
extendUrl String True 示例视频 url
desc String False 备注
createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

# 响应样例

{
    "code": 0,
    "message": "success",
    "data": {
        "pagination": {
                "pageNo": 1,
                "numberPages": 1,
                "numberRecords": 10,
                "pageSize": 10,
                "startIndex": 0
            },
        "result": [{
            "id": 2221738,
            "materialName": "公共视频模板1",
            "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
            "pkgUrl": "https://oss/folderPath/demo_20230608150104747.json",
            "desc": null,
            "createTime": "2023-01-13 12:31:13",
            "updateTime": "2023-01-13 12:31:13"
        }, {
            "id": 1112226,
            "materialName": "公共视频模板2",
            "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
            "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.json",
            "desc": null,
            "createTime": "2022-09-06 19:10:09",
            "updateTime": "2022-10-28 16:59:18"
        }]
    }
}

# 获取指定公共视频模板

# 接口描述

根据输入参数返回指定公共视频模板。

# 请求地址

POST /api/2dvh/v1/material/video/template

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
ids Long[] True 视频模板id数组

# 请求样例

{
  "ids": [13,16]
}

# 响应参数

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Array False 异常时通常为空
- id Long True 模板id
- materialName String True 模板名称
- thumbnailUrl String True 缩略图 Url
- pkgUrl String True 模板 url
- extendUrl String True 示例视频 url
- desc String False 备注
- createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
- updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

# 响应样例

{
  "code": 0,
  "message": "success",
  "data": [{
    "id": 13,
    "materialName": "公共视频模板1",
    "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
    "pkgUrl": "https://oss/folderPath/test_2023011312230521517.json",
    "desc": null,
    "createTime": "2023-01-13 12:31:13",
    "updateTime": "2023-01-13 12:31:13"
  }, {
    "id": 16,
    "materialName": "公共视频模板2",
    "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
    "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.json",
    "desc": null,
    "createTime": "2022-09-06 19:10:09",
    "updateTime": "2022-10-28 16:59:18"
  }]
}

# 获取全量公共直播脚本

# 接口描述

分页返回全量公共直播脚本列表。

# 请求地址

POST /api/2dvh/v1/material/live/script/list

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
pageNo Integer False 当前页码 (默认 1)
pageSize Integer False 每页条数 (默认 10)
sortName String False 排序字段名
sortValue String False 排序顺序: asc, desc

# 请求样例

{
  "pageNo": 1,
  "pageSize": 10
}

# 响应元素

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Object False data object ，异常时通常为空
- pagination Pagination True 分页信息(参照共通说明)
- result Array False 公共直播脚本（参照下面说明）

公共视频模板

字段 类型 必填 描述
id Long True 模板id
materialName String True 脚本名称
thumbnailUrl String True 缩略图 Url
pkgUrl String True 脚本素材 url
extendUrl String True 暂无内容
desc String False 备注
createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

# 响应样例

{
    "code": 0,
    "message": "success",
    "data": {
        "pagination": {
                "pageNo": 1,
                "numberPages": 1,
                "numberRecords": 10,
                "pageSize": 10,
                "startIndex": 0
            },
        "result": [{
            "id": 2221738,
            "materialName": "公共直播脚本1",
            "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
            "pkgUrl": "https://oss/folderPath/test_2023011312230521517.json",
            "desc": null,
            "createTime": "2023-01-13 12:31:13",
            "updateTime": "2023-01-13 12:31:13"
        }, {
            "id": 1112226,
            "materialName": "公共直播脚本2",
            "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
            "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.json",
            "desc": null,
            "createTime": "2022-09-06 19:10:09",
            "updateTime": "2022-10-28 16:59:18"
        }]
    }
}

# 获取指定公共直播脚本

# 接口描述

根据输入参数返回指定公共直播脚本。

# 请求地址

POST /api/2dvh/v1/material/live/script

# 请求头

Content-Type: application/json

# 请求参数

字段 类型 必填 描述
ids Long[] True 直播脚本id数组

# 请求样例

{
  "ids": [13,16]
}

# 响应参数

字段 类型 必填 描述
code Number True 0 - 成功, 其他 - 异常
message String True 异常详细信息
data Array False 异常时通常为空
- id Long True 脚本id
- materialName String True 直播脚本名称
- thumbnailUrl String True 缩略图 Url
- pkgUrl String True 脚本素材包 url
- extendUrl String True 暂无
- desc String False 备注
- createTime String True 创建时间，yyyy-MM-dd HH:mm:ss
- updateTime String True 最后更新时间，yyyy-MM-dd HH:mm:ss

# 响应样例

{
  "code": 0,
  "message": "success",
  "data": [{
    "id": 13,
    "materialName": "公共直播脚本1",
    "thumbnailUrl": "https://oss/folderPath/202208051916341307.png",
    "pkgUrl": "https://oss/folderPath/test_2023011312230521517.json",
    "desc": null,
    "createTime": "2023-01-13 12:31:13",
    "updateTime": "2023-01-13 12:31:13"
  }, {
    "id": 16,
    "materialName": "公共直播脚本2",
    "thumbnailUrl": "https://oss/folderPath/2022102468165914964.png",
    "pkgUrl": "https://oss/folderPath/shenxiaoyi_2022090710331356954.json",
    "desc": null,
    "createTime": "2022-09-06 19:10:09",
    "updateTime": "2022-10-28 16:59:18"
  }]
}

以上即为平台针对视频合成的任务可以提供的公共素材相关内容。

最后更新: 2025/1/14 17:04:12

← 语音处理 →