AddPlaylistItems
Region:
China (Beijing)
Request Parameters
Required
CasterIdThe ID of the produ...
ProgramItemsThe episodes that y...
ProgramIdThe ID of the episo...
ProgramConfigThe configurations ...
Plugin DownloadLearn more
VS Code Plugin
Before installing the plugin, please install VS CodeBefore installing the plugin, please install VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains Plugin
Before installing the plugin, please install JetBrains IDEBefore installing the plugin, please install JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

Operation Description

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.

Request Parameters

Field NameField Details
CasterIdstring

The ID of the production studio.View Details...

Example:0e94d1f4-1a65-445c-9dcf-de8b3b8d****Reference Value Source:
    CopyCaster
    AddCasterLayout
    CreateCaster
    DescribeCasters
    SetCasterConfig
    ModifyCasterEpisode
ProgramItemsstring

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.

Example:[{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}]Reference Value Source:
    ListPlaylistItems
ProgramIdstring

The ID of the episode list. If you do not specify this parameter, an episode list is created by default.

Example:445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramConfigstring

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.

Example:[{"RepeatNumber":"0","ProgramName":"my program"}]

Request Description

InputProgramItem

FieldExampleTypeDescription
ItemNameitem1StringThe name of the episode.
ResourceTypevodStringThe resource type. Valid values:vod: an ApsaraVideo VOD resource url: a video resource from a third party
ResourceValue5f8809f2-3352-4d1f-a8f7-86f9429f****StringIf 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

FieldExampleTypeDescription
RepeatNumber0IntegerThe 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.
ProgramNamemyprogramStringThe name of the episode list.

Response Parameters

Field NameField Details
Itemsobject

The information about the episodes.

ProgramIdstring

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.

Example:445409ec-7eaa-461d-8f29-4bec2eb9****
RequestIdstring

The request ID.

Example:5c6a2a0d-f228-4a64-af62-20e91b96****
Change History
No Change History found.