Skip to content

sunnyw1212/video-playback-extension

Repository files navigation

Video Playback Extension

A full-featured video and audio player extension. Control playback speed, skipping, rewinding and more.

Features

Speed up, slow down, advance and rewind HTML5 audio/video elements either with shortcuts or using a clean, elegant interface.

Optimize your media experience by:

  • controlling media on just your current active or across all tabs in Chrome
  • customizing playback speed
  • skipping forward or backward by custom time intervals
  • looping
  • restarting media from the very beginning
  • playing
  • pausing
  • an experimental Theater Mode (for video only)
  • customizable one key shortcuts for all actions

Once the extension is installed, navigate to any page with an HTML5 video or audio element and click on the extension to bring down the Player User Interface. Any changes made will affect all audio/video elements on the page and you can optionally control media across all tabs in Chrome using the Player UI.

Default Shortcuts:

  • s = Decrease playback speed by .25
  • w = Increase playback speed by .25
  • l = Loop
  • o = Pause
  • p = Play
  • e = Reset playback speed
  • r = Restart
  • a= Skip backward by the Skip Interval set in the Player UI
  • d = Skip forward by the Skip Interval set in the Player UI
  • t = Theater Mode

Local Development

Installing and Running Procedures:

  1. Check if your Node.js version is >= 14.
  2. Clone this repository.
  3. Run npm install to install the dependencies.
  4. Run npm start
  5. Load your extension on Chrome following:
    1. Access chrome://extensions/
    2. Check Developer mode
    3. Click on Load unpacked extension
    4. Select the build folder.
  6. Happy hacking.

Structure

All your extension's code must be placed in the src folder.

Webpack auto-reload and HRM

To make your workflow much more efficient this boilerplate uses the webpack server to development (started with npm start) with auto reload feature that reloads the browser automatically every time that you save some file in your editor.

You can run the dev mode on other port if you want. Just specify the env var port like this:

$ PORT=6002 npm run start

Content Scripts

Although this boilerplate uses the webpack dev server, it's also prepared to write all your bundles files on the disk at every code change, so you can point, on your extension manifest, to your bundles that you want to use as content scripts, but you need to exclude these entry points from hot reloading (why?). To do so you need to expose which entry points are content scripts on the webpack.config.js using the chromeExtensionBoilerplate -> notHotReload config. Look the example below.

Let's say that you want use the myContentScript entry point as content script, so on your webpack.config.js you will configure the entry point and exclude it from hot reloading, like this:

{
  
  entry: {
    myContentScript: "./src/js/myContentScript.js"
  },
  chromeExtensionBoilerplate: {
    notHotReload: ["myContentScript"]
  }
  
}

and on your src/manifest.json:

{
  "content_scripts": [
    {
      "matches": ["https://www.google.com/*"],
      "js": ["myContentScript.bundle.js"]
    }
  ]
}

Packing

After the development of your extension run the command

$ NODE_ENV=production npm run build

Now, the content of build folder will be the extension ready to be submitted to the Chrome Web Store. Just take a look at the official guide to more infos about publishing.

To zip the extension:

$ zip ~/Desktop/videoplaybackextension.zip ./build -r

Resources:

Credits:

Built on top of https://github.com/lxieyang/chrome-extension-boilerplate-react by Michael Xieyang Liu

License

(MIT License) - Copyright (c) 2021 Sunny Wong

About

Video Playback Customizer Chrome Extension

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published