全部产品
Search

搜索本产品

    视频直播：DescribeCasterVideoResources - 查询导播台视频源

    文档中心

    视频直播：DescribeCasterVideoResources - 查询导播台视频源

    更新时间：Nov 14, 2024

    查询导播台视频源。

    接口说明

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

    QPS 限制

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

    调试

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

    授权信息

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

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

    请求参数

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

    导播台 ID。

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

    • 如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。

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

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    总记录数。

    		2
    VideoResourcesarray<object>

    资源列表。

    VideoResourceobject

    资源列表。

    BeginOffsetinteger

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

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

    		1000
    EndOffsetinteger

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

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

    拉流地址。

    		http://guide.aliyundoc.com/example.org
    ImageIdstring

    媒资库图片素材 ID。

    		a089175eb5f4427684fc0715159a****
    ImageUrlstring

    图片素材 URL。

    		http://learn.aliyundoc.com/AppName/image.jpg
    LiveStreamUrlstring

    直播流地址。

    		rtmp://abcLive/appName/b5447c21fcfe444c9e9b6f7ba208****
    LocationIdstring

    视频源位置。

    		RV01
    MaterialIdstring

    素材 ID。

    		d2c429cd907742ee8f6e76465ad3****
    PtsCallbackIntervalinteger

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

    		0
    RepeatNuminteger

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

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

    资源 ID。

    		b5f8c837-ceeb-424f-b30b-68e94e86****
    ResourceNamestring

    资源名称。

    		resource-Name1
    VodUrlstring

    点播文件地址。

    当且仅当资源为文件视频，且视频文件未导入素材库时使用，仅限 MP4、FLV、TS 格式。

    		http://developer.aliyundoc.com/caster1.flv

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息
    400InvalidCasterId.Malformed%s
    401IllegalOperation%s
    404InvalidCaster.NotFound%s
    500InternalError%s

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

    变更历史

    变更时间变更内容概要操作
    2023-03-31OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情