接口規(guī)范 11. 串流相關(guān)接口

11 串流相關(guān)接口

11.1.查詢(xún)串流任務(wù)

• 用途
  查詢(xún)服務(wù)器上的串流任務(wù)。

• 請(qǐng)求
  streamingMgr/?request=get_streaming&id=
  id 串流任務(wù)在服務(wù)器上的唯一編號(hào)，省略時(shí)會(huì)返回所有任務(wù)的列表。

• 響應(yīng)

  {
  "code":0,
  "data":{
      "count":2,
      "items":[
                  {
              "name":"監(jiān)控視頻",
              "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個(gè)或多個(gè)串流任務(wù)。
  name 串流的名稱(chēng)，在添加任務(wù)時(shí)輸入
  id 串流的唯一編號(hào)，在添加任務(wù)時(shí)系統(tǒng)自動(dòng)分配，后續(xù)管理串流任務(wù)需要該id
  protocol 輸入?yún)f(xié)議
  source_url 視頻源地址
  video_only 輸入源是否只有視頻，on表示只有視頻
  audio_only 輸入源是否只有音頻，on表示只有音頻
  use_transcode 是否啟動(dòng)視頻轉(zhuǎn)碼，on表示啟動(dòng)，off或者省略表示沒(méi)有轉(zhuǎn)碼
  width 轉(zhuǎn)碼的輸出視頻畫(huà)面寬度，0表示保持輸入源畫(huà)幅大小
  height 轉(zhuǎn)碼的輸出視頻畫(huà)面高度，0表示保持輸入源畫(huà)幅大小
  bitrate 視頻轉(zhuǎn)碼的比特率，單位 kbps
  use_audio_transcode 是否啟動(dòng)音頻轉(zhuǎn)碼，on表示啟動(dòng)，off或者省略表示沒(méi)有轉(zhuǎn)碼
  bitrate_audio 音頻轉(zhuǎn)碼比特率 單位 kbps
  to_host 串流的目標(biāo)服務(wù)器IP或域名，localhost 表示串流到本機(jī)
  application 串流的目標(biāo)應(yīng)用名
  stream 串流的目標(biāo)直播流名稱(chēng)
  status 串流任務(wù)狀態(tài) 0沒(méi)有運(yùn)行 1正在運(yùn)行 其他表示異常

11.2.添加串流任務(wù)

• 用途
  添加一個(gè)串流任務(wù)。
  添加串流任務(wù)時(shí)，要調(diào)用接口的客戶(hù)端提供一個(gè)唯一的任務(wù)id，該id可由字母和數(shù)字組成，用于在調(diào)用后續(xù)接口時(shí)識(shí)別該任務(wù)。
  如果提供的id和已經(jīng)存在任務(wù)的id相同，則服務(wù)器會(huì)將該請(qǐng)求當(dāng)作修改串流任務(wù)處理。

• 請(qǐng)求
  streamingMgr/?request=add_streaming&name=監(jiān)控視頻&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
  參數(shù)：
  id 任務(wù)唯一編號(hào)，應(yīng)由字母或數(shù)字組成，長(zhǎng)度建議在6個(gè)字符以上，要避免重復(fù)
  protocol 串流輸入源的協(xié)議，支持rtsp、rtmp、udp、http、mms等協(xié)議
  source_url 串流輸入的源地址，該參數(shù)需要進(jìn)行【url編碼】
  video_only 是否只有視頻，on 表示只有視頻，在只有視頻時(shí)，所有音頻相關(guān)參數(shù)會(huì)被忽略
  use_transcode 是否進(jìn)行視頻轉(zhuǎn)碼，on表示進(jìn)行轉(zhuǎn)碼，off或者省略表示不轉(zhuǎn)碼。如果不進(jìn)行視頻轉(zhuǎn)碼，所有視頻轉(zhuǎn)碼參數(shù)會(huì)被忽略
  width 視頻轉(zhuǎn)碼輸出的畫(huà)面寬度，單位像素
  height 視頻轉(zhuǎn)碼輸出的畫(huà)面高度，單位像素
  bitrate 視頻轉(zhuǎn)碼輸出的比特率，單位kpbs
  use_audio_transcode 是否進(jìn)行音頻轉(zhuǎn)碼，on表示進(jìn)行轉(zhuǎn)碼，off或者省略表示不轉(zhuǎn)碼。如果不進(jìn)行音頻轉(zhuǎn)碼，所有音頻轉(zhuǎn)碼參數(shù)會(huì)被忽略。
  bitrate_audio 音頻轉(zhuǎn)碼比特率，單位kbps
  to_host 串流輸出的目標(biāo)服務(wù)器IP或域名，localhost表示向本機(jī)串流。
  application 串流輸出的應(yīng)用名，定義向服務(wù)器的哪個(gè)應(yīng)用輸出直播流
  stream 串流輸出的直播流名稱(chēng)

• 響應(yīng)

  {
  "code":0
  }

11.3.啟動(dòng)串流任務(wù)

• 用途
  啟動(dòng)一個(gè)串流任務(wù)。
  添加完串流任務(wù)后，可以調(diào)用該接口運(yùn)行任務(wù)。

• 請(qǐng)求
  streamingMgr/?request=start_streaming&id=BAF9B8E5BA819259
  id 串流任務(wù)的唯一編號(hào)，可以通過(guò)查詢(xún)串流任務(wù)接口獲得。

• 響應(yīng)

  {
  "code":0
  }

11.4.停止串流任務(wù)

• 用途
  停止一個(gè)串流任務(wù)。

• 請(qǐng)求
  streamingMgr/?request=stop_streaming&id=8A9B587159245ED5
  id 串流任務(wù)的唯一編號(hào)，可以通過(guò)查詢(xún)串流任務(wù)接口獲得。

• 響應(yīng)

  {
  "code":0
  }

11.5.刪除串流任務(wù)

• 用途
  刪除一個(gè)串流任務(wù)。

• 請(qǐng)求
  streamingMgr/?request=remove_streaming&id=8A9B587159245ED5
  id 串流任務(wù)的唯一編號(hào)，可以通過(guò)查詢(xún)串流任務(wù)接口獲得。

• 響應(yīng)

  {
  "code":0
  }