支持 聯繫支持 | 系統狀況 系統狀態
頁面內容

    一步步: Delivery System API

    本文檔提供了有關如何使用 Delivery System API 創建存儲庫(存儲庫),然後在存儲庫中保存並更新插件。

    概述

    這是您將執行的步驟:

    • 使用創建倉庫 Delivery System API
    • 創建用於存儲文件的本地文件夾
    • 創建一個插件並將其複製到倉庫
    • 改變 player 使用新的插件
    • 更改插件並觀察 player 使用修改後的插件

    注意:如果您是經驗豐富的Git用戶,您將看到一些API調用執行與Git相同的功能。 實際上,某些文件操作API調用只是執行Git命令。

    先決條件

    要開始這些逐步說明,請假設您已完成 一步步: Player 管理。 通過完成上述活動,您已經在命令行系統中定義了以下環境變量:

    • $ ACCOUNT_ID
    • $ EMAIL
    • $PLAYER_ID

    創建倉庫

    您現在將使用 Delivery System API 創建存儲庫並將文件複製到該存儲庫。 創建存儲庫後,您還可以使用API​​列出存儲庫,顯示存儲庫詳細信息,刪除存儲庫等,但是在許多工作流程中,這不是必需的。

    在curl語句中創建新的倉庫,您將使用HTTP PUT 方法,並在URL中包含新存儲庫的名稱。 執行此curl語句以創建一個名為repo的倉庫 firstRepo.

        curl \
          --user $EMAIL \
          --request PUT \
          https://repos.api.brightcove.com/v1/accounts/$ACCOUNT_ID/repos/firstRepo
        

    您將收到確認回購創建的回复。 響應將顯示:回購的名稱和公共URL。

    • 名稱:回購名稱
    • public_url:回購的公共URL
    • repo_url:存儲庫URL
        {
          "name": "firstRepo",
          "public_url": "http://players.brightcove.net/1507807800001/firstRepo",
          "repo_url": "https://repos.api.brightcove.com/v1/accounts/1507807800001/repos/firstRepo"
        }

    創建文件夾

    接下來,您需要在計算機上本地創建一個文件夾,用於存儲與您的關聯文件 Brightcove Player。 在您選擇的位置創建文件夾,然後移動(cd)放入該文件夾。

        mkdir firstRepo
        cd firstRepo

    創建插件

    現在,您將在文件夾中創建一個插件以復製到倉庫。 分步使用相同的插件: Player 管理,除了更改顯示的文本。 創建文件,將下面的文本粘貼到文件中,然後保存。 使用與分步操作相同的文件名: Player 管理, first-plugin.js.

        videojs.registerPlugin('firstPlugin', function() {
          var player = this,
          overlay = document.createElement('p');
          overlay.className = 'vjs-overlay';
          overlay.innerHTML = "NEW TEXT!";
          player.el().appendChild(overlay);
        });

    現在,您將新創建的插件文件複製到倉庫。 使用以下cURL語句執行此任務。

        curl \
          --user $EMAIL \
          --form contents=@first-plugin.js \
          --request PUT \
          https://repos.api.brightcove.com/v1/accounts/$ACCOUNT_ID/repos/firstRepo/files/first-plugin.js

    複製之後,您應該看到類似於以下內容的確認:

        {
          "name": "first-plugin.js",
          "public_url": "http://players.brightcove.net/1507807800001/firstRepo/first-plugin.js"
        }

    您可以使用以下cURL語句查看文件內容,以確認文件已正確複製。

        curl http://players.brightcove.net/$ACCOUNT_ID/firstRepo/first-plugin.js

    您也可以通過瀏覽 public_url 從文件副本返回。

    使用新的插件

    在分步中: Player 管理人員使用了curl語句來告訴 player 插件的JavaScript代碼的位置以及CSS位置和插件名稱。 您將再次執行相同的操作,只是這次插件的路徑將使用在文件副本的響應中找到的新路徑(如上副本響應的第2行所示)。 執行以下curl語句以指向新的插件位置。

        curl \
          --header "Content-Type: application/json" \
          --user $EMAIL \
          --request PATCH \
          --data '{
            "scripts": [
              "http://players.brightcove.net/$ACCOUNT_ID/firstRepo/first-plugin.js"
            ],
            "stylesheets": [
              "http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"
            ],
            "plugins": [{
              "name": "firstPlugin"
            }]
          }' \
          https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

    使用返回的 preview_url 瀏覽 player 然後您將看到顯示的插件中的新文本。 如果您選擇,還可以發布 player 並獲得出版 player URL。

    修改插件

    使用新型Brightcove的優勢之一 player 易於更新 player只需對插件進行一次更改,然後全部 player使用該插件的將會更新。 在這一步的這一點上,您將對插件進行少量更改,並看到其正在使用中,而無需對插件進行任何更改 player 本身。

    打開 first-plugin.js 文件並更新文本以供閱讀 較新的文字!

        overlay.innerHTML = "NEWer TEXT!";

    再次將文件複製到倉庫。

        curl \
          --user $EMAIL \
          --form contents=@first-plugin.js \
          --request PUT \
          https://repos.api.brightcove.com/v1/accounts/$ACCOUNT_ID/repos/firstRepo/files/first-plugin.js

    瀏覽相同 preview_url 從上方再次。 注意:由於瀏覽器緩存,您可能需要關閉瀏覽器選項卡,然後再次瀏覽,甚至清除瀏覽器的緩存以查看更新的文本。

    看到插件功能的最新版本後,即可發布 player.


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