概述:玩家管理 API

玩家管理是指玩家的創建、編輯和管理,作為發佈商的資源。播放程式管理是由伺服器端 REST API 實現的,可讓其消費者建立、設定、預覽和發佈播放程式執行個體。
 

簡介

創建和更新播放器的過程分為兩個階段。並非將所有更改自動應用於生產播放器,而是將更改分為預覽和發布。現在,您可以對預覽播放器進行所有希望的更新,而不會影響最終用戶看到的內容。您可以選擇隨時發布更改。

播放器管理API允許用戶執行以下操作:

  1. 創建一個球員
  2. 檢視玩家的設定
  3. 變更玩家的設定
  4. 列出與發布者關聯的所有玩家
  5. 發佈播放程式,使其可供消費者使用

另請參閱API參考

基本網址

API 的基本網址是:

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

簡介

玩家管理系統由三個關鍵對象組成。它們是默認模板,播放器和子播放器。

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

玩家們 -播放器是特定於客戶的設置,可捕獲要應用於模板的常規信息和自定義設置。這些設置將發送到API,並生成播放器對象。定制可以包括設置,樣式和插件。有關定制可能性的完整列表,請參見播放器配置指南

兒童玩家 -使用Embed API創建的子播放器是創建一個播放器的多個實例的結果。播放器具有您希望播放器擁有的大部分屬性,然後您可以使用子播放器來自定義不同播放器實例上的屬性子集。子播放器只能定義要添加到給定播放器中的媒體,也可以定義任何更改其所屬普通播放器的設置或樣式替代。對父級玩家設置的更改將應用於從父級玩家衍生的所有子級玩家。看看嵌入式API指南有關更多詳細信息。

此圖顯示了默認模板,播放器和子播放器之間的關係。

玩家實體階層
玩家實體階層

首次使用Player Management API時,您的帳戶中會生成一個Brightcove Default Player。該播放器對象供您選擇。您可以按原樣使用它,更改其設置,重新設置其樣式或添加插件。您可以選擇僅使用Brightcove Default Player進行自定義設置,也可以選擇創建其他播放器以捕獲網站上不同位置的不同外觀和設置。

發布概述

播放器管理系統的功能之一是能夠將要測試的更改與公開發布的播放器版本分開。在UI和API中,當您更改播放器的配置時,這些更改將通過播放器的預覽版本立即可用。這些預覽版完全可用且可測試。在發布播放器以使其公開可用之前,您可以共享預覽URL以獲得批准或在播放器預覽上進行工作,直到對更改滿意為止。

更新瀑布

發布玩家會影響子玩家。以下是有關發布的詳細信息:

  • 玩家發布觸發從該玩家創建的所有子玩家實例的重新發布。
  • 子玩家發布僅影響該子玩家。
  • Brightcove默認模板更新(由Brightcove控制)將觸發所有玩家的重新發布,而玩家重新發布又將觸發從每個玩家創建的所有子玩家的重新發布。

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

  • 默認模板將CSS值定義為紅色。
  • 播放器將相同的CSS值定義為白色。
  • 子播放器將相同的CSS值定義為藍色。

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

  • 播放器的CSS值為白色。
  • 子播放器的CSS值為藍色。

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

組態選項

為了創建一個比默認播放器更高級的播放器,您必須提供一個播放器配置。使用JSON定義配置。

速率限制

播放器管理API對每個啟用的唯一IP都有速率限制。以下是速率限制:

請求類型 限制
發布和創建(播放器和嵌入) 60個請求/分鐘
讀取(獲取) 600個請求/分鐘
寫(POST,PUT,PATCH和DELETE) 300個請求/分鐘
播放程式預覽 每分鐘100個請求

響應狀態碼

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

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