播放程式組態指南

帳號 ID

與播放器相關聯的視訊雲端帳號 ID。無法修改此值。

配置識別碼

ad_config_id資訊：

• 資料類型：字串
• 默認：undefined
• 動態傳遞 SSAI 廣告組態識別碼。除了在播放程式組態上設定之外，還可以透過 iframe 播放程式的 AdConfiggID 查詢字串參數在執行階段設定，或是頁面內播放程式的資料廣告配置 ID 屬性。其中任何一個都將覆蓋播放器配置中的任何值。

其他設置值的方法：

AD_容錯移轉

ad_failover資訊：

• 資料類型：布林值
• 默認：undefined
• 設為 true 以啟用廣告容錯移轉行為。這是一個多部分配置，取決於：
  • 您必須在播放器上設定 IM3 和 SSAI 外掛程式。
  • 應ad_config_id該有可用，否則 SSAI 廣告無法使用。

當設置為真的，播放器將延遲其自動初始化過程，直到廣告攔截檢測做出決定。這可能會延遲播放器初始化高達 100 毫秒左右。

應用程式 ID

application_id資訊：

• 資料類型：字串
• 默認：undefined
• 應用程式識別碼可用來區分度量中單一播放程式的多重用途。它是用戶不可見的。

其他設置值的方法：

僅音頻播放

將音頻資產與 Brightcove Player 一起使用時，有兩個自定義播放器的選項：

• 純音頻模式

  在此模式下，除控制欄外，所有播放器 UI 均被隱藏。

• 音頻海報模式

  在此模式下，海報圖像會在播放期間永久顯示。播放器尺寸與此模式下的視頻播放器相同。

兩種模式不能同時啟用。

• 如果兩者audio_only_mode和audio_poster_mode在播放器配置中設置為 true，純音頻模式將優先。
• 通過以下方式以編程方式啟用一種模式player.audioOnlyMode(true)或者player.audioPosterMode(true)如果啟用，將禁用其他模式。

有關實施細節，請參閱Brightcove Player 僅音頻文檔。

自動進階

autoadvance資訊：

• 資料類型：字串
• 預設：初始未啟用
• 與播放列表一起使用並設置播放列表的自動前進行為。

如需詳細資訊，請參閱下方的「播放清單」部分，以及播放清單 API 文件。

自動播放

autoplay資訊：

• 資料類型：布林值或字串
• 默認：false
• 表示播放器應該立即開始播放，在允許此操作的平台上。

如果設定autoplay為布林值，則會使用瀏覽器的原生自動播放行為。如果設定為下列三個有效字串值之一，就會發生下列情況：

• play：玩家將手動嘗試調用播放。
• muted：玩家將手動將播放器靜音並呼叫播放。
• any：玩家會先嘗試呼叫播放。如果失敗，請將播放器靜音並呼叫播放。

如果上述任何一項失敗，玩家將顯示「大遊戲按鈕」，就好像自動播放設定為 false 一樣。

下面顯示了一個 curl 語句來設置autoplay值：

使用布林值的範例

  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

讓視頻自動播放可能是一個複雜的情況。如需詳細資訊，請參閱「自動播放考量」文件。

其他設置值的方法：

塊機器人

block_robots資訊：

• 資料類型：布林值
• 默認：undefined
• 僅適用於 Brightcove Player 6.51.0 及更新版本。
• 如果為真，則添加一個<元>標記到 iframe 嵌入 HTML 以防止像 Google 的爬蟲這樣的機器人索引 iframe 嵌入 HTML 的內容。

屆時將添加以下內容真的 :

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

中國代理域名

china_proxy_domain資訊：

• 資料類型：字串
• 默認：undefined
• 如果提供，此域將用於路由玩家通過備用主機名向 Brightcove 服務發出的請求。一個例子是：

  "china_proxy_domain": "china.example.com"

上下文菜單

context_menu資訊：

