更新视频制作剧本

project_id

是

String

项目ID，获取方法请参考获取项目ID。

script_id

是

String

剧本ID。

X-Auth-Token

否

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。

X-App-UserId

否

String

第三方用户ID。不允许输入中文。

script_name

否

String

参数解释：

剧本名称。

约束限制：

不涉及。

取值范围：

只能使用中英文字符，字符长度1-256位。

默认取值：

不涉及。

script_description

否

String

参数解释：

剧本描述。

约束限制：

不涉及。

取值范围：

字符长度0-1024位。

默认取值：

不涉及。

view_mode

否

String

参数解释：

横竖屏类型。

约束限制：

不涉及。

取值范围：

• LANDSCAPE：横屏。

• VERTICAL：竖屏。

默认取值：

LANDSCAPE

model_asset_id

否

String

参数解释：

数字人模型资产ID。

约束限制：

不涉及

取值范围：

字符长度0-64位。

默认取值：

不涉及

model_asset_type

否

String

参数解释：

数字人模型类型。

约束限制：

不涉及

取值范围：

• HUMAN_MODEL_2D：分身数字人

• HUMAN_MODEL_3D：3D数字人

默认取值：

不涉及

voice_config

否

VoiceConfig object

语音配置参数。

video_config

否

VideoConfig object

视频输出配置。

scene_asset_id

否

String

参数解释：

场景资产ID。

约束限制：

分身数字人视频制作不需要填写该参数。

取值范围：

字符长度0-64位

默认取值：

不涉及

priv_data

否

String

参数解释：

私有数据，用户填写，原样带回。

约束限制：

不涉及

取值范围：

字符长度0-8192位

默认取值：

不涉及

background_music_config

否

BackgroundMusicConfig object

背景音乐配置。

说明：

仅分身数字人视频制作设置背景音乐；3D数字人视频制作不支持设置背景音乐。

review_config

否

ReviewConfig object

内容审核配置

shoot_scripts

否

Array of ShootScriptItem objects

拍摄脚本列表。

voice_asset_id

是

String

参数解释：

音色资产ID，可以从资产库中查询。

音色ID的查询操作，详见查询预置音色ID。

约束限制：

不涉及。

取值范围：

字符长度1-256位。

默认取值：

不涉及。

speed

否

Integer

参数解释：

语速。50表示0.5倍语速，100表示正常语速，200表示2倍语速。

当取值为“100”时，表示一个成年人的正常语速，约为250字/分钟。

约束限制：

不涉及。

取值范围：

50-200

默认取值：

100

pitch

否

Integer

参数解释：

音高。

约束限制：

不涉及。

取值范围：

50-200

默认取值：

100

volume

否

Integer

参数解释：

音量。

约束限制：

不涉及。

取值范围：

90-240

默认取值：

140

clip_mode

否

String

参数解释：

输出视频的剪辑方式。

约束限制：

不涉及。

取值范围：

• RESIZE：视频缩放。

• CROP：视频裁剪。

默认取值：

RESIZE

codec

是

String

参数解释：

视频编码格式及视频文件格式。

约束限制：

仅分身数字人视频制作支持VP8编码。

取值范围：

• H264：h264编码，输出mp4文件。

• VP8：vp8编码，输出webm文件。

默认取值：

不涉及

bitrate

是

Integer

参数解释：

输出平均码率。单位：kbps。

约束限制：

• 分身数字人视频制作采用质量优先，可能会超过设置的码率。

• 分身数字人直播码率范围[1000, 8000]。

默认取值：

不涉及

取值范围：

40-30000

width

是

Integer

参数解释：

视频宽度。单位：像素。

约束限制：

• clip_mode=RESIZE时，当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率。4K分辨率视频需要分身数字人模型支持4K的情况下才能使用。

• clip_mode=CROP，裁剪后视频，（dx,dy）为原点，保留视频像宽度为width。

• 分身数字人直播目前只支持1080x1920、1920x1080。

默认取值：

不涉及

取值范围：

0-3840

