启动整个节目单。
接口说明
先通过 AddPlaylistItems 接口添加节目单项，再调用本接口启动整个节目单。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:StartPlaylist |
update |
*Domain
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| ProgramId |
string |
是 |
节目单 ID。如果您通过 AddPlaylistItems 接口添加节目单项，请查看 AddPlaylistItems 接口调用返回的参数 ProgramId 值。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
| ResumeMode |
string |
否 |
重启模式。取值：
|
Custom |
| StartItemId |
string |
否 |
起始节目单项 ID。启动轮播时将先播放此节目单项。 重要
如果 ResumeMode 参数设置为 Custom 时，此参数才必传。 |
asdfasdfasdf**** |
| Offset |
integer |
否 |
启动偏移。视频文件起始偏移值。仅对文件视频有效， 单位：毫秒。 大于 0，表示从相对于首帧的偏差时间作为开始读取的位置。 |
10000 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| ProgramId |
string |
节目单 ID。可作为停止节目单的请求参数。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
| RequestId |
string |
请求 ID。 |
5c6a2a0d-f228-4a64-af62-20e91b96**** |
| StreamInfo |
object |
返回的流信息。 |
|
| AppName |
string |
应用名称。 |
liveApp**** |
| DomainName |
string |
主播流域名。 |
example.com |
| StreamName |
string |
播流名称。 |
liveStream**** |
| Streams |
object |
||
| Stream |
array<object> |
流信息列表。 |
|
|
object |
|||
| PullFlvUrl |
string |
FLV 播流地址。 |
http://aliyundoc.com/caster/liveStream****.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c**** |
| PullM3U8Url |
string |
RTMP 播流地址。 |
rtmp:///aliyundoc.com/caster/liveStream****?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1**** |
| PullRtmpUrl |
string |
m3u8 播流地址。 |
http://aliyundoc.com/caster/liveStream****.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b**** |
| Quality |
string |
画质。取值： 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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | IncorrectSceneStatus | %s | |
| 400 | IncorrectCasterStatus | %s | |
| 400 | IncorrectSceneStatus.Inuse | %s | |
| 400 | InvalidProgramId.Malformed | %s | |
| 400 | InvalidParameter.Malformed | %s | |
| 400 | InvalidNormType.Malformed | %s | |
| 400 | InvalidParameter.Offset | %s | |
| 400 | InvalidParameter.StartItemId | %s | |
| 500 | InternalError | %s | |
| 403 | UserQuotaExceed | %s | |
| 404 | PlayListNotFound | %s | |
| 404 | PlayListItemNotFound | %s | |
| 404 | InvalidCaster.NotFound | %s | |
| 404 | InvalidCasterTemplate.NotFound | %s | |
| 404 | IncorrectCasterStatus.EnableChannel | %s |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。