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

查询智能直播剧本详情

功能介绍

该接口用于查询智能直播剧本详情。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/smart-live-rooms/{room_id}

表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。不允许输入中文。

响应参数

状态码: 200

表3 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表4 响应Body参数

参数

参数类型

描述

room_name

String

直播间名称

room_description

String

直播间描述。

room_type

String

直播间类型。

  • NORMAL: 普通直播间,直播间一直存在,可以反复开播

  • TEMP: 临时直播间,直播任务结束后自动清理直播间。

  • TEMPLATE: 直播间模板。

scene_scripts

Array of LiveVideoScriptInfo objects

默认直播剧本列表。

interaction_rules

Array of LiveRoomInteractionRuleInfo objects

互动规则列表

play_policy

PlayPolicy object

剧本播放策略

video_config

VideoConfig object

视频输出配置。

output_urls

Array of strings

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

stream_keys

Array of strings

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

backup_model_asset_ids

Array of strings

主播轮换时备选主播数字人资产ID(仅形象资产,不包含音色)。

live_event_callback_config

LiveEventCallBackConfig object

直播事件回调通知配置

rtc_callback_config

RTCLiveEventCallBackConfig object

RTC回调事件配置。兼容处理,未携带配置则默认订阅LIVE_PROGRESS

review_config

ReviewConfig object

内容审核配置

shared_config

SharedConfig object

共享配置

view_mode

String

横竖屏类型。默认值为:VERTICAL。

  • LANDSCAPE:横屏。

  • VERTICAL: 竖屏。

co_streamer_config

CoStreamerConfig object

助播配置

room_id

String

直播间ID

create_time

String

直播间创建时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。

update_time

String

直播间更新时间,格式遵循:RFC 3339 如"2021-01-10T08:43:17Z"。

cover_url

String

直播间封面图URL

thumbnail

String

直播间封面图新URL

room_state

String

直播间配置状态。

  • ENABLE: 直播间正常可用。

  • DISABLE: 直播间不可用。不可用原因在error_info中说明。

  • BLOCKED:直播间被冻结。冻结原因在error_info中说明。

error_info

ErrorResponse object

数字人直播间出错信息。

表5 LiveVideoScriptInfo

参数

参数类型

描述

script_id

String

剧本ID。

script_name

String

剧本名称

script_description

String

剧本描述。

dh_id

String

数字人ID。对应形象和音色组合。

model_asset_id

String

数字人模型资产ID。

voice_config

VoiceConfig object

语音配置参数。

background_config

Array of BackgroundConfigInfo objects

背景配置。

layer_config

Array of LayerConfig objects

图层配置。

shoot_scripts

Array of LiveShootScriptItem objects

拍摄脚本列表。

表6 BackgroundConfigInfo

参数

参数类型

描述

background_type

String

背景类型。

  • IMAGE:图片背景,指定图片用作分身数字人背景。

  • COLOR:纯色背景,指定颜色RGB值作为分身数字人背景。

background_config

String

背景文件的URL。

说明:
  • 仅直播支持外部URL,其他业务通过资产库查询获取,不支持外部URL。

  • background_type=IMAGE时需要填写。

background_color_config

String

纯色背景的RGB颜色值。

说明:
  • background_type=COLOR时需要填写。

background_asset_id

String

背景资产ID。

说明:
  • 背景是背景图片时,填图片资产ID。

表7 LayerConfig

参数

参数类型

描述

layer_type

String

图层类型。

  • HUMAN: 人物图层

  • IMAGE: 素材图片图层

  • VIDEO: 素材视频图层

  • TEXT: 素材文字图层

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

素材文字图层配置。

表8 LayerPositionConfig

参数

参数类型

描述

dx

Integer

图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。

说明:
  • 横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

dy

Integer

图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。

说明:

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

layer_index

Integer

图片/视频/人物图的层顺序。

说明:
  • 图层顺序从1开始的整数,底层图层顺序是1,往上依次增加。

表9 LayerSizeConfig

参数

参数类型

描述

width

Integer

图层图片宽度像素值(相对画布大小)。

说明:

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

height

Integer

图层图片高度像素值(相对画布大小)。

说明:

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

表10 ImageLayerConfig

参数

参数类型

描述

image_url

String

图片文件的URL。

表11 VideoLayerConfig

参数

参数类型

描述

video_url

String

视频文件的URL。

video_cover_url

String

视频封面文件的URL。

loop_count

Integer

循环播放视频次数。

表12 TextLayerConfig

参数

参数类型

描述

text_context

String

文字图层的文本,内容需做Base64编码。

