プレーヤー設定ガイド

account_id

プレーヤーに関連付けられた Video Cloud アカウント ID。この値は変更できません。

config_id

ad_config_id information:

• データ型:文字列
• デフォルト: undefined
• 動的配信 SSAI 広告構成 ID。プレーヤー設定で設定できるだけでなく、iframe プレーヤーの場合は adconfigID クエリ文字列パラメーター、またはページ内プレーヤーの場合は data-ad-config-id 属性を使用して実行時に設定できます。これらのいずれかがプレイヤー構成内の任意の値を上書きします。

値を設定するその他の方法:

failover

ad_failover information:

• データ型:ブール
• デフォルト: undefined
• 広告のフェイルオーバー動作を有効にするには、true に設定します。これは、次の要素に依存するマルチパート構成です。
  • IMA3 プラグインと SSAI プラグインは両方ともプレーヤーで設定する必要があります。
  • ad_config_idを利用できるはずです。そうでない場合、SSAI 広告は利用できません。

true に設定した場合、プレーヤーは広告ブロック検出が決定するまで自動初期化プロセスを遅らせます。これにより、プレーヤーの初期化が最大 100 ミリ秒ほど遅れる可能性があります。

application_id

application_id information:

• データ型:文字列
• デフォルト: undefined
• アプリケーション ID は、メトリクスにおける 1 つのプレーヤーの複数の用途を区別するために使用されます。ユーザーには見えません。

値を設定するその他の方法：

オートアドバンス

autoadvance information:

• データ型:文字列
• デフォルト:最初は有効になっていない
• プレイリストで使用し、プレイリストの自動進動作を設定します。

詳細については、以下のプレイリストのセクションとプレイリスト API ドキュメントを参照してください。

自動再生

autoplay information:

• データ型:ブール値または文字列
• デフォルト: false
• これが許可されているプラットフォームで、プレーヤーがすぐにプレイを開始する必要があることを示します。

autoplayがブール値に設定されている場合、ブラウザーのネイティブの自動再生動作が使用されます。次の 3 つの有効な文字列値のいずれかに設定すると、次のようになります。

• play :プレーヤーは手動でプレイを呼び出そうとします。
• muted :プレーヤーは手動でプレイヤーをミュートし、プレイを呼び出します。
• any :プレイヤーは、まずプレイを呼び出そうとします。それが失敗した場合は、プレイヤーをミュートしてプレイを呼び出してください。

上記のいずれかが失敗した場合、プレイヤーは「ビッグプレイボタン」を、自動再生がfalseに設定されているかのように表示します。

次に、autoplay値を設定する curl ステートメントを示します。

ブール値の使用例

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
      "autoplay": true
      }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

文字列値の使用例

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
      "autoplay": "muted"
      }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

ビデオを自動再生するには、複雑な状況になる可能性があります。詳細については、「自動再生に関する考慮事項」を参照してください。

値を設定するその他の方法:

robots

block_robots情報:

• データ型:ブール値
• デフォルト: undefined
• Brightcove Player 6.51.0 以降でのみ使用できます。
• true の場合、追加します<meta>タグを iframe 埋め込み HTML に追加して、Google のクローラーなどのロボットが iframe 埋め込み HTML のコンテンツのインデックスを作成しないようにします。

次に示すように、使用すると真を意味することに注意してください。

<meta name="robots" content="noindex,nofollow">

コンテキストメニュー

context_menu情報:

• データ型:ブール型またはオブジェクト
• デフォルト: true
• true またはオブジェクトの場合、プレーヤーには、右クリックまたはロングタッチおきにアクティブ化されたコンテキストメニューが含まれます。このコンテキストメニューでは、プレーヤー情報のモーダルを開くか、ブライトコーブの企業 Web サイトへのリンクを開くことができます。コンテキストメニューの使用の詳細については、 Brightcove Player 情報モーダルドキュメントを参照してください。

  オブジェクトの場合は、次のプロパティがサポートされます。

  プロパティ	効果
  branding	に設定できますfalse明示的に削除するにはブライトコーブについてカスタムコンテキストメニューからのリンク。

  例:

  "context_menu": {
    "brightcove_branding": false
  }

クロスオリジン

crossorigin information:

• データ型:ブール値
• デフォルト:偽
• true の場合、基になる < video>要素は crossorigin= "anonymous」になります。つまり、プレーヤーに取り込まれたビデオやテキストトラックには CORS ヘッダーが必要です。

値を設定するその他の方法:

CSS カラーオーバーライド

