簡介
您可以在 player 配置從下面開始詳細介紹(並在左側導航欄中列出) 帳戶ID。 本文檔中還包括有關如何查看和配置屬性值的信息。
查看配置
有很多方法可以查看 player的配置,在本節中詳細介紹。
使用Studio
您可以使用Studio查看 player的JSON配置。 以下步驟詳細說明了該過程:
- 打開 PLAYERS 模塊並找到 player 您希望查看其中的配置。
- 點擊鏈接 player 打開 player的屬性。
- 點擊 JSON編輯器 在左側導航菜單中。
- 您可以查看 player的配置,類似於以下內容:
瀏覽使用 config.json
新實例 Brightcove player的配置存儲在JSON文件中。 您可以通過幾種方式查看此JSON文件或部分JSON文件。
一種查看 player 配置是通過更改 player的URL(以結尾) index.html
至 config.json
。 例如:
http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/config.json
中的某些屬性 player 配置定義以下內容:
- 的名稱和版本 player
- 該視頻 player 將播放
- 的帳戶 player 屬於
- player的ID
- 任何插件 player 可以使用的網址以及插件代碼位置的網址
- 影片播放前要展示的海報
一個例子 player 配置文件,用於 player 從循序漸進: Player 管理如下:
{
"player": {
"template": {
"version": "0.9.5",
"name": "single-video-template"
}
},
"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"
}]
},
"scripts": [
"http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"
],
"stylesheets": [
"http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"
],
"plugins": [{
"name": "firstPlugin"
}],
"account_id": "1507807800001",
"player_id": "54ade2f3-3b51-4a6b-bc87-32b9a0b81384",
"embed_id": "default"
}
{
"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"
}]
},
"video_cloud": {
"video": "4093372393001",
"policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
},
"player": {
"template": {
"name": "single-video-template",
"version": "6.5.0"
}
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
}
GET with $PLAYER_ID/configuration
端點
您可以使用HTTP檢索剛剛顯示的相同信息。 GET
方法。 使用 GET
與 /$PLAYER_ID/configuration
端點,您可以檢索 出版 player's 配置信息。 下面顯示了curl語句示例以及檢索到的JSON:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request GET \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
{
"player": {
"template": {
"version": "0.9.5",
"name": "single-video-template"
}
},
"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"
}]
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
}
{
"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"
}]
},
"video_cloud": {
"video": "4093372393001",
"policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
},
"player": {
"template": {
"name": "single-video-template",
"version": "6.5.0"
}
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
}
GET方法 $PLAYER_ID
端點
HTTP GET
與 /$PLAYER_ID
端點是檢索完整內容的方法 player 信息。 這種方法提供了一個超集 player 您剛剛看到的配置。 您可以想到此端點將“上一級”顯示配置信息,並包括預覽和發布的當前配置信息。 player 版本。 下面顯示了curl語句示例以及檢索到的JSON:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request GET \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID
{
"id": "HJyMlHiuZ",
"name": "Video Cloud CURL 10 March",
"branches": {
"preview": {
"configuration": {
"plugins": [{
"name": "firstPlugin"
}],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"player": {
"template": {
"version": "6.5.0",
"name": "single-video-template"
}
},
"video_cloud": {
"policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT",
"video": "4093372393001"
},
"media": {
"sources": [{
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.m3u8",
"type": "application/x-mpegURL"
}, {
"src": "http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
"type": "video/mp4"
}],
"poster": {
"highres": "http://solutions.brightcove.com/bcls/assets/images/Tiger.jpg"
}
}
},
"video_cloud": {
"aspect_ratio_height": "9",
"aspect_ratio_width": "16",
"video_id": "4093372393001",
"poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_4093546643001_7c09c5bb-7643-414d-81da-847a7e5e3654-AWSAccessKeyId-AKIAJWBBMGHEBQ6SISMA-Expires-1425580379-Signature-h4xCk8Zf9xH-2Be779r9ltwGI7Jzg-3D-vs.jpg?pubId=1507807800001&videoId=4093372393001"
},
"updated_at": "2017-08-23T18:09:52.590Z",
"template_updated_at": "2017-08-23T17:48:55.615Z",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/HJyMlHiuZ/preview/embeds/default/master/index.html"
},
"master": {
"configuration": {
"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"
}]
},
"video_cloud": {
"video": "4093372393001",
"policy_key": "BCpkADawqM2FnBS3InxzDxU4bd4otJdHKvexlXfhs_XgSj3jmBHAsV2xANIvSPd4KiakMbiQM5oYJPopOcJD7vNnPWGPGsnXCO3_ZGdjPmur53WV_a4JUPWHCLt5oiyekN44i24jZzHMB6hT"
},
"player": {
"template": {
"name": "single-video-template",
"version": "6.5.0"
}
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
},
"video_cloud": {
"poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_4093546643001_7c09c5bb-7643-414d-81da-847a7e5e3654-AWSAccessKeyId-AKIAJWBBMGHEBQ6SISMA-Expires-1425580379-Signature-h4xCk8Zf9xH-2Be779r9ltwGI7Jzg-3D-vs.jpg?pubId=1507807800001&videoId=4093372393001",
"video_id": "4093372393001",
"aspect_ratio_width": "16",
"aspect_ratio_height": "9"
},
"updated_at": "2017-08-23T18:10:11.843Z",
"template_updated_at": "2017-08-23T17:48:55.622Z",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/HJyMlHiuZ/master/embeds/default/master/index.html"
}
},
"created_at": "2017-08-23T17:48:55.615Z",
"accountId": "1507807800001",
"embed_count": 1,
"url": "http://players.brightcove.net/1507807800001/HJyMlHiuZ_default/index.html"
}
{
"account_id": "1507807800001",
"branches": {
"preview": {
"configuration": {
"plugins": [{
"name": "firstPlugin"
}],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"player": {
"template": {
"version": "1.5.0",
"name": "single-video-template"
}
},
"video_cloud": {
"policy_key": "BCpkADawqM3ClR-sni6Tc0sFppBHaE91MRyLjE8kUwQjOkXjmK-b2R9fN3IuOnRf_4uuV2LSFwT3eeKUxgYU75eT0c20JEnUKpKU6L-oyjn81zE_P1NF0HJBZiyXyqtHcAdvTpTb29d4S-BH",
"video": "3495887198001"
}
},
"video_cloud": {
"aspect_ratio_height": "14",
"aspect_ratio_width": "25",
"video_id": "3495887198001",
"poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_3495968128001_humbles-scrappy-statue2-vs.jpg?pubId=1507807800001"
},
"updated_at": "2014-10-23T14:33:21.107Z",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/a90a8479-9831-46f6-9eab-90efc7fb9c6b/preview/embeds/default/master/index.html"
},
"master": {
"configuration": {
"video_cloud": {
"video": "3495887198001",
"policy_key": "BCpkADawqM3ClR-sni6Tc0sFppBHaE91MRyLjE8kUwQjOkXjmK-b2R9fN3IuOnRf_4uuV2LSFwT3eeKUxgYU75eT0c20JEnUKpKU6L-oyjn81zE_P1NF0HJBZiyXyqtHcAdvTpTb29d4S-BH"
},
"player": {
"template": {
"name": "single-video-template",
"version": "1.5.0"
}
},
"scripts": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.js"],
"stylesheets": ["http://solutions.brightcove.com/bcls/video-js/new-player/first-plugin.css"],
"plugins": [{
"name": "firstPlugin"
}]
},
"video_cloud": {
"poster_image_url": "http://brightcove.vo.llnwd.net/e1/pd/1507807800001/1507807800001_3495968128001_humbles-scrappy-statue2-vs.jpg?pubId=1507807800001",
"video_id": "3495887198001",
"aspect_ratio_width": "25",
"aspect_ratio_height": "14"
},
"updated_at": "2014-10-23T14:33:41.201Z",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/a90a8479-9831-46f6-9eab-90efc7fb9c6b/master/embeds/default/master/index.html"
}
},
"id": "a90a8479-9831-46f6-9eab-90efc7fb9c6b",
"name": "1031+on+Oct+23",
"created_at": "2014-10-23T14:32:21.384Z",
"embed_count": 1,
"url": "http://players.brightcove.net/1507807800001/a90a8479-9831-46f6-9eab-90efc7fb9c6b_default/index.html"
}
設置名稱/說明
改變 player 您使用的配置 /$ACCOUNT_ID/players/$PLAYER_ID/configuration
端點,這就是本文檔的重點。 但是,您可以僅使用 /$ACCOUNT_ID/players/$PLAYER_ID
端點。 這兩個屬性是 name
以及 description
.
注意: name
您輸入 player 返回為 player_name
當您通過放置獲得配置時 config.json
在最後 player 預覽網址(返回為 name
當您通過 Player Management API。 但是你必須使用 name
當您創建或更新 player.
第一個代碼塊顯示了示例curl語句,該語句更改了 player's name
以及 description
。 請注意,JSON響應顯示了的預覽版本 player 是由PATCH方法生成的,因此您需要發布 player 獲得優化版本。
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"name": "My New Player Name",
"description": "My new player description"
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
{
"id": "62da9b4d-b8aa-45d5-ba46-f77eac9c9059",
"preview_url": "http://preview-players.brightcove.net/v1/accounts/1507807800001/players/62da9b4d-b8aa-45d5-ba46-f77eac9c9059/preview/embeds/default/master/index.html",
"preview_embed_code": "<iframe src='//preview-players.brightcove.net/v1/accounts/1507807800001/players/62da9b4d-b8aa-45d5-ba46-f77eac9c9059/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>"
}
設定值
您可以設置 player 使用發出HTTP方法調用的任何工具的配置值,或使用 JSON編輯器 這是Studio的一部分 PLAYERS 模塊。 可以使用curl工具,並且在 一步步: Player 管理 和AJAX的使用在許多 Brightcove Player 例子.
使用示例更改 JSON編輯器 顯示在這裡:

在編輯完 player的JSON配置。
配置屬性
一些配置屬性是由 Player 管理服務,且不可修改。 那些是:
- 帳戶ID
- player_ID
- embed_id
下面詳述的所有其他屬性都是可以修改的。
有關屬性的詳細信息如下。 您可以使用下面的列表快速訪問特定屬性。
- 全屏控制
- hls
- 不活躍
- 語言
- 語言
- 循環
- 媒體
- 靜音
- picture_in_picture_control
- 播放率
- player
- play_button
- player_ID
- player_名稱
- 內線
- 播放列表
- 插件
- 預緊
- query_string_to_window
- 重複
- 響應
- 腳本
- 樣式表
- techOrder
- 版
- video_cloud
- 體取向
- vttjs
- wait_for_ad_block_detect
帳戶ID
Video Cloud 與關聯的帳戶ID player。 這個值 無法修改.
ad_config_id
ad_config_id
:
- 數據類型:字符串
- 默認:
undefined
- 動態設計livery SSAI廣告配置ID。 除了設置在 player 配置,則可以在運行時通過iframe的adConfigId查詢字符串參數進行設置 player或網頁內data-ad-config-id屬性 players。 這些方法中的任何一個都將覆蓋 player 組態。
ad_failover
ad_failover
:
- 數據類型:布爾值
- 默認:
undefined
- 設置為true可啟用廣告故障轉移行為。 這是一個多部分配置,取決於:
- IMA3和SSAI插件都必須在 player.
- An
ad_config_id
應該可用,否則SSAI廣告不可用。
application_id
application_id
:
- 數據類型:字符串
- 默認:
undefined
- 應用程序ID用於區分單個應用程序的多種用途 player 在指標中。 用戶看不到它。
自動前進
autoadvance
:
- 數據類型:字符串
- 默認值:最初未啟用
- 與播放列表一起使用,並設置播放列表的自動前進行為。
自動播放
autoplay
:
- 數據類型:布爾值或字符串
- 默認:
false
- 表示 player 應該在允許的平台上立即開始播放。
If autoplay
設置為布爾值,將使用瀏覽器的本機自動播放行為。 如果將其設置為以下三個有效字符串值之一,則會發生以下情況:
play
:“ player 將手動嘗試調用播放。muted
:“ player 將手動靜音 player 並調用播放。any
:“ player 首先將嘗試調用播放。 如果失敗,請靜音 player 並調用播放。
如果以上任何一項失敗,則 player 會顯示“大播放按鈕”,就像自動播放設置為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
使視頻自動播放可能是一個複雜的情況。 見 自動播放注意事項 文檔以獲取更多詳細信息。
base_url(用於IP限制問題)
將IP限制與 Brightcove Player在北美以外地區使用。 當一個 Brightcove Player 要求從 Video Cloud 帳戶,它連接到此地址的目錄https://edge.api.brightcove.com/playback/v1/.
Edge端點的行為可能會導致IP限制問題:
- 從WITHIN北美點擊Edge時,它將直接點擊Edge,Edge會看到用戶的IP地址。 它可以根據IP限制白名單允許或拒絕對目錄的訪問。 這是所需的功能。
- 從北美以外地區訪問Edge時,出於負載平衡/本地緩存CDN的原因,它會通過Cloudfront。 這很重要,因為這樣一來,Edge會看到Cloudfront IP而不是用戶的IP,並且拒絕所有人,因為Cloudfront不在白名單中(而且永遠不會在白名單中,因為使用Cloudfront的任何人都可以訪問)。
要解決此問題,您可以配置 player 使用備用Edge端點, edge-elb.api.brightcove.com。 必須對每個人進行此更改 player 需要從北美以外地區訪問受IP限制的帳戶。
實際的配置更改涉及為 Video Cloud base_url
。 請記住,只有在IP限制與 Brightcove Player位於北美以外。 對於現有的 player,您可以使用以下curl命令,該命令使用 PATCH
HTTP方法(您必須用數據替換環境變量 $EMAIL
, $ACCOUNT_ID
以及 $PLAYER_ID
):
curl
--header "Content-Type: application/json"
--user $EMAIL
--request PATCH
--data '{
"video_cloud": {
"base_url": "https://edge-elb.api.brightcove.com/playback/v1/"
}
}'
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
如果您不熟悉捲曲,那麼以下文檔會有所幫助:
斷點
breakpoints
:
- 數據類型:對象
- 默認值:默認斷點是:
- 當與 響應 選項,設置斷點,這些斷點將配置如何在類名之間切換 player 調整基於 player的尺寸。
班級名稱 寬度範圍 vjs-layout-tiny 0-210 vjs-layout-x-small 211-320 vjs-layout-small 321-425 vjs-layout-medium 426-768 vjs-layout-large 769-1440 vjs-layout-x-large 1441-2560 vjs-layout-huge 2561+
雖然不能更改類名稱,但是可以通過如下對象來配置寬度範圍:
breakpoints: {
tiny: 300,
xsmall: 400,
small: 500,
medium: 600,
large: 700,
xlarge: 800,
huge: 900
}
- 斷點對象的鍵是通過刪除相關類名而派生的
vjs-layout-
前綴和任何-
字符。 - 斷點對象的值定義範圍的最大寬度。
- 並非所有鍵都需要定義。 通過傳遞帶有一個鍵/值對的對象,可以輕鬆地覆蓋單個斷點。 自定義斷點將在默認情況下與默認斷點合併。 player 已創建。
當 player的大小更改後,將按照大小順序檢查合併的斷點,直到找到匹配的斷點為止。 該斷點的關聯類名稱將作為一個類添加到 player。 先前斷點的類將被刪除。
跨源
crossorigin
:
- 數據類型:布爾值
- 默認值:false
- If 真,底層 元素將有 crossorigin =“ anonymous”。 這意味著任何視頻或文本軌道都被拉入 player 必須具有CORS標頭。
CSS顏色覆蓋
您可以使用三個屬性來覆蓋 player。 他們是:
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

