AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 视频直播 开发参考 API参考 API目录 云导播 导播台管理 SetCasterConfig - 设置导播台配置

SetCasterConfig - 设置导播台配置

更新时间：
产品详情
我的收藏

调用本接口对导播台进行详细配置，包括导播台的名称、转码配置、录制配置等参数信息。

接口说明

先通过 CreateCaster 接口创建导播台，再调用本接口对导播台进行详细配置。此接口将会全面替换现有的配置信息，如果您将某个参数设置为空，则会清除该参数在导播台中的现有配置。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:SetCasterConfig

update

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

否

地域 ID。

cn-shanghai
CasterId

string

是

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台，请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。

说明

直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。

a2b8e671-2fe5-4642-a2ec-bf93880e****
CasterName

string

否

导播台名称。

liveCaster****
DomainName

string

否

主播流域名。

请您在导播台启动前完成域名配置。 若该参数为空，默认清除导播台域名配置。

example.com
TranscodeConfig

string

否

转码配置。

JSON 格式字符串，结构体内部字段请按首字母大写，驼峰格式输入。 若该参数设置为空，默认清除转码配置， 当转码模板为空的时候，导播台启动时会报错。

{"casterTemplate": "lp_ld"}
RecordConfig

string

否

录制配置信息。格式为 JSON。配置元素信息如下：

  • endpoint：阿里云服务的 API 服务端地址。

  • ossBucket：ossBucket 名称。

  • videoFormat：支持导出的视频文件格式，例如：[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}]。

  • interval：时间间隔，单位为毫秒（ms）。

说明

参数设置为空时表示不启用录制功能。 若该参数置为空，默认清除录制配置。

{ "endpoint": "http://oss-cn-********.aliyuncs.com/api", "ossBucket****": "liveBucket****", "VideoFormat":[{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"m3u8\",\"CycleDuration\":21600,\"SliceOssObjectPrefix\":\"record/{AppName}/{StreamName}/{UnixTimestamp}\"},{\"OssObjectPrefix\":\"record/{AppName}/{StreamName}/{StartTime}_{EndTime}\",\"Format\":\"flv\",\"CycleDuration\":21600}] "interval": 5 }
Delay

number

否

延时播放。时间单位：秒。

  • 0（默认值）：禁用延时。

  • 大于 0：启用延时。

  • 空：默认清除延播配置。

说明

最大可支持设置 300 秒。

0
UrgentMaterialId

string

否

备播视频，媒资库素材 ID。若该参数置为空，默认清除备播配置。

a2b8e671
UrgentLiveStreamUrl

string

否

备播直播流 URL。

rtmp://demo.aliyundoc.com
SideOutputUrl

string

否

用户自定义导播台旁路输出地址对应的推流地址。 若该参数为空，则默认使用阿里云自动生成的输出地址对应的推流地址。

说明

目前 sideoutputUrl 只支持 rtmp 协议推流。

rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
SideOutputUrlList

string

否

多路转推流地址列表，可以是阿里云或第三方厂商的 CDN 推流地址，一个导播台最多支持添加 20 个 RTMP 转推地址。

说明

多个地址用["rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"]数组格式。

rtmp://domain/app/stream?***
CallbackUrl

string

否

用户回调地址。若需要接收回调通知，请输入可用的接收地址，接受 HTTP 协议。 若该参数置为空，默认取消导播台回调通知。

说明

导播台回调详细信息，请参见云导播回调信息说明。

http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****
ProgramEffect

integer

否

轮播生效标志。

  • 0：不生效。

  • 1：生效。

1
ProgramName

string

否

轮播台名称，若使用轮播功能时可配置。

program_name
ChannelEnable

integer

否

是否启用 Channel。

  • 0（默认）：不启用。

  • 1：启用。

说明

默认不启用，且启用后不可取消；不启用时 Resource 直接被布局引用，首次开启 Channel 需要在导播台停止的状态下进行，之前已存在的布局将被废弃，Resource 需要首先设置到 Channel 中，新增的布局直接引用 Channel，通过 Channel 可调整视频源播放进度和播放状态，该模式下视频源、PVW、PGM 三区域若引用同一 Resource，则对应画面将保持同步。

1
SyncGroupsConfig

string

否

多视角同步配置，让多个视频源同步。 多视角同步分为两个模式：

  • mode: 0（主播模式，多个视频源根据指定的模式同步。）

  • mode: 1（会议模式，没有主播视频的概念，所有视频源相互同步。）

主播模式：hostResourceId：主播模式下的主播视频源

会议模式：没有 hostRsoureId 字段，只提供需要提供的 resourceIds 中的资源 ids

"[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a****\",\"4e6521dc-a40a-4077-b6bf-1fb12a76****\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4****\"}]"
UrgentImageId

string

否

备播媒资库图片素材 ID。

a089175eb5f4427684fc0715159a****
UrgentImageUrl

string

否

备播图片素材 URL。

http://learn.aliyundoc.com/AppName/image.jpg
AutoSwitchUrgentOn

boolean

否

开启断流自动切换备播。

  • true：开启。

  • false：关闭。

true
AutoSwitchUrgentConfig

string

否

自动切备播配置。 eofThres：表示断流时间后自动切备播，单位为秒。

{"eofThres":3}

返回参数

名称

类型

描述

示例值

object

CasterId

string

导播台 ID。可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。

b4810848-bcf9-4aef-bd4a-e6bba2d9****
RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

{
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidUserId.Malformed %s
400 InvalidCasterId.Malformed %s
400 InvalidParameter.Malformed %s
400 IncorrectCasterStatus.Inuse %s
400 InvalidCaster.ChannelDisableUnsupported %s
400 IncorrectCasterStatus.EnableChannel %s
400 MissingParameter %s
500 InternalError %s
403 PermissionDenied %s
404 InvalidCaster.NotFound %s
404 InvalidDomainName.NotFound %s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：CreateCaster - 创建导播台下一篇：DescribeCasterConfig - 查询导播台配置