导播服务提供了一系列API接口,可以分为导播台创建与配置、视频内容编辑、视频内容输出、查询和管理等五大类,另外还提供轻量级轮播API接口。

接入导播服务

架构您可通过调API接口快速接入并使用导播服务,流程如下:
  1. 创建(CreateCaster)和配置导播台(SetCasterConfig)。
  2. 添加导播视频资源(AddCasterVideoResource)。
  3. 添加导播台布局(AddCasterLayout)。
  4. 启动导播台(StartCaster)。
  5. 停止导播台(StopCaster)。

通用导播台API列表

核心接口
API 描述
CreateCaster 创建导播台
SetCasterConfig 配置导播台
AddCasterVideoResource 添加视频源
SetCasterChannel 设置导播台通道
AddCasterLayout 添加导播台布局
AddCasterComponent 添加导播台组件
StartCaster 启动导播台
UpdateCasterSceneConfig 更新导播场景配置
CopyCasterSceneConfig 复制导播场景配置
DescribeCasterStreamUrl 查询导播台流地址
DescribeCasters 查询导播台列表
StopCaster 停止导播台
DeleteCaster 删除导播台
常用接口
API 描述
ModifyCasterVideoResource 修改视频源
DeleteCasterVideoResource 删除视频源
DescribeCasterVideoResources 查询视频源
ModifyCasterLayout 修改导播台布局
DeleteCasterLayout 删除导播台布局
DescribeCasterLayouts 查询导播台布局列表
ModifyCasterComponent 修改导播台组件
DeleteCasterComponent 删除导播台组件
DescribeCasterComponents 查询导播台组件列表
DescribeCasterConfig 查询导播台配置
DescribeCasterScenes 查询导播台场景列表
SetCasterSceneConfig 设置场景配置
DeleteCasterSceneConfig 删除导播台场景配置
StopCasterScene 停止场景
StartCasterScene 启动场景
UpdateCasterSceneAudio 更新场景音频配置
DescribeCasterSceneAudio 查询导播台场景音频配置
DescribeCasterChannels 查询导播台通道
CopyCaster 复制导播台
EffectCasterVideoResource 更新备播片
EffectCasterUrgent 切换备播
CallBack 添加回调
其他接口
API 描述
ModifyCasterEpisode 修改导播台节目
DeleteCasterEpisodeGroup 删除导播台节目列表
DeleteCasterEpisode 删除导播台节目
AddCasterEpisodeGroupContent 添加节目列表内容
AddCasterEpisodeGroup 添加导播台节目列表
AddCasterEpisode 添加导播台节目
说明 如果需要使用节目功能,推荐使用播单型导播台API。

播单型导播台API列表

API 描述
AddCasterProgram 添加导播台节目单
ModifyCasterProgram 修改导播台节目单
DescribeCasterProgram 查询导播台节目单
DeleteCasterProgram 删除导播台节目单

轻量级轮播API列表

API 描述
AddPlaylistItems 创建或添加节目单项
DeletePlaylistItems 删除节目单项
ListPlaylistItems 查询节目单项
EditPlaylist 编辑节目单
DeletePlaylist 删除节目单
ListPlaylist 查询节目单
StartPlaylist 启动节目单
StopPlaylist 停止节目单