本文提供云导播API的功能分组、接口描述以及接口文档参考。

导播台管理

API 描述
CreateCaster 创建导播台
SetCasterConfig 设置导播台配置
DescribeCasterConfig 查询导播台配置
DescribeCasters 查询导播台列表
DescribeCasterStreamUrl 查询导播台流地址
CopyCaster 复制导播台
StartCaster 启动导播台
StopCaster 停止导播台
DeleteCaster 删除导播台

输入源媒体管理

API 描述
AddCasterVideoResource 添加导播台视频资源
ModifyCasterVideoResource 修改导播台视频源
DeleteCasterVideoResource 删除导播台视频源
DescribeCasterVideoResources 查询导播台视频源

布局管理

API 描述
AddCasterLayout 添加导播台布局
ModifyCasterLayout 修改导播台布局
DeleteCasterLayout 删除导播台布局
DescribeCasterLayouts 查询导播台布局列表

组件管理

API 描述
AddCasterComponent 添加导播台组件
ModifyCasterComponent 修改导播台组件
DeleteCasterComponent 删除导播台组件
DescribeCasterComponents 查询导播台组件列表

节目单与节目管理

表 1. (旧)播单型API
API 描述
AddCasterEpisode 添加导播台节目
ModifyCasterEpisode 修改导播台节目
DeleteCasterEpisode 删除导播台节目
AddCasterEpisodeGroup 添加导播台节目列表
DeleteCasterEpisodeGroup 删除导播台节目列表
AddCasterEpisodeGroupContent 添加导播台节目列表信息
表 2. 轻量级轮播API
API 描述
AddPlaylistItems 创建或添加节目单项
DeletePlaylistItems 删除节目单项
ListPlaylistItems 查询节目单项
EditPlaylist 编辑节目单
DeletePlaylist 删除节目单
ListPlaylist 查询节目单
StartPlaylist 启动节目单
StopPlaylist 停止节目单

场景与音频管理

API 描述
CopyCasterSceneConfig 复制导播场景配置
DeleteCasterSceneConfig 删除导播台场景配置
UpdateCasterSceneConfig 更新导播场景配置
SetCasterSceneConfig 全量设置场景配置
DescribeCasterScenes 查询导播台场景列表
UpdateCasterSceneAudio 更新场景音频配置
DescribeCasterSceneAudio 查询导播台场景音频配置
StartCasterScene 启动场景
StopCasterScene 停止场景

通道管理

API 描述
SetCasterChannel 设置导播台通道
DescribeCasterChannels 查询导播台通道

备播管理

API 描述
EffectCasterUrgent 切换导播台备播
EffectCasterVideoResource 更新导播台备播片
CallBack 添加回调

轮播台管理

说明 新播单服务接入需使用新API接口,旧播单API服务可作查询使用。
表 3. 新播单型导播台API
API 描述
AddShowIntoShowList 添加一个节目到节目单
RemoveShowFromShowList 删除节目单的一个节目
DescribeShowList 查询节目单
ModifyShowList 修改播单属性
PlayChoosenShow 手动切换节目
InitializeAutoShowListTask 创建一个定时任务
DescribeAutoShowListTasks 查询自动启停的定时任务
EditShowAndReplace 添加剪辑任务
GetEditingJobInfo 查询剪辑任务
表 4. (旧)播单型导播台API
API 描述
AddCasterProgram 添加导播台节目单
ModifyCasterProgram 修改导播台节目单
DescribeCasterProgram 查询导播台节目单
DeleteCasterProgram 删除导播台节目单