Adds episodes to a production studio of the video carousel mode.

Usage note

If no episode list (program) exists in the production studio, this operation creates one for it.

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

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 you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response.

Notice The production studio must fulfill the following requirements when it was created:
  • NormType:3 which means the video carousel mode.
  • 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 to which you want to add the episodes. If you do not set this parameter, an episode list is created by default.

ProgramConfig String No [{"RepeatNumber":"0","ProgramName":"my program"}]

The configurations of the episode. If you add the episode to the streaming panel for the first time, this parameter is required to pass in the initial configurations. For more information, see the ProgramConfig section of this topic.

InputProgramItem

Parameter

Example

Type

Description

ItemName

item1

String

The name of the episode.

ResourceType

vod

String

The type of the episode resource. Valid value:

vod. Only video-on-demand (VOD) resources are supported.

ResourceValue

5f8809f2-3352-4d1f-a8f7-86f9429f****

String

The ID of the episode resource.

ProgramConfig

Parameter

Example

Type

Description

RepeatNumber

0

Integer

The number of times the episode repeats after the first playback is complete. Valid values:

0: specifies to play the episode only once. This is the default value.

-1: specifies to play the episode in loop mode.

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

ProgramName

myprogram

String

The name of the episode list to which you want to add the episode.

Response parameters

Parameter Type Example Description
Items Struct

The information about the episodes that you want to add.

FailedItems Array of FailedItem

The episodes that failed to be added.

ItemId String c09f3d63-eacf-4fbf-bd48-a07a6ba7****

The ID of the episode.

ItemName String item1

The name of the episode.

SuccessItems Array of SuccessItem

The episodes that were added.

ItemId String c09f3d63-eacf-4fbf-bd48-a07a6ba7****

The ID of the episode.

ItemName String item2

The name of the episode.

ProgramId String 445409ec-7eaa-461d-8f29-4bec2eb9****

The ID of the episode list to which the episodes were added. It can be used as a request parameter for deleting a episode, querying a episode, editing a episode list, deleting a episode list, querying a episode list, starting a episode list, and stopping a episode list.

RequestId String 5c6a2a0d-f228-4a64-af62-20e91b96****

The ID of the request.

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 

<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 

{
    "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, visit the API Error Center.