文档

GetVideoPreviewPlayInfo - 获取视频播放信息

更新时间:

获取视频播放信息。

接口说明

详细请参考最佳实践文档:在线预览视频

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/file/get_video_preview_play_info

请求参数

名称类型必填描述示例值
bodyobject

请求体参数。

share_idstring

分享 id。 如果通过分享操作文件,请携带x-share-token header 鉴权并传递此字段,此时drive_id无效。否则请使用aksk或者access_token方式鉴权,并传递drive_id字段。 share_iddrive_id两者必须有一个字段赋值。

7JQX1FswpQ8
drive_idstring

空间 id

1
file_idstring

文件 id

9520943DC264
categorystring

所属分类。 需要开通对应的转码功能,枚举如下:

  • live_transcoding(live 边转边播)
  • quick_video(quick 边转边播)
  • offline_audio(离线音频转码)
  • offline_video(离线视频转码)
枚举值:
  • live_transcoding在线视频边转边播
live_transcoding
template_idstring

清晰度模板 id。 填空表示取所有可用清晰度模板

264_480p
get_without_urlboolean

是否不获取播放 url。 如果填 true,只会获取转码元信息,并不会触发 ts 转码,返回的信息中没有播放 url。否则会返回播放 url,如果此 template_id 的视频还未转码,后台将触发器转码。 转码会产生对应的增值服务费用

true
url_expire_seclong

url 超时时间,单位:秒。 默认 15 分钟,最大 4 小时。

3600
get_master_urlboolean

是否获取 master m3u8 的 url,仅在 category = quick_video 时有效

false

返回参数

名称类型描述示例值
object

Schema of Response

domain_idstring

域 id

bj1
share_idstring

分享 id

7JQX1FswpQ8
drive_idstring

空间 id

1
file_idstring

文件 id

fileid1
video_preview_play_infoVideoPreviewPlayInfo

播放信息

codestring

错误码

VideoPreviewWaitAndRetry
messagestring

错误信息

media is transcoding, please wait and retry.
master_urlstring

master m3u8 的 url

https://pds-xxx-valueadd.oss-xxx.aliyuncs.com/qv/xxx/master.m3u8

示例

正常返回示例

JSON格式

{
  "domain_id": "bj1",
  "share_id": "7JQX1FswpQ8",
  "drive_id": "1",
  "file_id": "fileid1",
  "video_preview_play_info": {
    "category": "live_transcoding",
    "meta": {
      "duration": 0,
      "width": 0,
      "height": 0
    },
    "live_transcoding_task_list": [
      {
        "template_id": "",
        "status": "",
        "url": "",
        "keep_original_resolution": true
      }
    ],
    "quick_video_list": [
      {
        "template_id": "",
        "status": "",
        "url": ""
      }
    ],
    "offline_video_transcoding_list": [
      {
        "template_id": "",
        "status": "",
        "keep_original_resolution": true,
        "url": ""
      }
    ]
  },
  "code": "VideoPreviewWaitAndRetry",
  "message": "media is transcoding, please wait and retry.",
  "master_url": "https://pds-xxx-valueadd.oss-xxx.aliyuncs.com/qv/xxx/master.m3u8"
}

错误码

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

  • 本页导读 (0)
文档反馈