调用ModifyCasterVideoResource修改导播台视频资源。

使用说明

先通过CreateCaster接口创建导播台,再调用本接口修改导播台视频资源。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:ModifyCasterVideoResource

CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
ResourceId String 05ab713c-676e-49c0-96ce-cc408da1****

资源ID。如果您通过AddCasterVideoResource接口添加导播台视频源,请查看AddCasterVideoResource接口调用返回的参数ResourceId值。

ResourceName String test001

视频源名称。

LiveStreamUrl String rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5****

直播流地址。

重要 当视频源类型为直播流时,本参数才可用且必传。
MaterialId String f080575eb5f4427684fc0715159a****

素材ID。

VodUrl String http://developer.aliyundoc.com/AppName/StreamName.flv

点播文件地址。

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

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

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

仅对文件视频有效。单位:毫秒。

  • 大于0时,表示从相对于首帧的偏差时间为结束读取的位置。
  • 小于0时,表示相对于最后一帧的偏差时间作为结束读取的位置。
RepeatNum Integer 0

仅对文件视频有效,表示播放完后重复继续播放的次数。

  • 0(默认值):表示不重复播放。
  • -1:表示一直循环重复。
PtsCallbackInterval Integer 2000

PTS回调间隔。单位:毫秒,仅对点播素材有效。

ImageId String a089175eb5f4427684fc0715159a****

媒资库图片素材ID。

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

图片素材URL。

说明 当视频源类型为图片且图片文件未导入素材库时,本参数才可用。支持上传jpg、png格式图片,最大文件不可超过10M。

返回数据

名称 类型 示例值 描述
RequestId String CF60DB6A-7FD6-426E-9288-122CC1A52FA7

请求ID。

CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。可作为查询导播台视频源、添加导播台布局、查询导播台布局列表的请求参数。

ResourceId String 98461064-1c94-4dc1-85ce-94098764****

资源ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ModifyCasterVideoResource
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&ResourceId=05ab713c-676e-49c0-96ce-cc408da1****
&<公共请求参数>

正常返回示例

XML格式

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

<?xml version="1.0" encoding="UTF-8" ?>
<ModifyCasterVideoResourceResponse>
	<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
    <CasterId>LIVEPRODUCER_POST-cn-0pp1czt****</CasterId>
    <ResourceId>98461064-1c94-4dc1-85ce-94098764****</ResourceId>
</ModifyCasterVideoResourceResponse>

JSON格式

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

{
  "ModifyCasterVideoResourceResponse" : {
    "RequestId" : "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
    "CasterId" : "LIVEPRODUCER_POST-cn-0pp1czt****",
    "ResourceId" : "98461064-1c94-4dc1-85ce-94098764****"
  }
}

错误码

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