2.2.8

實例 API

最後更新


本頁列出 FPlyr 實例的公開方法與屬性,以及全域名稱與 ESM 匯出。

方法


方法回傳說明
play(isFull?)void播放並把播放按鈕切為暫停圖示;isFull 為 true 時於行動裝置改由全螢幕播放器播放
pause(isFull?)void暫停並把按鈕切回播放圖示
isPaused(isFull?)boolean是否暫停;YouTube 以播放器狀態是否為 1 判斷
isMuted(isFull?)boolean是否靜音
destroy()void釋放播放器,順序見下方

這些方法依就緒時才設定的來源旗標分流,在 when.ready 觸發前或於 ready 內同步呼叫會回傳 undefined、不作用於媒體(見生命週期事件)。

destroy() 的釋放順序


  1. 移除容器的 mousemove/mouseleave 處理
  2. 停止進度輪詢
  3. Vimeo/YouTube 呼叫 SDK 的 destroy()(YouTube 連同全螢幕播放器);HTML5 媒體先暫停再清空 src
  4. 從 DOM 移除容器
  5. when.destroyed 為函式時呼叫它

屬性


屬性型別說明
bodyDOM 元素播放器容器(.FPlyr)
optionobject合併後的 option;就緒後 volume 會跟著音量操作更新
whenobject生命週期回呼(when 或舊版 event)
panelplayerPanel控制面板實例,可取得 buttonPlay、inputProgress 等元素
stateFullboolean是否處於全螢幕
video/youtube/vimeo/audiostring實際採用的來源;未採用者為 undefined

範例


  1. <div style="max-width: 480px; aspect-ratio: 16 / 9"><div id="player"></div></div>
  2. <button id="destroy">destroy()</button>
  3. <script>
  4. const player = new FPlyr({
  5. id: "player",
  6. video: "https://cdn.pixabay.com/video/2023/11/28/191159-889246512_tiny.mp4",
  7. when: {
  8. ready: () => setTimeout(() => {
  9. console.log("isPaused:", player.isPaused());
  10. console.log("isMuted:", player.isMuted());
  11. console.log("option:", JSON.stringify(player.option));
  12. }),
  13. destroyed: () => console.log("destroyed, in DOM:", player.body.isConnected),
  14. },
  15. });
  16. document.getElementById("destroy").onclick = () => player.destroy();
  17. </script>
即時預覽 · @pardnchiu/flexplyr@2.2.9

全域與匯出


名稱來源說明
window.FPlyrdist/FlexPlyr.js主要類別
window.PDPlayerdist/FlexPlyr.jsFPlyr 的舊名,預計 3.x 移除
FPlyrdist/FlexPlyr.esm.jsESM 具名匯出
playerdist/FlexPlyr.esm.jsFPlyr 的舊名,預計 3.x 移除

  1. import { FPlyr } from "@pardnchiu/flexplyr/dist/FlexPlyr.esm.js";

相關頁面


EN