StartPlaylist - ApsaraVideo Live - Alibaba Cloud Documentation Center

Starts playing an episode list.

Operation description

You can call the AddPlaylistItems operation to add episodes to an episode list and then call this operation to start playing the episode list.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:StartPlaylist	update	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProgramId	string	Yes	The ID of the episode list. If the episode list was created by calling the AddPlaylistItems operation, check the value of the response parameter ProgramId to obtain the ID.	445409ec-7eaa-461d-8f29-4bec2eb9****
ResumeMode	string	No	The method to resume the playback of the episode list. Valid values: Restart: resumes the playback from the beginning. Continue: resumes the playback from the position where the previous playback stops. The StartItemId parameter is required only if you set ResumeMode to Custom. Custom: resumes the playback from a custom position.	Custom
StartItemId	string	No	The ID of the first episode to play. This episode is the first to play in carousel playback. Note This parameter is required only if you set ResumeMode to Custom.	asdfasdfasdf****
Offset	integer	No	The offset of the position where the system starts the playback. This parameter takes effect only if the input source is a video file. Unit: milliseconds. A value greater than 0 indicates an offset from the first frame.	10000

Response parameters

Parameter	Type	Description	Example
	object
ProgramId	string	The ID of the episode list. You can use the ID as a request parameter in the API operation that is used to stop playing the episode list.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b96****
StreamInfo	object	The information about the live stream.
AppName	string	The name of the application.	liveApp****
DomainName	string	The main streaming domain.	example.com
StreamName	string	The name of the live stream.	liveStream****
Streams	array<object>	The streaming URLs.
Stream	object
PullFlvUrl	string	The streaming URL in the Flash Video (FLV) format.	http://aliyundoc.com/caster/liveStream**.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c**
PullM3U8Url	string	The streaming URL in the Real-Time Messaging Protocol (RTMP) format.	rtmp:///aliyundoc.com/caster/liveStream**?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1**
PullRtmpUrl	string	The streaming URL in the M3U8 format.	http://aliyundoc.com/caster/liveStream**.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b**
Quality	string	The video quality of the live stream. Valid values: original: original quality	original

Examples

Sample success responses

JSONformat

{
  "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"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message
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
403	UserQuotaExceed	%s
404	PlayListNotFound	%s
404	PlayListItemNotFound	%s
404	InvalidCaster.NotFound	%s
404	InvalidCasterTemplate.NotFound	%s
404	IncorrectCasterStatus.EnableChannel	%s
500	InternalError	%s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history