调用GetPlayInfo通过视频ID直接获取媒体文件(支持视频和音频)的播放地址。

调试

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

请求参数

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

系统规定参数。取值:GetPlayInfo

VideoId String 93ab850b4f6*****54b6e91d24d81d4

视频ID。

Formats String mp4,mp3

视频流格式。多个用英文逗号(,)分隔。支持格式:

  • mp4
  • m3u8
  • mp3
  • mpd
说明 默认获取所有格式的流。MPD格式仅当转码模板中配置了mpd封装格式时才会输出。更多详情,请参见转码模板配置-Container
AuthTimeout Long 1800

播放地址过期时间。单位:秒。

  • 当OutputType取值为CDN时:
    • 只有开启了URL鉴权播放地址才会定期失效,否则会永久有效。
    • 最小值:1
    • 最大值:无限制。
    • 默认值:未设置时,取值为URL鉴权中设置的默认有效时长。
  • 当OutputType取值为OSS时:
    • 只有存储权限为私有,播放地址才会定期失效,否则会永久有效。
    • 最小值:1
    • 最大值:为降低源站安全风险,最大值为2592000(即30天)。
    • 默认值:未设置时,取值为3600
OutputType String cdn

输出地址类型。取值:

  • oss:回源地址。
  • cdn(默认):加速地址。
说明 仅支持播放格式为MP4的OSS地址。
StreamType String video

视频流类型。多个用英文逗号(,)分隔。支持类型:

  • video:视频。
  • audio:音频。

默认获取所有类型的流。

ReAuthInfo String {"uid":"12345","rand":"abckljd"}

CDN二次鉴权参数。为JSON字符串。当开启了CDN二次鉴权功能时,可通过该参数设置鉴权URL的uid和rand,请参见URL鉴权

Definition String FD

视频流清晰度。多个用英文逗号(,)分隔。取值:

  • FD:流畅。
  • LD:标清。
  • SD:高清。
  • HD:超清
  • OD:原画。
  • 2K:2K。
  • 4K:4K。
  • SQ:普通音质。
  • HQ:高音质。
  • AUTO:自适应码率。
说明 默认获取所有清晰度的流。AUTO格式仅当转码模板中配置了打包时才会有该清晰度输出,请参见转码模板配置-PackageSetting
ResultType String Single

返回数据类型。取值:

  • Single(默认):每种清晰度和格式只返回一路最新转码完成的流。
  • Multiple:每种清晰度和格式返回所有转码完成的流。
PlayConfig String {"PlayDomain":"vod.test_domain","XForwardedFor":"yqCD7Fp1uqChoVj/sl/p5Q==","PreviewTime":"20","MtsHlsUriToken":"yqCD7Fp1uqChoVjslp5Q"}

播放自定义设置。为JSON字符串,支持指定域名播放设置。参数构造详情,请参见PlayConfig

说明 PlayConfig不设置或者其中PlayDomain不设置时,接口默认使用点播配置的默认域名;如果没有设置默认域名,则会根据域名的修改时间倒叙查询,使用最新修改过的域名作为播放域名。为防止返回的不是想要的域名,建议在控制台设置默认播放域名。

返回数据

名称 类型 示例值 描述
RequestId String 52c7e33c-0c17-47*****c1-efd6f26d368d

请求ID。

PlayInfoList Array of PlayInfo

视频播放信息(流信息)。

PlayInfo
Bitrate String 992.7800

视频流码率。单位:Kbps。

CreationTime String 2017-06-26T05:38:48Z

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Definition String LD

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

  • LD:流畅。
  • SD:标清。
  • HD:高清。
  • FHD:超清。
  • OD:原画。
  • 2K:2K。
  • 4K:4K。
  • SQ:普通音质。
  • HQ:高音质。
Duration String 3.1667

视频流长度。单位:秒。

Encrypt Long 1

视频流是否加密流,取值:

  • 0:否。
  • 1:是。
EncryptType String AliyunVoDEncryption

视频流加密类型。取值:

  • AliyunVoDEncryption:阿里云视频加密。
  • HLSEncryption:HLS标准加密。
Format String mp4

视频流格式。若媒体文件为视频则取值:

  • mp4
  • m3u8
说明 若是纯音频则取值:mp3
Fps String 30.0032

视频流帧率。单位:帧/每秒。

Height Long 960

视频流高度。单位:px。

JobId String fd1c76fc806b*****194405528706d29

媒体流转码的作业ID。作为媒体流的唯一标识。

ModificationTime String 2017-06-26T05:40:48Z

更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

NarrowBandType String 0

窄带高清类型。取值:

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

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

