调用AddCasterProgram添加导播台节目单。

使用说明

请先创建导播台,添加导播台视频资源后再调用本接口添加导播台节目单。本接口目前只支持视频源和组件两种节点类型。使用API创建导播台,请参见创建导播台

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String AddCasterProgram

系统规定参数。取值:AddCasterProgram

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

导播台ID。

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

地域ID。

Episode.N.EpisodeType String Resource

节点类型。

  • Resource:视频源。如果选择Resource类型,必须同时设置请求参数Episode.N.ResourceId和Episode.N.SwitchType。
  • Component:组件。 如果选择Component类型,必须同时设置请求参数Episode.N.ComponentId.N。
Episode.N.EpisodeName String program_name_1

节目名称。

Episode.N.ResourceId String a2b8e671-2fe5-4642-a2ec-bf93880e****

视频源ID。

注意 当Episode.N.EpisodeType为Resource时,本参数有用且必传。

当Episode.N.EpisodeType为Component时,本参数不可用。

如果您通过AddCasterVideoResource接口添加导播台视频源,请查看AddCasterVideoResource接口调用返回的参数ResourceId值。

Episode.N.ComponentId.N RepeatList [ "a2b8e671-2fe5-4642-a2ec-bf931826****", "a2b8e671-2fe5-4642-a2ec-28374657****"]

组件列表。按照元素顺序由下而上排列。

注意 当Episode.N.EpisodeType为Component时,本参数有用且必传。

当节点类型为Resource时,表示组件与视频源绑定并同步切换。

Episode.N.StartTime String 2016-06-29T09:00:00Z

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Episode.N.EndTime String 2016-06-29T10:02:00Z

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Episode.N.SwitchType String TimeFirst

切换策略。取值:

注意 当Episode.N.EpisodeType为Resource时,本参数才有用。
  • TimeFirst:时间优先,直播类视频源只允许采用时间优先。
  • ContentFirst:内容优先。
说明

请求参数中的N表示第几个的意思。例如:

Episode.N.EpisodeName表示传入第几个节目名称。Episode.1.EpisodeName表示传入第1个节目名称,Episode.2.EpisodeName表示传入第2个节目名称。

返回数据

名称 类型 示例值 描述
EpisodeIds Array of EpisodeId

节目ID列表,列表中元素顺序和传入节目顺序保持一致。

EpisodeId
EpisodeId String [ "16A96B9A-F203-4EC5-8E43-CB92E68F****", "16A96B9A-F203-4EC5-8E43-CB92E688****" ]

节目组ID。可作为修改导播台节目单,查询导播台节目单,删除导播台节目,修改导播台节目的请求参数。

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddCasterProgram
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&<公共请求参数>

正常返回示例

XML格式

<AddCasterProgramResponse>
  <EpisodeIds>
        <EpisodeId>
              <EpisodeId>["bb9f1234-40fa-48c3-ac7a-e2e132c9****"]</EpisodeId>
        </EpisodeId>
  </EpisodeIds>
  <RequestId>44A7CD26-FFAF-4964-BF38-B3567C2C431A</RequestId>
</AddCasterProgramResponse>

JSON格式

{
    "AddCasterProgramResponse": {
        "EpisodeIds": {
            "EpisodeId": {
                "EpisodeId": "[\"bb9f1234-40fa-48c3-ac7a-e2e132c9****\"]"
            }
        },
        "RequestId": "44A7CD26-FFAF-4964-BF38-B3567C2C431A"
    }
}

错误码

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