获取视频播放信息。
接口说明
-
请确保在使用该接口前,已充分了解网盘与相册服务产品的收费方式和价格。
-
调用该接口前,请确保当前 domain 已开通对应 category 的转码功能。转码功能开通和转码模板配置请联系我们的技术支持,详情参考联系我们。
-
该接口为同步接口。如果请求时对应文件在对应转码方式上尚未转码,则接口会响应 202 VideoPreviewWaitAndRetry 提示等待重试。如果请求时对应文件在对应转码方式上无法转码,则接口会响应 404 NotFound.VideoPreviewInfo。
-
该接口会产生转码数据并保存到租户 domain 的增值数据空间,以供最终用户进行音视频在线播放。对于特定的转码方式,该接口提供了 domain 级去重转码能力。
-
该接口返回的播放链接在转码类型为 quick_video 时,将包含未进行 URL 编码的
{
和}
字符。IOS 平台开发时请注意先对返回链接进行 URL 解码和编码以避免系统 NSURL 库解码失败。 -
该接口返回的播放链接在转码类型为 quick_video 时,根据链接对应 m3u8 内容获取分片内容时将不支持 Range Get。
更多详细内容请参考最佳实践文档:在线预览视频。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求语法
POST /v2/file/get_video_preview_play_info HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 请求体参数。 | |
share_id | string | 否 | 分享 id。
如果通过分享操作文件,请携带 | |
drive_id | string | 否 | 空间 id | 1 |
file_id | string | 是 | 文件 id | 9520943DC264 |
category | string | 是 | 所属分类。 需要开通对应的转码功能,枚举如下:
| quick_video |
template_id | string | 否 | 清晰度模板 id。 填空表示取所有可用清晰度模板 | 264_480p |
get_without_url | boolean | 否 | 是否不获取播放 url。 如果填 true,只会获取转码元信息,并不会触发 ts 转码,返回的信息中没有播放 url。否则会返回播放 url,如果此 template_id 的视频还未转码,后台将触发器转码。 转码会产生对应的增值服务费用 | true |
url_expire_sec | long | 否 | url 超时时间,单位:秒。 默认 15 分钟,最大 4 小时。 | 3600 |
re_transcode | boolean | 否 | 是否发起重转。设置为 true 时会对文件发起重转,固定响应 202 等待重试。使用该参数前请先联系我们配置开启支持。 | true |
get_master_url | boolean | 否 | 是否获取 master m3u8 的 url,仅在 category = quick_video 时有效 | false |
返回参数
示例
正常返回示例
JSON
格式
{
"domain_id": "bj1",
"share_id": "7JQX1FswpQ8",
"drive_id": 1,
"file_id": "fileid1",
"video_preview_play_info": {
"category": "quick_video",
"meta": {
"duration": 4.2898,
"width": 1920,
"height": 1080
},
"live_transcoding_task_list": [
{
"template_id": "264_480p",
"status": "finished",
"url": "https://example.data.aliyunpds.com/lt/xxx/media.m3u8",
"keep_original_resolution": true,
"preview_url": "https://example.data.aliyunpds.com/lt/xxx/ref_task.m3u8"
}
],
"quick_video_list": [
{
"template_id": "264_480p",
"status": "finished",
"url": "https://example.data.aliyunpds.com/qv/xxx/media.m3u8",
"preview_url": "https://example.data.aliyunpds.com/qv/xxx/ref_task.m3u8"
}
],
"offline_video_transcoding_list": [
{
"template_id": "264_1080p",
"status": "finished",
"keep_original_resolution": true,
"url": "https://example.data.aliyunpds.com/xxx/master.mp4\n"
}
],
"live_transcoding_subtitle_task_list": [
{
"language": "en",
"status": "finished",
"url": "https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt"
}
],
"quick_video_subtitle_list": [
{
"language": "en",
"status": "finished",
"url": "https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt"
}
],
"offline_video_transcoding_subtitle_list": [
{
"language": "en",
"status": "finished",
"url": "https://example.data.aliyunpds.com/lt/A05EF408DAB5D3F57C94F67658C99C406EFCA7DD/subtitle/subtitle_0.vtt"
}
],
"master_url": "https://pds-xxx-valueadd.oss-xxx.aliyuncs.com/qv/xxx/master.m3u8"
}
}
错误码
访问错误中心查看更多错误码。