新增打点剪辑

接口描述

本接口用于为该赛事新增一个打点信息，用来标记某一时刻的事件，并生成该时间段的一段剪辑视频以及该剪辑视频的缩略图。

请求

请求路径

Path	Method	说明
/v1/event/{$eventId}/annotation	POST	新增打点信息

请求参数

无

请求头

无其他特殊头域

请求体

参数	类型	是否必须	描述
timeType	Integer	是	打点时间类型，支持offset和unixtimestamp
source	String	否	打点来源。 manual标识人工打点，ai标识AI打点，narrate标识解说打点。默认为manual
annotations	List <Annotation>	是	Annotation Object数组

Annotation Object定义

参数	类型	是否必须	描述
time	Integer	是	打点时间，和duration一起标识时间段。
duration	Integer	是	持续时长，单位秒。 duration如果是负数，时间区间为[time-duration, time]。duration为正数，时间区间为[time, time + duration]。 duration默认为0， 时间区间为[time - 20, time]
tag	String	否	用于对该tag信息的描述
template	String	否	该值为空时不对视频做特殊处理；该值为slow_motion则为慢动作模式
mediaSource	String	否	在源流上打点填origin，在贴片流上打点填live，默认为origin

响应头域

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

响应体

参数	类型	描述
annotationIdList	List	Annotaion对应的ID List

示例

• 请求示例

  POST /v1/event/event-xxxxx/annotation HTTP/1.1
  host: {host}
  content-type: application/json
  authorization: {authorization}
  
  {
    "timeType": "offset",
    "source": "manual",
    "annotations": [
        {
            "time": 300,
            "duration": 10,
            "tag": "shot"
        }
    ]
  }

• 响应示例

  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
  
  {
    "annotationIdList":
        [
            "9cf37668-6292-46d0-xxxx-9f1a5f4528cf"
        ]
  }

剪辑查询接口

接口描述

本接口用于查询该赛事的打点剪辑。

请求

请求路径

Path	Method	说明
/v1/event/{$eventId}/clips	GET	查询打点剪辑信息

请求参数

参数	类型	是否必须	描述
id	String	否	打点ID，未指定的情况，响应全部打点信息
source	String	否	剪辑对应的打点来源，默认为all。可选值为ai和manual，分别是ai打点和手动打点
aiLimit	Integer	否	返回的AI剪辑数量限制，默认不限制
status	String	否	剪辑状态，默认为all，返回所有状态的剪辑，可选填下面响应体中的status的值

请求头

无其他特殊头域

请求体

无

响应头域

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

响应体

参数	类型	描述
clipsList	Object List	剪辑列表
+annotationId	String	打点ID
+url	String	生成mp4会有一定延迟，状态不为ok时，url为HLS地址，状态为ok时url为mp4地址。
+thumbnail	String	状态不为ok时，为空，状态为ok时url为缩略图地址。
+status	String	剪辑状态，各状态如下: waiting --- 等待处理 processing --- 正在处理剪辑 thumbnailProcessing --- 正在处理缩略图 ok --- 处理完成 failed --- 处理失败
+tag	String	打点描述信息
+source	String	打点来源。

示例

• 请求示例

  GET /v1/event/event-xxxxxxxxxx/clips?source=ai&aiLimit=15&status=ok 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
  
  {
    "clipsList":[
         {
            "annotationId": "941df281-26b7-4aaa-a086-c05f834864d9",
            "url": "https://ibs-xxxx.cdn.bcebos.com/pull-ibs.baidubce.com/ibs_live/event-xxxxxxxxxx/941df281-26b7-xxxx-a086-c05f834864d9.mp4",
            "thumbnail": "https://ibs-xxxx.cdn.bcebos.com/pull-ibs.baidubce.com/ibs_live/event-xxxxxxxxxx/941df281-26b7-xxxx-a086-c05f834864d9-thumbnail.jpg",
            "status": "ok",
            "tag": "{\"resource\":\"Shot\",\"attributes\":[\"goal\"],\"name\":\"AI精彩片段1-进球\"}",
            "source": "ai"
        },
        {
            "annotationId": "11e3542a-9421-4f32-919a-005e5dbdb2e7",
            "url": "https://ibs-xxxx.cdn.bcebos.com/pull-ibs.baidubce.com/ibs_live/event-xxxxxxxxxx/11e3542a-9421-xxxx-919a-005e5dbdb2e7.mp4",
            "thumbnail": "https://ibs-xxxx.cdn.bcebos.com/pull-ibs.baidubce.com/ibs_live/event-xxxxxxxxxx/11e3542a-9421-xxxx-919a-005e5dbdb2e7-thumbnail.jpg",
            "status": "ok",
            "tag": "{\"resource\":\"Shot\",\"attributes\":[\"shot\"],\"name\":\"AI精彩片段2-射门\"}",
            "source": "ai"
        }
    ]
  }

删除剪辑接口

接口描述

本接口用于删除该赛事指定的打点剪辑。

请求

请求路径

Path	Method	说明
/v1/event/{$eventId}/clips	DELETE	删除打点剪辑

请求参数

参数	类型	是否必须	描述
id	String	是	打点ID

请求头

无其他特殊头域

请求体

无

响应头域

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

响应体

无

响应码

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

示例

• 请求示例

  DELETE /v1/event/event-xxxxxxxxxx/clips?annotationId=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