文档首页/ 数字内容生产线 MetaStudio/ API参考/ 分身视频直播/ 直播任务管理/ 控制数字人直播过程
更新时间：2024-12-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

控制数字人直播过程

功能介绍

该接口用于控制数字人直播过程。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs/{job_id}/command

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

room_id

是

String

剧本ID。

job_id

是

String

任务ID。

请求参数

表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参数

参数

是否必选

参数类型

描述

command

是

String

参数解释：

命令名称。

约束限制：

不限制

取值范围：

  • INSERT_PLAY_SCRIPT：插入表演脚本。用于互动回复。数字人不变，背景不变。params结构定义：PlayTextInfo。

  • INSERT_PLAY_AUDIO：插入驱动音频。用于音频直接驱动。数字人不变，背景不变。params结构定义：PlayAudioInfo。

  • REWRITE_PLAY_SCRIPT：动态编辑未播放剧本。params结构定义：scene_scripts。

  • REWRITE_INTERACTION_RULES：动态修改互动规则。params结构定义：interaction_rules。

  • GET_CURRENT_PLAYING_SCRIPTS：查询本轮剧本列表。响应为：LivePlayingScriptList结构。

  • SHOW_LAYER：显示导播素材，用于直播导播。params结构定义：LiveGuideRuleInfo。

  • REFRESH_OUTPUT_URL：更新当前任务的rtmp推流信息。params结构定义： RefreshOutputUrlConfig。

  • GET_LIVE_JOB_CONFIG_INFO：获取任务中的房间信息。params结构定义：与直播间详情响应体一致。

  • CLEAN_UP_INSERT_COMMAND：清理未播放的插入命令。params结构定义：CleanUpInsertCommand

    默认取值：

    不涉及

params

否

Object

参数解释：

命令参数。

约束限制：

不限制

取值范围：

参考COMMNAD说明。

默认取值：

不涉及

review_config

否

ReviewConfig object

内容审核配置
表4 ReviewConfig

参数

是否必选

参数类型

描述

no_need_review

否

Boolean

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

响应参数

状态码： 200

表5 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。
表6 响应Body参数

参数

参数类型

描述

command_id

String

控制命令ID

command

String

命令名称。

  • INSERT_PLAY_SCRIPT：插入表演脚本。用于互动回复。数字人不变，背景不变。params结构定义：ShootScript。

  • REWRITE_PLAY_SCRIPT：动态编辑未播放剧本。params结构定义：scene_scripts。

  • INSERT_PLAY_AUDIO：插入驱动音频。用于音频直接驱动。数字人不变，背景不变。params结构定义：PlayAudioInfo。

  • GET_CURRENT_PLAYING_SCRIPTS：查询本轮剧本列表。响应为LivePlayingScriptList结构。

  • REFRESH_OUTPUT_URL：更新当前任务的rtmp推流信息。params结构定义： RefreshOutputUrlConfig。

  • REWRITE_INTERACTION_RULES：动态修改互动规则。params结构定义：interaction_rules。

  • GET_LIVE_JOB_CONFIG_INFO：获取任务中的房间信息。params结构定义：SmartLiveRoomInfo。

  • CLEAN_UP_INSERT_COMMAND：清理未播放的插入命令。params结构定义：CleanUpInsertCommand

result

String

命令执行结果

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-live-jobs/26f06524-4f75-4b3a-a853-b649a21aaf66/command

{
  "command" : "INSERT_PLAY_SCRIPT",
  "params" : {
    "text_config" : {
      "text" : "看到评论区有观众问问题，我来响应下。"
    },
    "play_type" : "APPEND",
    "rule_index" : "test-rule-index"
  }
}

响应示例

状态码： 200

成功。

{
  "command" : "GET_CURRENT_PLAYING_SCRIPTS",
  "result" : ""
}

状态码： 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"
}

状态码

状态码

描述

200

成功。

400

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

401

未鉴权或鉴权失败。

500

内部服务错误。

错误码

请参见错误码。

父主题： 直播任务管理