npm 包 wtc-controller-video 使用教程

阅读时长 12 分钟读完

简介

wtc-controller-video 是一个基于HTML5 video的前端控制器,可以帮助开发者快速实现视频播放、暂停、快进、音量控制等常用操作。它提供了多种样式、主题和扩展功能,支持自定义样式和事件回调函数,是一款非常实用的前端控制器组件。

安装

该包可通过npm进行安装:

使用

引入依赖

要使用该组件,需要在HTML页面中引入依赖的CSS和JS文件:

初始化控制器

在HTML页面中添加 video 标签,并指定 wtc-controller-video 类名:

在JavaScript中初始化控制器:

此时就可以通过 controller 对象来控制视频播放状态。

选项和回调函数

可以通过 controller 构造函数的第二个参数来指定选项和回调函数:

-- -------------------- ---- -------
--- ------- - -
  ------ -------
  ------- ---
--

--- --------- - -
  ------- ---------- -
    ----------------------
  --
  -------- ---------- -
    --------------------
  -
--

--- ---------- - --- ------------------------- -------- -----------

上面的代码指定了主题为 dark,音量为 0.5,并添加了 onPlay 和 onPause 两个回调函数。

自定义样式

可以通过更改CSS来自定义控制器的样式,可以添加或更改下面这些CSS类:

-- -------------------- ---- -------
------------------
-----------------------
-----------------
------------------
---------------------
-------------------------
----------------------------
-----------------
-------------------------
---------------------------
-----------------------
-------------------
-----------------------
------------------------

API

提供以下方法和属性:

  1. .play():播放视频
  2. .pause():暂停视频
  3. .togglePlay():切换播放状态(播放-暂停)
  4. .mute():静音
  5. .unmute():取消静音
  6. .toggleMute():切换静音状态(有声-静音)
  7. .setVolume(volume):设置音量,0~1之间的小数
  8. .getVolume():获取当前音量
  9. .getDuration():获取视频总时长(秒)
  10. .getCurrentTime():获取当前播放时间(秒)
  11. .seekTo(time):跳转到指定时间(秒)
  12. .isPlaying():判断是否正在播放
  13. .isMuted():判断是否静音
  14. .destroy():销毁控制器

示例代码

-- -------------------- ---- -------
--------- -----
------
------
  ----- ------------------------------------------- -----------------
  ------- ---------------------------------------------------
  
  -------
    ------------ -
      --------- ---------
      ------- --
      ------ -----
      ------- -----
      ----------------- ------- -- -- -----
      ------ -----
      -------- -----
      ---------------- --------------
      ------------ -------
      -------- - -----
      ----------- -----------
    -
    
    ----------------- -
      ---------- --
      ------- ----
      ------- - -----
      --------- ---------
    -
    
    --------------------- -
      ------- ----
      ----------------- -----
      ------ --
    -
    
    ------------------------ -
      ------- ----
      ----------------- -----
      ------ --
      --------- ---------
      ---- --
      ----- --
    -
    
    ------------- -
      ---------- -----
    -
    
    ------------------- -
      --------- ---------
      ------- -----
      ------ -----
    -
    
    -------------------- -
      --------- ---------
      ----- --
      ---- --
      ---------- -----
      ------------ -----
    -
    
    ------------- ------------------ -
      ----------------- ------- -- -- -----
      -------------- --
      ------- -----
    -
    
    ------------- ----------------- -
      -------- -----
    -
    
    ------------- ------------------------ -
      ---------- -----
      ------------ -----
    -
    
    ------------- ----------------------- -
      ------- -----
      ------ ------
    -
    
    ------------- ----------------------- ------------------------ -
      ---------- -----
      ------------ -----
    -
    
    ------------- ----------------------- ---------------------------- -
      ------- -----
      ----------- -----
    -
  
  --------
-------
------

  ---- -------------------------------------
    ------ ----------------------- -------------------------------------
    ---- --------------------
      ---- ---------------------------
        ------- --------------- -------------------- --------- ----------------------
        ------- ---------------- --------------------- --------- -----------------------
      ------
      ---- -------------------------
        ---- ------------------------------ -----------------------------------
        ---- --------------------------- --------------------------------
      ------
      ---- ---------------------
        ----- --------------------------- ---------------------------------
        ----- ---------------------------------------
        ----- ------------------------- -------------------------------
      ------
      ---- ---------------------------
        -- ------------------------------ -- ------------------
        ---- ------------------------------ ------------------------------
      ------
    ------
  ------

  --------
    --- ----- - ------------------------------------------------
    
    --- ------- - -
      ------ --------------
    --
    
    --- --------- - -
      ------- ---------- -
        ----------------------
      --
      -------- ---------- -
        --------------------
      -
    --
    
    --- ---------- - --- ------------------------- -------- -----------
    
    -- -----
    --- ---------- - ---------------------------------------
    --- ----------- - ------------------------------------------------
    --- -------------- - ---------------------------------------------------
    --- --------- - ---------------------------------------------------
    
    --------------------------- ---------- -
      --- ------- - --------------------- - ------------------ - ----
      ----------------------- - ------- - ----
    ---
    
    ------------------------- ---------- -
      --- -------- - -------------------
      -- ---------------- - -- -
        --- ------- - --------------- - ------------------ - ----
        -------------------------- - ------- - ----
      -
    ---
    
    --- ------- - ------
    --- -------- - -----------------------------------------------------
    
    ---------------------------------- ---------- -
      -- --------- -
        --------------------
        ------- - ------
        -------------------------------------------
        ---------------------------------------
      - ---- -
        ------------------
        ------- - -----
        ------------------------------------------
        ----------------------------------------
      -
    ---
    
    ----------------------------------- ----------- -
      --- ------- - --------- - ---------------------
      ------------------------------
    ---
  ---------

-------
-------

结语

wtc-controller-video 是一款非常实用的前端控制器组件,可以帮助开发者快速实现视频播放、暂停、快进、音量控制等常用操作。通过本文的学习,你应该已经了解了该组件的基本用法和高级功能,可以在实际项目中灵活运用。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055bbc81e8991b448d9547

纠错
反馈