启动数字人智能直播任务
功能介绍
该接口用于启动数字人智能直播任务。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/smart-live-rooms/{room_id}/smart-live-jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
room_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。不允许输入中文。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。
|
co_streamer_config |
否 |
CoStreamerConfig object |
助播配置 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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时生效。 说明:
|
is_enable_super_resolution |
否 |
Boolean |
视频是否开启超分。 说明:
true: 开启 false: 不开启 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
字幕框宽度 说明:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repeat_count |
否 |
Integer |
剧本重复播放次数。 -1表示持续重复,直至人工停止 0 表示不重复,仅执行一次 其他值n,实际运行次数为n+1次 |
auto_play_script |
否 |
Boolean |
是否启动推理,自动播放剧本。 如果不启动推理,数字人为静默状态。 true: 服务完成任务初始化后,自动播放剧本 false: 服务完成任务初始化后,等待信号后再开始播放剧本 |
play_mode |
否 |
String |
驱动方式。默认TEXT
|
random_play_mode |
否 |
String |
随机播报模式。
|
need_independent_capture_client |
否 |
Boolean |
是否需要独立采集端 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
live_event_type_callback_url |
否 |
String |
直播事件回调地址。https地址,需自带鉴权串。 |
auth_type |
否 |
String |
认证类型。
|
key |
否 |
String |
密钥Key |
callback_event_type |
否 |
Array of strings |
回调的直播事件类型列表。 当前仅支持取值: SHOOT_SCRIPT_SWITCH,剧本段落切换事件。 RTMP_STREAM_STATE_CHANGE,RTMP链接发生变化回调事件。 REPLY_COMMAND_FINISH,回复播放完成通知 回调事件结构体定义:
{ "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"}" } |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
rtc_callback_event_type |
否 |
Array of strings |
RTC回调的直播事件类型列表。 当前仅支持取值: LIVE_PROGRESS,直播剧本进度通知。 REPLY_COMMAND_FINISH,回复播放完成通知。 回调事件结构体定义:
{ "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" }" } |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
voice_config |
否 |
VoiceConfig object |
语音配置参数。 |
streamer_action |
否 |
String |
助播出声时主播行为。
|
响应参数
状态码: 202
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
开播风险告警列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
app_id |
String |
RTC应用ID。 |
room_id |
String |
RTC房间ID。 |
users |
Array of RTCUserInfo objects |
加入RTC房间用户信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_type |
String |
用户类型。
|
user_id |
String |
RTC用户ID。 |
signature |
String |
RTC鉴权token。 |
ctime |
Long |
有效期。时间戳,单位:秒。 |
参数 |
参数类型 |
描述 |
---|---|---|
live_event_type_callback_url |
String |
直播事件回调地址。https地址,需自带鉴权串。 |
auth_type |
String |
认证类型。
|
key |
String |
密钥Key |
callback_event_type |
Array of strings |
回调的直播事件类型列表。 当前仅支持取值: SHOOT_SCRIPT_SWITCH,剧本段落切换事件。 RTMP_STREAM_STATE_CHANGE,RTMP链接发生变化回调事件。 REPLY_COMMAND_FINISH,回复播放完成通知 回调事件结构体定义:
{ "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"}" } |
参数 |
参数类型 |
描述 |
---|---|---|
warning_type |
String |
告警类型。
|
状态码: 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/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代码示例如下。
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 |
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()); } } } |
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 |
# 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) |
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 |
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 |
内部服务错误。 |
错误码
请参见错误码。