AI 助理
备案控制台
文档
输入文档关键字查找
首页 智能媒体服务 开发参考 API参考 API目录 媒资管理 GetPlayInfo - 获取音视频播放地址

GetPlayInfo - 获取音视频播放地址

更新时间：
产品详情
我的收藏

本接口通过音视频ID直接获取媒体文件（支持视频和音频）的播放地址。集成阿里云播放器SDK（适用于URL播放方式）或第三方播放器后，可使用该地址进行音视频播放。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
MediaIdstring否

媒资 ID。

说明 MediaId 和 InputURL 字段中至少一个不能为空。
86434e152b7d4f20be480574439fe***
InputURLstring否

注册媒资时填写的 InputURL，详情见 RegisterMediaInfo 。

说明 MediaId 和 InputURL 字段中至少一个不能为空。
http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 vod://****20b48fb04483915d4f2cd8ac****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

******11-DB8D-4A9A-875B-275798******
MediaBaseobject

媒资信息。

CreationTimestring

创建时间。

2021-09-22T10:07:31+08:00
Statusstring

资源状态。取值范围：

  • Init（初始状态：源文件未就绪）

  • Preparing（源文件准备中：比如上传中或者剪辑合成中）

  • PrepareFail（源文件准备失败：比如获取源文件信息失败）

  • Normal（正常：源文件已就绪）

Normal
MediaIdstring

媒资 ID。

2eea77a61c7b4ddd95bec34a6f65b***
CoverURLstring

封面 URL。

https://***.oss-cn-shanghai.aliyuncs.com/cover/281c64d6-b5fb-4c57-97cd-84da56a8b151_large_cover_url.jpg
Titlestring

标题。

testTitle
MediaTypestring

媒体文件类型，取值：

video：视频。 audio：纯音频。

video
MediaTagsstring

标签。

  • 最多不超过 16 个标签。

  • 多个用逗号分隔。

  • 单个标签不超过 32 字节。

  • UTF8 编码。

test,ccc
CateIdlong

分类 ID。可通过以下方式获取：

  • 登录 IMS 控制台，选择 媒资管理 > 分类管理查看分类 ID。
  • 通过创建分类接口创建分类时，分类 ID 为返回参数 CateId 的值。
  • 通过获取分类接口查询分类时，为请求后返回参数 CateId 的值。
4220
Descriptionstring

内容描述

desc
PlayInfoListarray<object>

音/视频播放信息（流信息）。

PlayInfoobject

音/视频详细信息。

CreationTimestring

创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2022-05-10T02:28:49Z
Statusstring

媒体流状态，取值：

  • Normal：正常。
  • Invisible：不可见。
Normal
NarrowBandTypestring

窄带高清类型。取值：

  • 0：普通。
  • 1.0：窄带高清 1.0。
  • 2.0：窄带高清 2.0。

仅当配置了窄带高清 1.0 内置转码模板的清晰度时才会生效。更多详情，请参见转码模板配置-Definition。

0
Heightlong

媒体流高度。单位：px。

1080
Bitratestring

媒体流码率。单位：Kbps。

20
ModificationTimestring

更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2022-05-13T11:39:41.714+08:00
WatermarkIdstring

当前媒体流关联的水印 ID。

5bed88672b1e2520ead228935ed51***
Encryptlong

媒体流是否加密流，取值：

  • 0：否。
  • 1：是。
0
Definitionstring

视频流清晰度定义。取值：

  • FD：流畅。
  • LD：标清。
  • SD：高清。
  • HD：超清
  • OD：原画。
  • 2K：2K。
  • 4K：4K。
  • SQ：普通音质。
  • HQ：高音质。
  • AUTO：自适应码率。
HD
EncryptTypestring

媒体流加密类型。取值：

  • AliyunVoDEncryption：阿里云视频加密。
  • HLSEncryption：HLS 标准加密。
说明 如果加密类型为 AliyunVoDEncryption，则只能使用阿里云播放器 SDK 才能正常播放。
AliyunVoDEncryption
StreamTypestring

媒体流类型。 若媒体流为视频则取值：video，若是纯音频则取值：audio。

video
Sizelong

媒体流大小。单位：Byte。

418112
Widthlong

媒体流宽度。单位：px。

1024
Fpsstring

媒体流帧率。单位：帧/每秒。

25
Durationstring

媒体流长度。单位：秒。

9.0464
PlayURLstring

视频流的播放地址。

https://***.aliyuncdn.com/sv/756bee1-17f980f0945/756bee1-17f980f0945.mp4
Formatstring

媒体流格式。

  • 若媒体文件为视频则取值： mp4、 m3u8。
  • 若是纯音频则取值：mp3。
mp4
HDRTypestring

媒体流 HDR 类型。取值：

  • HDR
  • HDR10
  • HLG
  • DolbyVision
  • HDRVivid
  • SDR+
HDR
BitDepthinteger

颜色位深。

8
FileURLstring

文件 OSS 地址。

http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/43a68ee9-181809b6aba/43a68ee9-181809b6aba.mpeg
TransTemplateTypestring

转码模板类型，取值：

  • Normal：普通模板
  • AudioTranscode：音频转码
  • Remux：转封装
  • NarrowBandV1：窄带高清 1.0
  • NarrowBandV2：窄带高清 2.0
  • UHD：音画增强（超高清）
Normal
StreamTagsstring

流标签，用于标识转码处理类型。

"{\"ims.audioServiceType\": \"AudioEnhancement\"}"
JobIdstring

任务 ID。

36c9d38e70bf43ed9f7f8f48d6356***

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "MediaBase": {
    "CreationTime": "2021-09-22T10:07:31+08:00",
    "Status": "Normal",
    "MediaId": "2eea77a61c7b4ddd95bec34a6f65b***",
    "CoverURL": "https://***.oss-cn-shanghai.aliyuncs.com/cover/281c64d6-b5fb-4c57-97cd-84da56a8b151_large_cover_url.jpg",
    "Title": "testTitle",
    "MediaType": "video",
    "MediaTags": "test,ccc",
    "CateId": 4220,
    "Description": "desc"
  },
  "PlayInfoList": [
    {
      "CreationTime": "2022-05-10T02:28:49Z",
      "Status": "Normal",
      "NarrowBandType": "0",
      "Height": 1080,
      "Bitrate": "20",
      "ModificationTime": "2022-05-13T11:39:41.714+08:00",
      "WatermarkId": "5bed88672b1e2520ead228935ed51***",
      "Encrypt": 0,
      "Definition": "HD",
      "EncryptType": "AliyunVoDEncryption",
      "StreamType": "video",
      "Size": 418112,
      "Width": 1024,
      "Fps": "25",
      "Duration": "9.0464",
      "PlayURL": "https://***.aliyuncdn.com/sv/756bee1-17f980f0945/756bee1-17f980f0945.mp4",
      "Format": "mp4",
      "HDRType": "HDR",
      "BitDepth": 8,
      "FileURL": "http://outin-***.oss-cn-shanghai.aliyuncs.com/sv/43a68ee9-181809b6aba/43a68ee9-181809b6aba.mpeg",
      "TransTemplateType": "Normal",
      "StreamTags": "\"{\\\"ims.audioServiceType\\\": \\\"AudioEnhancement\\\"}\"",
      "JobId": "36c9d38e70bf43ed9f7f8f48d6356***"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-25OpenAPI 返回结构发生变更查看变更详情
2022-11-29OpenAPI 返回结构发生变更查看变更详情
上一篇：ListMediaMarks - 列出媒资的全部标记信息下一篇：DeletePlayInfo - 删除媒体流
文档推荐