Socket
Socket
Sign inDemoInstall

@glezsosa/videojs-settings

Package Overview
Dependencies
8
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @glezsosa/videojs-settings

A settings button for Video.js


Version published
Weekly downloads
1
decreased by-66.67%
Maintainers
1
Install size
2.00 MB
Created
Weekly downloads
 

Readme

Source

videojs-settings

A settings plugin for Hola Video.JS fork. Shows a menu with optional 3 items:

  1. Technical info – shows overlay with video tech info
  2. Quality select – if possible, user can select different quality for current video
  3. Report playback issue – automatically send player logs to Hola (for now this feature is working only with Hola CDN)

Extra features:

  • minimal right-click context menu;
  • default volume/quality (if available) configuration;
  • persistent volume/quality saved accross page reloads (if hola/videojs-utils included).

Quick start

To start using Hola settings plugin, follow these steps:

  1. Add these includes to your document's <head>:
<script src="https://cdn.rawgit.com/hola/videojs5-settings/08567a8660366ba71cb937ae2b8fdc2cf8369e56/dist/videojs-settings.min.js"></script>
  1. Set plugins option for your Video.js setup:

In video tag data-setup attribute in your html

<video ... data-setup='{"plugins":{"settings":{"info":true,"report":true,"quality":true}}}'>
  <source src="http://cdn.example.com/static/mp4/example_1080p.mp4" type="video/mp4" label="high" />
  <source src="http://cdn.example.com/static/mp4/example_720p.mp4" type="video/mp4" label="medium" />
  <source src="http://cdn.example.com/static/mp4/example_360p.mp4" type="video/mp4" label="low" default />
</video>

or in javascript videojs call:

videojs('your-video-element', {
  plugins: {
    settings: {
      info: true,
      report: true,
      quality: {
        sources: [
          {src:"http://cdn.example.com/static/mp4/example_1080p.mp4", type: "video/mp4", label: "high"},
          {src:"http://cdn.example.com/static/mp4/example_720p.mp4", type: "video/mp4", label: "medium"},
          {src:"http://cdn.example.com/static/mp4/example_360p.mp4", type: "video/mp4", label: "low", "default": true}
        ]
      },
      volume: {level: 0.5, mute: true},
      show_settings_popup_on_click: true
    }
  }
});

Configuration options

The following configuration options are supported by this plugin:

PropertyTypeDefaultDescription
info<Boolean>falseShow 'technical info' in settings menu
report<Boolean>falseShow 'report playback issue' in settings menu
quality.sources<Array>List of quality sources. Shown in settings menu if quality.sources.length>1
quality.sources[i].src<String>Media source URL
quality.sources[i].type<String>Media source type
quality.sources[i].label<String>Media source label: shown in settings menu
quality.sources[i]['default']<Boolean>falseMedia source to be selected by default. NOTE: this may be overriden by persistent configuration.
volume```false```
volume.level<Float>1.0Volume level between 0.0 and 1.0. NOTE: use volume.mute instead of 0.0 if you want to disable volume level. NOTE: this may be overriden by persisten configuration, use volume.override_local_storage = true to force defined configuration.
volume.mute<Boolean>falseVolume mute. NOTE: this may be overriden by persisten configuration, use volume.override_local_storage = true to force defined configuration.
volume.override_local_storage<Boolean>falseSet to true if you want to force volume configuration and ignore user choice saved in persistent configuration
show_settings_popup_on_click<Boolean>falseSelect the trigger method to show settings menu: onhover (false) or onclick (true)

Events

EventDescription
beforeresolutionchangeFired when user clicks on a quality menu item. Use event.preventDefault() to cancel user selection (for instance when login required to view higher quality video etc).
resolutionchangeFired when new resolution applied. Use player.currentSrc() to identify selected quality.

FAQs

Last updated on 27 May 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc