文档

API调用

更新时间:

本文提供通过API使用虚拟演播厅的流程及API参考。

说明

导播台虚拟演播厅功能从2023年04月01日00:00起正式开始商业化收费,计费详情请参见云导播费用

如果您不需要使用该服务,请在商业化收费前,停止使用虚拟演播厅直播,以免产生费用。

前提条件

背景信息

  • 导播服务提供了一系列API接口,支持对虚拟演播厅布局添加、删除、查询、修改等操作内容。您可以参考本文了解如何使用API接口快速接入虚拟演播厅服务。

  • 如需使用控制台完成虚拟演播厅进行视频直播,请参见控制台操作指南

API操作指引

您可通过调用API接口快速接入并使用虚拟演播厅服务,流程如下:

  1. 创建并配置导播台,类型需选择虚拟演播厅。调用接口,请参见CreateCaster SetCasterConfig

  2. 添加导播视频资源,调用接口,请参见AddCasterVideoResource

  3. 添加虚拟演播厅布局,调用接口,请参见AddStudioLayout

  4. (可选)添加导播台组件,调用接口,请参见AddCasterComponent

  5. 启动导播台,调用接口,请参见StartCaster

  6. 设置播放场景,调用接口,请参见SetCasterSceneConfig

  7. 停止导播台,调用接口,请参见StopCaster

API参考

您可以根据自身需求完善对导播台的视频内容编辑、内容输出、配置和管理等。相关接口,请参见云导播API概览

  • 本页导读 (1)
文档反馈