云直播 云导播 API 概览

这里说明云导播 API 的功能分组、接口描述以及提供接口文档参考。云导播 API 可帮助你实现对云导播台的控制和管理,从而简化直播制作流程并提高工作效率。

相关产品
云直播 产品页,含版本规格、价格与购买入口。

云导播 API 可以分为以下几个功能分组:

·导播台列表页

·获取导播台详细配置信息

·查询导播台当前的预监、主监信息

·获取导播台输入源、预监、主监的预览链接

·添加、修改、删除输入源

·添加、修改、删除布局

·添加、修改、删除推流配置

·添加、修改、删除水印

·添加、修改、删除文本

·修改主监配置

·启动、修改、停止预监

·启动、修改、停止主监

·进阶功能

一、导播台列表页

API 描述
DescribeCasterList 查询导播台列表
CreateCaster 创建导播台
ModifyCaster 修改导播台
DeleteCaster 删除导播台
CopyCaster 复制导播台

二、获取导播台详细配置信息

API 描述
DescribeCaster 查询导播台信息
DescribeCasterInputInfos 查询导播台输入源列表
DescribeCasterOutputInfos 查询导播台的推流信息列表
DescribeCasterLayoutInfos 查询导播台布局列表
DescribeCasterMarkPicInfos 查询导播台水印信息列表
DescribeCasterMarkWordInfos 查询导播台文本配置列表
DescribeCasterTransitionTypes 获取导播台转场列表

三、查询导播台当前的预监、主监信息

API 描述
DescribeCasterDisplayInfo 查询导播台展示信息

四、获取导播台输入源、预监、主监的预览链接

API 描述
DescribeCasterPlayUrl 获取导播台视频流播放url
 获取预监(PVW)预览链接
 获取主监(PGM)预览链接

七、添加直播推流URL

API 描述
CreateCasterInputPushUrl 生成导播台推流URL(获取推流URL)
AddCasterInputInfo 新增导播台输入源(将推流URL添加到输入源中)

八、添加直播拉流URL

API 描述
AddCasterInputInfo 添加直播拉流URL

九、添加点播URL

API 描述
AddCasterInputInfo 添加点播URL

十、添加图片URL

API 描述
AddCasterInputInfo 添加图片URL

十一、修改输入源

API 描述
ModifyCasterInputInfo 修改导播台输入源

十二、删除输入源

API 描述
DeleteCasterInputInfo 删除导播台输入源

十四、添加布局

API 描述
AddCasterLayoutInfo 新增导播台布局(添加模板布局)
 添加自定义布局
 添加色度抠像布局
 添加AI抠像布局

十五、修改布局

API 描述
ModifyCasterLayoutInfo 修改导播台布局(修改布局)

十六、删除布局

API 描述
DeleteCasterLayoutInfo 删除导播台布局(删除布局)

十八、添加推流配置

API 描述
AddCasterOutputInfo 新增导播台推流信息(添加推流到腾讯云)
 添加推流到第三方

十九、修改推流配置

API 描述
ModifyCasterOutputInfo 修改导播台推流信息(修改推流到腾讯云配置)
 修改推流到第三方配置

20、删除推流配置

API 描述
DeleteCasterOutputInfo 删除导播台推流信息

22、添加水印

API 描述
AddCasterMarkPicInfo 新增导播台水印信息(添加水印,位置使用百分比信息)
 添加水印,位置使用精确像素信息

23、修改水印

API 描述
ModifyCasterMarkPicInfo 修改导播台水印信息(修改水印)

24、删除水印

API 描述
DeleteCasterMarkPicInfo 删除导播台水印信息(删除水印)

26、添加文本

API 描述
AddCasterMarkWordInfo 新增导播台文本配置(添加普通类型固定文本)
 添加普通类型滚动文本
 添加时钟

27、修改文本

API 描述
ModifyCasterMarkWordInfo 修改导播台文本配置(修改文本)

28、删除文本

API 描述
DeleteCasterMarkWordInfo 删除导播台文本配置(删除文本)

29、修改主监配置

API 描述
ModifyCaster 修改主监配置

31、启动预监

API 描述
CreateCasterPvw 创建导播台预监任务(启动单画面布局预监)
 启动普通布局预监
 启动预监时使用水印
 启动预监时使用文本

32、修改预监

API 描述
CreateCasterPvw 切换预监布局
 切换预监布局,画面切换时使用转场

33、停止预监

API 描述
StopCasterPvw 停止导播台预监任务(停止预监)

35、启动主监

API 描述
CreateCasterPgmFromPvw 复制导播台预监展示信息创建主监任务(复制预监配置启动主监)
 复制预监配置启动主监,启动时单画面输入源从头开始播放
CreateCasterPgm 创建导播台主监任务(单独启动主监)
 单独启动主监,启动时单画面输入源从头开始播放

36、修改主监

API 描述
CreateCasterPgm 切换主监布局
 修改主监布局,画面切换时使用转场
 修改主监,切换到单画面输入源时,从头开始播放

37、停止主监

API 描述
StopCasterPgm 停止导播台主监任务

39、音视频不同步切换

API 描述
CreateCasterPgm 音视频不同步切换

40、断流时设置备播

API 描述
AddCasterInputInfo 新增断流时备播视频
 新增断流时备播图片

41、字幕功能

API 描述
AddCasterMarkWordInfo 添加固定显示字幕
 添加单次滚动字幕

42、调整输入源音量

API 描述
ModifyCasterInputInfo 调整输入源音量

43、释放导播台

API 描述
ReleaseCaster 释放导播台
赞 (0)
上一篇 4天前
下一篇 4天前