プレーヤーの色をオーバーライドするために使用できる3つのプロパティがあります。非対応形式:

• controlColor :ボタンとテキストの色（再生ヘッドの位置やビデオ再生時間など）
• controlBarColor :コントロールバーと大きな再生ボタンの背景色
• progressColor :プログレスバーの色

これらのプロパティには、有効な CSS カラー (16 進色など) が許容される値です。

次に、CSS プロパティの 3 つすべてを緑に設定する curl ステートメントと、結果を表示するスクリーンショットが続きます。

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request PATCH \
  --data '{
      "css": {
        "controlColor": "green",
        "controlBarColor": "green",
        "progressColor": "green"
      }
  }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

デバッグします

debug情報:

• データ型:ブール値
• デフォルト: false
• true の場合、プレーヤーはデバッグモードになります。これは、再生エンジンや分析など、さまざまなプレーヤーコンポーネントのログを有効にするために使用できます。

デバッガ

このプロパティは非推奨です。を参照してください。コンテキストメニュー。

ドック

dock information:

• データ型:ブール値
• デフォルト:true
• 明示的であればfalse、プレーヤーにはビデオタイトルと説明を表示できる、いわゆるドックは含まれません。

embed_id

embed_id information:

• データ型:文字列
• デフォルト: undefined
• このプレーヤーに関連付けられた Video Cloud 埋め込み ID。値がの場合、defaultそのプレイヤーは子プレーヤーではないことを意味します。値がでない場合default、それはプレイヤーの親を表す値です。

値を設定するその他の方法：

エラー

errors information:

• データ型:オブジェクトまたはブール値
• デフォルト:true
• false明示的に設定すると、プレーヤーはエラーメッセージプラグインである videojs-errors を含めることを防ぎます。この値を false にすると、エラーが発生したときに、プレーヤーは詳細なエラーメッセージを視聴者に表示しません。再生を妨げるエラーは、Web 開発者コンソールに表示されます。

fullscreen_control（またはフルスクリーンコントロール）

fullscreen_control情報:

• データ型:ブール値
• デフォルト:true
• フルスクリーンコントロールをコントロールバーに表示するかどうかを示します。 false の場合、ダブルクリックして全画面表示へのアクションも無効になります。

次に、fullscreen_control値を設定する curl ステートメントを示します。

  curl \
  --header "Content-Type: application/json" \
  --user $EMAIL \
  --request PATCH \
  --data '{
    "autoplay": true,
    "fullscreen_control": false
    }' \
  https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

次の 2 つのスクリーンショットは、フルスクリーンコントロールの有無にかかわらず、プレーヤーを示しています。

hls

hls information:

• データタイプ:オブジェクトまたはブール演算
• デフォルト: {}
• 場合false、プレーヤーは videojs-http-streaming を含みません。それ以外の場合は、 videojs-http-ストリーミングのオプションとしてオブジェクトが渡されます。

initial_bidth

initial_bandwidth情報:

• データ型:数値
• デフォルト: undefined
• 6.53.0 以降でのみ利用可能
• 低帯域幅または高帯域幅シナリオを優先するために、再生エンジンのレンディション選択をプライムするために使用されるビット/秒の初期値を設定します

言語

language information:

• データ型:文字列
• デフォルト: undefined
• iframe lang<html>埋め込みの要素の属性、つまりプレーヤーの言語を設定するために提供できます。

値を設定するその他の方法：

言語

languages information:

• データタイプ:文字列の配列
• デフォルト: undefined
• 指定された言語をプレーヤーに含めるための文字列の配列を指定できます。有効な言語は、Video.js に含まれている言語だけです。詳細については、「Brightcove Player のローカライズ」ドキュメントを参照してください。

値を設定するその他の方法：

ループ

loop情報:

• true の場合、ビデオが終了するとすぐに最初からやり直します。

値を設定するその他の方法：

メディア

mediaプロパティには、オブジェクトまたはオブジェクトの配列を指定できます。次の表に示すように、子プロパティを持ちます。

例

単一のソース例：

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "src": "//path/to/some/media-file.mp4",
  "width": "600px"
}

複数のソースの例:

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "width": "600px"
}

複数のメディアオブジェクトの例：

"media": [{
  "height": "300px",
  "src": "//path/to/some/media-file.mp4",
  "width": "600px"
}, {
  "height": "300px",
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "width": "600px"
}]

実際に再生されるソースの詳細については、「どのレンディションが再生されるかを決定する」を参照してください。

currentSrc()関数を使用すると、どのソースが再生されているかを確認できます。次のスクリーンショットは、ブラウザコンソールでの関数の使用を示しています。