示例:若想添加文字水印“测试文字水印”,那么text_context的值为:5rWL6K+V5paH5a2X5rC05Y2w

font_name

String

字体。当前支持的字体:

  • HarmonyOS_Sans_SC_Black:鸿蒙粗体

  • HarmonyOS_Sans_SC_Regular:鸿蒙常规

  • HarmonyOS_Sans_SC_Thin:鸿蒙细体

  • fzyouh:方正瘦体

font_size

Integer

字体大小(像素)。

取值范围:[4, 120]

font_color

String

字体颜色。RGB颜色值。

表13 LiveShootScriptItem

参数

参数类型

描述

sequence_no

Integer

剧本序号。

title

String

段落标题。

text_config

TextConfig object

话术配置。

audio_config

LiveAudioConfig object

直播音频配置

表14 TextConfig

参数

参数类型

描述

text

String

台词脚本。

支持两种模式,纯文本模式和标签模式。

纯文本模式

纯文本模式,使用方法,如“大家好,我是人工智大家,是个虚拟主播”。

标签模式

SSML标签的详细定义请参考文本驱动SSML定义

表15 LiveAudioConfig

参数

参数类型

描述

asset_id

String

插入音频资产的资产id,外部资产信息无需填写

audio_url

String

音频URL。仅支持MP3格式,大小<100MB。输出会自动转化为单声道16KHZ采样。

subtitle_url

String

音频对应的字幕文件URL。仅SRT格式,大小<1MB。

表16 LiveRoomInteractionRuleInfo

参数

参数类型

描述

rule_index

String

规则索引

rule_name

String

规则名称

enabled

Boolean

是否启用

event_type

Integer

事件类型。 * 1:弹幕事件 * 2:用户入场事件 * 3:用户点赞事件 * 4:用户送礼事件 * 10: 预置话术事件

hit_condition

HitCondition object

命中条件

trigger

TriggerProcess object

触发器

review_config

ReviewConfig object

内容审核配置

group_id

String

互动规则库ID。从互动库导入时携带互动库ID。

group_name

String

互动规则库名称。从互动库导入时携带互动库名称。

enabled_scenes

Array of strings

规则启用场景。部分场景启用时填写。不填写为全部。

表17 HitCondition

参数

参数类型

描述

relation

String

条件关系;取值And或者Or RESERVED 为兜底回复不会去判断其他命中条件

priority

Integer

优先级,数值越低优先级越高;取值0-999,默认值为500,为可选值

tags

Array of HitConditionTag objects

匹配关系配置

表18 HitConditionTag

参数

参数类型

描述

tag

String

事件内容关键字段

operation

String

字段处理

  • SUM: 累计

  • AVG:平均

  • COUNT: 计数

  • NONE: 无处理

match

String

匹配类型

  • EQUAL: 完全相等

  • REGEX:正则匹配

  • MATH_GT:数值大于

  • MATH_GE: 数值大于等于

  • MATH_LT:数值小于

  • MATH_LE:数值小于等于

  • MATH_EQ:数值相等

value

String

匹配值

表19 TriggerProcess

参数

参数类型

描述

time_window

Integer

处理抑制时长。单位秒。

-1 表示整场直播

0 表示无抑制,每次都触发

reply_mode

String

回复类型。

  • SYSTEM_REPLY:系统自动回复设置的话术。

  • CALLBACK:回调给其他服务,携带设置的话术。

  • SHOW_LAYER: 显示叠加图层,不影响话术。

  • INTELLIGENT_REPLY: 智能交互回复话术。

layer_config

SmartLayerConfig object

智能图层配置。

extra_layer_config

SmartLayerConfig object

额外图层,用于有产品同时需要显示动态文本场景,配置第二图层使用。

reply_texts

Array of strings

回复话术集

reply_audios

Array of ReplyAudioInfo objects

回复音频集。填写audio_url。

reply_order

String

回复次序

  • RANDOM:随机

  • ORDER:顺序循环

reply_role

String

回复角色。默认为主播

  • STREAMER:主播

  • CO_STREAMER:助播

robot_id

String

机器人ID。

表20 SmartLayerConfig

参数

参数类型

描述

layer_type

String

图层类型。

  • IMAGE: 素材图片图层

  • VIDEO: 素材视频图层

  • TEXT: 文本图层

asset_id

String

图层所需资产的资产id,外部资产信息无需填写

position

LayerPositionConfig object

图层位置配置。

size

LayerSizeConfig object

图层大小配置。

image_config

SmartImageLayerConfig object

素材图片图层配置。

video_config

