新增集锦

接口描述

本接口用于为该赛事新增一个集锦，通过指定多个打点剪辑ID和指定模版，合成一个的集锦视频以及该集锦视频的缩略图。

请求

请求路径

Path	Method	说明
/v1/event/${eventId}/highlights	POST	新增集锦

请求参数

无

请求头

无其他特殊头域

请求体

参数	类型	是否必须	描述
clipsIdList	List <String>	是	用于剪辑ID列表（限制：最多10个clips）
template	String	否	模板名字，默认为default，支持定制

响应头域

除公共头域外，无其他特殊头域

响应体

参数	类型	描述
higlightId	String	集锦ID，一条集锦的唯一标识

示例

• 请求示例

  POST /v1/event/event-xxxxxxxxxxx/highlights HTTP/1.1
  host: {host}
  content-type: application/json
  authorization: {authorization}
  
  {
    "clipsIdList": [
        "9a842d0c-d0b1-xxxx-9874-0c24eef8",
        "9cf37668-6292-xxxx-b77e-9f1a5f45"
    ],
     "template":"default"
  }

• 响应示例

  HTTP/1.1 200 OK
  x-bce-request-id: 8dbde9a9-34e8-4071-afa0-b6d4c4e974b2
  Date: Tue, 08 Now 2023 15:00:00 GMT
  Content-Type: application/json;charset=UTF-8
  
  {
    "highlightId": "954498ff-9112-xxxx-bcca-6ceaafcf6216"
  }

集锦查询接口

接口描述

本接口用于查询该赛事的集锦视频。

请求

请求路径

Path	Method	说明
/v1/event/{$eventId}/highlights	GET	查询集锦视频

请求参数

参数	类型	是否必须	描述
id	String	否	集锦唯一标识，新建集锦时返回的highlight id。 没有显示指定id时，会响应本次赛事所有的集锦

请求头

无其他特殊头域

请求体

无

响应头域

除公共头域外，无其他特殊头域

响应体

参数	类型	描述
highlightsList	List	集锦列表
+id	String	集锦ID
+status	String	集锦状态，状态如下: waiting --- 等待处理 processing --- 正在处理 thumbnailProcessing --- 正在处理缩略图 ok --- 处理完成 failed --- 处理失败
+clipsIdList	String	创建集锦时指定的clips id列表
+template	String	模板名称
+thumbnail	String	状态不为ok时，为空，状态为ok时url为缩略图地址
+url	String	集锦访问地址，注意: 只有在status == ok时，才会返回url

示例

• 请求示例

  GET /v1/event/event-xxxxxxxxxx/highlights HTTP/1.1
  host: {host}
  content-type: application/json
  authorization: {authorization}

• 响应示例

  HTTP/1.1 200 OK
  x-bce-request-id: 8dbde9a9-34e8-4071-afa0-b6d4c4e974b2
  Date: Tue, 08 Now 2023 15:00:00 GMT
  Content-Type: application/json;charset=UTF-8
  
  {
  "highlightsList":
    [
        {
            "id": "954498ff-9112-xxxx-bcca-6ceaafcf",
            "status": "ok",
            "clipsIdList": [
                "9a842d0c-d0b1-xxxx-9874-0c24eef8",
                "9cf37668-6292-xxxx-b77e-9f1a5f45"
            ],
            "url":"https://pull-ibs.baidubce.com/ibs_live/954498ff-9112-xxxx-bcca-6ceaafcf.mp4"
         }
     ]
  }

删除集锦接口

接口描述

本接口用于删除该赛事指定的集锦视频。

请求

请求路径

Path	Method	说明
/v1/event/{$eventId}/highlights	DELETE	删除集锦视频

请求参数

参数	类型	是否必须	描述
id	String	是	集锦ID

请求头

无其他特殊头域

请求体

无

响应头域

除公共头域外，无其他特殊头域

响应体

无

响应码

HTTP Status Code	说明
200	删除成功
400	event不存在或者集锦不存在，在errorMessage中会有描述
500	内部处理错误

示例

• 请求示例

  DELETE /v1/event/event-xxxxxxxxxx/highlights?highlightsId=9cf37668-6292-46d0-xxxx-9f1a5f4528cf HTTP/1.1
  host: {host}
  content-type: application/json
  authorization: {authorization}

• 响应示例

  HTTP/1.1 200 OK
  x-bce-request-id: 8dbde9a9-34e8-4071-afa0-b6d4c4e974b2
  Date: Tue, 08 Now 2023 15:00:00 GMT
  Content-Type: application/json;charset=UTF-8
  
  success

集锦模版查询接口

接口描述

本接口用于查询该用户下的所有的集锦模版信息。

请求

请求路径

Path	Method	说明
/v1/highlights/template	GET	查询集锦模版

请求参数

参数	类型	是否必须	描述
pageNo	Integer	是	页数，从1开始
pageSize	Integer	是	每页个数

请求头

无其他特殊头域

请求体

无

响应头域

除公共头域外，无其他特殊头域

响应体

参数	类型	描述
pageNo	Integer	页数，从1开始
pageSize	Integer	每页个数
totalCount	Integer	总数
highlightsList	List<Template>	集锦模版列表

Template Object定义

参数	类型	描述
name	String	模版名
example	String	模版示例视频

示例

• 请求示例

  GET /v1/highlights/template HTTP/1.1
  host: {host}
  content-type: application/json
  authorization: {authorization}

• 响应示例

  HTTP/1.1 200 OK
  x-bce-request-id: 8dbde9a9-34e8-4071-afa0-b6d4c4e974b2
  Date: Tue, 08 Now 2023 15:00:00 GMT
  Content-Type: application/json;charset=UTF-8
  
  {
    "pageNo": 1,
    "pageSize": 10,
    "totalCount": 2,
    "templateList": [
        {
            "name": "百度",
            "example": "https://xxxx.xxxx.bcebos.com/template/百度/example.mp4"
        },
        {
            "name": "default",
            "example": "https://xxxx.xxxx.bcebos.com/template/default/example.mp4"
        }
    ]
  }