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

概述: Player Management API

Player 管理是指創建,編輯和管理 player作為發布者的資源。 Player 管理是通過服務器端的REST API實現的,該API允許其使用者創建,配置,預覽和發布 player 實例。

簡介

創建和更新 players是分兩階段進行的。 而不是將所有更改自動應用於生產 players,將更改分為預覽和發布。 現在,您可以進行預覽所需的所有更新 player 而不會影響您的最終用戶。 您可以選擇隨時發布更改。

Player Management API 允許用戶:

  1. 創建一個 player
  2. 查看一個的設置 player
  3. 更改一個的設置 player
  4. 列出所有 player與發布者關聯的
  5. 發布一個 player 向消費者提供

另見 API參考.

基本網址

API的基本URL為:

    https://players.api.brightcove.com/v2

簡介

player 管理系統由三個關鍵對象組成。 它們是默認模板, players和孩子 players.

Brightcove默認模板 -模板是一組文件和設置,用作創建呈現給用戶的觀看體驗的基礎,也是所有 player已創建。 這些文件最終使用自定義進行編譯 player 設置並生成實際的代碼,該代碼已加載到瀏覽器中( player)。 當前只有一個模板在系統範圍內使用。 因此,無法通過API看到模板。

Players - Players是特定於客戶的設置,可捕獲要應用於模板的常規信息和自定義設置。 這些設置將發送到API, player 對象結果。 定制可以包括設置,樣式和插件。 有關自定義功能的完整列表,請參見 Player 配置指南.

孩子 Players -兒童 player使用Embed API創建的,是創建一個的多個實例的結果 player。 “ player 擁有您希望擁有的大部分屬性 player 有,然後你可以生一個孩子 player 自定義不同屬性的子集 player 實例。 一個孩子 player 只能定義要添加到給定媒體的媒體 player,也可以定義任何更改常規設置的設置或樣式替代 player 它所屬的。 對父母的改變 player 設置將適用於所有孩子 player是從父級產生的 player。 看看 嵌入式API指南 了解更多細節。

此圖顯示了默認模板之間的關係, players和孩子 players.

Player 實體層次
Player 實體層次

當您使用 Player Management API 第一次是Brightcove Default Player 是在您的帳戶中生成的。 那 player 對像是您要選擇的。 您可以按原樣使用它,更改其設置,重新設置其樣式或添加插件。 您可以選擇僅使用Brightcove默認值 Player 與您的自定義,或者您可以選擇創建其他 player捕獲網站上不同位置的不同外觀和設置。

發布概述

其中一個特點 Player 管理系統可以將您要測試的更改與您的版本分開 player 已公開發布。 在用戶界面和API中,當您更改 player的配置,可以通過預覽版本立即獲取更改 player。 這些預覽版完全可用且可測試。 您可以共享預覽網址以供批准,也可以在 player 預覽,直到對更改滿意為止,然後再發布 player 使其公開可用。

更新瀑布

發布一個 player 有可能影響孩子的後果 players。 以下是有關發布的詳細信息:

  • A player 發布觸發所有孩子的重新發布 player 從中創建的實例 player.
  • 一個孩子 player 發布只會影響那個孩子 player.
  • Brightcove默認模板更新(由Brightcove控制)將觸發所有內容的重新發布 players和 player 重新發布會觸發所有孩子重新發布 player從每個創建 player.

設置以兒童取勝方式應用。 這意味著子級的設置將優先於父級的設置。 考慮以下:

  • 默認模板將CSS值定義為紅色。
  • A player 將相同的CSS值定義為白色。
  • 一個孩子 player 將相同的CSS值定義為藍色。

由於孩子贏了,結果將是:

  • player的CSS值為白色。
  • 孩子 player的CSS值為藍色。

如果屬性的數據類型是數組,則可以更改此繼承行為。 的 數組字段 《 Embed APIs Guide》的“嵌入”部分介紹了詳細信息。

配置選項

為了創建一個 player 比默認值更高級 player,你必須提供一個 Player 組態。 使用JSON定義配置。

限速

Player Management API 每個啟用的唯一IP都有速率限制。 以下是速率限制:

請求類型 限制
發布和創建(player和嵌入) 60個請求/分鐘
讀取(獲取) 600個請求/分鐘
寫(POST,PUT,PATCH和DELETE) 300個請求/分鐘
Player 產品規格書預覽 100個請求/分鐘

響應狀態碼

響應和錯誤代碼/消息基於這些 由W3定義。 一些最常見的代碼是:

  • 200 要求成功
  • 201 已創建( player,一個配置)
  • 400 錯誤的請求-API調用的語法可能不正確
  • 401 身份驗證無效-檢查密碼輸入是否正確,或者您是否遵循了 OAuth指示 正確地
  • 404 找不到-檢查資源是否存在以及API調用中使用的URL是否正確
  • 429超過限速
  • 500 內部服務器錯誤-嘗試滿足請求時發生錯誤

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