トラックの例を含むメディアオブジェクト：

"media": {
  "height": "300px",
  "poster": {
    "highres": "//path/to/poster.jpg"
  },
  "sources": [{
    "src": "//path/to/some/media-file.mp4",
    "type": "video/mp4"
  }, {
    "src": "//path/to/some/media-file.webm",
    "type": "video/webm"
  }],
  "tracks": [{
    "src": "//path/to/captions.vtt",
    "srclang": "en",
    "label": "English"
  }],
  "width": "600px"
}

次のJSONでは、media含むプロパティ：

• A ポスター.highres プロパティ
• A ソース 2つのソースオブジェクトを含むプロパティ。1つはHLSビデオ用、もう1つはMP4ビデオ用です。

  "media": {
    "poster": {
      "highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
    },
    "sources": [{
      "type": "application/x-mpegURL",
      "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8"
    }, {
      "type": "video/mp4",
      "src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4"
    }]
  },

ミュートされています

muted information:

• データ型:ブール値
• デフォルト： false
• プレーヤーのロード時にサウンドをミュートするかどうかを指定します。

値を設定するその他の方法：

picture_in_picture_control

picture_in_picture_control information:

• データ型:ブール値
• デフォルト:true
• 組み込みのピクチャインピクチャコントロールをコントロールバーに表示するかどうかを指定します。

play_button

play_button情報:

• データ型:オブジェクト
• デフォルト: undefined
• カスタムプレーヤーボタンスタイルの CSS クラスを追加します。Brightcove Playerバージョン 5 以降のみ

オブジェクトのプロパティ:

playback

playback_rates information:

• データタイプ:配列
• デフォルト：なし
• 再生レートコントロールに表示する再生レートの配列。

値は読み込まれ、プレイヤーのコントロールバーの再生レートコントロールに表示されます。

Studio または curl を使用して、プロパティの値を変更できます。

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
        "playback_rates": [0.1,1,2.5,6]
       }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

プレーヤー

player information:

• データタイプ:オブジェクト
• デフォルト：プレイヤー固有の情報を入力
• このプレーヤーに関するさまざまなメタデータが含まれています, 次の表は、最も関連性の高いリストされています.

プロパティ	タイプ	効果
非アクティブ	ブール値	true の場合、プレーヤーはグレーのボックスに表示され、コンテンツ所有者がプレーヤーを無効にしたことを説明するエラーメッセージが表示されます。を参照してください非アクティブな詳細詳細については、この表の下の内容を参照してください。
template.version	ひも	プレーヤーのビルド元のテンプレートバージョン番号。プレーヤーモジュールの JSON エディタを使用して、プレーヤーのバージョンを手動で設定できます。
in_page_embed_url	ひも	ページ内埋め込みに使用するベース URL

非アクティブの詳細

プレイヤーを非アクティブにすることは可能です。これは、プレーヤーがコンテンツの提供を停止し、削除されたプレーヤーが閲覧された場合に 404 エラーが表示されないようにしたい場合があります。

プレイヤーを無効にするには、playerinactiveフィールドのプロパティをtrue , 次のように:

            curl \
            --header "Content-Type: application/json" \
            --user $EMAIL \
            --request PATCH \
            --data '{
              "player": {
                  "inactive": true
              }
            }' \
            https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

もちろん、プレーヤーを有効にしたい場合は、inactiveプロパティをに設定することができますfalse。

プレーヤーを無効にすると、ユーザーがプレーヤーを参照すると、次のメッセージが表示されます。

player_id

player_id information:

• データ型:文字列
• プレーヤーに関連付けられた Video Cloud プレーヤー ID

値を設定するその他の方法：

player_name

player_name information:

• データ型:文字列
• プレイヤーに関連付けられている Video Cloud

プレイインライン

playsinline information:

• データ型:ブール値
• デフォルト:偽
• インライン/非ネイティブプレーヤーの再生に playsinline属性を必要とするプラットフォーム (iOS など) でプレーヤーがインライン再生を許可するかどうかを決定します。

値を設定するその他の方法:

プラグイン

pluginsこの配列は、video.js プラグインを初期化する順序と、それらに適用するカスタマイズされた設定を指定します。プラグインは、scripts対応するプロパティの URL エントリ、および必要に応じてサポートstylesheets URL でサポートされる必要があります。plugins配列の各要素は、nameプロパティを持つオブジェクトです。

たとえば、plugins プロパティが次のように表示されたとします。