調試器
調試器顯示 player 模態窗口中的信息。 見 Player 信息模態 有關完整信息的文檔。
碼頭
dock
:
- 數據類型:布爾值
- 默認值:true
- 如果明確
false
中, player 不會包括所謂的 碼頭 可以顯示視頻標題和說明的位置。
embed_id
embed_id
:
- 數據類型:字符串
- 默認:
undefined
- Video Cloud 與此相關的嵌入ID player。 如果值為
default
這意味著 player 不是孩子 player。 如果不是default
,它是代表 player.
錯誤
errors
:
- 數據類型:對像或布爾
- 默認值:true
- 明確設定
false
將防止 player 從包括 videojs錯誤,這是錯誤消息插件。 將此值設為假會導致 player 發生錯誤時不向查看者顯示詳細的錯誤消息。 阻止播放的錯誤仍將出現在Web開發人員控制台中。
閃光
flash
:
- 數據類型:對象
- 默認:
undefined
- 可用於提供自定義Flash選項,以 Video.js.
全屏控制
fullscreenControl
:
- 數據類型:布爾值
- 默認值:true
- 指示是否應在控制欄中顯示全屏控件
以下顯示了curl語句來設置 fullscreenControl
值:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"autoplay": true,
"fullscreenControl": false
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
以下兩個屏幕截圖顯示了 player 有和沒有全屏控件:


