search

kim-company / videojs-chromecast

Google Chromecast VideoJS Plugin
MIT License
84 stars 42 forks source link

readme

VideoJS Chromecast Plugin

Displays a Chromecast button in the control bar. The button is only shown if the Google Cast extension is installed and a Chromecast is currently available.

video player

Getting started

NOTE: The Chromecast Plugin won't work if you open the index.html in the browser. It must run on a webserver.

  1. Add data-cast-api-enabled="true" in your <html> Tag.
  2. Include videojs.chromecast.css and videojs.chromecast.js in the <head>.
  3. Initialize the VideoJS Player with the Chromecast Plugin like the configuration example.
  4. When a Chromecast is available in your network, you should see the cast button in the controlbar.

If you are not able to configure the player, check out the demo directory.

Configuration example

videojs("my_player_id", {
  plugins: {
    chromecast: {
      appId: "AppID of your Chromecast App",
      metadata: {
        title: "Title",
        subtitle: "Subtitle"
      }
    }
  }
});

Contributing

david-dm

Ensure that you have installed Node.js and npm

Test that Grunt's CLI is installed by running grunt --version. If the command isn't found, run npm install -g grunt-cli. For more information about installing Grunt, see the getting started guide.

  1. Fork and clone the repository.
  2. Run npm install to install the dependencies.
  3. Run grunt to grunt this project.

You can test your changes with the included demo

  1. Run node demo-server.js to start the server.
  2. See http://localhost:3000/demo/ in your browser.