サポート サポートへのお問い合わせ | システムステータス システムステータス
ページコンテンツ

    ステップバイステップ:デリバリーシステム API

    このドキュメントでは、配信システム API を使用してリポジトリ (レポ) を作成する方法の実践的な概要を説明します。リポジトリでは、プラグインを保存および更新します。

    概要

    実行する手順は次のとおりです。

    • Delivery SystemAPIを使用してリポジトリを作成します
    • ファイルストレージ用のローカルフォルダを作成します
    • プラグインを作成し、リポジトリにコピーします
    • 新しいプラグインを使用するようにプレーヤーを変更します
    • プラグインを変更し、プレーヤーが変更されたプラグインを使用していることを確認します

    注:経験豊富なGitユーザーの場合、API呼び出しの一部がGitでも実行できる同等の機能を実行していることがわかります。実際、ファイル操作API呼び出しの中には、単にGitコマンドを実行するものもあります。

    前提条件

    これらのステップバイステップの説明を開始するには、ステップバイステップ:プレーヤー管理。上記のアクティビティを完了することにより、コマンドラインシステムで次の環境変数を定義しました。

    • $ ACCOUNT_ID
    • $ EMAIL
    • $ PLAYER_ID

    リポジトリを作成する

    次に、Delivery System APIを使用してリポジトリを作成し、ファイルをそのリポジトリにコピーします。リポジトリが作成されると、APIを使用してリポジトリの一覧表示、リポジトリの詳細の表示、リポジトリの削除などを行うこともできますが、多くのワークフローではこれは必要ありません。

    新しいリポジトリを作成するためのcurlステートメントでは、HTTPを使用しますPUTメソッドを使用して、新しいリポジトリの名前をURLに含めます。このcurlステートメントを実行して、という名前のリポジトリを作成しますfirstRepo

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

    リポジトリの作成を確認する応答が届きます。応答には、リポジトリの名前とパブリックURLが表示されます。

    • name:リポジトリの名前
    • 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

    プラグインを作成する

    次に、フォルダにプラグインを作成して、リポジトリにコピーします。ステップバイステップから同じプラグインを使用します。表示されるテキストを変更することを除いて、プレーヤー管理。ファイルを作成し、下のテキストをファイルに貼り付けて保存します。ステップバイステップで使用したものと同じファイル名を使用します。プレイヤー管理、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ファイルコピーから返されます。

    新しいプラグインを使用する

    ステップバイステップで:プレーヤー管理curlステートメントを使用して、プラグインの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プレーヤーを閲覧すると、プラグインからの新しいテキストが表示されます。必要に応じて、プレーヤーを公開し、公開されたプレーヤーのURLを取得することもできます。

    プラグインを変更する

    新しいBrightcoveプレーヤーを使用する利点の1つは、プラグインに1回の変更を加えるだけでプレーヤーを簡単に更新できることであり、そのプラグインを使用するすべてのプレーヤーが更新されます。手順のこの時点で、プラグインに小さな変更を加え、プレーヤー自体に変更を加えることなく、プラグインが使用されていることを確認します。

    を開きます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再び上から。注:ブラウザのキャッシュが原因で、ブラウザのタブを閉じてもう一度参照するか、ブラウザのキャッシュをクリアしてテキストが更新されていることを確認する必要がある場合があります。

    プラグインの最新バージョンが機能していることを確認したら、プレーヤーを公開できます。