AddPlaylistItems - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

After you create a production studio with a layout and components, you can call this operation to add items to a playlist. If a playlist does not exist, a new one is created. For more information about how to create a production studio by calling an API operation, see Create a production studio.

QPS limit

The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed the limit, API calls are throttled. This may impact your business. We recommend that you call this operation at a reasonable rate.

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:AddPlaylistItems

create

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the value of the CasterId parameter that is returned. If you create a production studio in the ApsaraVideo Live console, go to ApsaraVideo Live console > Production Studio > Cloud Production Studio to view the name of the production studio. Note The name of the production studio in the list on the Cloud Production Studio page is the ID of the production studio. The production studio must have the following configurations: NormType: 3. You must create a lightweight carousel production studio. You can call the CreateCaster operation to create the studio. CasterTemplate: lp_noTranscode. channelEnable: 0. programEffect: 1.	0e94d1f4-1a65-445c-9dcf-de8b3b8d****
ProgramItems	string	Yes	The list of playlist items. This is a JSON string. For more information, see InputProgramItem.	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]
ProgramId	string	No	The playlist ID. If you leave this parameter empty, a new playlist is created.	445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramConfig	string	No	The playlist item configurations. If this is the first time you add items, pass this parameter for initialization. For more information, see ProgramConfig.	[{"RepeatNumber":"0","ProgramName":"my program"}]

InputProgramItem

Parameter	Example	Type	Description
ItemName	item1	String	The name of the playlist item.
ResourceType	vod	String	The resource type. Valid values: vod: an ApsaraVideo VOD resource. url: a third-party video resource.
ResourceValue	5f8809f2-3352-4d1f-a8f7-86f9429f****	String	If ResourceType is set to vod, ResourceValue is the media asset ID. If ResourceType is set to URL, ResourceValue is the URL of the third-party video.

ProgramConfig

Parameter	Example	Type	Description
RepeatNumber	0	Integer	The number of times to repeat playback after the item finishes. Valid values: 0 (default): Playback does not repeat. -1: Playback repeats in a loop. Other positive integers: The number of times to repeat playback.
ProgramName	myprogram	String	The name of the playlist.

Response parameters

Parameter	Type	Description	Example
	object
Items	object	The list of information about the added playlist items.
FailedItems	array<object>	The list of playlist items that failed to be added.
	object
ItemId	string	The ID of the playlist item.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the playlist item.	item1
SuccessItems	array<object>	The list of playlist items that were successfully added.
	object
ItemId	string	The ID of the playlist item.	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ItemName	string	The name of the playlist item.	item2
ProgramId	string	The playlist ID. You can use this ID as a request parameter to delete playlist items, query playlist items, edit a playlist, delete a playlist, query a playlist, start a playlist, or stop a playlist.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	The request ID.	5c6a2a0d-f228-4a64-af62-20e91b96****

Examples

Success response

JSON format

{
  "Items": {
    "FailedItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item1"
      }
    ],
    "SuccessItems": [
      {
        "ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "ItemName": "item2"
      }
    ]
  },
  "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidCasterId.Malformed	%s
400	PlayListIsEmpty	%s
400	MissInputParams	%s
400	InvalidProgramId.Malformed	%s
400	InvalidParameter.Malformed	%s
500	InternalError	%s
403	UserQuotaExceed	%s
404	InvalidCaster.NotFound	%s
404	InvalidDomainName.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.