全部产品
Search
文档中心

视频直播:更新导播场景配置

更新时间:Apr 30, 2024

调用UpdateCasterSceneConfig更新导播场景配置。

使用说明

调用本接口增量设置场景配置,不清空原配置,布局信息在原场景上增量修改,效率较全量设置高。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String UpdateCasterSceneConfig

系统规定参数。取值:UpdateCasterSceneConfig

ComponentId.N String ["98778372-c30f-4442-85ba-2e3e4e3d****"]

组件ID列表,数组内按照由下至上的顺序排列组件。

说明

N表示第几个的意思。例如:

ComponentId.1表示第1个组件ID,

ComponentId.2表示第2个组件ID。

CasterId String 80787064-1c94-4dc1-85ce-9409960a****

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
SceneId String 242b4e2c-c30f-4442-85ba-2e3e4e3d****

场景ID。

LayoutId String eeab74fb-379d-4599-a93d-86d16a05****

布局ID。如果您通过DescribeCasterLayouts接口查询导播台布局列表,请查看DescribeCasterLayouts接口调用返回的参数LayoutId值。

返回数据

名称

类型

示例值

描述

RequestId String CF60DB6A-7FD6-426E-9288-122CC1A52FA7

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=UpdateCasterSceneConfig
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&LayoutId=eeab74fb-379d-4599-a93d-86d16a05****
&SceneId=242b4e2c-c30f-4442-85ba-2e3e4e3d****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<UpdateCasterSceneConfigResponse>
	<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
</UpdateCasterSceneConfigResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "UpdateCasterSceneConfigResponse" : {
    "RequestId" : "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
  }
}

错误码

访问错误中心查看更多错误码。