播单背景设置

调用SetShowListBackground进行播单背景设置

使用说明

  • 请先创建新播单型导播台,再调用本接口添加背景素材。使用API创建导播台,请参见创建导播台
  • 可以使用本接口创建/更新/删除播单背景, 当参数ResourceType、ResourceUrl、MaterialId 都为空即可删除背景。
重要
  • 使用视频点播(VOD)资源,可优先选择托管Bucket资源,自有Bucket资源存在过期风险,如果您选用自有Bucket资源,需注意资源的有效期时间。
  • 素材资源输入请优先选择视频直播和视频点播的资源,若从第三方URL输入资源存在播放失败可能性,需确定资源的质量和有效性。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String SetShowListBackground

系统规定参数。取值:SetShowListBackground

CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
ResourceType String VOD

素材类型。取值:

  • LIVE:直播素材。可支持直播素材和第三方URL。
  • VOD:点播素材。可支持点播素材和第三方URL。
  • PIC:图片素材。可支持点播素材和第三方URL。
说明 三选一或者不传。
MaterialId String a2b8e671-2fe5-4642-a2ec-bf93880e****

点播素材ID。

说明 与外部ResourceUrl二选一。
ResourceUrl String http://****/atestObject****.m3u8

外部素材url。

返回数据

名称

类型

示例值

描述

RequestId String 987DA143-A39C-5B5D-AF5B-3B07944A0036

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=SetShowListBackground
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&ResourceType=VOD
&MaterialId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&ResourceUrl=http://****/atestObject****.m3u8
&公共请求参数

正常返回示例

XML格式

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

<SetShowListBackgroundResponse>
    <RequestId>987DA143-A39C-5B5D-AF5B-3B07944A0036</RequestId>
</SetShowListBackgroundResponse>

JSON格式

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

{
  "RequestId" : "987DA143-A39C-5B5D-AF5B-3B07944A0036"
}

错误码

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