pdplayerkit
v2.2.6
Published
FlexPlyr is a lightweight JavaScript library that provides embedded HTML5 video players and YouTube players, featuring highly customizable control panels and visual effects.
Downloads
330
Maintainers
Readme
FlexPlyr
(原名:PDPlayerKit,自 2.2.4
版本起更名為 FlexPlyr)
模組化 JavaScript 媒體播放器 支援 HTML5、YouTube、Vimeo,提供靈活主題與完整控制面板。
特點
多媒體播放
- 支援多類型:可播放 HTML5 影片 / 音訊、YouTube 與 Vimeo。
- 兼容桌面與行動設備,支持
playsinline
和 全螢幕模式 切換。
高度自定義控制面板
- 自由定制按鈕:播放速率調整、音量控制、進度條 等功能按需配置。
- 提供多種內建主題: (如 Minimal、Classic、Retro、Simple),方便自由選擇。
輕量與無依賴
- 基於 原生 API 和 YouTube / Vimeo API,無需額外庫,開箱即用。
- 完全移除 PDRenderKit 的依賴,減少耦合,提升使用便捷性。
- 文件體積小於 數 KB,即使在行動設備上也能高效運行。
全面的事件監聽
- 支持多種事件監聽: (如 ready、playing、pause、end),方便深度擴展。
多版本支持
- 提供 ESM (ECMAScript Module) 與 一般版本,適用於多種開發環境,靈活集成。
更直觀的控制按鈕
- 按鈕圖示使用 Google Icons,清晰、現代,適配各類主題風格。
友善授權
- 授權從 GPL 3.0 調整為 MIT,方便自由使用與修改,適應更多商業或個人項目。
安裝方式
從 npm 安裝
npm i @pardnchiu/flexplyr
從 CDN 引入
- 引入
FlexPlyr
套件<!-- Version 2.2.4 and above --> <script src="https://cdn.jsdelivr.net/npm/@pardnchiu/flexplyr@[VERSION]/dist/FlexPlyr.js"></script> <!-- Version 2.2.3 and below --> <script src="https://cdn.jsdelivr.net/npm/pdplayerkit@[VERSION]/dist/PDPlayerKit.js"></script>
- Module 版本
// Version 2.2.4 and above import { FPlyr } from "https://cdn.jsdelivr.net/npm/@pardnchiu/flexplyr@[VERSION]/dist/FlexPlyr.esm.js"; // Version 2.2.3 and below import { player } from "https://cdn.jsdelivr.net/npm/pdplayerkit@[VERSION]/dist/PDPlayerKit.module.js";
- 初始化
FPlyr
// Version 2.2.4 and above // Unified: FPlyr // Version 2.2.3 and below // IIFE: PDPlayer // ESM: player const dom = new FPlyr({ // 選填:指定元件替換為播放器(元件的 ID) // 若未指定,需手動將 dom.body 加入至視圖中 // id: "元件 ID", // 必填:媒體來源設定,以下選項中僅能選擇一項 video: "[影片位置]", // audio: "[音訊位置]", // vimeo: "[Vimeo ID]", // youtube: "[YouTube ID]" // 選填:播放設置 option: { // 是否顯示滑桿,預設 true showThumb: true, // 控制面板外觀風格,例如 "minimal" 或 "classic" panelType: "[風格選擇]", // 控制面板按鈕,依需求選擇顯示的功能 panel: [ "play", "progress", "time", "timeMini", "volume", "volumeMini", "rate", "full" ], // 播放器預設音量 volume: 100, // 播放器預設靜音 mute: false }, // 選填:事件監聽器,可監聽播放過程中的特定事件 when: { ready: function () { console.log("播放器準備完成"); }, playing: function () { console.log("播放中"); }, pause: function () { console.log("暫停"); }, end: function () { console.log("播放結束"); }, destroyed: function () { console.log("已移除"); } } }); // 若無指定元件,需手動將播放器加入至 DOM 中 (...).appendChild(dom.body); // 移除元件 // dom.destory();
開發者
授權條款
本專案依據 MIT 授權使用。
©️ 2023 邱敬幃 Pardn Chiu