调用GetPlayInfo通过音视频ID可获取音视频的播放地址。存储在视频点播中的音视频,获取其播放地址后,可使用阿里云播放器(适用于URL播放方式)或其他第三方播放器(系统原生播放器、开源播放器、自研播放器等)进行播放。
接口说明
-
请确保在使用该接口前,已充分了解视频点播产品的收费方式和价格。从点播的播放地址直接下载或播放视频将产生下行流量费用,未配置加速域名时请参见存储流出流量计费;已配置加速域名时请参见加速服务计费。如果您已开通了存储传输加速,则从点播的播放地址直接下载或播放视频还将涉及下载加速费用,计费详情请参见存储传输加速计费。
-
只有状态为正常(Status 字段值为 Normal)的视频才能正常播放。关于播放地址的播放说明及使用限制等更多信息,请参见音视频播放。
-
当视频播放异常时,您可以调用 GetMezzanineInfo 接口查询视频源文件信息是否正确。
-
如需调用本接口生成 m3u8 溯源水印视频流,请先提交工单,申请开通,如何提交工单,请参见联系我们。更多溯源水印详细信息,请参见数字水印。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vod:GetPlayInfo |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
VideoId | string | 是 | 音/视频 ID,仅支持传入单个音/视频 ID。可通过以下方式获取:
| 93ab850b4f654b6e91d24d81d44**** |
Formats | string | 否 | 媒体流格式。多个格式之间使用半角逗号(,)分隔。取值:
说明
dash 封装格式时才会输出。更多详情,请参见Container:封装格式。 | mp4,m3u8 |
AuthTimeout | long | 否 | 设置播放地址的有效时间。单位:秒。
| 1800 |
OutputType | string | 否 | 输出地址类型。取值:
| cdn |
StreamType | string | 否 | 媒体流类型。多个类型之间用半角逗号(,)分隔。支持类型:
默认获取所有类型的流。 | video |
ReAuthInfo | string | 否 | CDN 二次鉴权参数,为 JSON 字符串。当开启了 URL 鉴权的 A 方式鉴权功能时,可通过该参数设置鉴权 URL 的 | {"uid":"12345","rand":"abckljd"} |
Definition | string | 否 | 视频流清晰度。多个清晰度之间用半角逗号(,)分隔。取值:
说明
| LD |
ResultType | string | 否 | 返回数据类型。取值:
| Single |
PlayConfig | string | 否 | 播放自定义设置。为 JSON 字符串,支持指定域名播放设置。参数构造详情,请参见 PlayConfig 。 说明
PlayDomain 不设置时,接口默认使用点播配置的默认域名;如果没有设置默认域名,则会根据域名的修改时间倒序查询,使用最新修改过的域名作为播放域名。为防止返回的不是想要的域名,建议设置默认播放域名(可登录视频点播控制台,选择配置管理 > 媒资管理配置 > 存储管理 > 管理 > 回源到此存储地址的域名设置默认播放域名)。EncryptType 参数设置为AliyunVoDEncryption 时,为了保障您的视频安全,默认不返回私有加密流播放地址,若需要返回私有加密流播放地址,需要同时设置ResultType 参数为Multiple 。 | {"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"} |
AdditionType | string | 否 | 获取弹幕蒙版数据 URL 地址,取值:danmu。 说明
仅当 outputType 取值为cdn 时才会生效。
| danmu |
Trace | string | 否 | 用户自定义的数字水印信息。
| test mark |
DigitalWatermarkType | string | 否 | 数字水印类型。取值:
| TraceMark |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "F552E596-967D-5500-842F-17E6364****",
"VideoBase": {
"CreationTime": "2017-06-26T06:38:48Z",
"Status": "Normal",
"VideoId": "93ab850b4f654b6e91d24d81d44****",
"CoverURL": "http://example.aliyundoc.com/sample.jpg?auth_key=2333232-atb****",
"Duration": "3.1667",
"Title": "阿里云VOD",
"MediaType": "video",
"DanMuURL": "http://example.aliyundoc.com/****?auth_key=abdf2123-6783232****",
"StorageClass": "Standard"
},
"PlayInfoList": {
"PlayInfo": [
{
"CreationTime": "2022-04-18T07:37:15Z",
"Status": "Normal",
"Specification": "H264.LD",
"NarrowBandType": "0",
"Height": 640,
"Bitrate": "450.878",
"ModificationTime": "2022-04-20T06:32:19Z",
"WatermarkId": "dgfn26457856****",
"Encrypt": 1,
"Definition": "LD",
"EncryptType": "AliyunVoDEncryption",
"StreamType": "video",
"JobId": "80e9c6580e754a798c3c19c59b16****",
"Size": 418112,
"Width": 360,
"Fps": "25",
"Duration": "9.0464",
"PlayURL": "https://example.aliyundoc.com/d52ee123f331466aabf6ab32a93d****/a777f9e24e6e47a2a942467d5c38ea37-8ee8e04293c6657fdda282bc422704****.m3u8",
"Format": "m3u8",
"HDRType": "HLG",
"BitDepth": 8,
"JobType": 2,
"JobExt": "CopyrightMarkTest"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-18 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-09-05 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-12-23 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-11-16 | OpenAPI 返回结构发生变更 | 查看变更详情 |
接口错误码
下表列举了本接口特有的错误码。
错误代码 | 错误信息 | HTTP 状态码 | 说明 |
---|---|---|---|
Forbidden.IllegalStatus | Status of the video is illegal. Current Status is %s. | 403 | 视频状态无效,当前状态为%s。只有 Normal 状态的视频才能播放。 |
InvalidVideo.NotFound | The video does not exist. | 404 | 视频不存在。 |
InvalidVideo.NoneStream | The video has no stream to play for the request parameter ‘Formats : mp4, Definition : LD, StreamType : video’. | 404 | 根据您的筛选条件找不到可以播放的转码输出流,请检查您的转码配置与筛选条件是否匹配。 |
Forbidden.AliyunVoDEncryption | Currently only the AliyunVoDEncryption stream exists, you must use the Aliyun player to play or set the value of ResultType to Multiple. | 403 | 当前仅存在阿里云视频加密的转码输出流,必须使用阿里云播放器进行播放或者设置请求参数 ResultType 值为 Multiple。 |