PlayURL String http://vod.aliyunsample.com/ABEBDE15CC479FD4D1329/52a53151eba5226f8e2da3b55bc57c49.m3u8?auth_key=abdf2123-6783232****

视频流的播放地址。

Size Long 418112

视频流大小.单位:Byte。

Specification String H264.LD

音视频转码输出规格。取值范围,请参见输出规格

Status String Normal

视频流状态,取值:

  • Normal:正常。
  • Invisible:不可见。
StreamType String video

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

WatermarkId String dgfn26457856****

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

Width Long 540

视频流宽度。单位:px。

VideoBase Struct

视频基本信息。

CoverURL String http://image.example.com/sample.jpg?auth_key=2333232-atb****

视频封面。

CreationTime String 2017-06-26T06:38:48Z

视频创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Duration String 3.1667

视频时长。单位:秒。

MediaType String video

媒体文件类型,取值:

  • video:视频。
  • audio:纯音频。
Status String Normal

视频状态。具体取值范围及描述,请参见视频状态Status的取值列表

Title String 阿里云VOD

视频标题。

VideoId String 93ab850b4f6*****54b6e91d24d81d4

视频ID。

示例

请求示例

https://vod.aliyuncs.com/?Action=GetPlayInfo
&VideoId=93ab850b4f6*****54b6e91d24d81d4
&<公共请求参数>

正常返回示例

XML格式

<GetPlayInfoResponse>
      <VideoBase>
            <Status>Normal</Status>
            <VideoId>93ab850b4f6*****54b6e91d24d81d4</VideoId>
            <CreationTime>2017-06-26T05:38:48Z</CreationTime>
            <MediaType>video</MediaType>
            <Title>阿里云VOD</Title>
            <Duration>3.1667</Duration>
            <CoverURL>http://image.example.com/sample.jpg?auth_key=2333232-atb****</CoverURL>
      </VideoBase>
      <RequestId>52c7e33c-0c17-47*****c1-efd6f26d368d</RequestId>
      <PlayInfoList>
            <PlayInfo>
                  <Status>Normal</Status>
                  <StreamType>video</StreamType>
                  <Size>418112</Size>
                  <WatermarkId>dgfn26457856****</WatermarkId>
                  <Fps>30.0032</Fps>
                  <Definition>LD</Definition>
                  <Specification>H264.LD</Specification>
                  <ModificationTime>2017-06-26T05:40:48Z</ModificationTime>
                  <Duration>3.1667</Duration>
                  <Bitrate>992.7800</Bitrate>
                  <Encrypt>1</Encrypt>
                  <Format>mp4</Format>
                  <EncryptType>AliyunVoDEncryption</EncryptType>
                  <NarrowBandType>0</NarrowBandType>
                  <PlayURL>http://vod.aliyunsample.com/ABEBDE15CC479FD4D1329/52a53151eba5226f8e2da3b55bc57c49.m3u8?auth_key=abdf2123-6783232****</PlayURL>
                  <CreationTime>2017-06-26T06:38:48Z</CreationTime>
                  <Height>960</Height>
                  <Width>540</Width>
                  <JobId>fd1c76fc806b*****194405528706d29</JobId>
            </PlayInfo>
      </PlayInfoList>
</GetPlayInfoResponse>

JSON格式

{
	"VideoBase": {
		"Status": "Normal",
		"VideoId": "93ab850b4f6*****54b6e91d24d81d4",
		"CreationTime": "2017-06-26T05:38:48Z",
		"MediaType": "video",
		"Title": "阿里云VOD",
		"Duration": "3.1667",
		"CoverURL": "http://image.example.com/sample.jpg?auth_key=2333232-atb****"
	},
	"RequestId": "52c7e33c-0c17-47*****c1-efd6f26d368d",
	"PlayInfoList": {
		"PlayInfo": [{
			"Status": "Normal",
			"StreamType": "video",
			"Size": "418112",
			"WatermarkId": "dgfn26457856****",
			"Fps": "30.0032",
			"Definition": "LD",
			"Specification": "H264.LD",
			"ModificationTime": "2017-06-26T05:40:48Z",
			"Duration": "3.1667",
			"Bitrate": "992.7800",
			"Encrypt": "1",
			"Format": "mp4",
			"EncryptType": "AliyunVoDEncryption",
			"NarrowBandType": "0",
			"PlayURL": "http://vod.aliyunsample.com/ABEBDE15CC479FD4D1329/52a53151eba5226f8e2da3b55bc57c49.m3u8?auth_key=abdf2123-6783232****",
			"CreationTime": "2017-06-26T06:38:48Z",
			"Height": "960",
			"Width": "540",
			"JobId": "fd1c76fc806b*****194405528706d29"
		}]
	}
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

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

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: