调用AddCasterVideoResource添加导播台视频源。

使用说明

请先创建导播台，再调用本接口添加导播台视频源。视频源数量受限于导播台输入路数。使用API创建导播台，请参见创建导播台。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 AddCasterVideoResource

系统规定参数。取值：AddCasterVideoResource。
CasterId String 是 LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。

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

视频源名称。
LocationId String 否 RV01

用于标识视频源位置。

定义布局内画面的引用编号，每个位置至多关联一个资源，格式需符合“RV01~RV12”，即RV+数字，数字范围[01~99]。
LiveStreamUrl String 否 rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****

阿里云直播流地址。

重要 当视频源类型为直播流时，本参数必填。
说明 视频源类型不是直播流时，请求时不要带这个参数。
StreamId String 否 faaa9a6b-1234-1a20-2345-874378483****

流ID。
MaterialId String 否 f080575eb5f4427684fc0715159a****

媒资库素材ID。

重要 当视频源类型为素材时，本参数才可用且必须传入。

如果您通过DescribeCasterConfig接口查询导播台配置信息，请查看DescribeCasterConfig接口调用返回的参数UrgentMaterialId值。

说明 UrgentMaterialId值即为媒资库素材ID值。
VodUrl String 否 http://learn.aliyundoc.com/AppName/StreamName.flv

点播文件地址。

重要 当视频源类型为文件视频且视频文件未导入素材库时，本参数才可用。
说明 点播文件仅限MP4、FLV、TS格式。
BeginOffset Integer 否 1000

视频文件起始偏移值。单位：毫秒。

重要 当视频源类型为文件视频时，本参数才有用。
说明 大于0，表示从相对于首帧的偏差时间作为开始读取的位置。
EndOffset Integer 否 10000

视频文件结束偏移值。单位：毫秒。

重要 当视频源类型为文件视频时，本参数才有用。
  • 大于0时：从相对于首帧的偏差时间为结束读取的位置。
  • 小于0时：相对于最后一帧的偏差时间作为结束读取的位置。
RepeatNum Integer 否 0

播放完后重复继续播放的次数。取值：

重要 当视频源类型为文件视频时，本参数才有用。
  • 0（默认值）：不重复播放。
  • -1：一直循环重复。
PtsCallbackInterval Integer 否 2000

PTS回调间隔。单位：毫秒。
FixedDelayDuration Integer 否 0

该字段对视频进行固定延迟设置，可用于字幕同步。单位ms, 默认取值为0， 取值范围0-5000。
ImageId String 否 a089175eb5f4427684fc0715159a****

媒资库图片素材ID。

说明 当视频源类型为图片时，本参数才可用且必须传入。
ImageUrl String 否 http://learn.aliyundoc.com/AppName/image.jpg

图片素材URL。

说明 当视频源类型为图片且图片文件未导入素材库时，本参数才可用。支持上传jpg、png格式图片，最大文件不可超过10M。
说明 视频源类型是根据直播流地址里的资源类型判断的。

返回数据

名称 类型 示例值 描述
ResourceId String e5542d98-b08c-46bf-83e9-5b09d08c****

资源ID。可作为删除导播台视频源，修改导播台视频源的请求参数。
RequestId String CF60DB6A-7FD6-426E-9288-122CC1A52FA7

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddCasterVideoResource
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&ResourceName=test001
&<公共请求参数>

正常返回示例

XML格式

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

<?xml version="1.0" encoding="UTF-8" ?>
<AddCasterVideoResourceResponse>
	<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
	<ResourceId>e5542d98-b08c-46bf-83e9-5b09d08c****</ResourceId>
</AddCasterVideoResourceResponse>

JSON格式

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

{
  "RequestId" : "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
  "ResourceId" : "e5542d98-b08c-46bf-83e9-5b09d08c****"
}

错误码

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