接口規范 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
  }