数字内容生产线 METASTUDIO-启动数字人智能直播任务:请求参数

时间:2023-12-21 11:19:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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。

说明:

*不允许输入中文。

表3 请求Body参数

参数

是否必选

参数类型

描述

video_config

VideoConfig object

视频输出配置。

play_policy

PlayPolicy object

剧本播放策略

output_urls

Array of strings

RTMP视频推流第三方直播平台地址。

stream_keys

Array of strings

RTMP视频推流第三方直播平台流秘钥,与推流地址对应。

interaction_callback_url

String

互动回调URL,含鉴权信息。

live_event_callback_config

LiveEventCallBackConfig object

直播事件回调通知配置

表4 VideoConfig

参数

是否必选

参数类型

描述

clip_mode

String

输出视频的剪辑方式。默认值RESIZE。

  • RESIZE:视频缩放。

  • CROP:视频裁剪。

codec

String

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

  • H264: h264编码,输出mp4文件

  • VP8:vp8编码,输出webm文件

bitrate

Integer

输出平均码率。

单位:kbps。

最小值40,最大值30000。

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

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

width

Integer

视频宽度。

单位:像素。

最小值320,最大值2560。

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

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

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

height

Integer

视频高度。

单位:像素。

最小值320,最大值2560。

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

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

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

frame_rate

String

帧率。

单位:FPS。

说明:
  • 分身数字人视频固定25FPS。

is_subtitle_enable

Boolean

输出的视频是否带字幕。默认false。

说明:

true: 打开字幕 false: 关闭字幕

subtitle_config

SubtitleConfig object

字幕配置。

dx

Integer

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

clip_mode= CROP时生效。

说明:

*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。

dy

Integer

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

clip_mode= CROP时生效。

说明:

*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。

表5 SubtitleConfig

参数

是否必选

参数类型

描述

dx

Integer

字幕左上角像素点坐标。

说明:

*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。

dy

Integer

字幕左上角像素点坐标。

说明:

*横屏(16:9)视频像素为1920x1080;竖屏(9:16)视频像素为1080x1920。

font_name

String

字体。当前支持的字体:

  • HarmonyOS_Sans_SC_Black:鸿蒙粗体

  • HarmonyOS_Sans_SC_Regular:鸿蒙常规

  • HarmonyOS_Sans_SC_Thin:鸿蒙细体

font_size

Integer

字体大小。

取值范围:[4, 120]

h

Integer

字幕框高度

w

Integer

字幕框宽度

表6 PlayPolicy

参数

是否必选

参数类型

描述

repeat_count

Integer

剧本重复播放次数。 -1表示持续重复,直至人工停止 0 表示不重复,仅执行一次 其他值n,实际运行次数为n+1次

auto_play_script

Boolean

是否自动播放剧本。 true: 服务完成任务初始化后,自动播放剧本 false: 服务完成任务初始化后,等待信号后再开始播放剧本

play_mode

String

驱动方式。默认TEXT

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

  • AUDIO: 语音驱动

random_play_mode

String

随机播报模式。

  • NONE: 不启动随机播报。

  • SCENE: 按场景随机播报。场景内段落按顺序播报。

  • SCRIPT_ITEM:按段落随机播报。场景按顺序播报。

  • SCENE_AND_SCRIPT_ITEM: 场景和段落都随机播报。

表7 LiveEventCallBackConfig

参数

是否必选

参数类型

描述

live_event_type_callback_url

String

直播事件回调地址。https地址,需自带鉴权串。

auth_type

String

认证类型。

  • NONE。URL中自带认证。

  • MSS_A。HMACSHA256签名模式,在URL中追加参数:hwSecret,hwTime。取值方式:hwSecret=hmac_sha256(Key, URI(live_event_callback_url)+ hwTime)&hwTime=hex(timestamp)

key

String

密钥Key

callback_event_type

Array of strings

回调的直播事件类型列表

support.huaweicloud.com/api-metastudio/StartSmartLive.html