调用DescribeCasterVideoResources查询导播台视频源。

使用说明

先通过CreateCaster接口创建导播台，再调用本接口查询导播台视频源。

QPS限制

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

调试

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

请求参数

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

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

导播台ID。

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

返回数据

名称 类型 示例值 描述
Total Integer 2

总记录数。
RequestId String CF60DB6A-7FD6-426E-9288-122CC1A52FA7

请求ID。
VideoResources Array of VideoResource

资源列表。
VideoResource
EndOffset Integer 10000

视频文件结束偏移值。仅对文件视频有效，单位：毫秒。

  • 大于0：从相对于首帧的偏差时间为结束读取的位置。
  • 小于0：从相对于最后一帧的偏差时间作为结束读取的位置。
FlvUrl String http://guide.aliyundoc.com/example.org

拉流地址。
BeginOffset Integer 1000

视频文件起始偏移值。仅对文件视频有效， 单位：毫秒。

大于0，表示从相对于首帧的偏差时间作为开始读取的位置。
PtsCallbackInterval Integer 0

点播文件的回调间隔，等于0时为不回调。
MaterialId String d2c429cd907742ee8f6e76465ad3****

素材ID。
LocationId String RV01

视频源位置。
LiveStreamUrl String rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****

直播流地址。
VodUrl String http://developer.aliyundoc.com/caster1.flv

点播文件地址。

当且仅当资源为文件视频，且视频文件未导入素材库时使用，仅限MP4、FLV、TS格式。
ResourceId String b5f8c837-ceeb-424f-b30b-68e94e86****

资源ID。
RepeatNum Integer 0

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

  • 0（默认值）：不重复播放。
  • -1：一直循环重复播放。
ResourceName String resource-Name1

资源名称。
ImageId String a089175eb5f4427684fc0715159a****

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

图片素材URL。

示例

请求示例

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

正常返回示例

XML格式

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

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeCasterVideoResourcesResponse>
<RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
<Total>2</Total>
<VideoResources>
    <VideoResource>
        <EndOffset>10000</EndOffset>
        <BeginOffset>1000</BeginOffset>
        <MaterialId>d2c429cd907742ee8f6e76465ad3****</MaterialId>
        <FlvUrl>http://guide.aliyundoc.com/example.org</FlvUrl>
        <ResourceId>b5f8c837-ceeb-424f-b30b-68e94e86****</ResourceId>
        <ResourceName>resource-Name1</ResourceName>
        <LocationId>RV01</LocationId>
        <RepeatNum>0</RepeatNum>
        <LiveStreamUrl>rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****</LiveStreamUrl>
        <PtsCallbackInterval>0</PtsCallbackInterval>
        <VodUrl>http://developer.aliyundoc.com/caster1.flv</VodUrl>
    </VideoResource>
</VideoResources>
</DescribeCasterVideoResourcesResponse>

JSON格式

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

{
  "DescribeCasterVideoResourcesResponse" : {
    "RequestId" : "CF60DB6A-7FD6-426E-9288-122CC1A52FA7",
    "Total" : 2,
    "VideoResources" : {
      "VideoResource" : {
        "EndOffset" : 10000,
        "BeginOffset" : 1000,
        "MaterialId" : "d2c429cd907742ee8f6e76465ad3****",
        "FlvUrl" : "http://guide.aliyundoc.com/example.org",
        "ResourceId" : "b5f8c837-ceeb-424f-b30b-68e94e86****",
        "ResourceName" : "resource-Name1",
        "LocationId" : "RV01",
        "RepeatNum" : 0,
        "LiveStreamUrl" : "rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****",
        "PtsCallbackInterval" : 0,
        "VodUrl" : "http://developer.aliyundoc.com/caster1.flv"
      }
    }
  }
}

错误码

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