文档首页> 数字内容生产线 MetaStudio> API参考> 分身视频直播> 直播任务管理> 启动数字人智能直播任务

更新时间：2024-06-13 GMT+08:00

在线调试

CLI示例

查看PDF

启动数字人智能直播任务

功能介绍

该接口用于启动数字人智能直播任务。

调用方法

请参见如何调用API。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方法请参考获取项目ID。
room_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参数
参数	是否必选	参数类型	描述
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	直播事件回调通知配置
rtc_callback_config	否	RTCLiveEventCallBackConfig object	RTC回调事件配置。兼容处理，未携带配置则默认订阅LIVE_PROGRESS
view_mode	否	String	横竖屏类型。默认值为：VERTICAL。 LANDSCAPE：横屏。 VERTICAL：竖屏。
co_streamer_config	否	CoStreamerConfig 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	视频宽度。单位：像素。说明： clip_mode=RESIZE时，当前支持1920x1080、1080x1920、1280x720、720x1280、3840x2160、2160x3840六种分辨率。4K分辨率视频需要分身数字人模型支持4K的情况下才能使用。 clip_mode=CROP，裁剪后视频，（dx,dy）为原点，保留视频像宽度为width。分身数字人直播目前只支持1080x1920。
height	是	Integer	视频高度。单位：像素。说明： 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时生效。说明：以模特分辨率为画布大小，比如1920*1080分辨率的模特，dx最小值是0，最大值是1920。
dy	否	Integer	裁剪视频左上角像素点坐标。 clip_mode= CROP时生效。说明：以模特分辨率为画布大小，比如1920*1080分辨率的模特，dy最小值是0，最大值是1080
is_enable_super_resolution	否	Boolean	视频是否开启超分。说明： true: 开启 false: 不开启

表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	字幕框高度说明：参数h用于方便前端计算字幕框左上角坐标，后台不使用该参数
w	否	Integer	字幕框宽度说明：字幕框宽度固定为屏幕宽度的80% 参数w用于方便前端计算字幕框左上角坐标，后台不使用该参数

表6 PlayPolicy
参数	是否必选	参数类型	描述
repeat_count	否	Integer	剧本重复播放次数。 -1表示持续重复，直至人工停止 0 表示不重复，仅执行一次其他值n，实际运行次数为n+1次
auto_play_script	否	Boolean	是否自动播放剧本。 true: 服务完成任务初始化后，自动播放剧本 false: 服务完成任务初始化后，等待信号后再开始播放剧本
play_mode	否	String	驱动方式。默认TEXT TEXT: 文本驱动，即通过TTS合成语音 AUDIO: 语音驱动 NO_PRESET: 无预置剧本。人工控制模式。
random_play_mode	否	String	随机播报模式。 NONE: 不启动随机播报。 SCENE: 按场景随机播报。场景内段落按顺序播报。 SCRIPT_ITEM：按段落随机播报。场景按顺序播报。 SCENE_AND_SCRIPT_ITEM：场景和段落都随机播报。
need_independent_capture_client	否	Boolean	是否需要独立采集端

表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) MSS_A_HEAD。HMACSHA256签名模式，参数hwSecret,hwTime放置在Head中。取值方式：x-hw-mss-secret=hmac_sha256(Key, URI（live_event_callback_url）+ hwTime) x-hw-mss-time=hex(timestamp) MEITUAN_DEFAULT。仅用于美团平台调用回调使用。
key	否	String	密钥Key
callback_event_type	否	Array of strings	回调的直播事件类型列表。当前仅支持取值： SHOOT_SCRIPT_SWITCH，剧本段落切换事件。 RTMP_STREAM_STATE_CHANGE,RTMP链接发生变化回调事件。 REPLY_COMMAND_FINISH,回复播放完成通知回调事件结构体定义： event_type: 事件类型。 message: 事件描述。 SHOOT_SCRIPT_SWITCH事件回调定义如下： { "event_type": "SHOOT_SCRIPT_SWITCH", "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"scene_script_name\":\"商品1\",\"shoot_script_sequence_no\":\"2\",\"shoot_script_title\":\"段落2\"}" } RTMP_STREAM_STATE_CHANGE回调定义如下： { "event_type": "RTMP_STREAM_STATE_CHANGE", "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"output_url\":\"rtmp://xxx/xx/xx\",\"stream_key\":\"xxxxx\",\"state\":\"CONNECTED\"}" } 其中state取值： CONNECTING 链路连接中, CONNECTED 链路已连接，DISCONNECTED 链路已断开，RECONNECTING 链路重连中, END 联络不再重连，链路已结束 REPLY_COMMAND_FINISH回调定义如下： { "event_type": "REPLY_COMMAND_FINISH", "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"reply_id\":\"e87104f76d7546ce8a46ac6b04c49c3c"}" }

