创建视频制作剧本
功能介绍
该接口用于创建视频制作剧本。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/digital-human-video-scripts
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目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 |
model_asset_id |
否 |
String |
参数解释: 数字人模型资产ID。 约束限制: 不涉及 取值范围: 字符长度0-64位。 默认取值: 不涉及 |
model_asset_type |
否 |
String |
参数解释: 数字人模型类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
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 |
内容审核配置 |
audio_files |
否 |
ShootScriptAudioFiles object |
用于语音驱动的音频文件上传URL列表。 |
action_config |
否 |
ActionConfig 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 |
codec |
否 |
String |
参数解释: 视频编码格式及视频文件格式。 约束限制: 仅分身数字人视频制作支持VP8和QTRLE编码。QTRLE编码时文本驱动字符数限制小于1500字,音频驱动音频长度小于5分钟。 QTRLE编码需要先申请开通白名单后才能使用 取值范围:
默认取值: 不涉及 |
bitrate |
是 |
Integer |
参数解释: 输出平均码率。单位:kbps。 约束限制:
默认取值: 不涉及 取值范围: 40-30000 |
width |
是 |
Integer |
参数解释: 视频宽度。单位:像素。 约束限制:
默认取值: 不涉及 取值范围: 0-3840 |
height |
是 |
Integer |
参数解释: 视频高度。 单位:像素。 约束限制:
默认取值: 不涉及 取值范围: 0-3840 |
frame_rate |
否 |
String |
参数解释: 帧率。单位:FPS。 约束限制: 分身数字人视频固定25FPS。 默认取值: 25 |
is_subtitle_enable |
否 |
Boolean |
参数解释: 输出的视频是否带字幕。 约束限制: 分身数字人直播暂时不支持字幕。 取值范围:
默认取值: 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 |
参数解释: 视频是否开启超分。 约束限制: 仅分身数字人视频制作支持。 取值范围
默认取值: false |
is_end_at_first_frame |
否 |
Boolean |
参数解释: 视频结束帧是否跟起始帧相同。需要多个数字人视频无缝拼接时设置成true。 约束限制: 仅分身数字人视频制作支持,当视频制作时插入动作标签后此设置将失效。 取值范围
默认取值: false |
output_external_url |
否 |
String |
视频文件上传的外部URL。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
dx |
否 |
Integer |
参数解释: 字幕框左下角像素点坐标。 约束限制: 不涉及。 默认取值: 不涉及。 取值范围: 0-1920 |
dy |
否 |
Integer |
参数解释: 字幕框左下角像素点坐标。 约束限制: 不涉及。 默认取值: 不涉及。 取值范围: 0-1920 |
h |
否 |
Integer |
参数解释: 字幕框高度。 约束限制: 参数h用于方便前端计算字幕框左上角坐标,后台不使用该参数。 取值范围: 0-1920 |
w |
否 |
Integer |
参数解释: 字幕框宽度。 约束限制:
取值范围: 0-1920 |
font_name |
否 |
String |
参数解释: 字体。当前支持的字体请参考服务支持的字体 约束限制: 不涉及。 取值范围: 字符长度0-64位 默认取值: HarmonyOS_Sans_SC_Black |
font_size |
否 |
Integer |
参数解释: 字体大小。接口的取值范围为0-120,实际业务使用的取值范围要求为24-120,请以业务实际使用要求为准。 约束限制: 不涉及。 取值范围: 0-120 默认取值: 54 |
font_color |
否 |
String |
参数解释: 字幕字体颜色的RGB颜色值。 约束限制: 无 取值范围: 字符长度0-7位,固定长度 默认取值: #FFFFFF |
stroke_color |
否 |
String |
参数解释: 字幕字体描边颜色的RGB颜色值。 约束限制: 无 取值范围: 字符长度0-7位,固定长度 |
stroke_thickness |
否 |
Float |
参数解释: 字幕字体描边粗细像素值。 约束限制: 无 取值范围: 0-50 取值范围: 0-50 |
opacity |
否 |
Float |
参数解释: 字幕字体不透明度,0表示完全透明,1表示完全不透明。默认1。 约束限制: 无 取值范围: 0-1 取值范围: 0-1 默认取值: 1 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
music_asset_id |
否 |
String |
参数解释: 音乐资产ID。 约束限制: 不涉及。 取值范围: 字符长度0-64位。 默认取值: 不涉及。 |
volume |
否 |
Integer |
参数解释: 音乐音量。如100,表示音量100%,50表示音量50%。 约束限制: 不涉及。 取值范围: 0-100 默认取值: 100 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。查询脚本详情时返回。 |
audio_id |
否 |
Integer |
audio id 取值范围: 0-10000 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action_interval |
否 |
Float |
算法自动插入无语义动作的时间间隔。这个参数填0或者不填默认是间隔4秒,设置成255时不自动插入无语义动作。 取值范围: 0-255 默认取值: 0 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sequence_no |
否 |
Integer |
参数解释: 剧本序号。 约束限制: 同一个剧本序号不重复。 默认取值: 不涉及。 取值范围: 0-2147483647 |
shoot_script |
是 |
ShootScript object |
表演脚本。 |
subtitle_file_info |
否 |
SubtitleFiles object |
字幕文件信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
script_type |
否 |
String |
参数解释: 脚本类型,即视频制作的驱动方式 约束限制: 不涉及 取值范围
默认取值: TEXT |
text_config |
否 |
TextConfig object |
讲解词配置。 |
audio_duration |
否 |
Float |
语音驱动时,音频时长,单位秒。
取值范围: 0-36000 |
audio_drive_action_config |
否 |
Array of AudioDriveActionConfig objects |
语音驱动时的动作配置。 |
audio_drive_file_external_url |
否 |
String |
语音驱动音频文件外部下载URL。
|
background_config |
否 |
Array of BackgroundConfigInfo objects |
背景配置。 |
layer_config |
否 |
Array of LayerConfig objects |
图层配置。 |
audio_config |
否 |
AudioInfo object |
音频文件信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
text |
是 |
String |
参数解释: 台词脚本。支持两种模式,纯文本模式和标签模式。
约束限制: 不含SSML标签字符数最长10000个字符。 取值范围: 字符长度0-131072位。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action_tag |
是 |
String |
动作标签 |
action_name |
否 |
String |
动作名称 |
action_start_time |
是 |
Float |
动作开始时间 取值范围: 0-2592000 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
background_type |
是 |
String |
参数解释: 背景类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
background_config |
否 |
String |
参数解释: 背景文件的URL。 约束限制:
取值范围: 字符长度1-2048位 默认取值: 不涉及。 |
background_color_config |
否 |
String |
参数解释: 纯色背景的RGB颜色值。 约束限制: background_type=COLOR时需要填写。 取值范围: 字符长度0-16位 默认取值: #FFFFFF |
background_asset_id |
否 |
String |
参数解释: 背景资产ID。
背景是背景图片时,填图片资产ID。
约束限制: 不涉及 取值范围: 字符长度0-64位 默认取值: 不涉及 |
background_image_config |
否 |
BackgroundImageConfig object |
背景图片大小及位置配置。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
dx |
是 |
Integer |
参数解释: 背景图片左上角像素点的X轴位置值(画布左上角坐标是0x0)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 需要保证背景图片要铺满画布。即dx <= 0,并且横屏时dx + width >=1920,竖屏时dx + width >=1080。 取值范围: -5760-0 默认取值: 0 |
dy |
是 |
Integer |
参数解释: 背景图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 需要保证背景图片要铺满画布。即dy <= 0,并且横屏时dy + height >=1080,竖屏时dy + height >=1920。 取值范围: -5760-0 默认取值: 0 |
width |
是 |
Integer |
参数解释: 背景图片宽度像素值(相对画布大小)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 需要保证背景图片要铺满画布。即width > 1080,并且横屏时dx + width >=1920,竖屏时dx + width >=1080。 取值范围: 1-7680 |
height |
是 |
Integer |
参数解释: 背景图片高度像素值(相对画布大小)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 需要保证背景图片要铺满画布。height> 1080,并且横屏时dy + height >=1080,竖屏时dy + height >=1920。 取值范围: 1-7680 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
layer_type |
是 |
String |
参数解释: 图层类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
asset_id |
否 |
String |
参数解释: 图层所需资产的资产id,外部资产信息无需填写。 约束限制: 不涉及。 取值范围: 字符长度0-64位 默认取值: 不涉及 |
group_id |
否 |
String |
参数解释: 多场景素材编组。同一group_id的素材,在应用全局时共享位置信息。 约束限制: 不涉及。 取值范围: 字符长度0-64位 默认取值: 不涉及 |
position |
否 |
LayerPositionConfig object |
图层位置配置。 |
size |
否 |
LayerSizeConfig object |
图层大小配置。 |
rotation |
否 |
LayerRotationConfig 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 |
参数解释: 图层图片左上角像素点的Y轴位置值图层图片宽度像素值(相对画布大小)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。 取值范围: 1-7680 |
height |
否 |
Integer |
参数解释: 图层图片高度像素值(相对画布大小)。 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 约束限制: 该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。| 取值范围: 1-7680 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
angle |
否 |
Integer |
参数解释: 旋转角度。 取值范围: 角度范围0-360度。 默认取值: 0度。 约束限制: 以素材中心点旋转。 取值范围: 0-360 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
image_url |
否 |
String |
参数解释: 图片文件的URL。 约束限制:
取值范围: 字符长度1-2048位。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
video_url |
否 |
String |
参数解释: 视频文件的URL。 约束限制:
取值范围: 字符长度1-2048位。 默认取值: 不涉及。 |
video_cover_url |
否 |
String |
参数解释: 视频封面文件的URL。 约束限制:
取值范围: 字符长度1-2048位。 默认取值: 不涉及。 |
loop_count |
否 |
Integer |
参数解释: 循环播放视频次数。 特殊取值:
约束限制: 不涉及。 取值范围: -1-100 默认取值: -1 |
video_sound |
否 |
Integer |
参数解释: 视频声音大小,0 - 100,表示开启视频声音原视频音量的百分比 特殊取值:
约束限制: 不涉及。 取值范围: 0-100 |
is_play_the_entire_video |
否 |
Boolean |
参数解释: 是否播放完整个视频,true表示播放完整个视频,false表示当场景文本/音频结束时,视频也同时不再播放。 特殊取值: 默认值为false 约束限制: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。
约束限制: 不涉及 默认取值: 不涉及 取值范围: 0-10000 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
text_subtitle_file |
否 |
SubtitleFileInfo object |
|
audio_subtitle_file |
否 |
SubtitleFileInfo object |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
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。查询脚本详情时返回。 |
audio_id |
Integer |
audio id 取值范围: 0-10000 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-video-scripts
{
"script_name" : "大自然的传说",
"script_description" : "课件",
"model_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a",
"scene_asset_id" : "7ad01cf66f6cc54e45a2021558b7fbb0",
"voice_config" : {
"voice_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a"
},
"video_config" : {
"codec" : "H264",
"bitrate" : 4000,
"frame_rate" : "25",
"width" : 1920,
"height" : 1080
},
"shoot_scripts" : [ {
"sequence_no" : 0,
"shoot_script" : {
"text_config" : {
"text" : "大家好,我是云笙"
},
"animation_config" : [ {
"animation" : "7affc1c9d10b9779957fce7d4aecbd35"
} ],
"background_config" : [ {
"background_type" : "IMAGE",
"background_config" : "https://{endpoint}/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241324&Signature=tD38peKsCkh%2FygE3IffeLbewuEw%3D"
} ]
}
} ]
}
响应示例
状态码:200
成功。
{
"script_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
}
状态码:400
请求传参异常,包含错误码及对应描述。
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
}
状态码:401
未鉴权或鉴权失败。
{
"error_code" : "MSS.00000001",
"error_msg" : "Unauthorized"
}
状态码:500
内部服务错误。
{
"error_code" : "MSS.00000004",
"error_msg" : "Internal Error"
}
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion;
import com.huaweicloud.sdk.metastudio.v1.*;
import com.huaweicloud.sdk.metastudio.v1.model.*;
import java.util.List;
import java.util.ArrayList;
public class CreateVideoScriptsSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
MetaStudioClient client = MetaStudioClient.newBuilder()
.withCredential(auth)
.withRegion(MetaStudioRegion.valueOf("<YOUR REGION>"))
.build();
CreateVideoScriptsRequest request = new CreateVideoScriptsRequest();
CreateVideoScriptsReq body = new CreateVideoScriptsReq();
VideoConfig videoConfigbody = new VideoConfig();
videoConfigbody.withCodec(VideoConfig.CodecEnum.fromValue("H264"))
.withBitrate(4000)
.withWidth(1920)
.withHeight(1080)
.withFrameRate(VideoConfig.FrameRateEnum.fromValue("25"));
VoiceConfig voiceConfigbody = new VoiceConfig();
voiceConfigbody.withVoiceAssetId("a5d295cdb345c11bd9f36bc22ced3a7a");
List<BackgroundConfigInfo> listShootScriptBackgroundConfig = new ArrayList<>();
listShootScriptBackgroundConfig.add(
new BackgroundConfigInfo()
.withBackgroundType(BackgroundConfigInfo.BackgroundTypeEnum.fromValue("IMAGE"))
.withBackgroundConfig("https://{endpoint}/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241324&Signature=tD38peKsCkh%2FygE3IffeLbewuEw%3D")
);
TextConfig textConfigShootScript = new TextConfig();
textConfigShootScript.withText("大家好,我是云笙");
ShootScript shootScriptShootScripts = new ShootScript();
shootScriptShootScripts.withTextConfig(textConfigShootScript)
.withBackgroundConfig(listShootScriptBackgroundConfig);
List<ShootScriptItem> listbodyShootScripts = new ArrayList<>();
listbodyShootScripts.add(
new ShootScriptItem()
.withSequenceNo(0)
.withShootScript(shootScriptShootScripts)
);
body.withScriptDescription("课件");
body.withVideoConfig(videoConfigbody);
body.withSceneAssetId("7ad01cf66f6cc54e45a2021558b7fbb0");
body.withScriptName("大自然的传说");
body.withVoiceConfig(voiceConfigbody);
body.withShootScripts(listbodyShootScripts);
body.withModelAssetId("a5d295cdb345c11bd9f36bc22ced3a7a");
request.withBody(body);
try {
CreateVideoScriptsResponse response = client.createVideoScripts(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkmetastudio.v1 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = MetaStudioClient.new_builder() \
.with_credentials(credentials) \
.with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateVideoScriptsRequest()
videoConfigbody = VideoConfig(
codec="H264",
bitrate=4000,
width=1920,
height=1080,
frame_rate="25"
)
voiceConfigbody = VoiceConfig(
voice_asset_id="a5d295cdb345c11bd9f36bc22ced3a7a"
)
listBackgroundConfigShootScript = [
BackgroundConfigInfo(
background_type="IMAGE",
background_config="https://{endpoint}/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241324&Signature=tD38peKsCkh%2FygE3IffeLbewuEw%3D"
)
]
textConfigShootScript = TextConfig(
text="大家好,我是云笙"
)
shootScriptShootScripts = ShootScript(
text_config=textConfigShootScript,
background_config=listBackgroundConfigShootScript
)
listShootScriptsbody = [
ShootScriptItem(
sequence_no=0,
shoot_script=shootScriptShootScripts
)
]
request.body = CreateVideoScriptsReq(
script_description="课件",
video_config=videoConfigbody,
scene_asset_id="7ad01cf66f6cc54e45a2021558b7fbb0",
script_name="大自然的传说",
voice_config=voiceConfigbody,
shoot_scripts=listShootScriptsbody,
model_asset_id="a5d295cdb345c11bd9f36bc22ced3a7a"
)
response = client.create_video_scripts(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := metastudio.NewMetaStudioClient(
metastudio.MetaStudioClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateVideoScriptsRequest{}
codecVideoConfig:= model.GetVideoConfigCodecEnum().H264
frameRateVideoConfig:= model.GetVideoConfigFrameRateEnum().E_25
videoConfigbody := &model.VideoConfig{
Codec: &codecVideoConfig,
Bitrate: int32(4000),
Width: int32(1920),
Height: int32(1080),
FrameRate: &frameRateVideoConfig,
}
voiceConfigbody := &model.VoiceConfig{
VoiceAssetId: "a5d295cdb345c11bd9f36bc22ced3a7a",
}
backgroundConfigBackgroundConfig:= "https://{endpoint}/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241324&Signature=tD38peKsCkh%2FygE3IffeLbewuEw%3D"
var listBackgroundConfigShootScript = []model.BackgroundConfigInfo{
{
BackgroundType: model.GetBackgroundConfigInfoBackgroundTypeEnum().IMAGE,
BackgroundConfig: &backgroundConfigBackgroundConfig,
},
}
textConfigShootScript := &model.TextConfig{
Text: "大家好,我是云笙",
}
shootScriptShootScripts := &model.ShootScript{
TextConfig: textConfigShootScript,
BackgroundConfig: &listBackgroundConfigShootScript,
}
sequenceNoShootScripts:= int32(0)
var listShootScriptsbody = []model.ShootScriptItem{
{
SequenceNo: &sequenceNoShootScripts,
ShootScript: shootScriptShootScripts,
},
}
scriptDescriptionCreateVideoScriptsReq:= "课件"
sceneAssetIdCreateVideoScriptsReq:= "7ad01cf66f6cc54e45a2021558b7fbb0"
scriptNameCreateVideoScriptsReq:= "大自然的传说"
modelAssetIdCreateVideoScriptsReq:= "a5d295cdb345c11bd9f36bc22ced3a7a"
request.Body = &model.CreateVideoScriptsReq{
ScriptDescription: &scriptDescriptionCreateVideoScriptsReq,
VideoConfig: videoConfigbody,
SceneAssetId: &sceneAssetIdCreateVideoScriptsReq,
ScriptName: &scriptNameCreateVideoScriptsReq,
VoiceConfig: voiceConfigbody,
ShootScripts: &listShootScriptsbody,
ModelAssetId: &modelAssetIdCreateVideoScriptsReq,
}
response, err := client.CreateVideoScripts(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion;
import com.huaweicloud.sdk.metastudio.v1.*;
import com.huaweicloud.sdk.metastudio.v1.model.*;
import java.util.List;
import java.util.ArrayList;
public class CreateVideoScriptsSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
MetaStudioClient client = MetaStudioClient.newBuilder()
.withCredential(auth)
.withRegion(MetaStudioRegion.valueOf("<YOUR REGION>"))
.build();
CreateVideoScriptsRequest request = new CreateVideoScriptsRequest();
CreateVideoScriptsReq body = new CreateVideoScriptsReq();
VideoConfig videoConfigbody = new VideoConfig();
videoConfigbody.withCodec(VideoConfig.CodecEnum.fromValue("H264"))
.withBitrate(4000)
.withWidth(1920)
.withHeight(1080)
.withFrameRate(VideoConfig.FrameRateEnum.fromValue("25"));
VoiceConfig voiceConfigbody = new VoiceConfig();
voiceConfigbody.withVoiceAssetId("a5d295cdb345c11bd9f36bc22ced3a7a");
List<BackgroundConfigInfo> listShootScriptBackgroundConfig = new ArrayList<>();
listShootScriptBackgroundConfig.add(
new BackgroundConfigInfo()
.withBackgroundType(BackgroundConfigInfo.BackgroundTypeEnum.fromValue("IMAGE"))
.withBackgroundConfig("https://{endpoint}/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241324&Signature=tD38peKsCkh%2FygE3IffeLbewuEw%3D")
);
TextConfig textConfigShootScript = new TextConfig();
textConfigShootScript.withText("大家好,我是云笙");
ShootScript shootScriptShootScripts = new ShootScript();
shootScriptShootScripts.withTextConfig(textConfigShootScript)
.withBackgroundConfig(listShootScriptBackgroundConfig);
List<ShootScriptItem> listbodyShootScripts = new ArrayList<>();
listbodyShootScripts.add(
new ShootScriptItem()
.withSequenceNo(0)
.withShootScript(shootScriptShootScripts)
);
body.withScriptDescription("课件");
body.withVideoConfig(videoConfigbody);
body.withSceneAssetId("7ad01cf66f6cc54e45a2021558b7fbb0");
body.withScriptName("大自然的传说");
body.withVoiceConfig(voiceConfigbody);
body.withShootScripts(listbodyShootScripts);
body.withModelAssetId("a5d295cdb345c11bd9f36bc22ced3a7a");
request.withBody(body);
try {
CreateVideoScriptsResponse response = client.createVideoScripts(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkmetastudio.v1 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = MetaStudioClient.new_builder() \
.with_credentials(credentials) \
.with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateVideoScriptsRequest()
videoConfigbody = VideoConfig(
codec="H264",
bitrate=4000,
width=1920,
height=1080,
frame_rate="25"
)
voiceConfigbody = VoiceConfig(
voice_asset_id="a5d295cdb345c11bd9f36bc22ced3a7a"
)
listBackgroundConfigShootScript = [
BackgroundConfigInfo(
background_type="IMAGE",
background_config="https://{endpoint}/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241324&Signature=tD38peKsCkh%2FygE3IffeLbewuEw%3D"
)
]
textConfigShootScript = TextConfig(
text="大家好,我是云笙"
)
shootScriptShootScripts = ShootScript(
text_config=textConfigShootScript,
background_config=listBackgroundConfigShootScript
)
listShootScriptsbody = [
ShootScriptItem(
sequence_no=0,
shoot_script=shootScriptShootScripts
)
]
request.body = CreateVideoScriptsReq(
script_description="课件",
video_config=videoConfigbody,
scene_asset_id="7ad01cf66f6cc54e45a2021558b7fbb0",
script_name="大自然的传说",
voice_config=voiceConfigbody,
shoot_scripts=listShootScriptsbody,
model_asset_id="a5d295cdb345c11bd9f36bc22ced3a7a"
)
response = client.create_video_scripts(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := metastudio.NewMetaStudioClient(
metastudio.MetaStudioClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateVideoScriptsRequest{}
codecVideoConfig:= model.GetVideoConfigCodecEnum().H264
frameRateVideoConfig:= model.GetVideoConfigFrameRateEnum().E_25
videoConfigbody := &model.VideoConfig{
Codec: &codecVideoConfig,
Bitrate: int32(4000),
Width: int32(1920),
Height: int32(1080),
FrameRate: &frameRateVideoConfig,
}
voiceConfigbody := &model.VoiceConfig{
VoiceAssetId: "a5d295cdb345c11bd9f36bc22ced3a7a",
}
backgroundConfigBackgroundConfig:= "https://{endpoint}/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671241324&Signature=tD38peKsCkh%2FygE3IffeLbewuEw%3D"
var listBackgroundConfigShootScript = []model.BackgroundConfigInfo{
{
BackgroundType: model.GetBackgroundConfigInfoBackgroundTypeEnum().IMAGE,
BackgroundConfig: &backgroundConfigBackgroundConfig,
},
}
textConfigShootScript := &model.TextConfig{
Text: "大家好,我是云笙",
}
shootScriptShootScripts := &model.ShootScript{
TextConfig: textConfigShootScript,
BackgroundConfig: &listBackgroundConfigShootScript,
}
sequenceNoShootScripts:= int32(0)
var listShootScriptsbody = []model.ShootScriptItem{
{
SequenceNo: &sequenceNoShootScripts,
ShootScript: shootScriptShootScripts,
},
}
scriptDescriptionCreateVideoScriptsReq:= "课件"
sceneAssetIdCreateVideoScriptsReq:= "7ad01cf66f6cc54e45a2021558b7fbb0"
scriptNameCreateVideoScriptsReq:= "大自然的传说"
modelAssetIdCreateVideoScriptsReq:= "a5d295cdb345c11bd9f36bc22ced3a7a"
request.Body = &model.CreateVideoScriptsReq{
ScriptDescription: &scriptDescriptionCreateVideoScriptsReq,
VideoConfig: videoConfigbody,
SceneAssetId: &sceneAssetIdCreateVideoScriptsReq,
ScriptName: &scriptNameCreateVideoScriptsReq,
VoiceConfig: voiceConfigbody,
ShootScripts: &listShootScriptsbody,
ModelAssetId: &modelAssetIdCreateVideoScriptsReq,
}
response, err := client.CreateVideoScripts(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功。 |
400 |
请求传参异常,包含错误码及对应描述。 |
401 |
未鉴权或鉴权失败。 |
500 |
内部服务错误。 |
错误码
请参见错误码。