接口規(guī)范 13. 文件上傳及管理相關(guān)接口

13 文件上傳及管理相關(guān)接口

這組接口實(shí)現(xiàn)視頻資源的上傳及管理，為視頻轉(zhuǎn)碼和發(fā)布提供支持。
上傳的服務(wù)器上的視頻文件，經(jīng)過轉(zhuǎn)碼發(fā)布后形成可以對(duì)外播出的在線視頻資源。
本小節(jié)描述文件上傳和管理的接口，轉(zhuǎn)碼接口在下一章節(jié)說明。

13.1.文件上傳接口

• 用途
  通過HTTP POST協(xié)議上傳視頻文件。文件上傳接口是一個(gè)特殊的接口，接口位置與其他接口有差異。
  上傳協(xié)議采用HTTP POST協(xié)議，提交form的數(shù)據(jù)采用multipart/form-data編碼（enctype="multipart/form-data"）。
  這里有詳細(xì)的規(guī)范（對(duì)于Web開發(fā)，通常您無需閱讀這個(gè)文檔）：
  rfc1867 http://www.ietf.org/rfc/rfc1867.txt
  對(duì)于采用Web頁面上傳的應(yīng)用，采用典型的form提交上傳文件即可，數(shù)據(jù)提交地址設(shè)為本接口地址。

• 請(qǐng)求
  http://host/upload?app=g3_video&sub_path=&file_name=&token=abcd&field_name=field_abcd
  其中:
  http://host/upload 是上傳位置，保持不變。host替換成實(shí)際的流媒體服務(wù)器IP地址或域名。
  參數(shù)：
  app=g3_video,表示上傳的是視頻文件，要保持不變。
  sub_path表示上傳到哪個(gè)子目錄下，如果省略表示上傳到用戶根目錄下。
  file_name上傳文件要在服務(wù)器上保存的文件名，如果跟上傳文件名一樣，則省略。該參數(shù)提供了一個(gè)上傳文件在服務(wù)器上重新命名的機(jī)會(huì)。中文件名要采用UTF-8編碼。
  token意義跟其他接口一樣。

• 響應(yīng)

  {
  "code":0
  }

13.2.查詢文件列表接口

• 用途
  查詢服務(wù)器上的某個(gè)目錄下的視頻文件列表。
• 請(qǐng)求
  fileMgr/?request=list_files&subpath=&page=1
  sub_path 文件存放的子目錄，對(duì)應(yīng)上傳文件時(shí)的sub_path參數(shù)。如果省略，則查詢用戶根目錄下的文件。
  page頁碼，該接口支持分頁查詢，分頁信息在返回?cái)?shù)據(jù)中。
• 響應(yīng)

  {
  "code":0,
  "data":{
      "page":"1",
      "page_size":"50",
      "pages":"1",
      "total":"1",
      "count":1,
      "items":[{
              "filename":"案例視頻8.mp4",
              "mtime":"2018-01-12 12:43",
              "size":"3153954",
              "charset":"UTF-8",
              "timestamp":1515732410,
              "is_media":1,
              "duration":98,
              "bitrate":255309,
              "stream_number":2,
              "timestamp_m":1515397208,
              "streams":[
                          {
                          "index":"0",
                          "type":"video",
                          "codec":"h364",
                          "pic_width":640,
                          "pic_height":352,
                          "bitrate":208980,
                          "duration":98,
                          "pix_fmt":"yuv420p",
                          "frame_rate":"28/1"
                          },
                          {
                          "index":"1",
                          "type":"audio",
                          "codec":"aac",
                          "lan":"und",
                          "channels":1,
                          "bitrate":43970,
                          "duration":98,
                          "sample_rate":44100
                          }
                        ]
              }]
      }
  }

  返回?cái)?shù)據(jù)包含分頁信息，在文件量較大時(shí)要按頁查詢。
  items元素包含0或多個(gè)文件信息。streams元素是該文件包含的音視頻流信息，一個(gè)多媒體文件會(huì)包含1到多個(gè)音視頻流
  filename 文件名，返回的文件名總是采用UTF-8編碼
  charset 文件名在服務(wù)器上的字符集編碼，省略表示是UTF-8編碼。如果為非UTF-8編碼，在后續(xù)的接口中請(qǐng)將該屬性帶入
  mtime 文件最后的修改時(shí)間
  size 文件大小，單位字節(jié)
  duration 文件播出時(shí)長，單位秒
  bitrate 綜合碼率，單位bps
  stream_number 文件包含的音視頻流總數(shù)
  streams元素：
  streams包含0或多個(gè)音視頻流，屬性：
  index 流的索引編號(hào)，在轉(zhuǎn)碼接口中，在多語言音頻流的情況下，可以通過傳入音頻流索引號(hào)選擇指定的音頻流。
  type 視頻或音頻，對(duì)應(yīng) video 或 audio
  codec 流編碼格式，例如視頻h364編碼，音頻aac編碼等
  bitrate 流的比特率，單位bps
  pix_fmt 視頻幀格式
  frame_rate 幀率
  pic_width 視頻畫幅寬度
  pic_height 視頻畫幅高度
  lan 音頻語言信息，語言編碼縮寫
  channels 音頻聲道數(shù)
  sample_rate音頻采樣率

