This topic lists the API operations of the production studio feature and provides references.
The API operations of the production studio feature are categorized into the following
types:
Manage production studios
Operation | Description |
---|---|
CreateCaster | Creates a production studio. |
SetCasterConfig | Sets all parameters for a production studio. |
DescribeCasterConfig | Queries the configurations of a production studio. |
DescribeCasters | Queries the information about 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
API | Description |
---|---|
AddCasterVideoResource | Adds a video resource to a production studio. |
ModifyCasterVideoResource | Modifies a video resource of a production studio. |
DeleteCasterVideoResource | Removes a video resource from a production studio. |
DescribeCasterVideoResources | Queries the video resources of a production studio. |
Manage layouts
API | 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
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 the components of a streaming panel. |
Manage episode lists and episodes
API | 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 to a production studio. |
DeleteCasterEpisodeGroup | Deletes an episode list from a production studio. |
AddCasterEpisodeGroupContent | Adds an episode list to a production studio. |
API | Description |
---|---|
AddPlaylistItems | Adds episodes to a production studio of the video carousel mode. |
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 playback for an episode list. |
StopPlaylist | Stops playback for an episode list. |
Manage scenes and audio configurations
API | 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 information about a scene 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
API | Description |
---|---|
SetCasterChannel | Configures a channel of a production studio. |
DescribeCasterChannels | Queries the channels of a production studio. |
Manage standby videos
API | Description |
---|---|
EffectCasterUrgent | Switches a program scene to a standby video in a production studio. |
EffectCasterVideoResource | Updates the standby video resource in a specified scene. |
CallBack | Add a production studio callback. |
Manage carousel playback
Note You must use the new API operations for newly added production studios in playlist
mode. The phased out API operations are listed for compatibility only.
API | Description |
---|---|
AddShowIntoShowList | Adds an episode to an episode list. |
RemoveShowFromShowList | Removes a specified episode from an episode list. |
DescribeShowList | Queries the details of an episode list. |
ModifyShowList | Modifies the attributes of a playlist. |
PlayChoosenShow | Switches to a specified episode. |
API | 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 | Removes an episode list from a production studio. |