SmartVideoLayerConfig object

素材视频图层配置。

text_config

SmartTextLayerConfig object

素材视频图层配置。

表21 SmartImageLayerConfig

参数

参数类型

描述

image_url

String

图片文件的URL。

display_duration

Integer

图片显示时长。单位s

  • 0 显示时长规则:若携带reply_texts,reply_audios,与播放语音内容时长保持一致;

    未携带场景,与匹配的关键词语音内容时长保持一致。

表22 SmartVideoLayerConfig

参数

参数类型

描述

video_url

String

视频文件的URL。

video_cover_url

String

视频封面文件的URL。

display_duration

Integer

视频显示时长。单位s

  • 0 显示时长规则:若携带reply_texts,reply_audios,与播放语音内容时长保持一致;

    未携带场景,与匹配的关键词语音内容时长保持一致

表23 SmartTextLayerConfig

参数

参数类型

描述

text_type

String

文本类型。

  • DYNAMIC: 动态文本,需要进行关键字替换。

  • STATIC: 静态文本。

text_context

String

文本。

font_name

String

字体。当前支持的字体:

  • HarmonyOS_Sans_SC_Black:鸿蒙粗体

  • HarmonyOS_Sans_SC_Regular:鸿蒙常规

  • HarmonyOS_Sans_SC_Thin:鸿蒙细体

  • fzyouh:方正瘦体

font_size

Integer

字体大小(像素)。

取值范围:[4, 120]

font_color

String

字体颜色。RGB颜色值。

display_duration

Integer

文本显示时长。单位s

  • 0 显示时长规则:若携带reply_texts,reply_audios,与播放语音内容时长保持一致;

    未携带场景,与匹配的关键词语音内容时长保持一致

表24 ReplyAudioInfo

参数

参数类型

描述

audio_url

String

音频URL

audio_name

String

音频名

表25 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

是否需要独立采集端

表26 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: 不开启

表27 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用于方便前端计算字幕框左上角坐标,后台不使用该参数

表28 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"}"
}
表29 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"
  }"
}
表30 ReviewConfig

参数

参数类型

描述

no_need_review

Boolean

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

表31 SharedConfig

参数

参数类型

描述

shared_type

String

共享类型。

  • PRIVATE: 私有,仅本租户可访问。

  • PUBLIC: 公开,所有租户可访问。当前仅提供系统资产可公开访问。

  • SHARED:共享,指定租户可访问。拥有者指定租户可访问。

shared_state

String

共享状态。

  • PUBLISHED: 发布。模板可用。

  • DRAFT: 草稿。编辑态,仅拥有者可访问。

  • REVIEW:审核态。不可编辑,仅拥有者/审核人员可查看。

expire_time

String

共享过期时间。空表示永久不过期。

allowed_project_ids

Array of strings

允许访问本资产的租户列表

表32 CoStreamerConfig

参数

参数类型

描述

voice_config

VoiceConfig object

语音配置参数。

streamer_action

String

助播出声时主播行为。

  • SILENCE:静默

  • VOLUME_DOWN:音量降低

表33 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。

表34 ErrorResponse

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 400

表35 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 401

表36 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 404

表37 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表38 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

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

响应示例

状态码: 200

成功。

{
  "room_id" : "24bad716-87b1-45e5-8912-6102f7693265",
  "room_name" : "大自然的传说",
  "room_description" : "课件",
  "scene_scripts" : [ {
    "script_name" : "大自然的传说 一",
    "model_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a",
    "voice_config" : {
      "voice_asset_id" : "a5d295cdb345c11bd9f36bc22ced3a7a"
    },
    "background_config" : [ {
      "background_type" : "IMAGE",
      "background_config" : "978f893e1de4553c183b7a805e6290f5"
    } ],
    "shoot_scripts" : [ {
      "sequence_no" : 1,
      "text_config" : {
        "text" : "大家好,我是云笙"
      }
    } ]
  } ]
}

状态码: 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 ShowSmartLiveRoomSolution {

    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();
        ShowSmartLiveRoomRequest request = new ShowSmartLiveRoomRequest();
        request.withRoomId("{room_id}");
        try {
            ShowSmartLiveRoomResponse response = client.showSmartLiveRoom(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
# 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 = ShowSmartLiveRoomRequest()
        request.room_id = "{room_id}"
        response = client.show_smart_live_room(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.ShowSmartLiveRoomRequest{}
	request.RoomId = "{room_id}"
	response, err := client.ShowSmartLiveRoom(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功。

400

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

401

未鉴权或鉴权失败。

404

无内容。

500

内部服务错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品