调用StartPlaylist启动整个节目单。
使用说明
先通过AddPlaylistItems接口添加节目单项,再调用本接口启动整个节目单。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | StartPlaylist |
系统规定参数。取值: StartPlaylist。 |
ProgramId | String | 是 | 445409ec-7eaa-461d-8f29-4bec2eb9**** |
节目单ID。如果您通过AddPlaylistItems接口添加节目单项,请查看AddPlaylistItems接口调用返回的参数ProgramId值。 |
RegionId | String | 否 | cn-shanghai |
地域ID。 |
ResumeMode | String | 否 | Custom |
重启模式。取值:
|
StartItemId | String | 否 | asdfasdfasdf**** |
起始节目单项ID。启动轮播时将先播放此节目单项。 注意 如果ResumeMode参数设置为Custom时,此参数才必传。
|
Offset | Integer | 否 | 10000 |
启动偏移。视频文件起始偏移值。仅对文件视频有效, 单位:毫秒。 大于0,表示从相对于首帧的偏差时间作为开始读取的位置。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ProgramId | String | 445409ec-7eaa-461d-8f29-4bec2eb9**** |
节目单ID。可作为停止节目单的请求参数。 |
RequestId | String | 5c6a2a0d-f228-4a64-af62-20e91b96**** |
请求ID。 |
StreamInfo | Struct |
返回的流信息。 |
|
AppName | String | liveApp**** |
应用名称。 |
DomainName | String | example.com |
主播流域名。 |
StreamName | String | liveStream**** |
播流名称。 |
Streams | Array of Stream |
流信息列表。 |
|
Stream | |||
PullFlvUrl | String | http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c**** |
FLV播流地址。 |
PullM3U8Url | String | rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1**** |
RTMP播流地址。 |
PullRtmpUrl | String | http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b**** |
m3u8播流地址。 |
Quality | String | original |
画质。取值: original:原画。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=StartPlaylist
&ProgramId=445409ec-7eaa-461d-8f29-4bec2eb9****
&<公共请求参数>
正常返回示例
XML
格式
<StartPlaylistResponse>
<RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>
<StreamInfo>
<StreamName>liveStream****</StreamName>
<DomainName>example.com</DomainName>
<AppName>liveApp****</AppName>
<Streams>
<Stream>
<PullFlvUrl>http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c****</PullFlvUrl>
<PullM3U8Url>rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1****</PullM3U8Url>
<Quality>original</Quality>
<PullRtmpUrl>http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b****</PullRtmpUrl>
</Stream>
</Streams>
</StreamInfo>
<ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>
</StartPlaylistResponse>
JSON
格式
{
"StartPlaylistResponse": {
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****",
"StreamInfo": {
"StreamName": "liveStream****",
"DomainName": "example.com",
"AppName": "liveApp****",
"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****",
"Quality": "original",
"PullRtmpUrl": "http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b****"
}
}
},
"ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****"
}
}
错误码
访问错误中心查看更多错误码。