hls
hls
:
- 數據類型:對像或布爾
- 默認:
{}
- If
false
中, player 將不包括 videojs-http-streaming。 否則,對象將作為選項傳遞 videojs-http-streaming.
待用 player
有可能使 player無效。 您可能需要這樣做才能擁有 player 停止投放內容,但如果刪除則不會出現404錯誤 player 被瀏覽。
停用 player 設置 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
當然,如果您想激活 player,你可以設置 inactive
財產 false
.
一旦 player 如果用戶瀏覽了 player 將顯示以下消息:

語言
language
:
- 數據類型:字符串
- 默認:
undefined
- 可以提供設置
lang
的屬性<html>
元件。
語言
languages
:
- 數據類型:字符串數組
- 默認:
undefined
- 可以是將導致指定語言包含在字符串中的字符串數組 player。 唯一有效的語言是Video.js中包含的那些語言。 見 本地化 Brightcove Player 文檔以獲取更多信息。
循環
loop
:
- 使視頻在結束時重新開始。
媒體
media
property具有子屬性,如下表所示。
財產 | 數據類型 | 產品描述 |
---|---|---|
SRC | 串 |
|
來源 | 對像數組 |
|
標題 | 串 |
|
海報 | 串 |
|
建議身高 | 串 |
|
寬度 | 串 |
|
軌道 | 排列 |
在以下JSON中,您可以看到一個 media
該屬性包含:
- A 海報 財產
- A 來源 屬性包含兩個源對象,一個用於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"
}]
},
選擇要播放的源取決於您配置的視頻順序以及瀏覽器和設備的功能, player 已加載。 如果您尚未更改默認設置,並且本地支持HLS,則 player 將檢查是否有任何來源指向HLS視頻,並選擇找到的第一個。 如果本地不支持HLS或未指定HLS視頻源,則接下來將嘗試HTML播放。 如前所述,將選擇第一個可播放源。 如果前兩次嘗試播放視頻失敗,將嘗試Flash後備。
總而言之,播放順序指定了您首選的播放媒體,然後每個配置的選項都會嘗試所有可用的音源,並使用它知道如何播放的第一個音源。
您可以使用 currentSrc()
功能。 以下屏幕截圖顯示了在瀏覽器控制台中使用該功能的過程。