"plugins": [{
  "name": "foo",
  "options": {
    "bar": true
  }
}]

実行時に、 fooプラグインは、指定されたオプションで初期化されます。

player.foo({bar: true});

プラグインオブジェクトに含まれるスクリプトやスタイルシートは、トップレベルのスクリプトやスタイルシートと同じ方法でインライン化されます。インライン化されます。 前 トップレベルのアセット。

オプションプロパティの詳細

optionsこの子プロパティでは、初期化時に使用するデータを渡します。次の JSON は、内の 1 つのオブジェクトを渡しますoptions。

  "plugins": [{
    "name": "navigateOnVideoEnd",
    "options" : {"redirectURL": "http://docs.brightcove.com"}
  }]

これにより、プレーヤーの設定を介してプラグインにデータを渡すことができるようになります。たとえば、redirectURL上記のオブジェクトを使用するには、プラグイン自体で次のようにします。

  videojs.registerPlugin('navigateOnVideoEnd', function (options) {
    var myPlayer = this;
    myPlayer.on("ended", function () {
      window.location.href = options.redirectURL;
    });
  });

注：標準プラグインの実装を使用しますが、options無名関数のパラメータとして使用します。その後、options.propertyName記法を使用して値にアクセスできます。

Brightcoveが提供するプラグインの中には、プラグインレジストリを利用するものもあり、ここで示したものとは設定が異なります。概要を参照してください。詳細については、プラグインレジストリドキュメント。

プリロード

preload information:

• データ型:文字列
• デフォルト: none
• preload 属性は、ビデオタグがロードされるとすぐにビデオデータのダウンロードを開始するかどうかをブラウザに通知します。オプションは、[ 自動]、[ メタデータ]、および [なし]です。

オプションの詳細

• 自動 :ユーザーが最終的にビデオを見ない場合でも、ビデオファイル全体をダウンロードできることを示します。肯定的な面では、視聴者がビデオを再生すると、すぐに再生を開始できます。負の側では、視聴者がビデオを再生しない場合でも、プリロード/ロードが発生するため、このオプションは帯域幅消費を増加させます。

• メタデータ (デフォルト):ビデオのメタデータをロードします。これには、ビデオの持続時間やサイズなどの情報が含まれます。この設定では、数秒のビデオデータもロードされます。

• なし :ビデオデータをプリロードしないでください。これは、ユーザーが [再生] をクリックしてダウンロードを開始するまで待ちます。

値を設定するその他の方法:

  <video-js preload ...>
  or
  { "preload": "auto" }

query_string_to_window

query_string_to_window information:

1. • 名前: query_string_to_window.target
   • データ型:文字列
   • 説明:ウィンドウに作成する宛先オブジェクト。パースされたクエリ文字列全体が移入されます。たとえば、query_string_to_window.targetプレーヤー構成で次のものを使用します。

       {
       "query_string_to_window": {"target": "queryStringParams"}
       }

     次のクエリ文字列を指定します。

       ?foo=bar&nums=1&nums=2

     を使用すると、window.queryStringParams次のグローバルオブジェクトがプレーヤーとプラグインで利用できるようになります。

       {
       foo: 'bar',
       nums: ['1', '2']
       }

2. • 名前: query_string_to_window.globals
   • データタイプ:配列
   • 説明:ウィンドウオブジェクトのプロパティ名の配列で、クエリ文字列内の値から移入されます。windowオブジェクトまたはそのプロトタイプチェーンにすでに存在する一致するプロパティは設定されません。たとえば、query_string_to_window.globalsプレーヤー構成で次のものを使用します。

       {
       "query_string_to_window": {
         "globals": [
           "foo",
           "nums",
           "self"
         ]
       }
       }

     次のクエリ文字列を指定します。

       ?foo=bar&nums=1&nums=2&self=not-allowed

     を使用すると、window次のプロパティが追加された次のグローバルオブジェクトが生成されます。

       window.foo; // 'bar'
       window.nums; // ['1', '2']
       
       // Because `self` already exists on the `window` object, it will not be set
       // and a warning will be logged to the browser console.
       window.self; // window

繰り返す

repeat information:

• データ型はboolean
• プレーヤーがプレイリストプレーヤーの場合、プレイリストの再生が繰り返されます。つまり、プレイリストプロパティが使用されている場合です。
• プレイヤー構成の最上位レベルで設定します。

スクリプト

scripts information:

