接口规范 11. 串流相关接口

11 串流相关接口

11.1.查询串流任务

• 用途
  查询服务器上的串流任务。

• 请求
  streamingMgr/?request=get_streaming&id=
  id 串流任务在服务器上的唯一编号，省略时会返回所有任务的列表。

• 响应

  {
  "code":0,
  "data":{
      "count":2,
      "items":[
                  {
              "name":"监控视频",
              "id":"BAF9B8E5BA819259",
              "protocol":"rtsp",
              "source_url":"rtsp://192.168.2.246:8555/H264SubStream",
              "video_only":"on",
              "use_transcode":"on",
              "video_size":"1280x720",
              "width":"1280",
              "height":"720",
              "bitrate":"500",
              "use_audio_transcode":"on",
              "bitrate_audio":"56",
              "to_host":"localhost",
              "application":"show",
              "stream":"cameral1",
              "status":0
          },
          {
              "name":"本地文件串流",
              "id":"D16E78096B55C850",
              "protocol":"file",
              "source_url":"file:///var/media/jgdy.mp4",
              "to_host":"localhost",
              "application":"liveshow",
              "stream":"jgdy",
              "status":0
          }
      ]
  }
  }

  items元素包含0个或多个串流任务。
  name 串流的名称，在添加任务时输入
  id 串流的唯一编号，在添加任务时系统自动分配，后续管理串流任务需要该id
  protocol 输入协议
  source_url 视频源地址
  video_only 输入源是否只有视频，on表示只有视频
  audio_only 输入源是否只有音频，on表示只有音频
  use_transcode 是否启动视频转码，on表示启动，off或者省略表示没有转码
  width 转码的输出视频画面宽度，0表示保持输入源画幅大小
  height 转码的输出视频画面高度，0表示保持输入源画幅大小
  bitrate 视频转码的比特率，单位 kbps
  use_audio_transcode 是否启动音频转码，on表示启动，off或者省略表示没有转码
  bitrate_audio 音频转码比特率 单位 kbps
  to_host 串流的目标服务器IP或域名，localhost 表示串流到本机
  application 串流的目标应用名
  stream 串流的目标直播流名称
  status 串流任务状态 0没有运行 1正在运行 其他表示异常

11.2.添加串流任务

• 用途
  添加一个串流任务。
  添加串流任务时，要调用接口的客户端提供一个唯一的任务id，该id可由字母和数字组成，用于在调用后续接口时识别该任务。
  如果提供的id和已经存在任务的id相同，则服务器会将该请求当作修改串流任务处理。

• 请求
  streamingMgr/?request=add_streaming&name=监控视频&id=BAF9B8E5BA819259&protocol=rtsp&source_url=rtsp%3a%2f%2f192.168.2.246%3a8555%2fH264SubStream&video_only=on&use_transcode=on&video_size=1280x720&width=1280&height=720&bitrate=500&use_audio_transcode=on&bitrate_audio=56&to_host=localhost&application=show&stream=cameral1
  参数：
  id 任务唯一编号，应由字母或数字组成，长度建议在6个字符以上，要避免重复
  protocol 串流输入源的协议，支持rtsp、rtmp、udp、http、mms等协议
  source_url 串流输入的源地址，该参数需要进行【url编码】
  video_only 是否只有视频，on 表示只有视频，在只有视频时，所有音频相关参数会被忽略
  use_transcode 是否进行视频转码，on表示进行转码，off或者省略表示不转码。如果不进行视频转码，所有视频转码参数会被忽略
  width 视频转码输出的画面宽度，单位像素
  height 视频转码输出的画面高度，单位像素
  bitrate 视频转码输出的比特率，单位kpbs
  use_audio_transcode 是否进行音频转码，on表示进行转码，off或者省略表示不转码。如果不进行音频转码，所有音频转码参数会被忽略。
  bitrate_audio 音频转码比特率，单位kbps
  to_host 串流输出的目标服务器IP或域名，localhost表示向本机串流。
  application 串流输出的应用名，定义向服务器的哪个应用输出直播流
  stream 串流输出的直播流名称

• 响应

  {
  "code":0
  }

11.3.启动串流任务

• 用途
  启动一个串流任务。
  添加完串流任务后，可以调用该接口运行任务。

• 请求
  streamingMgr/?request=start_streaming&id=BAF9B8E5BA819259
  id 串流任务的唯一编号，可以通过查询串流任务接口获得。

• 响应

  {
  "code":0
  }

11.4.停止串流任务

• 用途
  停止一个串流任务。

• 请求
  streamingMgr/?request=stop_streaming&id=8A9B587159245ED5
  id 串流任务的唯一编号，可以通过查询串流任务接口获得。

• 响应

  {
  "code":0
  }

11.5.删除串流任务

• 用途
  删除一个串流任务。

• 请求
  streamingMgr/?request=remove_streaming&id=8A9B587159245ED5
  id 串流任务的唯一编号，可以通过查询串流任务接口获得。

• 响应

  {
  "code":0
  }