视频制作接口-基础版

最近更新时间:2024-11-11 17:49:31

我的收藏

接口说明

使用 ssml 文本和数智人进行视频制作,通过音视频制作进度查询接口最终返回成品视频和字幕文件。
注意:
不支持定义主播位置等未剪辑高级参数,如需使用需要切换到 视频制作接口-进阶版 接口。

调用协议

HTTPS + JSON
POST     /v2/ivh/videomaker/broadcastservice/videomake
Header   Content-Type: application/json;charset=utf-8

请求参数

参数
类型
必须
说明
VirtualmanKey
string
定义播报的角色、服装、姿态、分辨率等信息,参数为枚举值。
InputSsml
string
播报的文本内容,支持ssml标签,支持的标签类型参照 数智人 SSML 标记语言规范,标签写法参照示例,内容不能换行,符号需转义。上限2万字(字数按 unicode 字符数计算)。DriverType为空、或 Text 时,该字段必填
说明:
当 Format 为 TransparentMov 时,上限为2千字。
SpeechParam
object
定义音频的详细参数
SpeechParam.Speed
float
语速(1.0为正常语速,范围[0.5-1.5],值为0.5时播报语速最慢,值为1.5时播报语速最快,DriverType为音频驱动类型时,语速控制不生效)
SpeechParam.TimbreKey
string
音色key,默认使用形象自有音色
SpeechParam.Volume
int
音量大小,范围[0,10],对应音量大小。默认为0,代表正常音量,值越大音量越高。
说明:
TimbreKey 在 male_1-20、female_1-23(即男声1-20、女声1-23)间的音色不支持音量调节。
SpeechParam.EmotionCategory
string
控制合成音频的情感,仅支持多情感音色使用,可选值参考个人资产管理 API 分页查询音色列表接口。
SpeechParam.EmotionIntensity
int
控制合成音频情感程度,取值范围为 [50,200],只有 EmotionCategory 不为空时生效。
SpeechParam.TimbreLanguage
string
音色语种,可选语种参考个人资产管理 API分页查询音色列表 接口,多语种音色在合成时必须选择对应语种。
VideoParam
object
定义合成视频的详细参数,
VideoParam.Format
string
视频输出格式,默认 TransparentWebm
TransparentWebm:带 Alpha 通道的 webm 格式视频 TransparentMov:带 Alpha 通道的 mov 格式视频 Mp4:绿幕 mp4 格式视频;非抠像形象为原始素材背景
CallbackUrl
string
当用户增加回调 url 时,将把视频制作结果以固定格式发送 post 请求到该 url 地址,固定格式见 附录二: 回调请求体格式,需注意:
1、限制 CallbackUrl 长度小于1000
2、只发送一次请求,无论是哪种问题导致的请求失败,都不会再进行发送。
DriverType
string
驱动类型,默认Text
1. Text:文本驱动,要求 InputSsml 字段必填
2. OriginalVoice:原声音频驱动,要求 InputAudioUrl 字段必填
3. ModulatedVoice:变声音频驱动,可通过 Speech.TimbreKey 指定音色,未填写时使用主播默认音色
InputAudioUrl
string
驱动数智人的音频 url,当 DriverType 为 OriginalVoice、ModulatedVoice 时,该字段必填。
音频格式要求:
1. 小样本形象时长不超过60分钟,不少于0.5秒;非小样本形象时长不超过10分钟,不少于0.5秒
2. 支持格式:wav、mp3、wma、m4a、aac
说明:
当 Format 为 TransparentMov 时,时长不超过6分钟,不少于0.5秒;
VideoStorageS3Url
string
可传入含鉴权 s3 协议存储 url,视频成品会上传至该 url
SubtitleStorageS3Url
string
可传入含鉴权 s3 协议存储 url,字幕成品会上传至该 url
ConcurrencyType
string
视频制作任务使用的并发类型,默认采用优先使用独享,其次使用共享的策略
1. Exclusive:独享并发,若无独享并发,任务提交失败
2. Shared: 共享并发

返回参数

参数
类型
必须
说明
TaskId
string
视频制作的任务 ID,携带 TaskId 访问音视频制作进度查询接口,可获得制作进度和制作结果

请求示例

{
"Header": {},
"Payload": {
"VirtualmanKey": "k3dda2d3b56f4ec89778f2e032c2e294",
"InputSsml": "你好,我是虚拟<phoneme alphabet=\\"py\\" ph=\\"fu4\\">主</phoneme>播",
"SpeechParam": {
"Speed": 1.0
},
"VideoParam": {
"Format": "TransparentWebm"
}
}
}

返回示例

{
"Header": {
"Code": 0,
"DialogID": "",
"Message": "",
"RequestID": "fde854eaa981c7f2f7285d1c7eca335b",
"SessionID": "gzb7dec22117297528294581119"
},
"Payload": {
"TaskId": "81883d47c6154edf8e276531f09227b6"
}
}