接口规范 5. 点播流相关接口

5.点播流相关接口

5.1.查询点播流

• 用途
  查询某个应用下的点播视频流。
  如果查询的是点播应用（如"vod"），返回的是该点播应用下的点播流列表。
  如果查询的是直播应用（如“liveshow”），则会返回的是有录制数据的历史直播流的列表，列表中的时长、修改时间、生成时间属性都是针对该流最后一个录制版本的描述。可以通过下一个接口查询某个直播流下的详细录制数据。

• 请求
  streamMgr/?request=get_streams&application=vod&pageno=1&page_size=20
  application 应用名
  pageno 页码
  page_size 分页大小，【保留】，该参数暂不支持传入，分页大小由服务器根据数据量自动分页。
  在视频流较多的情况下，可以通过传入页码参数请求某一范围内的数据。返回的数据中含有详细的分页信息，可以通过请求第一页获取数据总量和分页的详情。
  本文档的后续章节将不再对分页属性做解释。

• 响应

  {
  "code":0,
  "data":{
      "page":1,
      "page_size":"20",
      "pages":"2",
      "total":"28",
      "modify_time":"1515731044",
      "count":20,
      "items":[
          {
              "seq":1,
              "application":"vod",
              "stream":"fk7cpizvhwshjnyu",
              "type":"movie",
              "starttime":"1515155078",
              "modifytime":"1515155078",
              "active":"no",
              "duration":"10",
              "formats":"flv,hls,mp4"
          },
          {
              "seq":2,
              "application":"vod",
              "stream":"VID20160916153947",
              "type":"movie",
              "starttime":"1515154953",
              "modifytime":"1515154953",
              "active":"no",
              "duration":"36",
              "formats":",,mp4"
          } ]
  }
  }

  返回应用下的点播流。
  data元素下包含数据量和分页信息：
  page 当前页码
  pages 总页数
  page_size 分页大小
  total 总数据条数
  count 当前分页中的数据条数
  items元素下包含0或多条点播数据流，每条记录的属性如下：
  application 应用名
  stream 流名称
  type 点播流类型,movie表示是视频点播流，live表示是直播流（由直播流形成的归档数据）。
  modifytime 最后修改的时间戳
  "starttime 开始生成的时间戳，对于movie类型的流，表示转码生成的时间，对于live类型的流表示录制的时间。
  duration 视频流的播出时长，单位 秒
  formats 视频流的格式，一个视频流可以有多种格式，多种格式之间使用逗号分开，可以是flv、hls、mp4格式中的一种或多种。

5.2.查询直播流录制数据

• 用途
  查询某个直播流的录制数据，录制数据也是一种点播流，是录制直播流形成的点播数据。
  一个直播流每次启停都会生一份录制数据，多次启停后会在一个直播流下生成多份录制数据。直播流的录制数据使用版本号区分，版本号从0开始，每生成一个新文件版本号会增1。

• 请求
  streamMgr/?request=get_stream_files&application=liveshow&stream=jgdy&pageno=1&page_size=20
  application 应用名
  stream 直播流名称
  pageno 页码
  page_size 分页大小

• 响应

  {
  "code":0,
  "data":{
      "page":1,
      "page_size":"20",
      "pages":"1",
      "total":"2",
      "modify_time":"1515755949",
      "count":2,
      "items":[
          {
              "version":"1",
              "size":"28759864",
              "duration":"353",
              "starttime":"1515655308",
              "modifytime":"1515655659",
              "formats":"hls"
          },
          {
              "version":"0",
              "size":"121345164",
              "duration":"1209",
              "starttime":"1515218380",
              "modifytime":"1515219588",
              "formats":"hls"
          }
      ]
  }
  }

  返回某个直播流的录制数据。
  items元素下包含0或多条录制数据，每条数据的属性如下：
  version 版本号
  size 录制数据大小，单位 字节
  duration 视频流的播出时长，单位 秒
  modifytime 最后修改的时间戳，可以理解成录制结束的时间戳
  "starttime 开始录制的时间戳。
  formats 视频流的格式，一个视频流可以有多种格式，多种格式之间使用逗号分开，可以是flv、hls、mp4格式中的一种或多种。

5.3.删除视频流

• 用途
  删除一个视频流。
  如果请求删除的是一个视频点播流名称（如"vod"应用下的某个流），会把这个点播流下的视频数据删除掉。
  如果请求的是一个直播流名称，则会把这个直播流下的所有版本的录制数据删除。要删除直播流的某个版本的录制数据，使用下一个接口（删除录制数据）。

• 请求
  streamMgr/?request=remove_stream&application=vod&stream=fk7cpizvhwshjnyu
  application 应用名
  stream 流名称

• 响应

  {
  "code":0
  }

5.4.删除录制数据

• 用途
  删除某个直播流的某个版本的录制数据。
  要删除所有版本的录制数据，请使用上一接口（删除视频流）；

• 请求
  streamMgr/?request=remove_stream_version&application=liveshow&stream=yellow&version=31
  application 应用名
  stream 流名称
  version 录制版本号

• 响应

  {
  "code":0
  }