StartPlaylist - ApsaraVideo Live - Alibaba Cloud Documentation Center

Starts a playlist.

Operation description

Call the AddPlaylistItems operation to add items to a playlist. Then, call this operation to start the playlist.

QPS limit

This operation has a queries per second (QPS) limit of 10 for each user. If you exceed this limit, your API calls are throttled, which may affect your business. Call this operation within the specified limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:StartPlaylist

update

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
ProgramId	string	Yes	The ID of the playlist. If you add items to the playlist by calling the AddPlaylistItems operation, use the value of the ProgramId parameter that is returned.	445409ec-7eaa-461d-8f29-4bec2eb9****
ResumeMode	string	No	The restart mode. Valid values: Restart: Starts from the beginning. Continue: Resumes playback from where it was stopped. The StartItemId parameter is required only when you set the ResumeMode parameter to Custom. Custom: Custom start point.	Custom
StartItemId	string	No	The ID of the item to play first. When the carousel starts, this item is played. Important This parameter is required only when you set ResumeMode to Custom.	asdfasdfasdf****
Offset	integer	No	The start offset for the video file. This parameter is valid only for video files. Unit: milliseconds. A value greater than 0 specifies the start time relative to the first frame.	10000

Response parameters

Parameter	Type	Description	Example
	object
ProgramId	string	The ID of the playlist. You can use this ID as a request parameter to stop the playlist.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b96****
StreamInfo	object	The information about the stream.
AppName	string	The application name.	liveApp****
DomainName	string	The streaming domain.	example.com
StreamName	string	The stream name.	liveStream****
Streams	object
Stream	array<object>	The list of stream information.
	object
PullFlvUrl	string	The FLV streaming URL.	http://aliyundoc.com/caster/liveStream**.flv?auth_key=1612772224-0-0-3632be7cd9907169e8b09e91099c**
PullM3U8Url	string	The RTMP streaming URL.	rtmp:///aliyundoc.com/caster/liveStream**?auth_key=1612772224-0-0-4404ca59c0246226d49d01f734b1**
PullRtmpUrl	string	The M3U8 streaming URL.	http://aliyundoc.com/caster/liveStream**.m3u8?auth_key=1612772224-0-0-919a023a127156fe82e3562c3b3b**
Quality	string	The video quality. Valid value: original: original quality.	original

Examples

Success response

JSON format

{
  "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
500	InternalError	%s
403	UserQuotaExceed	%s
404	PlayListNotFound	%s
404	PlayListItemNotFound	%s
404	InvalidCaster.NotFound	%s
404	InvalidCasterTemplate.NotFound	%s
404	IncorrectCasterStatus.EnableChannel	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.