AddPlaylistItems - ApsaraVideo Live

Usage notes

Create a production studio, add a layout and components to the production studio, and then call this operation to add episodes. If no episode list exists in the production studio, this operation creates an episode list for the production studio. For more information about how to create a production studio, see CreateCaster.

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. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	AddPlaylistItems	The operation that you want to perform. Set the value to AddPlaylistItems.
CasterId	String	Yes	0e94d1f4-1a65-445c-9dcf-de8b3b8d****	The ID of the production studio. If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID. If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Note You can find the ID of the production studio in the Instance Name column. The production studio must use the following configurations: NormType: 3. You need to call the CreateCaster operation to create a production studio for lightweight carousel playback in advance. CasterTemplate: lp_noTranscode. channelEnable: 0. programEffect: 1.
ProgramItems	String	Yes	[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f**"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c**"}]	The episodes that you want to add to the production studio. The value is a JSON string. For more information, see the InputProgramItem section of this topic.
ProgramId	String	No	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the episode list. If you do not specify this parameter, an episode list is created by default.
ProgramConfig	String	No	[{"RepeatNumber":"0","ProgramName":"my program"}]	The configurations of the episode list. If the episode list is added to the production studio for the first time, specify this parameter to pass in the initial configurations. For more information, see the ProgramConfig section of this topic.

InputProgramItem

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

ProgramConfig

Field	Example	Type	Description
RepeatNumber	0	Integer	The number of playbacks after the first playback is complete. Valid values: 0 (default): specifies that the episode list is played only once. -1: specifies that the episode list is played in loop mode. Positive integer: specifies the number of times the episode list repeats after the first playback is complete.
ProgramName	myprogram	String	The name of the episode list.

Field

Example

Type

Description

RepeatNumber

0

Integer

The number of playbacks after the first playback is complete. Valid values:

0 (default): specifies that the episode list is played only once.

-1: specifies that the episode list is played in loop mode.

Positive integer: specifies the number of times the episode list repeats after the first playback is complete.

ProgramName

myprogram

String

The name of the episode list.

Response parameters

Parameter	Type	Example	Description
ProgramId	String	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the episode list. You can use the ID as a request parameter in the API operation that is used to remove episodes, query episodes, edit an episode list, delete an episode list, query the information about an episode list, start playing an episode list, or stop playing an episode list.
RequestId	String	5c6a2a0d-f228-4a64-af62-20e91b96****	The request ID.
Items	Object		The information about the episodes.
SuccessItems	Array of SuccessItem		The episodes that were added.
ItemName	String	item2	The name of the episode.
ItemId	String	c09f3d63-eacf-4fbf-bd48-a07a6ba7****	The ID of the episode.
FailedItems	Array of FailedItem		The episodes that failed to be added.
ItemName	String	item1	The name of the episode.
ItemId	String	c09f3d63-eacf-4fbf-bd48-a07a6ba7****	The ID of the episode.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=AddPlaylistItems
&CasterId=0e94d1f4-1a65-445c-9dcf-de8b3b8d****
&ProgramItems=[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}]
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<AddPlaylistItemsResponse>
    <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>
    <Items>
        <FailedItems>
            <ItemName>item2</ItemName>
            <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>
        </FailedItems>
        <SuccessItems>
            <ItemName>item2</ItemName>
           <ItemId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ItemId>
        </SuccessItems>
    </Items>
    <ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>
</AddPlaylistItemsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.