StartPlaylist - 开始播放列表项

启动整个节目单。

接口说明

先通过 AddPlaylistItems 接口添加节目单项,再调用本接口启动整个节目单。

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:StartPlaylistupdate
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
ProgramIdstring

节目单 ID。如果您通过 AddPlaylistItems 接口添加节目单项,请查看 AddPlaylistItems 接口调用返回的参数 ProgramId 值。

445409ec-7eaa-461d-8f29-4bec2eb9****
ResumeModestring

重启模式。取值:

  • Restart:从头开始。
  • Continue:根据停止前播放位置继续。如果 ResumeMode 参数设置为 Custom 时,请求参数 StartItemId 才必填。
  • Custom:自定义。
Custom
StartItemIdstring

起始节目单项 ID。启动轮播时将先播放此节目单项。

注意 如果 ResumeMode 参数设置为 Custom 时,此参数才必传。

asdfasdfasdf****
Offsetinteger

启动偏移。视频文件起始偏移值。仅对文件视频有效, 单位:毫秒。

大于 0,表示从相对于首帧的偏差时间作为开始读取的位置。

10000

返回参数

名称类型描述示例值
object
ProgramIdstring

节目单 ID。可作为停止节目单的请求参数。

445409ec-7eaa-461d-8f29-4bec2eb9****
RequestIdstring

请求 ID。

5c6a2a0d-f228-4a64-af62-20e91b96****
StreamInfoobject

返回的流信息。

AppNamestring

应用名称。

liveApp****
DomainNamestring

主播流域名。

example.com
StreamNamestring

播流名称。

liveStream****
Streamsarray<object>

流信息列表。

Streamobject
PullFlvUrlstring

FLV 播流地址。

http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c****
PullM3U8Urlstring

RTMP 播流地址。

rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1****
PullRtmpUrlstring

m3u8 播流地址。

http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b****
Qualitystring

画质。取值: original:原画。

original

示例

正常返回示例

JSON格式

{
  "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****",
  "StreamInfo": {
    "AppName": "liveApp****",
    "DomainName": "example.com",
    "StreamName": "liveStream****",
    "Streams": {
      "Stream": [
        {
          "PullFlvUrl": "http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c****",
          "PullM3U8Url": "rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1****",
          "PullRtmpUrl": "http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b****",
          "Quality": "original"
        }
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息
400IncorrectSceneStatus%s
400IncorrectCasterStatus%s
400IncorrectSceneStatus.Inuse%s
400InvalidProgramId.Malformed%s
400InvalidParameter.Malformed%s
400InvalidNormType.Malformed%s
400InvalidParameter.Offset%s
400InvalidParameter.StartItemId%s
403UserQuotaExceed%s
404PlayListNotFound%s
404PlayListItemNotFound%s
404InvalidCaster.NotFound%s
404InvalidCasterTemplate.NotFound%s
404IncorrectCasterStatus.EnableChannel%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史