• 數據類型：布爾值或對象
• 默認：true
• 如果真的或一個對象，播放器將包含一個上下文菜單，該菜單會在每隔一次右鍵單擊或長按時激活。此上下文菜單可以打開玩家信息模式或指向 Brightcove 公司網站的鏈接。有關使用上下文菜單的更多信息，請參閱Brightcove 玩家信息模式文檔。

  如果是對象，則支持以下屬性：

  屬性	效果
  brightcove_branding	可以設置為錯誤的明確地刪除關於 Brightcove來自自定義上下文菜單的鏈接。

  範例：

  "context_menu": {
    "brightcove_branding": false
  }

交叉原點

crossorigin資訊：

• 資料類型：布林值
• 預設值：假
• 如果為 true ，底層 < 視頻 > 元素將具有交叉源 =「匿名」。這意味著任何拉入播放器的視頻或文本軌道都必須有 CORS 標題。

其他設置值的方法：

CSS 顏色覆寫

有三個屬性可以用來覆蓋播放器中的顏色。它們是：

• controlColor：按鈕和文字的顏色 (例如，播放磁頭位置和視訊持續時間)
• controlBarColor：控制欄和大播放按鈕的背景顏色
• progressColor：進度條的顏色

任何有效的 CSS 顏色（例如，包括十六進制顏色）都是這些屬性可接受的值。

這裡是一個 curl 語句，將所有三個 CSS 屬性設置為綠色，然後顯示結果的屏幕截圖：

  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
• 如果真的 , 播放器將被置於調試模式。這可用於打開各種播放器組件的日誌記錄，例如播放引擎和分析。

除錯器

此屬性已棄用，請參閱上下文菜單 .

delivery_config_id

delivery_config_id資訊：

• 資料類型：字串
• 默認：undefined
• 動態交付規則配置 ID。

其他設置值的方法：

碼頭

dock資訊：

• 資料類型：布林值
• 預設值：真實
• 如果明確的話false，播放器將不會包含可以顯示影片標題和說明的所謂 Dock 。

嵌入 ID

embed_id資訊：

• 資料類型：字串
• 默認：undefined
• 與此播放器相關聯的視訊雲端嵌入 ID。如果值是default這意味著玩家不是一個孩子玩家。如果該值不是default，它是代表玩家父代的值。

其他設置值的方法：

錯誤

errors資訊：

• 資料類型：物件或布林值
• 預設值：真實
• 明確設置false將阻止播放器包含視頻錯誤，這是錯誤消息插件。如果將此值設為 false，則在發生錯誤時，玩家無法向觀眾顯示詳細的錯誤訊息。阻止播放的錯誤仍然會出現在 Web 開發者控制台中。

全屏控制（或全屏控制）

fullscreen_control資訊：

• 資料類型：布林值
• 預設值：真實
• 指示是否應在控制欄中顯示全屏控件。如果錯誤的，雙擊全屏操作也將被禁用。

下面顯示了一個 curl 語句來設置fullscreen_control值：

  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

下列兩個螢幕擷取畫面會顯示有或不具有全螢幕控制的播放器：

HLS

hls資訊：

• 資料類型：物件或布林值
• 默認：{}
• 如果false播放程式將不包含視訊-HTTP 串流。否則，一個對象將被作為視頻的 HTTP 流的選項傳遞。

初始帶寬

initial_bandwidth資訊：

• 數據類型：數字
• 默認：undefined
• 僅適用於 6.53.0 及更新版本
• 設置一個初始比特每秒值，用於準備播放引擎的再現選擇以支持低或高帶寬場景

語言

language資訊：

• 資料類型：字串
• 默認：undefined
• 可以提供設置lang的屬性<html> iframe 中的元素嵌入，因此，播放器的語言。

其他設置值的方法：

語言

languages資訊：

• 資料類型：字串陣列
• 默認：undefined
• 可以是字符串數組，這將導致指定的語言被包含在播放器中。唯一有效的語言是包含在 Video.js 中的語言。如需詳細資訊，請參閱本地化布萊特灣播放器文件。

其他設置值的方法：

迴圈

