2.2.8

設定選項

最後更新


本頁列出 new FPlyr(config) 的所有設定欄位、預設值,以及初始 volume、mute 的套用方式。

config


欄位型別必要說明
idstring否既有元素的 ID,該元素會成為播放器容器;未指定或找不到時建立新的 div.FPlyr,需手動插入 player.body
videostring擇一影片 URL
youtubestring擇一YouTube 影片 ID
vimeostring擇一Vimeo 影片 ID
audiostring擇一音訊 URL
optionobject否面板與播放設定,見下表
whenobject否生命週期回呼,見生命週期事件

多個來源同時設定時的優先順序見媒體來源。

option


欄位型別預設值說明
panelTypestring""面板風格,見面板風格
panelItemstring[]["play", "progress", "time", "volumeMini", "rate", "full"]控制元件,見面板控制元件
showThumbbooleantrue是否顯示滑桿拖曳把手
volumenumber100初始音量(0–100),見 volume 與 mute 的套用方式
mutebooleanfalse初始靜音,見 volume 與 mute 的套用方式

不指定 id


未指定 id 時播放器不會出現在頁面上,直到你插入 player.body:
  1. <section id="mount" style="max-width: 480px; aspect-ratio: 16 / 9"></section>
  2. <script>
  3. const player = new FPlyr({
  4. video: "https://cdn.pixabay.com/video/2023/11/28/191159-889246512_tiny.mp4",
  5. option: { panelType: "simple" },
  6. });
  7. console.log("attached before append:", player.body.isConnected);
  8. document.getElementById("mount").appendChild(player.body);
  9. console.log("attached after append:", player.body.isConnected);
  10. console.log("class:", player.body.className);
  11. </script>
即時預覽 · @pardnchiu/flexplyr@2.2.9

無效設定


config 不是物件時,建構子以 console.log 輸出 config: 不存在。 後直接返回,不拋出例外,實例沒有 body:
  1. <script>
  2. const player = new FPlyr("player");
  3. console.log("body:", String(player.body));
  4. </script>
即時預覽 · @pardnchiu/flexplyr@2.2.9

volume 與 mute 的套用方式


  • option.volume:同時傳入頂層 volume 時由建構子寫入(src/js/model/player.js:61);只傳 option 時音量為 100。
  • option.mute:同樣由頂層 mute 寫入(:65)。就緒時播放器套用音量(:424),音量大於 0 即設為非靜音(:243),因此播放器以非靜音狀態開始;需要靜音時,由觀看者按下 volume 控制元件的靜音鈕(面板控制元件)或把音量拖到 0。

  1. <div style="max-width: 480px; aspect-ratio: 16 / 9; margin-bottom: 12px"><div id="a"></div></div>
  2. <div style="max-width: 480px; aspect-ratio: 16 / 9"><div id="b"></div></div>
  3. <script>
  4. const a = new FPlyr({
  5. id: "a",
  6. video: "https://cdn.pixabay.com/video/2023/11/28/191159-889246512_tiny.mp4",
  7. option: { volume: 30, mute: true },
  8. when: { ready: () => setTimeout(() => console.log("option only ->", a.option.volume, a.isMuted())) },
  9. });
  10. const b = new FPlyr({
  11. id: "b",
  12. video: "https://cdn.pixabay.com/video/2023/11/28/191159-889246512_tiny.mp4",
  13. volume: 30,
  14. mute: true,
  15. option: { volume: 30, mute: true },
  16. when: { ready: () => setTimeout(() => console.log("option + legacy ->", b.option.volume, b.isMuted())) },
  17. });
  18. </script>
即時預覽 · @pardnchiu/flexplyr@2.2.9

相關頁面


EN