表8 RTCLiveEventCallBackConfig
参数	是否必选	参数类型	描述
rtc_callback_event_type	否	Array of strings	RTC回调的直播事件类型列表。当前仅支持取值： LIVE_PROGRESS，直播剧本进度通知。 REPLY_COMMAND_FINISH，回复播放完成通知。回调事件结构体定义： message_type: 消息类型。 data: 消息描述。 LIVE_PROGRESS事件回调定义如下： { "message_type": "live_progress_notify", "data": { "script_name": "场景一", "shoot_script_sequence_no": 2, "shoot_script_title": "引导语", "offset": "247", "reply_id": "e87104f76d7546ce8a46ac6b04c49c3c" } } REPLY_COMMAND_FINISH回调定义如下： { "message_type": "reply_command_finish_notify", "data":"{ "reply_id":"e87104f76d7546ce8a46ac6b04c49c3c" }" }

表9 CoStreamerConfig
参数	是否必选	参数类型	描述
voice_config	否	VoiceConfig object	语音配置参数。
streamer_action	否	String	助播出声时主播行为。 SILENCE：静默 VOLUME_DOWN：音量降低

**表10** VoiceConfig
参数	是否必选	参数类型	描述
voice_asset_id	是	String	音色资产ID。
speed	否	Integer	语速。默认值100，最小值50，最大值200。说明：当取值为“100”时，表示一个成年人正常的语速，约为250字/分钟。 50表示0.5倍语速，100表示正常语速，200表示2倍语速。
pitch	否	Integer	音高。默认值100，最小值50，最大值200。
volume	否	Integer	音量。默认值140，最小值90，最大值240。

响应参数

状态码： 202

**表11** 响应Header参数
参数	参数类型	描述
X-Request-Id	String	请求ID。

**表12** 响应Body参数
参数	参数类型	描述
job_id	String	直播任务ID。
rtc_room_info	RTCRoomInfoList object	RTC房间信息。
live_event_report_url	String	直播事件上报地址。用户将自行获取的直播间事件上报到此地址，用于触发智能互动，自动回复话术。
live_event_callback_config	LiveEventCallBackConfig object	直播事件回调通知配置
live_warning_info	Array of LiveWarningItem objects	开播风险告警列表。

**表13** RTCRoomInfoList
参数	参数类型	描述
app_id	String	RTC应用ID。
room_id	String	RTC房间ID。
users	Array of RTCUserInfo objects	加入RTC房间用户信息。

**表14** RTCUserInfo
参数	参数类型	描述
user_type	String	用户类型。 CAPTURE: 直播助手，将摄像头获取视频流推送到RTC房间 ANIMATION: VDS服务，从RTC房间拉视频流生成动作数据 RENDER: 渲染服务，将动作数据渲染成数字人动画 PLAYER: 普通观看方，可选择原始视频流或者数字人动画视频流观看 INFERENCE_USER: 数字人推理端用户。从RTC房间接收音频流，并推送视频流到RTC房间 END_USER: 端侧用户。从推送音频流到RTC房间，并从RTC房间接收视频流
user_id	String	RTC用户ID。
signature	String	RTC鉴权token。
ctime	Long	有效期。时间戳，单位：秒。