loop資訊：

• 如果真的 , 使視頻在結束後立即重新開始。

其他設置值的方法：

媒體

這media property 可以是對像或對像數組，並具有下表所示的子屬性。

範例

單一來源示例：

"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到包含：

• 一個海報。高級財產
• 包含兩個來源物件的來源屬性，一個用於 HLS 視訊，另一個用於 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資訊：

• 資料類型：布林值
• 預設值：假
• 決定播放程式載入時音效是否為靜音。

其他設置值的方法：

圖片控制

picture_in_picture_control資訊：

• 資料類型：布林值
• 預設值：真實
• 指出內建子母畫面控制項是否應該顯示在控制列中。

播放按鈕 (_S)

play_button資訊：

• 數據類型：對象
• 默認：undefined
• 為自定義播放器按鈕樣式添加 CSS 類，僅限 Brightcove Player 版本 5+

對象屬性：

播放速率 (_L)

playback_rates資訊：

• 資料類型：陣列
• 預設：無
• 播放速率控制中顯示的播放速率陣列。

然後在播放器控制欄中的播放速率控制中讀取這些值。

您可以使用 Studio 或捲曲來更改屬性的值：

  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資訊：

• 資料類型：物件
• 預設：填入玩家特定資訊
• 包含有關此播放器的各種元數據，最相關的列在下表中。

屬性	類型	效果
非作用中	布林	什麼時候真的，播放器將顯示為灰色框，並顯示一條錯誤消息，說明內容所有者已停用播放器。見不活躍的細節此表下方的內容以獲取更多信息。
模板.版本	串	構建播放器的模板版本號。您可以使用 PLAYER 模組 JSON 編輯器手動設定播放程式版本。
嵌入式網址	串	用於頁內嵌入的基本 URL

不活躍的細節

有可能讓玩家無法使用。您可能想要這樣做，讓播放程式停止提供內容，但是如果瀏覽已刪除的播放程式，則不會顯示 404 錯誤。

若要停用播放器，請將player欄位的inactive屬性設定為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。

停用播放程式後，如果使用者瀏覽播放程式，將會出現下列訊息：

播放器 ID

player_id資訊：

• 資料類型：字串
• 與播放器相關聯的視訊雲端播放器 ID

其他設置值的方法：

播放器名稱 (_L)

player_name資訊：

• 資料類型：字串
• 與播放器關聯的視頻雲播放器名稱

遊戲內嵌

playsinline資訊：

• 資料類型：布林值
• 預設值：假
• 確定播放器是否應允許在需要在線播放內聯/非本地播放器播放的屬性（例如 iOS）。

其他設置值的方法：

插件

這plugins array 指定初始化 video.js 插件的順序以及要應用於它們的任何自定義設置。該插件必須由相應的scripts屬性 URL 條目支持，如果需要支持的stylesheets URL。的每個元素plugins數組是一個對象name財產。

例如，如果您的插件屬性如下所示：

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

在運行時，富插件將使用提供的選項進行初始化：

player.foo({bar: true});

插件對像中包含的任何腳本或樣式表都將以與頂級腳本或樣式表相同的方式內聯；他們將被內聯前頂級資產。

選項物業詳情

在這個options子屬性，你傳遞數據在初始化時使用。下列 JSON 會傳遞在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資訊：

• 資料類型：字串
• 默認：none
• 預加載屬性通知瀏覽器視頻數據是否應該在加載視頻標籤後立即開始下載。選項為自動、中繼資料和無選項。

選項詳情

• 自動：表示可以下載整個視訊檔案，即使使用者最後沒有觀看視訊。正面來說，如果觀眾播放視頻，它可以立即開始播放。在負面的一面，這個選項會增加頻寬消耗，因為即使觀眾不播放視頻，預先載入/載入也會發生。

• 中繼資料 (預設)：載入視訊的中繼資料，其中包括視訊的持續時間和尺寸等資訊。此設定也會載入數秒的視訊資料。

