videojs ()
函數兼作用戶創建播放器實例以及主庫命名空間的主要功能。
它也可以用作預先存在的 Player實體的 getter。但是,我們強烈建議為此目的使用 VideoJs.getPlayer ()
,因為它避免了任何意外初始化的可能性。
由於限制在我們的 JSDoc 模板中,我們無法將其正確地記錄為函數和命名空間,因此它的函數簽名記錄在此處。
參數
身份證
字串 | 元素,必要
視頻元素或視頻元素 ID。
選項
對象,可選
用於提供設置的選項對象。請參閱:選項指南。
準備
組件~ReadyCallback, 選修的
返回值
該視頻 JS()
函數返回一個播放器實例。
班級
成員
-
靜態瀏覽器:物件
-
對瀏覽器實用程序模塊作為對象的引用。
- 請參閱:
-
靜態 DOM : 對象
-
對 DOM 實用程序模塊作為對象的引用。
- 請參閱:
-
靜態日誌:功能
-
日誌實用程序模塊作為對象的引用。
- 請參閱:
-
靜態選項:物件
-
全局選項對象。如果在創建播放器時未指定覆蓋,這些設置就會生效。
-
靜態播放器:物件
-
玩家的全球枚舉。
鍵是玩家 ID 和值可以是播放器實例或
空被處置
的球員。 -
靜態觸摸啟用:布爾
-
使用瀏覽器。觸摸啟用; 僅包括與 4.x 的向後兼容性。
- 棄用:
-
- 自 5.0 版本以來,請使用瀏覽器啟用。
-
靜態網址:物件
-
URL 公用程式模組做為物件的參考。
- 請參閱:
-
靜態版本:字符串
-
當前的 Video.js 版本。遵循語義版本控制。
方法
-
靜止的添加語言(代碼,數據)→ {對象
-
添加語言,以便所有玩家都可以使用。示例:
視頻。添加語言('es',{'你好':'你好' });
參數:
名字 類型 描述 代碼
細繩 語言代碼或字典屬性
數據
目的 要翻譯的數據值
傳回:
目的 -生成的語言字典對象
-
靜態綁定(上下文,fn,uid 選擇)→ {函數}
-
綁定(又名代理或上下文)。一種更改函數上下文的簡單方法。
它還在函數上存儲了一個唯一的 id,因此可以輕鬆地將其從事件中刪除。
參數:
名字 類型 屬性 描述 語境
混合的 要綁定為作用域的對象。
FN
功能 要綁定到範圍的函數。
uid
數字 < 選購配備 >
要設置的功能的可選唯一 ID
傳回:
功能 -將綁定到給定上下文中的新函數
-
靜態計算風格 (埃爾, 扶植)
utils/computed-style.js
,第 23行
-
安全的 getComputedStyle。
這是必要的,因為在 Firefox 中,如果播放器被加載到帶有
顯示:none 的 iframe 中
,則getComputedStyle
返回null
,因此,我們進行空檢查以確保播放器在這些情況下不會中斷。參數:
名字 類型 描述 埃爾
元素 您想要計算樣式的元素
支柱
細繩 你想要的屬性名稱
-
靜態創建時間範圍(開始,結束)
-
創建一個
時間範圍
模仿一個對象HTML5 TimeRanges 實例 .參數:
名字 類型 描述 開始
數字 | 數組.<數組> 單個範圍(數字)或範圍數組(每個數組包含兩個數字的數組)的開始。
結尾
數字 單個範圍的結束。不能與
start
引數的陣列形式一起使用。 -
靜態創建模式(開始,結束)
-
創建一個
時間範圍
模仿一個對象HTML5 TimeRanges 實例 .參數:
名字 類型 描述 開始
數字 | 數組.<數組> 單個範圍(數字)或範圍數組(每個數組包含兩個數字的數組)的開始。
結尾
數字 單個範圍的結束。不能與
start
引數的陣列形式一起使用。 -
靜態取消註冊插件(名稱)
-
註銷 Video.js 插件。
參數:
名字 類型 描述 姓名
細繩 要註銷的插件的名稱。必須是與現有插件匹配的字符串。
投擲:
-
如果嘗試註銷基本插件。
- 類型
- 錯誤
-
-
靜態擴展(超類,子類方法選擇)→ {函數}
-
用於通過使用
extends
關鍵字模擬 ES 子類的現有類。參數:
名字 類型 屬性 預設 描述 超類
功能 要繼承的類
子類方法
目的 < 選購配備 >
{} 新類的方法
傳回:
功能 -具有繼承 superClass 的 subClassMethods 的新類。
- 棄用:
-
- 是
範例
var MyComponent = videojs.extend(videojs.getComponent('Component'), { 我的自定義方法:函數(){ // 在我的方法中做事。 } });
-
靜態格式時間(秒,引導)→ {字符串}
utils/format-time.js
, 第九十一行
-
委派至預設時間格式化函數或透過
setFormatTime 提供的自訂函數
。將秒格式化為時間字串 (H: MM: SS 或 M: SS)。提供指南(以秒為單位)將強制使用多個前導零來覆蓋指南的長度。
參數:
名字 類型 描述 秒
數字 轉成字符串的秒數
指導
數字 在之後對字符串建模的數字(以秒為單位)
傳回:
細繩 -時間格式化為 H:毫米:SS 或 M:SS
範例
格式化時間 (125, 600)
-
靜態獲取所有播放器()→ {數組}
-
返回所有當前玩家的數組。
傳回:
大批 -所有玩家的數組。該數組將按照
對象 .keys
提供的順序進行,這可能會在 JavaScript 引擎之間有所不同。 -
靜態獲取組件(名稱)→ { 組件 }
-
得到
成分
基於它註冊的名稱。參數:
名字 類型 描述 姓名
細繩 要獲取的組件的名稱。
-
靜態獲取播放器(ID)→ { 播放器 | 未定義}
-
根據 ID 或 DOM 元素獲取單個播放器。
如果你想檢查一個元素或 ID 是否有關聯的 Video.js 播放器,但如果沒有則不創建一個,這很有用。
參數:
名字 類型 描述 身份證
細繩 | 元素 一個 HTML 元素 -
<視頻>
,<音頻>
, 或者<video-js>
- 或匹配的字符串ID
的這樣一個元素。 -
靜態獲取播放器()→ {對象}
-
獲取包含當前創建的玩家的對象,以玩家 ID 為鍵
傳回:
目的 -創建的玩家
-
靜態獲取插件(名稱)→ {功能 | 未定義}
-
如果存在,則按名稱獲取插件。
參數:
名字 類型 描述 姓名
細繩 插件的名稱。
傳回:
功能 | 不明確的 -插件(或
未定義
)。 -
靜態獲取插件(名稱選擇)→ {對象 | 未定義}
-
獲取包含多個 Video.js 插件的對象。
參數:
名字 類型 屬性 描述 名字
大批 < 選購配備 >
如果提供,應該是一個插件名稱數組。默認為所有插件名稱。
傳回:
目的 | 不明確的 -包含與其名稱相關的插件的對象(S)或
undefined,
如果沒有匹配的插件存在)。 -
靜態獲取插件版本(名稱)→ {字符串}
-
獲取插件的版本(如果可用)
參數:
名字 類型 描述 姓名
細繩 插件的名稱。
傳回:
細繩 -插件的版本或空字符串。
-
靜態獲取技術(名稱)→ { 技術 | 未定義}
-
得到
科技
按名稱從共享列表中。參數:
名字 類型 描述 姓名
細繩 駱駝案
或標題要取得的科技大寫字母
名稱 -
靜態是交叉起源(網址,WinLoc 選項)→ {布爾}
-
返回傳遞的url是否為跨域請求。
參數:
名字 類型 屬性 描述 網址
細繩 要檢查的網址。
winloc
目的 < 選購配備 >
檢查 url 的域,默認為 window.location
性質
名字 類型 屬性 描述 協議
細繩 < 選購配備 >
窗口位置協議默認為 window.location.protocol
主持人
細繩 < 選購配備 >
窗口位置主機默認為 window.location.host
傳回:
布爾值 -是否跨域請求。
-
靜態合併選項(... 源)→ {對象}
utils/merge-options.js
, 第二十四行
-
參數:
名字 類型 屬性 描述 來源
數組.<對象> < 可重複使用 >
要合併為一個新對象的一個或多個對象。
傳回:
目的 -一個新對象,它是所有源的合併結果。
-
靜態關閉(elem,類型選擇,fn 選項)
-
從元素中刪除事件偵聽器
參數:
名字 類型 屬性 描述 元素
元素 | 目的 要從中刪除偵聽器的對象。
類型
細繩 | 數組.<字符串> < 選購配備 >
要刪除的偵聽器類型。不包括從元素中刪除所有事件。
FN
事件目標~事件監聽器 < 選購配備 >
要刪除的特定偵聽器。不要包含以刪除事件類型的偵聽器。
-
靜態開啟(元素,類型,fn)
utils/events.js
, 第 262行
-
向元素添加事件偵聽器它將處理函數存儲在單獨的緩存對像中,並將通用處理程序添加到元素的事件,以及元素的唯一 ID (guid)。
參數:
名字 類型 描述 元素
元素 | 目的 綁定監聽器的元素或對象
類型
細繩 | 數組.<字符串> 要綁定的事件類型。
FN
事件目標~事件監聽器 事件監聽器。
-
靜態一個(元素,類型,fn)
-
只為一個事件觸發一次監聽器。
參數:
名字 類型 描述 元素
元素 | 目的 要綁定到的元素或對象。
類型
細繩 | 數組.<字符串> 活動名稱/類型
FN
事件~事件監聽器 事件監聽函數
-
靜態解析網址(網址)→ {網址:URL 對象}
utils/url.js
,第 43行
-
解析和解析 URL 的元素。
參數:
名字 類型 描述 網址
字串 要解析的網址
傳回:
網址:網址對象 -網址詳細信息的對象
-
靜態插件(名稱,插件)
-
使用 Video.js 註冊插件的棄用方法
參數:
名字 類型 描述 姓名
細繩 插件名稱
插入
插入 | 功能 插件子類或函數
- 棄用:
-
- videojs.plugin() 已棄用;使用 videojs.registerPlugin() 代替
-
靜態寄存器組件(名稱,補償)→ { 組件 }
video.js地
鐵第 328 號線
-
註冊一個組件,以便可以通過名稱引用它。在添加到其他組件時使用,無論是通過添加子
組件 .addChild('我的組件')
或通過默認的子選項{孩子:['我的組件']}
。注意:您也可以在添加之前初始化組件。
組件。添加子(新的我的組件());
參數:
名字 類型 描述 姓名
細繩 組件的類名
比較
成分 組件類
-
靜態寄存器插件(名稱,插件)→ {功能}
-
註冊一個 Video.js 插件。
參數:
名字 類型 描述 姓名
細繩 要註冊的插件的名稱。必須是一個字符串,不得匹配現有的插件或
播放器
原型上的方法。插入
功能 的子類
插入
或基本插件的功能。傳回:
功能 -對於高級插件,該插件的工廠函數。對於基本插件,初始化插件的包裝函數。
-
靜態寄存器技術(名稱,技術)
-
註冊一個
科技
進入 videojs 的共享列表。參數:
名字 類型 描述 姓名
細繩 的名字
科技
註冊。技術
目的 要註冊的
技術
類。 -
靜態重置格式時間()
-
將 formatTime 重置為默認實現。
-
靜態設置格式時間(自定義)
utils/format-time.js
, 第六十行
-
用自定義實現替換默認的 formatTime 實現。
參數:
名字 類型 描述 自定義實現
功能 將用於代替默認 formatTime 實現的函數。將接收以秒為單位的當前時間和指南(以秒為單位)作為參數。
-
靜態觸發器(元素,事件,哈希選擇)→ {布爾 | 未定義}
-
為元素觸發事件
參數:
名字 類型 屬性 描述 元素
元素 | 目的 觸發事件的元素
事件
事件目標~事件 | 細繩 字符串(類型)或具有類型屬性的事件對象
散列
目的 < 選購配備 >
隨事件一起傳遞的數據散列
傳回:
布爾值 | 不明確的 -返回默認的
相反
如果默認默認被阻止。否則,返回未定義
-
靜態使用(類型,中間件)
tech/middleware.js
,第四十六行
-
定義播放器應通過返回中間件對象的工廠函數使用的中間件。
參數:
名字 類型 描述 類型
細繩 要匹配的 MIME 類型或
“*”
適用於所有 MIME 類型。中間件
中間件工廠 將為匹配類型執行的中間件工廠函數。
-
靜態 xhr (選項)→ {XML 格式 | X 域請求}
-
跨瀏覽器的 XMLHttpRequest 包裝器。
參數:
名字 類型 描述 選項
目的 請求的設置。
傳回:
XML 網站請求 | 域名請求 -請求對象。