• データ型は、プレーヤーに含まれている JavaScript ファイルを参照する文字列の配列です
• デフォルト値なし
• プレーヤーのビルド時に、これらのファイルはダウンロードされ、結果の出力にインライン展開されるため、実行時に後でフェッチする必要はありません
• スクリプトは scripts配列で指定された順序でインライン化されます。

  "scripts": [
    "https://example.com/script.js",
    "https://example.com/depends-on-script.js"
  ]

• スクリプトは指定された順序でインライン化されるため、互いに依存するスクリプトを安全に含めることができます。

スキン

skin information:

• データ型:ブールまたは文字列
• デフォルト:未定義
• プレーヤーが使用する表示スタイルバリアントを決定します。この値は、bc.SKINブラウザーのグローバルアクセス可能なプロパティにも反映されます。次の値が認識されます。

  値	BC.skin	説明
  "graphite"	"graphite"	旧バージョンの Brightcove Player スタイルといくつかの互換性ハックを使用します。
  false	"none"	すべての Brightcove プレーヤーのスタイリングを無効にします。これは、高度にカスタマイズされた UI をゼロから使用するオプションです。
  未定義	"luna"	undefinedこのままにすると、プレイヤーはデフォルトのスキン (例:k.a.Luna)。

stylesheets

stylesheets information:

• プレーヤーに含めるべきCSSファイルを参照するURL文字列の配列
• プレーヤーの構築時に、追加のスタイルシートがダウンロードされ、プレーヤーにインライン展開されるため、実行時にフェッチする必要はありません
• スタイルシートは、 stylesheets配列で指定した順序で含まれます。

  "stylesheets": [
    "https://example.com/layout.css",
    "https://example.com/skin.css"
  ]

suppress_not_supported

suppress_not_supported_error information:

• データ型:ブール
• デフォルト:未定義
• true の場合、ソースを再生できない最初のエラーは、最初のユーザーインタラクションまで延期されます。Googlebot など、動画を再生できないブラウザからエラーを隠すのに便利です。

tech_order (または techOrder)

tech_order information:

• データ型:配列
• デフォルト：['html5'、'フラッシュ']
• デフォルトでは、Brightcove Player は、動画を再生するソースと技術の組み合わせを検索するときに、技術ファースト・オーダーを実行します。つまり、2 つのソースと 2 つの技術がある場合、プレーヤーは次の再生テクノロジを試す前に、tech_orderオプションプロパティの最初の技術を使用して各ビデオを再生しようとします。ガイドを参照してください。詳細については、再生テクノロジのドキュメントを参照してください。

次の curl ステートメントを使用して、tech_orderをデフォルトからに変更できます。['html5','flash']['flash','html5'] :

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
        "tech_order": "['flash','html']"
       }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

umd

umd (Universal Module Definition) information:

• データ型:ブール
• デフォルト:true
• ブライトコーブプレイヤー 6.53.0 以降でのみ使用可能
• true の場合、RequireJS などのモジュールシステムで使用するために、UMD (ユニバーサルモジュール定義) の定型文をプレーヤーに追加します。明示的にfalseに設定すると、プレーヤーはモジュールローダーを操作せず、単にbc グローバル変数を公開します。

volume_オリエンテーション

volume_orientation information:

• データ型:文字列
• デフォルト:水平
• ブライトコーブプレイヤー 6.32.0 以降でのみ使用可能
• volume_orientationプロパティは、ボリュームレベルスライダーが水平方向または垂直のどちらに向いているかを決定します。

  

  

有効な値は次のとおりです。

Studio または curl を使用して、プロパティの値を変更できます。

  curl \
    --header "Content-Type: application/json" \
    --user $EMAIL \
    --request PATCH \
    --data '{
        "volume_orientation": "vertical"
       }' \
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration

vttjs

vttjs information:

• データ型:文字列
• デフォルト:vjs.zencdn.net CDN
• これは、標準の Video.js オプション vtt.js と同じです。BrightcovePlayerはvttjs代わりに、点線のプロパティ名はPlayer Management APIでは使用できず、他の場所で問題が発生する可能性があるためです。
• として設定することができますデータ-vttjs属性、 vttjs iframeクエリパラメータ、 vttjsセットアップオプションまたはvttjsプレーヤー構成で。

wait_for_ad_block_detect

wait_for_ad_block_detect information:

• データ型:ブール値
• デフォルト:未定義
• に設定するとtrue、広告ブロック検出が決定するまで、プレーヤーは自動初期化プロセスを遅らせます。これにより、プレイヤーの初期化が最大100ミリ秒程度遅れる可能性があります。これをに設定する必要はありませんtrue使用する場合ad_failoverどちらの場合も遅延動作が発生するためです。