height

是

Integer

参数解释：

视频高度。

单位：像素。

约束限制：

• clip_mode=RESIZE时，当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率分辨率。

• clip_mode=CROP，裁剪后视频，（dx,dy）为原点，保留视频像高度为height。

• 分身数字人直播目前只支持1080x1920、1920x1080。

默认取值：

不涉及

取值范围：

0-3840

frame_rate

否

String

参数解释：

帧率。单位：FPS。

约束限制：

分身数字人视频固定25FPS。

默认取值：

25

is_subtitle_enable

否

Boolean

参数解释：

输出的视频是否带字幕。

约束限制：

分身数字人直播暂时不支持字幕。

取值范围：

• true: 打开字幕

• false: 关闭字幕

默认取值：

false

subtitle_config

否

SubtitleConfig object

字幕配置。

dx

否

Integer

参数解释：

裁剪视频左上角像素点横坐标。

说明：

以模特分辨率为画布大小，比如1920*1080分辨率的模特，dx最小值是0，最大值是1920。

约束限制：

clip_mode= CROP时生效。

默认取值：

不涉及

取值范围：

-1920-3840

dy

否

Integer

参数解释：

裁剪视频左上角像素点纵坐标。

说明：

以模特分辨率为画布大小，比如1920*1080分辨率的模特，dy最小值是0，最大值是1080

约束限制：

clip_mode= CROP时生效。

默认取值：

不涉及

取值范围：

-1920-3840

is_enable_super_resolution

否

Boolean

参数解释：

视频是否开启超分。

约束限制：

仅分身数字人视频制作支持。

取值范围

• true: 开启

• false: 不开启

默认取值：

false

is_end_at_first_frame

否

Boolean

参数解释：

视频结束帧是否跟起始帧相同。需要多个数字人视频无缝拼接时设置成true。

约束限制：

仅分身数字人视频制作支持，当视频制作时插入动作标签后此设置将失效。

取值范围

• true: 开启

• false: 不开启

默认取值：

false

output_external_url

否

String

视频文件上传的外部URL。

说明：

• 需要先申请开通白名单后，才允许将视频上传到外部URL。

dx

否

Integer

参数解释：

字幕框左下角像素点坐标。

约束限制：

不涉及。

默认取值：

不涉及。

取值范围：

0-1920

dy

否

Integer

参数解释：

字幕框左下角像素点坐标。

约束限制：

不涉及。

默认取值：

不涉及。

取值范围：

0-1920

font_name

否

String

参数解释：

字体。当前支持的字体请参考服务支持的字体

约束限制：

不涉及。

取值范围：

字符长度0-64位

默认取值：

HarmonyOS_Sans_SC_Black

font_size

否

Integer

参数解释：

字体大小。接口的取值范围为0-120，实际业务使用的取值范围要求为24-120，请以业务实际使用要求为准。

约束限制：

不涉及。

取值范围：

0-120

默认取值：

54

h

否

Integer

参数解释：

字幕框高度。

约束限制：

参数h用于方便前端计算字幕框左上角坐标，后台不使用该参数。

取值范围：

0-1920

w

否

Integer

参数解释：

字幕框宽度。

约束限制：

• 字幕框宽度固定为屏幕宽度的80%

• 参数w用于方便前端计算字幕框左上角坐标，后台不使用该参数

取值范围：

0-1920

music_asset_id

否

String

参数解释：

音乐资产ID。

约束限制：

不涉及。

取值范围：

字符长度0-64位。

默认取值：

不涉及。

volume

否

Integer

参数解释：

音乐音量。如100，表示音量100%，50表示音量50%。

约束限制：

不涉及。

取值范围：

0-100

默认取值：

100

no_need_review

否

Boolean

免审核。 目前仅白名单用户可使用此参数，非白名单用户跟随系统策略审核。

sequence_no

否

Integer

参数解释：

剧本序号。

约束限制：

同一个剧本序号不重复。

默认取值：

不涉及。

取值范围：

0-2147483647

shoot_script