**表15** 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) MSS_A_HEAD。HMACSHA256签名模式，参数hwSecret,hwTime放置在Head中。取值方式：x-hw-mss-secret=hmac_sha256(Key, URI（live_event_callback_url）+ hwTime) x-hw-mss-time=hex(timestamp) MEITUAN_DEFAULT。仅用于美团平台调用回调使用。
key	String	密钥Key
callback_event_type	Array of strings	回调的直播事件类型列表。当前仅支持取值： SHOOT_SCRIPT_SWITCH，剧本段落切换事件。 RTMP_STREAM_STATE_CHANGE,RTMP链接发生变化回调事件。 REPLY_COMMAND_FINISH,回复播放完成通知回调事件结构体定义： event_type: 事件类型。 message: 事件描述。 SHOOT_SCRIPT_SWITCH事件回调定义如下： { "event_type": "SHOOT_SCRIPT_SWITCH", "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"scene_script_name\":\"商品1\",\"shoot_script_sequence_no\":\"2\",\"shoot_script_title\":\"段落2\"}" } RTMP_STREAM_STATE_CHANGE回调定义如下： { "event_type": "RTMP_STREAM_STATE_CHANGE", "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"output_url\":\"rtmp://xxx/xx/xx\",\"stream_key\":\"xxxxx\",\"state\":\"CONNECTED\"}" } 其中state取值： CONNECTING 链路连接中, CONNECTED 链路已连接，DISCONNECTED 链路已断开，RECONNECTING 链路重连中, END 联络不再重连，链路已结束 REPLY_COMMAND_FINISH回调定义如下： { "event_type": "REPLY_COMMAND_FINISH", "message":"{\"room_id\":\"26f065244f754b3aa853b649a21aaf66\",\"job_id\":\"e87104f76d7546ce8a46ac6b04c49c3c\",\"reply_id\":\"e87104f76d7546ce8a46ac6b04c49c3c"}" }

**表16** LiveWarningItem
参数	参数类型	描述
warning_type	String	告警类型。 TOO_LESSS_SCRIPT_ITEMS：段落（话术）数量太少。 TOO_SHORT_SCRIPT_TIME：段落（话术）总时长太短。 TOO_LESS_DANMAKU_RULES：弹幕互动规则太少。 RANDOM_PLAY_CLOSED: 随机播放开关关闭。 ROTATION_MODEL_CLOSED: 主播轮转未配置。

状态码： 400

**表17** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

状态码： 401

**表18** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

状态码： 500

**表19** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。

请求示例

POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-rooms/24bad716-87b1-45e5-8912-6102f7693265/smart-live-jobs

{
  "output_urls" : [ "rtmp://vfxpush.hwcloudvr.cn/live/lysa" ]
}

响应示例

状态码： 202

成功。

{
  "job_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代码示例如下。

      
       
         
         
           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 StartSmartLiveSolution {

    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();
        StartSmartLiveRequest request = new StartSmartLiveRequest();
        request.withRoomId("{room_id}");
        StartSmartLiveReq body = new StartSmartLiveReq();
        List<String> listbodyOutputUrls = new ArrayList<>();
        listbodyOutputUrls.add("rtmp://vfxpush.hwcloudvr.cn/live/lysa");
        body.withOutputUrls(listbodyOutputUrls);
        request.withBody(body);
        try {
            StartSmartLiveResponse response = client.startSmartLive(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = StartSmartLiveRequest()
        request.room_id = "{room_id}"
        listOutputUrlsbody = [
            "rtmp://vfxpush.hwcloudvr.cn/live/lysa"
        ]
        request.body = StartSmartLiveReq(
            output_urls=listOutputUrlsbody
        )
        response = client.start_smart_live(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           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.StartSmartLiveRequest{}
	request.RoomId = "{room_id}"
	var listOutputUrlsbody = []string{
        "rtmp://vfxpush.hwcloudvr.cn/live/lysa",
    }
	request.Body = &model.StartSmartLiveReq{
		OutputUrls: &listOutputUrlsbody,
	}
	response, err := client.StartSmartLive(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
202	成功。
400	请求传参异常，包含错误码及对应描述。
401	未鉴权或鉴权失败。
500	内部服务错误。

错误码

请参见错误码。

父主题：直播任务管理

上一篇：直播任务管理

下一篇：查询某个智能直播间下直播任务列表

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

启动数字人智能直播任务

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线