查询视频制作剧本详情
功能介绍
该接口用于查询视频制作剧本详情。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/digital-human-video-scripts/{script_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
[项目ID,获取方法请参考获取项目ID。](tag:hc,hk) |
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。不允许输入中文。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
script_name |
String |
剧本名称 |
script_description |
String |
剧本描述。 |
view_mode |
String |
横竖屏类型。默认值是LANDSCAPE。
|
model_asset_id |
String |
数字人模型资产ID。 |
model_asset_type |
String |
数字人模型类型。
|
voice_config |
VoiceConfig object |
语音配置参数。 |
video_config |
VideoConfig object |
视频输出配置。 |
scene_asset_id |
String |
场景资产ID。 说明:
|
priv_data |
String |
私有数据,用户填写,原样带回。 |
background_music_config |
BackgroundMusicConfig object |
背景音乐配置 |
review_config |
ReviewConfig object |
内容审核配置 |
shoot_scripts |
Array of ShootScriptShowItem objects |
拍摄脚本列表。 |
script_id |
String |
剧本ID。 |
create_time |
String |
创建时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
update_time |
String |
更新时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。 |
audio_files |
ShootScriptAudioFiles object |
用于语音驱动的音频文件上传URL列表。 |
script_cover_url |
String |
剧本封面下载url。 |
参数 |
参数类型 |
描述 |
---|---|---|
voice_asset_id |
String |
音色资产ID。 |
speed |
Integer |
语速。 默认值100,最小值50,最大值200。 说明:
|
pitch |
Integer |
音高。 默认值100,最小值50,最大值200。 |
volume |
Integer |
音量。 默认值140,最小值90,最大值240。 |
参数 |
参数类型 |
描述 |
---|---|---|
clip_mode |
String |
输出视频的剪辑方式。默认值RESIZE。
|
codec |
String |
视频编码格式及视频文件格式。
|
bitrate |
Integer |
输出平均码率。 单位:kbps。 最小值40,最大值30000。 说明:
|
width |
Integer |
视频宽度。 单位:像素。 说明:
|
height |
Integer |
视频高度。 单位:像素。 说明:
|
frame_rate |
String |
帧率。 单位:FPS。 说明:
|
is_subtitle_enable |
Boolean |
输出的视频是否带字幕。默认false。 说明:
true: 打开字幕 false: 关闭字幕 |
subtitle_config |
SubtitleConfig object |
字幕配置。 |
dx |
Integer |
裁剪视频左上角像素点坐标。 clip_mode= CROP时生效。 说明:
|
dy |
Integer |
裁剪视频左上角像素点坐标。 clip_mode= CROP时生效。 说明:
|
参数 |
参数类型 |
描述 |
---|---|---|
dx |
Integer |
字幕框左下角像素点坐标。 说明:
*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。 |
dy |
Integer |
字幕框左下角像素点坐标。 说明:
*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。 |
font_name |
String |
字体。当前支持的字体:
|
font_size |
Integer |
字体大小。 取值范围:[4, 120] |
h |
Integer |
字幕框高度 说明:
|
w |
Integer |
字幕框宽度 说明:
|
参数 |
参数类型 |
描述 |
---|---|---|
music_asset_id |
String |
音乐资产ID。 |
volume |
Integer |
音乐音量。如100,表示音量100%,50表示音量50%。 默认值100,最小值0,最大值100。 |
参数 |
参数类型 |
描述 |
---|---|---|
sequence_no |
Integer |
剧本序号。 |
shoot_script |
ShootScriptDetail object |
剧本配置 |
参数 |
参数类型 |
描述 |
---|---|---|
script_type |
String |
脚本类型,即视频制作的驱动方式。默认TEXT
|
text_config |
TextConfig object |
讲解词配置。 |
animation_config |
Array of AnimationConfig objects |
动作配置。 说明:
|
background_config |
Array of BackgroundConfigInfo objects |
背景配置。 |
emotion_config |
Array of EmotionConfig objects |
情感标签配置。 说明:
|
layer_config |
Array of LayerConfig objects |
图层配置。 |
thumbnail_url |
String |
剧本场景缩略图url。 |
参数 |
参数类型 |
描述 |
---|---|---|
text |
String |
台词脚本。 支持两种模式,纯文本模式和标签模式。 纯文本模式 纯文本模式,使用方法,如“大家好,我是人工智大家,是个虚拟主播”。 标签模式 SSML标签的详细定义请参考文本驱动SSML定义。 |
参数 |
参数类型 |
描述 |
---|---|---|
background_type |
String |
背景类型。
|
background_config |
String |
背景文件的URL。 说明:
|
background_color_config |
String |
纯色背景的RGB颜色值。 说明:
|
background_asset_id |
String |
背景资产ID。 说明:
|
参数 |
参数类型 |
描述 |
---|---|---|
layer_type |
String |
图层类型。
|
asset_id |
String |
图层所需资产的资产id,外部资产信息无需填写 |
group_id |
String |
多场景素材编组。同一group_id的素材,在应用全局时共享位置信息。 |
position |
LayerPositionConfig object |
图层位置配置。 |
size |
LayerSizeConfig object |
图层大小配置。 |
image_config |
ImageLayerConfig object |
素材图片图层配置。 |
video_config |
VideoLayerConfig object |
素材视频图层配置。 |
text_config |
TextLayerConfig object |
素材文字图层配置。 |
参数 |
参数类型 |
描述 |
---|---|---|
dx |
Integer |
图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。 说明:
|
dy |
Integer |
图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。 说明:
横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 |
layer_index |
Integer |
图片/视频/人物图的层顺序。 说明:
|
参数 |
参数类型 |
描述 |
---|---|---|
width |
Integer |
图层图片宽度像素值(相对画布大小)。 说明:
横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 |
height |
Integer |
图层图片高度像素值(相对画布大小)。 说明:
横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。 |
参数 |
参数类型 |
描述 |
---|---|---|
video_url |
String |
视频文件的URL。 |
video_cover_url |
String |
视频封面文件的URL。 |
loop_count |
Integer |
循环播放视频次数。 |
参数 |
参数类型 |
描述 |
---|---|---|
text_context |
String |
文字图层的文本,内容需做Base64编码。 示例:若想添加文字水印“测试文字水印”,那么text_context的值为:5rWL6K+V5paH5a2X5rC05Y2w |
font_name |
String |
字体。当前支持的字体:
|
font_size |
Integer |
字体大小(像素)。 取值范围:[4, 120] |
font_color |
String |
字体颜色。RGB颜色值。 |
参数 |
参数类型 |
描述 |
---|---|---|
audio_file_url |
Array of ShootScriptAudioFileItem objects |
用于语音驱动的音频文件上传URL。 |
参数 |
参数类型 |
描述 |
---|---|---|
sequence_no |
Integer |
剧本序号。 |
audio_file_upload_url |
String |
语音驱动音频文件上传URL。创建和更新脚本时返回。单个文件最大100M。支持上传MP3/WAV/M4A文件。 |
audio_file_download_url |
String |
语音驱动音频文件下载URL。查询脚本详情时返回。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-video-scripts/24bad716-87b1-45e5-8912-6102f7693265
响应示例
状态码: 200
成功。
{ "script_name" : "大自然的传说", "script_description" : "课件", "model_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a", "scene_asset_id" : "7ad01cf66f6cc54e45a2021558b7fbb0", "voice_config" : { "voice_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a", "speed" : 100, "pitch" : 100, "volume" : 140 }, "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" : "978f893e1de4553c183b7a805e6290f5" } ] } } ] }
状态码: 400
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码: 401
{ "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" }
状态码: 404
{ "error_code" : "MSS.00000002", "error_msg" : "Not Found" }
状态码: 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 |
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.*; public class ShowVideoScriptSolution { 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(); ShowVideoScriptRequest request = new ShowVideoScriptRequest(); request.withScriptId("{script_id}"); try { ShowVideoScriptResponse response = client.showVideoScript(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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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 = ShowVideoScriptRequest() request.script_id = "{script_id}" response = client.show_video_script(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 |
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.ShowVideoScriptRequest{} request.ScriptId = "{script_id}" response, err := client.ShowVideoScript(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功。 |
400 |
请求传参异常,包含错误码及对应描述。 |
401 |
未鉴权或鉴权失败。 |
404 |
无内容。 |
500 |
内部服务错误。 |
错误码
请参见错误码。