概述：內嵌設定檔 API

在本主題中，您將取得擷取設定檔 API 的概觀。內嵌描述檔 API 可讓您建立、擷取、更新和刪除視訊雲端帳戶的轉譯描述檔。

管理內嵌設定檔

當您上傳或重新轉碼視訊時，內嵌描述檔可作為轉碼的規格。您可以使用「內嵌設定檔 API」來管理這些設定檔。

術語詞彙

設定檔 JSON

下面的「配置文件 JSON」一詞意味著配置文件對象的 JSON 表示。它們包含頂層設定檔欄位和一組節目物件做為清單。請參閱標準設定檔，查看包含在每個帳戶中的標準設定檔的 JSON，以及包含 DRM 封裝的範例設定檔的內容安全性 (DRM 和 HLSE) 。

設定檔 ID

A profile id可以是設定檔中的idname最上層欄位。在這個例子中（配置文件的片段）：

    {
        "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 調用中使用。

參考識別碼

reference_id唯一識別輪廓中的節目。參考 ID 用於 DRM 封裝，並可用於未來其他用途。除了在配置文件中是唯一的，引用 ID 可以是任何字符串-它不應該包含空格。我們建議使用一些方案，以便輕鬆識別轉譯的格式，例如：mp4_1、mp4_2、hls1、hls2等。

設定檔版本

A version是帳戶設定檔的修訂版本號碼。它由一個長整數值表示。注意：它不是在 JSON 表示中引用。

作用中設定檔

描述檔是active否可用於上傳。例如，如果您更新設定檔，您會得到一個新的設定檔，其中包含已遞增的版本號碼處於作用中狀態，而舊版本會變成非作用中狀態。

標準設定檔

配置文件是standard如果它提供給 Brightcove 使用（即它不是單個帳戶特定的自定義配置文件）。

預設設定檔

default如果未明確選擇任何設定檔時使用設定檔。如果您沒有帳戶配置，或者沒有在您的配置中設置默認配置文件，Brightcove standard配置文件將根據您的帳戶類型使用其中一個配置文件。

基本網址

服務網址為：

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

授權

該 API 的授權是通過布萊特灣的 OAuth2 實現。您需要用戶端憑證 (用戶端識別碼和用戶端密碼)，這些憑證對您的帳戶具有下列作業的權限：

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_id和client_secret，您需要轉到 OAuth UI 並註冊一個應用程序：

管理 API 身份驗證憑證

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

您將使用您的客戶端憑據來獲取訪問令牌，這將允許您對 API 進行調用。訪問令牌傳遞在授權標頭中：

    Authorization: Bearer {your_access_token}

如需詳細資訊，請參閱 Oauth 區段。

最大轉譯

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

有條件的輸出

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

帳戶操作

在帳戶層級，您可以取得帳戶的所有設定檔並建立新的設定檔。

端點

    /accounts/{account_id}/profiles

取得所有設定檔

要獲取帳戶的所有配置文件（包括標準配置文件），請向上面顯示的端點提交 GET 請求。

建立設定檔

若要建立新的設定檔，您可以將 POST 請求提交到上面顯示的端點，包括設定檔的 JSON 資料做為請求主體。見樣本資料以下是JSON數據的示例，以及配置文件字段參考允許的字段。

單一輪廓操作

對於個別設定檔，您可以依名稱或 ID 取得設定檔、取代設定檔，以及刪除設定檔。

端點

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

對於profile_id，您可以使用以下任一：

名稱（例如平衡高清晰度）
產生的識別碼 (例如：

通過 ID 獲取配置文件

要檢索單個配置文件，請對上面所示的端點發出 GET 請求。

更新設定檔

要更新配置文件，請對上面的端點發出 PUT 請求，包括請求正文中配置文件的完整 JSON 數據。

注意：更新的配置文件的 JSON 必須包含id屬性。

刪除設定檔

若要刪除設定檔，請對上述端點發出 DELETE 要求。

這個動作是無法復原的

預設設定檔操作

您可以使用端點取得、設定或更新帳戶的預設隨選視訊和即時視訊設定檔：

    /accounts/{account_id}/configuration

取得預設設定檔

透過向上述端點提出 GET 要求，擷取帳戶的預設設定檔。

如果未設定預設設定檔，系統會傳回系統預設設定檔。

設定預設設定檔

要設置默認配置文件，請對上面顯示的端點發出 POST 請求，包括請求正文中的 JSON：

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

對於default_profile_id，您可以使用以下任一：

名稱（例如平衡高清晰度）
產生的識別碼 (例如：

更新預設設定檔

要更新默認配置文件，請對上面顯示的端點發出 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}
    }

注意事項：

如果您指定不存在的設定檔，請求將會失敗

範例設定檔

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

浮水印

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

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

    ...
    "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"
            }
          ]
      }, ...

有關這些字段的完整說明，請參見<a href="https://zencoder.support.brightcove.com/encoding-settings/assets/encoding-settings-watermarks.html>水印字段參考</a>。 p> </ section> </ article> <！-完整的引導程序佈局-> </ div> <div class =“ col-sm-2 right-side-bar”>