全部产品
Search

搜索本产品

    视频直播：设置导播台配置

    文档中心

    视频直播：设置导播台配置

    更新时间：Nov 23, 2023

    调用SetCasterConfig配置导播台。

    使用说明

    先通过CreateCaster接口创建导播台，再调用本接口配置导播台。全量覆盖配置信息，若指定参数置为空则清除导播台该项配置。

    QPS限制

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

    调试

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

    请求参数

    名称

    类型

    是否必选

    示例值

    描述
    Action String 是 SetCasterConfig

    系统规定参数。取值：SetCasterConfig。
    CasterId String 是 a2b8e671-2fe5-4642-a2ec-bf93880e****

    导播台ID。

    • 如果您通过CreateCaster接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。
    • 如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。
    说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
    CasterName String 否 liveCaster****

    导播台名称。
    DomainName String 否 example.com

    主播流域名。

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

    TranscodeConfig String 否 {"casterTemplate": "lp_ld"}

    转码配置。

    JSON格式字符串，结构体内部字段请按首字母大写，驼峰格式输入。 若该参数设置为空，默认清除转码配置， 当转码模板为空的时候，导播台启动时会报错。
    RecordConfig String 否 { "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 }

    录制配置信息。格式为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）。
    说明 参数设置为空时表示不启用录制功能。 若该参数置为空，默认清除录制配置。
    Delay Float 否 0

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

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

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

      说明 最大可支持设置300秒。
    UrgentMaterialId String 否 a2b8e671

    备播视频，媒资库素材ID。若该参数置为空，默认清除备播配置。
    UrgentLiveStreamUrl String 否 rtmp://demo.aliyundoc.com

    备播直播流URL。
    SideOutputUrl String 否 rtmp://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****

    用户自定义导播台旁路输出地址对应的推流地址。

    若该参数为空，则默认使用阿里云自动生成的输出地址对应的推流地址。

    说明 目前sideoutputUrl只支持rtmp协议推流。
    SideOutputUrlList String 否 rtmp://domain/app/stream?***

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

    说明 多个地址用"rtmp://domain/app1/stream1","rtmp://domain/app2/stream2"数组格式。
    CallbackUrl String 否 http://****/aliyundoc.com:8000/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f****

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

    ProgramEffect Integer 否 1

    轮播生效标志。

    • 0：不生效。
    • 1：生效。
    ProgramName String 否 program_name

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

    是否启用Channel。

    • 0（默认）：不启用。
    • 1：启用。
    说明 默认不启用，且启用后不可取消；不启用时Resource直接被布局引用，首次开启Channel需要在导播台停止的状态下进行，之前已存在的布局将被废弃，Resource需要首先设置到Channel中，新增的布局直接引用Channel，通过Channel可调整视频源播放进度和播放状态，该模式下视频源、PVW、PGM三区域若引用同一Resource，则对应画面将保持同步。
    SyncGroupsConfig String 否 "[{\"mode\":0,\"resourceIds\":[\"5a6c1c33-8424-46f6-813c-c152220a****\",\"4e6521dc-a40a-4077-b6bf-1fb12a76****\"],\"hostResourceId\":\"3aa2b39a-fd0e-4b8c-be73-b7af31c4****\"}]"

    多视角同步配置，让多个视频源同步。

    多视角同步分为两个模式：

    • mode: 0（主播模式，多个视频源根据指定的模式同步。）
    • mode: 1（会议模式，没有主播视频的概念，所有视频源相互同步。）

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

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

    备播媒资库图片素材ID。
    UrgentImageUrl String 否 http://learn.aliyundoc.com/AppName/image.jpg

    备播图片素材URL。
    AutoSwitchUrgentOn Boolean 否 true

    开启断流自动切换备播。

    • true：开启。
    • false：关闭。
    AutoSwitchUrgentConfig String 否 {"eofThres":3}

    自动切备播配置。

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

    返回数据

    名称

    类型

    示例值

    描述
    CasterId String b4810848-bcf9-4aef-bd4a-e6bba2d9****

    导播台ID。可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。
    RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

    请求ID。

    示例

    请求示例

    http(s)://live.aliyuncs.com/?Action=SetCasterConfig
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&<公共请求参数>

    正常返回示例

    XML格式

    HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<SetCasterConfigResponse>
	<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
	<casterId>b4810848-bcf9-4aef-bd4a-e6bba2d9****</casterId>
</SetCasterConfigResponse>

    JSON格式

    HTTP/1.1 200 OK
Content-Type:application/json

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

    错误码

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