• 無：請勿預先載入任何視訊資料。這將等到用戶點擊播放開始下載。

其他設置值的方法：

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

查詢字串到視窗

query_string_to_window資訊：

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資訊：

• 資料類型為boolean
• 如果播放器是播放清單播放器，將導致播放清單重複播放。也就是說，如果播放列表財產被使用。
• 設定在播放程式設定的最上層。

腳本

scripts資訊：

• 數據類型是一個字符串數組，參考包含在播放器中的 JavaScript 文件
• 沒有預設值
• 在播放器構建時，這些文件將被下載並內聯到生成的輸出中，以便它們不需要隨後在運行時獲取
• 腳本按照它們在劇本大批：

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

• 由於腳本是按指定順序內聯的，因此您可以安全地包含相互依賴的腳本

皮膚

skin資訊：

• 資料類型：布林值或字串
• 預設值：未定義
• 決定播放器將使用的視覺型式變體。這個值也反映在瀏覽器中的全局訪問bc.SKIN屬性。它會識別下列值：

  價格	BC. 皮膚	描述
  「石墨」	「石墨」	使用舊的布里特灣播放器風格以及一些兼容性黑客。
  假的	「無」	停用所有布萊特灣播放器樣式。這是從頭開始用於高度自定義 UI 的選項。
  未定義	「月神」	離開這個選項undefined會導致玩家使用預設的外觀 (也就是月神）。
  “藍寶石”	“藍寶石”	使用 Video Cloud Studio 創建播放器時的默認皮膚，而不是播放器本身的默認皮膚。

樣式表

stylesheets資訊：

• 引用應該包含在播放器中的 CSS 文件的 URL 字符串數組
• 在構建播放程序時，會下載額外的樣式表並內聯到播放器中，以便不需要在運行時獲取它們
• 樣式表按照您在樣式表大批：

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

抑制不支持錯誤

suppress_not_supported_error資訊：

• 資料類型：布林值
• 預設值：未定義
• 如果真的，無法播放源的初始錯誤被推遲到第一次用戶交互。對於無法播放視頻的瀏覽器隱藏錯誤很有用，例如 Googlebot。

技術訂單（或技術訂單）

tech_order資訊：

• 資料類型：陣列
• 預設值：['html5'，'閃光燈']
• 默認情況下，Brightcove Player 在搜索源/技術組合播放視頻時執行技術優先順序。這意味著如果您有兩個來源和兩個技術人員，播放器將嘗試播放每個視頻與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 (Universal Module Definition)資訊：

• 資料類型：布林值
• 預設值：真實
• 僅適用於 Brightcove Player 6.53.0 及更新版本
• 什麼時候真的 , 在播放器周圍添加 UMD（通用模塊定義）樣板，以便與 RequireJS 等模塊系統一起使用。如果明確設置為錯誤的，播放器將不會使用模塊加載器，只會公開 bc 全局變量。

體積 _ 方向

volume_orientation資訊：

• 資料類型：字串
• 預設值：水平
• 僅適用於 Brightcove Player 6.32.0 及更新版本
• 該volume_orientation屬性決定音量級滑塊是水平還是垂直方向。

  

  

有效值為：

您可以使用 Studio 或捲曲來更改屬性的值：

  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資訊：

• 資料類型：字串
• 預設值：
• 這與標準 Video.js 選項相同vtt.js .Brightcove 播放器使用vttjs相反，在播放器管理 API 中不可能使用帶點的屬性名稱，並且在其他地方可能會出現問題。
• 可以設置為數據-vttjs屬性，一個vttjs iframe 查詢參數，a vttjs設置選項或vttjs在播放器配置中。

等待區塊偵測

wait_for_ad_block_detect資訊：

• 資料類型：布林值
• 預設值：未定義
• 設定為時true，玩家會延遲其自動初始化程序，直到廣告封鎖偵測作出決定為止。這可能會延遲播放器初始化高達 100 毫秒左右。這不需要設置為true當使用時，ad_failover因為在這兩種情況下都會發生延遲行為。