Production Studio API overview-ApsaraVideo Live(LIVE)-阿里云帮助中心

This topic describes the API operations for Production Studio, which are grouped by function. It also provides a description of and a link to the documentation for each API operation.

The API operations for Production Studio are grouped by function:

Production studio management
Input source media management
Layout management
Component management
Program and program list management
Scenario and audio management
Channel management
Standby management
Playlist-mode production studio management
Virtual studio management

Production studio management

API	Description
CreateCaster	Creates a production studio.
SetCasterConfig	Configure the production studio
DescribeCasterConfig	Queries the configurations of a production studio.
DescribeCasters	Queries a list of production studios.
DescribeCasterStreamUrl	Queries the stream URL of a production studio.
CopyCaster	Copies a production studio.
StartCaster	Starts a production studio.
StopCaster	Stops a production studio.
DeleteCaster	Deletes a production studio.

Input source media management

API	Description
AddCasterVideoResource	Adds a video resource to a production studio.
ModifyCasterVideoResource	Modifies a video source of a production studio.
DeleteCasterVideoResource	Deletes a video source from a production studio.
DescribeCasterVideoResources	Queries the video sources of a production studio.

Layout management

API	Description
AddCasterLayout	Adds a layout to a production studio.
ModifyCasterLayout	You can modify the production studio layout.
DeleteCasterLayout	Deletes a layout from a production studio.
DescribeCasterLayouts	Queries a list of layouts for a production studio.

Component management

API	Description
AddCasterComponent	Adds a component to a production studio.
ModifyCasterComponent	Modifies a component of a production studio.
DeleteCasterComponent	Deletes a component from a production studio.
DescribeCasterComponents	Queries a list of components for a production studio.

Program and program list management

Table 1. Legacy playlist mode API operations
API	Description
AddCasterEpisode	Adds a program to a production studio.
ModifyCasterEpisode	Modifies a program of a production studio.
DeleteCasterEpisode	Deletes a program from a production studio.
AddCasterEpisodeGroup	Adds a program list to a production studio.
DeleteCasterEpisodeGroup	Deletes a program list from a production studio.
AddCasterEpisodeGroupContent	Adds information to a program list of a production studio.

Table 2. Lightweight carousel API operations
API	Description
AddPlaylistItems	Creating or adding a playlist item
DeletePlaylistItems	Delete an item from the program list
ListPlaylistItems	Queries items in a playlist.
EditPlaylist	Edits a playlist.
DeletePlaylist	Deletes a playlist.
ListPlaylist	Queries a playlist.
StartPlaylist	Starts a playlist.
StopPlaylist	Stops a playlist.

Scenario and audio management

API	Description
CopyCasterSceneConfig	Copies the scenario configurations of a production studio.
DeleteCasterSceneConfig	Deletes the scenario configurations of a production studio.
UpdateCasterSceneConfig	Updates the scenario configurations of a production studio.
SetCasterSceneConfig	Full scenario configuration settings
DescribeCasterScenes	Queries a list of scenarios for a production studio.
UpdateCasterSceneAudio	Updates the audio configurations of a scenario.
DescribeCasterSceneAudio	Queries the audio configurations of a scenario in a production studio.
StartCasterScene	Starts a scenario.
StopCasterScene	Stops a scenario.

Channel management

API	Description
SetCasterChannel	Sets a slot for a production studio.
DescribeCasterChannels	Queries the slots of a production studio.

Standby management

API	Description
EffectCasterUrgent	Switches to the standby stream of a production studio.
EffectCasterVideoResource	Updates the standby file of a production studio.
CallBack	Adds a callback.

Playlist-mode production studio management

Note

Use the new API operations for new playlist services. The legacy playlist API operations can be used for queries.

Table 3. New playlist-mode production studio API operations
API	Description
AddShowIntoShowList	Adds a show to a show list.
RemoveShowFromShowList	Removes a show from a show list.
DescribeShowList	Queries a show list.
ModifyShowList	Modifies the properties of a playlist.
PlayChoosenShow	Manually switches shows.
InitializeAutoShowListTask	Creates a scheduled task.
DescribeAutoShowListTasks	Queries scheduled tasks for automatic start and stop.
EditShowAndReplace	Adds a video editing task.
GetEditingJobInfo	Queries a video editing task.

Table 4. Legacy playlist-mode production studio API operations
API	Description
AddCasterProgram	Adds a program list to a production studio.
ModifyCasterProgram	Modifies a program list of a production studio.
DescribeCasterProgram	Queries a program list of a production studio.
DeleteCasterProgram	Deletes a program list from a production studio.

Virtual studio management

API	Description
AddStudioLayout	Adds a virtual studio layout.
AddStudioLayout	Deletes a virtual studio layout.
DescribeStudioLayouts	Queries virtual studio layouts.
ModifyStudioLayout	Modifies a virtual studio layout.