List of operations by function - ApsaraVideo Live - Alibaba Cloud Documentation Center

This topic lists the API operations of the production studio feature and provides relevant references.

The API operations of the production studio feature are categorized into the following types:

Manage production studios
Manage video sources
Manage layouts
Manage components
Manage episode lists and episodes
Manage scenes and audio configurations
Manage channels
Manage standby resources
Manage production studios in playlist mode

Manage production studios

Operation	Description
CreateCaster	Creates a production studio.
SetCasterConfig	Configures a production studio.
DescribeCasterConfig	Queries the configurations of a production studio.
DescribeCasters	Queries the list of production studios.
DescribeCasterStreamUrl	Queries the streaming URLs of a production studio.
CopyCaster	Duplicates a production studio.
StartCaster	Starts a production studio.
StopCaster	Stops a production studio.
DeleteCaster	Deletes a production studio.

Manage video sources

Operation	Description
AddCasterVideoResource	Adds an input source to a production studio.
ModifyCasterVideoResource	Modifies an input source of a production studio.
DeleteCasterVideoResource	Removes an input source from a production studio.
DescribeCasterVideoResources	Queries the input sources of a production studio.

Manage layouts

Operation	Description
AddCasterLayout	Adds a layout for a production studio.
ModifyCasterLayout	Modifies a layout of a production studio.
DeleteCasterLayout	Removes a layout of a production studio.
DescribeCasterLayouts	Queries a specified layout or all layouts of a production studio.

Manage components

Operation	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 the components of a production studio.

Manage episode lists and episodes

Table 1. Production studio in playlist mode (legacy)
Operation	Description
AddCasterEpisode	Adds an episode to a production studio.
ModifyCasterEpisode	Modifies the configurations of an episode in a production studio.
DeleteCasterEpisode	Removes an episode from a production studio.
AddCasterEpisodeGroup	Adds an episode list to a production studio.
DeleteCasterEpisodeGroup	Deletes an episode list from a production studio.
AddCasterEpisodeGroupContent	Adds information about an episode list in a production studio.

Table 2. Lightweight carousel playback
Operation	Description
AddPlaylistItems	Adds episodes to an episode list.
DeletePlaylistItems	Removes episodes from an episode list.
ListPlaylistItems	Queries the information about episodes in an episode list.
EditPlaylist	Updates episodes in an episode list.
DeletePlaylist	Deletes an episode list.
ListPlaylist	Queries the information about specified episode lists or all episode lists that belong to the current account.
StartPlaylist	Starts playing an episode list.
StopPlaylist	Stops playing an episode list.

Manage scenes and audio configurations

Operation	Description
CopyCasterSceneConfig	Copies the configuration of a PVW scene to a PGM scene.
DeleteCasterSceneConfig	Clears the configurations of a scene.
UpdateCasterSceneConfig	Modifies a scene of a production studio.
SetCasterSceneConfig	Sets all parameters, and configures and applies a layout for a scene of a production studio.
DescribeCasterScenes	Queries the scenes of a production studio.
UpdateCasterSceneAudio	Modifies the audio configurations of a scene.
DescribeCasterSceneAudio	Queries the audio configurations of a scene.
StartCasterScene	Starts a specified scene.
StopCasterScene	Stops a specified scene.

Manage channels

Operation	Description
SetCasterChannel	Configures a channel of a production studio.
DescribeCasterChannels	Queries the channels of a production studio.

Manage standby resources

Operation	Description
EffectCasterUrgent	Switches a PGM scene to the standby resource in a production studio.
EffectCasterVideoResource	Updates the standby resource in a specified scene.
CallBack	Add a production studio callback.

Manage production studios in playlist mode

Note

To use a production studio in playlist mode of the new version, you must use the following new API operations. The legacy API operations can be used for query.

Table 3. Production studio in playlist mode (new)
Operation	Description
AddShowIntoShowList	Adds an episode to an episode list.
RemoveShowFromShowList	Removes an episode from an episode list.
DescribeShowList	Queries the details of an episode list.
ModifyShowList	Modifies the attributes of an episode list.
PlayChoosenShow	Switches to a specified episode.
InitializeAutoShowListTask	Creates a scheduled task.
DescribeAutoShowListTasks	Queries scheduled tasks that are used to start and stop playing an episode list at specified points in time.
EditShowAndReplace	Adds an editing task.
GetEditingJobInfo	Queries editing tasks.

Table 4. Production studio in playlist mode (legacy)
Operation	Description
AddCasterProgram	Adds an episode list to a production studio.
ModifyCasterProgram	Modifies an episode list of a production studio.
DescribeCasterProgram	Queries the information about an episode list in a production studio.
DeleteCasterProgram	Deletes an episode list from a production studio.