AddCasterVideoResource - 添加导播台视频资源

添加视频源,视频源数量受限于导播台输入路数。

接口说明

使用说明

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

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:AddCasterVideoResourcecreate
  • Caster
    acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称类型必填描述示例值
CasterIdstring

导播台 ID。

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

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
LIVEPRODUCER_POST-cn-0pp1czt****
ResourceNamestring

视频源名称。

test001
LocationIdstring

用于标识视频源位置。本参数必填。

定义布局内画面的引用编号,每个位置至多关联一个资源,格式需符合“RV01~RV12”,即 RV+数字,数字范围[01~99]

RV01
LiveStreamUrlstring

阿里云直播流地址。

注意 当视频源类型为直播流时,本参数必填。

说明 视频源类型不是直播流时,请求时不要带这个参数。
rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****
MaterialIdstring

媒资库素材 ID。

注意 当视频源类型为素材时,本参数才可用且必须传入。

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

说明 UrgentMaterialId 值即为媒资库素材 ID 值。
f080575eb5f4427684fc0715159a****
VodUrlstring

点播文件地址。

注意 当视频源类型为文件视频且视频文件未导入素材库时,本参数才可用。

说明 点播文件仅限 MP4、FLV、TS 格式。
http://learn.aliyundoc.com/AppName/StreamName.flv
BeginOffsetinteger

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

注意 当视频源类型为文件视频时,本参数才有用。

说明 大于 0,表示从相对于首帧的偏差时间作为开始读取的位置。
1000
EndOffsetinteger

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

注意 当视频源类型为文件视频时,本参数才有用。

  • 大于 0 时:从相对于首帧的偏差时间为结束读取的位置。
  • 小于 0 时:相对于最后一帧的偏差时间作为结束读取的位置。
10000
RepeatNuminteger

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

注意 当视频源类型为文件视频时,本参数才有用。

  • 0(默认值):不重复播放。
  • -1:一直循环重复。
0
PtsCallbackIntervalinteger

PTS 回调间隔。单位:毫秒。

2000
FixedDelayDurationinteger

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

0
ImageIdstring

媒资库图片素材 ID。

说明 当视频源类型为图片时,本参数才可用且必须传入。
a089175eb5f4427684fc0715159a****
ImageUrlstring

图片素材 URL。

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

CF60DB6A-7FD6-426E-9288-122CC1A52FA7
ResourceIdstring

资源 ID。可作为删除导播台视频源,修改导播台视频源的请求参数。

e5542d98-b08c-46bf-83e9-5b09d08c****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400InvalidCasterId.Malformed%s
400InvalidUserId.Malformed%s
400InvalidParameter.Malformed%s
400InvalidLiveStreamUrl.Malformed%s
400InvalidMaterialId.Malformed%s
400InvalidVodUrl.Malformed%s
400ResourceNumberExceed%s
400MissingParameter%s
400DuplicateLocationID%s
400UnexpectedLocationID%s
401IllegalOperation%s
404InvalidCaster.NotFound%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
2024-08-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-03-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情