支持 聯繫支持 | 系統狀況 系統狀態

概述: Ingest Profiles API

在本主題中,您將獲得有關 Ingest Profiles API。 “ Ingest Profiles API 允許您創建,檢索,更新和刪除移交配置文件 Video Cloud 帳戶。

管理攝取配置文件

上傳或重新轉碼視頻時,提取配置文件用作轉碼的規範。 您可以使用 Ingest Profiles API.

專業術語

資料JSON

下面的術語“配置文件JSON”表示配置文件對象的JSON表示形式。 它們包含頂級配置文件字段和一組再現對象列表。 看到 標準配置文件 查看每個帳戶中包含的標準配置文件的JSON,以及 內容安全性(DRM和HLSe) 用於包含DRM包裝的樣本配置文件。

個人資料ID

A profile id 可以是 id or name 配置文件中的頂級字段。 在此示例中(配置文件的一部分):

    {
        "id": "5591b5ede4b0f7138939ad8c",
        "version": 4,
        "name": "screencast-1280",
        "description": "A high resolution profile optimized for screencasts with 1280 x 720 resolution.", ...

“ screencast-1280”或“ 5591b5ede4b0f7138939ad8c”都是有效的配置文件ID。 首次創建配置文件時,將提供一個帶有名稱但沒有ID的配置文件,並且響應中將包含創建的配置文件及其ID。 然後,您可以在隨後的任何API調用中使用它們。

參考編號

A reference_id 在配置文件中唯一標識演繹形式。 參考ID用於DRM打包,將來可能用於其他目的。 除了在配置文件中唯一之外,參考ID可以是任何字符串-不應包含空格。 我們建議使用某種方案,以使其易於識別格式的格式,例如: mp4_1, mp4_2, hls1, hls2等等。

個人資料版本

A version 是帳戶的配置文件的修訂版號。 它由一個長整數值表示。 注意:在JSON表示中未引用。

活動資料

個人資料是 active 如果可以用於上傳。 例如,如果更新配置文件,則會得到一個新的配置文件,該配置文件具有遞增的版本號,該版本號處於活動狀態,而舊版本則變為非活動狀態。

標準配置文件

個人資料是 standard 如果提供它供Brightcove使用(即它不是特定於單個帳戶的自定義配置文件)。

默認配置文件

個人資料是 default 如果未明確選擇配置文件時使用它。 如果您沒有帳戶配置,或者未在配置中設置默認配置文件,則使用Brightcove之一 standard 配置文件將根據您的帳戶類型使用。

基本網址

服務URL是:

    https://ingestion.api.brightcove.com/v1/

授權

通過Brightcove的OAuth2實現對API進行授權。 您將需要客戶端憑據(客戶端ID和客戶端密鑰),該憑據對您的帳戶具有以下操作權限:

  • video-cloud/ingest-profiles/profile/read
  • video-cloud/ingest-profiles/profile/write
  • video-cloud/ingest-profiles/account/read
  • video-cloud/ingest-profiles/account/write

得到一個 client_idclient_secret,則需要轉到OAuth UI並註冊一個應用:

您也可以通過CURL或郵遞員獲取憑據-請參閱:

您將使用客戶端憑據獲取訪問令牌,這些令牌將允許您調用API。 訪問令牌在授權標頭中傳遞:

    Authorization: Bearer {your_access_token}

看到 Oauth部分 了解更多信息。

最大演繹

您可以在攝取配置文件中定義的最大演繹數為25。如果定義的數量上限超過409,則請求將返回錯誤XNUMX響應:配置文件的演繹計數超出配置的演繹限制。

有條件的輸出

如果您攝取的視頻質量差異很大(例如,您的視頻可能包含使用低質量相機在手機上創建的用戶生成的內容),則可能希望根據視頻的比特率或其他屬性來生成某些移交源視頻。 這將防止創建和存儲冗餘格式。 看到 條件輸出 有關如何執行此操作的詳細信息。

賬戶操作

在帳戶級別,您可以獲取該帳戶的所有配置文件並創建新的配置文件。

端點

    /accounts/{account_id}/profiles

獲取所有資料

獲取該帳戶的所有配置文件(包括 標準型材),則將GET請求提交到上面顯示的端點。

建立個人資料

要創建新的配置文件,您需要向上述端點提交POST請求,包括該配置文件的JSON數據作為請求正文。 看到 樣本資料 以下是JSON數據的示例,以及 配置文件字段參考 允許的字段。

單配置文件操作

對於單個概要文件,您可以按名稱或ID獲取概要文件,替換概要文件,然後刪除概要文件。

端點

    /accounts/{account_id}/profiles/{profile_id}

對於 profile_id,您可以使用:

  • 名稱(例如,平衡高清)
  • generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

通過ID獲取個人資料

要檢索單個配置文件,請向上述端點發出GET請求。

更新個人資料

要更新配置文件,請向上述端點發出PUT請求,包括 完成 請求正文中的配置文件的JSON數據。

刪除個人資料

要刪除配置文件,請向上述端點發出DELETE請求。

這個動作是 不可逆轉

默認配置文件操作

您可以使用端點獲取,設置或更新帳戶的默認視頻點播和實時視頻配置文件:

    /accounts/{account_id}/configuration

獲取默認配置文件

向上述端點發出GET請求,以獲取您帳戶的默認配置文件。

如果未設置默認配置文件,則將返回系統默認配置文件。

設置默認配置文件

要設置默認配置文件,請向上述端點發出POST請求,包括請求正文中的JSON:

    {
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

對於 default_profile_id,您可以使用以下任一種:

  • 名稱(例如,平衡高清)
  • generated id (e.g. 54de14cce4b0a6d2bf9cb08a)

更新默認配置文件

要更新默認配置文件,請向上方顯示的端點發出PUT請求,並在請求正文中包含以下JSON:

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_profile_id": {default_profile_id}
    }

獲取 configuration_id 從響應到GET或POST請求。

設置默認實時配置文件

設置默認實時配置文件與設置默認視頻點播配置文件完全相同,不同之處在於請求正文中的這一更改:

    {
      "id": {configuration_id},
      "account_id": {account_id},
      "default_live_profile_id": {default_live_profile_id}
    }

筆記:

  • 如果您指定了不存在的配置文件,則請求將失敗

樣本資料

標準配置文件 該文檔將為您顯示所有當前存在的所有默認配置文件 Video Cloud 帳戶。

水印

如果要在視頻中添加水印(或徽標圖像),則可以使用提取配置文件中的水印字段。

這是帶有水印的演繹配置文件的示例:

    ...
    "renditions": [
        {
          "media_type": "video",
          "id": "559697ece4b072e9641b8404",
          "reference_id": "mp0",
          "format": "mp4",
          "audio_codec": "aac",
          "audio_bitrate": 64,
          "video_codec": "h264",
          "speed": 3,
          "video_bitrate": 450,
          "decoder_bitrate_cap": 771,
          "decoder_buffer_size": 1028,
          "keyframe_rate": 0.5,
          "max_frame_rate": 30,
          "width": 480,
          "height": 270,
          "h264_profile": "baseline",
          "watermarks": [
            {
              "y": "70%",
              "width": "20%",
              "url": "http://learning-services-media.brightcove.com/images/bc_logo.png"
            }
          ]
      }, ...

看到


頁面最後更新於12年2020月XNUMX日