是

ShootScript object

表演脚本。

subtitle_file_info

否

SubtitleFiles object

字幕文件信息。

script_type

否

String

参数解释：

脚本类型，即视频制作的驱动方式

约束限制：

不涉及

取值范围

• TEXT: 文本驱动，即通过TTS合成语音

• AUDIO: 语音驱动

默认取值：

TEXT

text_config

否

TextConfig object

讲解词配置。

audio_drive_action_config

否

Array of AudioDriveActionConfig objects

语音驱动时的动作配置。

audio_drive_file_external_url

否

String

语音驱动音频文件外部下载URL。

说明：

• 需要先申请开通白名单后，才允许通过外部URL的音频文件来驱动分身数字人视频。

background_config

否

Array of BackgroundConfigInfo objects

背景配置。

layer_config

否

Array of LayerConfig objects

图层配置。

audio_config

否

AudioInfo object

音频文件信息。

text

是

String

参数解释：

台词脚本。支持两种模式，纯文本模式和标签模式。

• 纯文本模式：使用方法，如“大家好，我是人工智大家，是个虚拟主播”。

• 标签模式：SSML标签的详细定义请参考文本驱动SSML定义。

约束限制：

不含SSML标签字符数最长10000个字符。

取值范围：

字符长度0-131072位。

默认取值：

不涉及。

action_tag

是

String

动作标签

action_name

否

String

动作名称

action_start_time

是

Float

动作开始时间

取值范围：

0-2592000

background_type

是

String

参数解释：

背景类型。

约束限制：

不涉及。

取值范围：

• IMAGE：图片背景，指定图片用作分身数字人背景。

• COLOR：纯色背景，指定颜色RGB值作为分身数字人背景。

默认取值：

不涉及

background_config

否

String

参数解释：

背景文件的URL。

约束限制：

• 仅直播支持外部URL，其他业务通过资产库查询获取，不支持外部URL。

• background_type=IMAGE时需要填写。

取值范围：

字符长度1-2048位

默认取值：

不涉及。

background_color_config

否

String

参数解释：

纯色背景的RGB颜色值。

约束限制：

background_type=COLOR时需要填写。

取值范围：

字符长度0-16位

默认取值：

#FFFFFF

background_asset_id

否

String

参数解释：

背景资产ID。

说明：

背景是背景图片时，填图片资产ID。

约束限制：

不涉及

取值范围：

字符长度0-64位

默认取值：

不涉及

layer_type

是

String

参数解释：

图层类型。

约束限制：

不涉及。

取值范围：

• HUMAN: 人物图层

• IMAGE： 素材图片图层

• VIDEO： 素材视频图层

• TEXT: 素材文字图层

默认取值：

不涉及

asset_id

否

String

参数解释：

图层所需资产的资产id，外部资产信息无需填写。

约束限制：

不涉及。

取值范围：

字符长度0-64位

默认取值：

不涉及

group_id

否

String

参数解释：

多场景素材编组。同一group_id的素材，在应用全局时共享位置信息。

约束限制：

不涉及。

取值范围：

字符长度0-64位

默认取值：

不涉及

position

否

LayerPositionConfig object

图层位置配置。

size

否

LayerSizeConfig object

图层大小配置。

image_config

否

ImageLayerConfig object

素材图片图层配置。

video_config

否

VideoLayerConfig object

素材视频图层配置。

text_config

否

TextLayerConfig object

素材文字图层配置。

dx

是

Integer

参数解释：

图层左上角像素点的X轴位置值（画布左上角坐标是0x0）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

-1920-3840

默认取值：

0

dy

是

Integer

参数解释：

图层图片左上角像素点的Y轴位置值（画布左上角坐标是0x0）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

-1920-3840

默认取值：

0

layer_index

是

Integer

参数解释：

图片、视频、人物图的层顺序。

说明：

图层顺序为从1开始的整数，底层图层顺序是1，往上依次增加。

约束限制：

如果出现重复则重复图层叠加关系随机。

取值范围：