靜音
muted
:
- 數據類型:布爾值
- 默認值:false
- 確定當 player 負載。
picture_in_picture_control
picture_in_picture_control
:
- 數據類型:布爾值
- 默認值:true
- 指示是否應在控制欄中顯示內置畫中畫控件。
播放率
playback_rates
:
- 數據類型:數組
- 默認值:無
- 要在播放速率控件中顯示的播放速率數組。
讀取值,然後將其顯示在播放速率控件中。 player的控制欄。

您可以使用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
player
:
- 數據類型:對象
- 默認值:填充 player 具體信息
- 包含有關此的各種元數據 player, 例如
inactive
以及template.version
.
play_button
play_button
:
- 數據類型:對象
- 可通過以下屬性進行修改 player 配置:
財產 類型 影響 徘徊 串 glow
ordarken
; 默認為粉紅色/漸進顏色塑造 串 square
orrectangle
; 默認是一個圓位置 串 topLeft
ortopRight
; 默認為中心
player_ID
player_id
:
- 數據類型:字符串
- Video Cloud player 與關聯的ID player
player_名稱
player_name
:
- 數據類型:字符串
- Video Cloud player 與一個相關的名稱 player -注意:
name
您輸入 player 返回為player_name
當您通過放置獲得配置時config.json
在最後 player 預覽網址(返回為name
當您通過 Player Management API。 但是你必須使用name
當您創建或更新 player.
內線
playsinline
:
- 數據類型:布爾值
- 默認值:false
- 啟用 player 用於內聯播放(某些設備上播放所必需)。
播放列表
現在,有兩種不同的播放列表實現,詳細說明請參見 使用播放列表 文獻。 默認值為版本3。此處詳細介紹了配置這兩個版本的信息。
兩種配置都將顯示如何設置以下內容:
autoadvance
:分配了以秒為單位的整數,以延遲將下一個視頻加載到播放列表之前; 的價值0
分配不會導致視頻之間的等待; 的價值null
分配不會導致自動前進。playOnSelect
:分配true
因此,當您從播放列表菜單中單擊某個項目時,即使加載了 player 已暫停。
播放列表版本3(默認)
要使用版本3插件配置播放列表,請使用插件註冊表。 以下是curl語句,用於配置播放列表版本3插件的使用:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request POST \
--data '{
"name": "Plugin Registry Test Player",
"configuration": {
"video_cloud": {
"video": "4093372393001"
},
"plugins": [
{
"registry_id": "@brightcove/videojs-bc-playlist-ui",
"version": "3.x"
}
]
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
看到 插件註冊表 有關其使用和益處的信息的文檔。
設置 playOnSelect
以及 autoadvance
創建時的選項 player 使用以下內容:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request POST \
--data '{
"name": "Plugin Registry Test Player",
"configuration": {
"video_cloud": {
"video": "4093372393001"
},
"plugins": [
{
"registry_id": "@brightcove/videojs-bc-playlist-ui",
"version": "3.x",
"options": {
"playOnSelect": true
}
}
],
"autoadvance": 2
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
播放列表版本1(舊版)
除了 autoadvance
以及 playOnSelect
用於配置版本1播放列表使用的其他兩個屬性。它們是:
playlist
:分配true
有一個 player 使用播放列表。adjusted
:分配true
擁有 player 調整 player 播放列表的尺寸。
以下是curl語句,用於設置與播放列表相關的三個屬性:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"playlist": true,
"autoadvance": 2,
"studio_configuration": {
"player": {
"adjusted": true,
"height": "",
"width": ""
}
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
設置 playOnSelect
對於版本1的播放列表,請使用以下curl語句:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
{"playOnSelect": true}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
以編程方式確定是否 player 包含一個播放列表
如果您在包含以下內容的頁面中使用JavaScript, player 並希望檢查是否使用了播放列表插件,可以使用以下方法:
player.hasPlugin('playlist')
如果您要檢查是否存在播放列表插件,而不是在帶有 player (例如,檢查清單 player與連接器配合使用),則必須使用更為複雜的過程。 你會讀 player的配置,然後檢查是否 插件 條的規定, player的JSON包含 “ name”:“ bcPlaylistUi”。 該任務的一種解決方案如下:
var theJSON = {},
pluginAra = [],
ifFound = [],
theJSONString =
'{"account_id":"1507807800001","autoadvance":0,"autoplay":false,"embed_id":"default","fullscreenControl":true,"id":"r1fbqySRZ","player":{"inactive":false,"template":{"locked":false,"name":"single-video-template","version":"6.8.3","version_alias":null}},"player_id":"r1fbqySRZ","player_name":"playlist v2 junk","playlist":true,"plugins":[{"injected_version":"2.1.2","name":"bcPlaylistUi","options":{"playOnSelect":true},"registry_id":"@brightcove/videojs-bc-playlist-ui","version":"2.x"}],"preload":"metadata","scripts":["//players.brightcove.net/videojs-bc-playlist-ui/2.1.2/videojs-bc-playlist-ui.min.js"],"studio_configuration":{"player":{"adjusted":true,"height":150,"width":300}},"stylesheets":["//players.brightcove.net/videojs-bc-playlist-ui/2.1.2/videojs-bc-playlist-ui.css"],"updated_at":"2017-10-30T18:06:07.800Z","video_cloud":{"policy_key":"BCpkADawqM2_X3Xxh3xln23EqlR3BETHrfycIPT-a7kqhBi6q8g3XOmTr3tEJiFoi_YmI7vfbJzS4mY0Un5RACc3jC8cLVqyvmfWFLI-tG5oJYGXNUrvOwRJYQEt2eVpMZnBd0FH22i7Mtk3","video":null}}';
theJSON = JSON.parse(theJSONString);
pluginAra = theJSON.plugins;
ifFound = pluginAra.filter(function(pluginAra) {
return pluginAra.name === "bcPlaylistUi"
});
if (ifFound.length === 1) {
console.log('Contains playlist plugin');
} else {
console.log('No playlist');
}
插件
plugins
屬性指定初始化video.js插件的順序以及要應用到它們的任何自定義設置。 該插件必須由相應的支持 scripts
屬性網址條目,並在需要時提供支持 stylesheets
網址。 每個元素 plugins
數組是一個帶有 name
屬性,還可以包含可選 options
屬性:
name
:video.js插件的名稱,取自支持的JavaScript代碼options
:設置的對象哈希值將覆蓋以在初始化時提供給插件
選項子
在這 options
子屬性,您可以在初始化時傳遞要利用的數據。 以下JSON傳遞了 options
.
"plugins": [{
"name": "navigateOnVideoEnd",
"options" : {"redirectURL": "http://docs.brightcove.com"}
}]
這使您能夠通過以下方式將數據傳遞給插件 player 組態。 例如,使用 redirectURL
上面顯示的對象,您將在插件本身中執行以下操作:
videojs.registerPlugin('navigateOnVideoEnd', function (options) {
var myPlayer = this;
myPlayer.on("ended", function () {
window.location.href = options.redirectURL;
});
});
注意:您使用標準插件實現,但使用 options
作為匿名函數中的參數。 然後,您可以使用 options.propertyName
符號。
一些Brightcove提供的插件利用了插件註冊表,並且配置與此處顯示的有所不同。 見 概述:插件註冊表 有關詳細信息的文檔。
預緊
preload
:
- 數據類型:字符串
- 默認:
none
- preload屬性會通知瀏覽器,在加載視頻標籤後,是否應立即開始下載視頻數據。 選項是 汽車, 元數據和 沒有.
-
汽車:表示即使用戶最終不會觀看視頻,也可以下載整個視頻文件。 從正面看,如果觀眾播放視頻,它可以立即開始播放。 不利的一面是,即使觀眾沒有播放視頻,此選項也會因預加載/加載而增加帶寬消耗。
-
元數據 (默認):加載視頻的元數據,其中包括視頻的時長和尺寸等信息。 此設置還將加載幾秒鐘的視頻數據。
-
沒有:不要預加載任何視頻數據。 這將一直等到用戶單擊播放開始下載。
<video-js preload ...>
or
{ "preload": "auto" }
query_string_to_window
query_string_to_window
:
-
- 名稱:
query_string_to_window.target
- 數據類型:字符串
- 描述:要在窗口上創建的目標對象,該目標對象將填充有完整的已解析查詢字符串。 例如,使用
query_string_to_window.target
鑑於以下 player 配置:{ "query_string_to_window": {"target": "queryStringParams"} }
?foo=bar&nums=1&nums=2
window.queryStringParams
全局對象可用於 player 和插件:{ foo: 'bar', nums: ['1', '2'] }
- 名稱:
-
- 名稱:
query_string_to_window.globals
- 數據類型:數組
- 說明:窗口對象的屬性名稱的數組,將從查詢字符串中找到的值填充。 上已經存在的任何匹配屬性
window
對像或其原型鏈將不會設置。 例如,使用query_string_to_window.globals
鑑於以下 player 配置:{ "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
- 如果播放列表重複播放, player 是播放列表 player。 設置在最高層 player 組態。
響應
responsive
:
- 數據類型:布爾值
- 默認:
true
- 將此選項設置為
true
將導致 player 根據響應斷點自定義自身(請參閱: 斷點 選項)。
有關啟用此功能的完整詳細信息,請參見以下版本的發行說明: Brightcove Player 6.29.2.
腳本
scripts
:
- 數據類型是一個字符串數組,該字符串引用包含在 player
- 無默認值
- 當時 player 建立文件後,將下載這些文件並將其內聯到結果輸出中,這樣就無需隨後在運行時獲取它們
- 腳本按照指定的順序內聯,因此您可以安全地包含相互依賴的腳本
skin
:
- 數據類型:布爾值或字符串
- 默認值:未定義
- 確定視覺樣式的變體 player 將使用。 此值還反映在可全局訪問的
bc.SKIN
瀏覽器中的屬性。 它識別以下值:值 皮膚 產品描述 “石墨” “石墨” 用舊 Brightcove Player 樣式以及一些兼容性技巧。 假 “沒有” 全部禁用 Brightcove Player 樣式。 從頭開始,這是用於高度定制的UI的選項。 未定義 “露娜” 離開這個 undefined
將導致 player 使用默認皮膚(又名Luna)。
樣式表
stylesheets
:
- 包含CSS文件的網址字符串數組,這些文件應包含在 player
- 當時 player 構建後,將下載其他樣式表並將其內聯到 player 這樣就不需要在運行時獲取它們
- 樣式表包含在您指定它們的順序中
techOrder
techOrder
:
- 數據類型:數組
- 默認值:['html5','flash']
- 默認情況下 Brightcove Player 施行 科技至上 在搜索源/技術組合以播放視頻時進行排序。 這意味著,如果您有兩個來源和兩個技術, player 會嘗試使用第一個技術播放每個視頻
techOrder
選項屬性,然後再嘗試下一種播放技術。 見 指南:播放技術 文檔以獲取更多信息。
您可以使用以下curl語句來更改 techOrder
從默認 ['html5','flash']
至 ['flash','html5']
:
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request PATCH \
--data '{
"techOrder": "['flash','html']"
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
版
您可以手動設置 player 使用的版本 PLAYERS 模 JSON編輯器.

video_cloud
使用此屬性,您可以創建一個 player 使用您的視頻 Video Cloud 圖書館。 下面的curl語句顯示 player 使用創建 Video Cloud 視頻的ID。
curl \
--header "Content-Type: application/json" \
--user $EMAIL \
--request POST \
--data '{
"name": "Video Cloud CURL 10 March",
"configuration": {
"video_cloud": {
"video": "4093372393001"
}
}
}' \
https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
請注意,在請求主體對像中, name
以及 description
是頂級屬性,而其他所有屬性都是 configuration
賓語。 任何 配置屬性 可以包含在 configuration
當您創建 player.
體取向
volume_orientation
:
- 數據類型:字符串
- 默認值:水平
-
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
:
- 數據類型:字符串
- 默認值:vjs.zencdn.net CDN
- 設置要加載的URL vtt.js。 這與標準Video.js選項相同
vtt.js
。 “ Brightcove Player 使用vttjs
相反,因為不能在 Player Management API,並且在其他地方可能會出現問題。 該選項可以設置為data-vttjs
屬性,一個vttjs
iframe查詢參數,一個vttjs
設置選項或vttjs
在 player 組態。
wait_for_ad_block_detect
wait_for_ad_block_detect
:
- 數據類型:布爾值
- 默認值:未定義
- 設置為
true
中, player 將延遲其自動初始化過程,直到廣告塊檢測已做出決定為止。 這可能會延遲 player 最多可以初始化100毫秒左右。 不需要設置為true
使用時,ad_failover
因為在兩種情況下都會出現延遲行為。