13.3.查詢文件目錄接口

• 用途
  查詢服務(wù)器上的文件目錄。
• 請(qǐng)求
  fileMgr/?request=list_dirs&subpath=
  sub_path 文件存放的子目錄，如果省略，則查詢用戶根目錄下的文件目錄。
• 響應(yīng)

  {
  "code":0,
  "data":{
      "count":2,
      "items":[
          {
              "filename":"auto",
              "mtime":"2018-01-06 16:36",
              "size":"4096",
              "timestamp":0,
              "auto_transcode":1
          },
          {
              "filename":"audio",
              "mtime":"2017-12-27 18:09",
              "size":"4096",
              "timestamp":0,
              "auto_transcode":0
          }]
   }
  }

  items元素包含0或多個(gè)目錄信息。
  filename 目錄名
  mtime 最后修改時(shí)間
  auto_transcode 是否針對(duì)該目錄設(shè)置了自動(dòng)轉(zhuǎn)碼任務(wù)，1表示有自動(dòng)轉(zhuǎn)碼任務(wù)

13.4.查詢文件信息接口

• 用途
  查詢服務(wù)器上的某個(gè)視頻文件的信息。
• 請(qǐng)求
  fileMgr/?request=get_file&filename=案例視頻8.mp4&charset=UTF-8
  filename 文件名，如果在子目錄中，應(yīng)當(dāng)包含完整的相對(duì)目錄，如 mypath/myfile.mp4，文件名采用UTF-8編碼
  charset 文件名在服務(wù)器上的實(shí)際字符集編碼，在查詢文件列表接口中有返回。
• 響應(yīng)

  {
  "code":0,
  "data":{
      "count":1,
      "items":[
          {
              "filename":"/案例視頻8.mp4",
              "charset":"UTF-8",
              "mtime":1515732213,
              "size":3153954,
              "timestamp":1516941450,
              "is_media":1,
              "duration":98,
              "bitrate":255309,
              "stream_number":2,
              "timestamp_m":1515397208,
              "streams":[
                  {
                      "index":"0",
                      "type":"video",
                      "codec":"h364",
                      "pic_width":640,
                      "pic_height":352,
                      "bitrate":208980,
                      "duration":98,
                      "pix_fmt":"yuv420p",
                      "frame_rate":"28/1"
                  },
                  {
                      "index":"1",
                      "type":"audio",
                      "codec":"aac",
                      "lan":"und",
                      "channels":1,
                      "bitrate":43970,
                      "duration":98,
                      "sample_rate":44100
                  }
              ]
          }
      ]
  }
  }

  返回一個(gè)文件的信息，包含多媒體信息。
  返回?cái)?shù)據(jù)的文件信息的描述與查詢文件列表接口中對(duì)文件信息的描述相同。

13.5.刪除文件接口

• 用途
  刪除服務(wù)器上的文件。
• 請(qǐng)求
  fileMgr/?request=remove&filename=myvideo.mp4&charset=ASCII
  filename 文件名，如果在子目錄中，應(yīng)當(dāng)包含完整的相對(duì)目錄，如 mypath/myfile.mp4，文件名采用UTF-8編碼
  charset 文件名在服務(wù)器上的實(shí)際字符集編碼，在查詢文件列表接口中有返回。
• 響應(yīng)

  {
  "code":0
  }