1-100

默认取值：

100

width

否

Integer

参数解释：

图层图片宽度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。

取值范围：

1-7680

height

否

Integer

参数解释：

图层图片高度像素值（相对画布大小）。

横屏（16:9）画布像素为1920x1080；竖屏（9:16）画布像素为1080x1920。

约束限制：

该值为相对于画布的像素值，仅表示布局位置关系，与输出画面分辨率无关。|

取值范围：

1-7680

image_url

否

String

参数解释：

图片文件的URL。

约束限制：

• 仅直播支持外部URL，其他业务通过资产库查询获取，不支持外部URL。

  取值范围：

  字符长度1-2048位。

  默认取值：

  不涉及

video_url

否

String

参数解释：

视频文件的URL。

约束限制：

• 仅直播支持外部URL，其他业务通过资产库查询获取，不支持外部URL。

  取值范围：

  字符长度1-2048位。

  默认取值：

  不涉及。

video_cover_url

否

String

参数解释：

视频封面文件的URL。

约束限制：

• 仅直播支持外部URL，其他业务通过资产库查询获取，不支持外部URL。

  取值范围：

  字符长度1-2048位。

  默认取值：

  不涉及。

loop_count

否

Integer

参数解释：

循环播放视频次数。

特殊取值：

• 0：表示不播放

• -1：表示持续循环播放

约束限制：

不涉及。

取值范围：

-1-100

默认取值：

-1

text_context

否

String

参数解释：

文字图层的文本，内容需做Base64编码。

示例：若想添加文字水印“测试文字水印”，那么text_context的值为：5rWL6K+V5paH5a2X5rC05Y2w

约束限制：

不涉及。

取值范围：

字符长度0-1024位。

默认取值：

不涉及。

font_name

否

String

字体。当前支持的字体请参考服务支持的字体

约束限制：

不涉及。

取值范围：

字符长度0-64位

默认取值：

HarmonyOS_Sans_SC_Black

font_size

否

Integer

参数解释：

字体大小（像素）。接口的取值范围为0-120，实际业务使用的取值范围要求为4-120，请以业务实际使用要求为准。

约束限制：

不涉及。

取值范围：

0-120

默认取值：

16

font_color

否

String

参数解释：

字体颜色。RGB颜色值。

约束限制：

不涉及。

取值范围：

字符长度0-16位

默认取值：

#FFFFFF

audio_id

否

Integer

参数解释：

音频id。

说明：

• 获取方式：剧本为音频驱动时，查询剧本详情或者更新剧本会返回audio_id

  约束限制：

  不涉及

  取值范围：

  0-10000

  默认取值：

  不涉及

取值范围：

0-10000

text_subtitle_file

否

SubtitleFileInfo object

audio_subtitle_file

否

SubtitleFileInfo object

subtitle_file_download_url

否

String

字幕文件下载链接。

subtitle_file_upload_url

否

String

字幕文件上传链接。

subtitle_file_state

否

String

字幕文件生成状态。

• GENERATING：字幕文件生成中。

• GENERATE_SUCCEED：字幕文件生成成功。

• GENERATE_FAILED：字幕文件生成失败。

job_id

否

String

字幕文件生成任务ID。

X-Request-Id

String

请求ID。

script_id

String

剧本ID

audio_files

ShootScriptAudioFiles object

用于语音驱动的音频文件上传URL列表。

audio_file_url

Array of ShootScriptAudioFileItem objects

用于语音驱动的音频文件上传URL。

sequence_no

Integer

剧本序号。

取值范围：

0-2147483647

audio_file_upload_url

String

语音驱动音频文件上传URL。创建和更新脚本时返回。单个文件最大100M。支持上传MP3/WAV/M4A文件。

audio_file_download_url

String

语音驱动音频文件下载URL。查询脚本详情时返回。

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

error_code

String

错误码。

error_msg

String

错误描述。

200

成功。

400

请求传参异常，包含错误码及对应描述。

401

未鉴权或鉴权失败。

500

内部服务错误。