videojs-dynamic-watermark

1.1.0 • Public • Published

videojs-dynamic-watermark

Displays text watermark over the VideoJS player and updates the position dynamically.

Table of Contents

Installation

Installation

npm install --save videojs-dynamic-watermark

Plugin Options

Default options

{
  elementId: 'unique-id',
  watermarkText: 'sbbullet',
  changeDuration: 1000,
  cssText: 'display: inline-block; color: grey; background-color: transparent; font-size: 1rem; z-index: 9999; position: absolute; @media only screen and (max-width: 992px){font-size: 0.8rem;}'
}

Options

  • elementId string Unique id to be used as the id attribute of watermark element. Must be unique in the DOM.
  • watermarkText string Watermark text content
  • changeDuration int Milliseconds after which the position of watermark is changed. FYI 1000 milliseconds = 1 second
  • cssText string CSS style properties to be used for the watermark. Tweak the look and feel of the watermark text as you wish using CSS

Usage

To include videojs-dynamic-watermark on your website or web application, use any of the following methods.

<script> Tag

This is the simplest case. Get the script in whatever way you prefer and include the plugin after you include video.js, so that the videojs global is available.

With Default Options

<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-dynamic-watermark.min.js"></script>
<script>
  var player = videojs("my-video");

  player.dynamicWatermark();
</script>

With Custom Options

<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-dynamic-watermark.min.js"></script>
<script>
  var player = videojs("my-video");

  player.dynamicWatermark({
    elementId: "unique_id",
    watermarkText: "It will be displayed over video",
    changeDuration: 1000,
    cssText:
      "display: inline-block; color: grey; background-color: transparent; font-size: 1rem; z-index: 9999; position: absolute; @media only screen and (max-width: 992px){font-size: 0.8rem;}",
  });
</script>

Using image or other elements

You can use image, svg or any other HTML element like a button (which if clicked goes to some url) as your watermark content simply by this tricky hack.

<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-dynamic-watermark.min.js"></script>
<script>
  var player = videojs("my-video");

  player.dynamicWatermark({
    elementId: "unique_id",
    watermarkText: "<img height='20' width='20' src='https://i.pravatar.cc' />",
    changeDuration: 1000,
    cssText:
      "display: inline-block; color: grey; background-color: transparent; font-size: 1rem; z-index: 9999; position: absolute; @media only screen and (max-width: 992px){font-size: 0.8rem;}",
  });
</script>

Browserify/CommonJS

When using with Browserify, install videojs-dynamic-watermark via npm and require the plugin as you would any other module.

var videojs = require("video.js");

// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require("videojs-dynamic-watermark");

var player = videojs("my-video");

player.dynamicWatermark();

RequireJS/AMD

When using with RequireJS (or another AMD library), get the script in whatever way you prefer and require the plugin as you normally would:

require(["video.js", "videojs-dynamic-watermark"], function (videojs) {
  var player = videojs("my-video");

  player.dynamicWatermark();
});

License

MIT. Copyright (c) Santosh Bhattarai <mr.bullet.sb@gmail.com>

Readme

Keywords

Package Sidebar

Install

npm i videojs-dynamic-watermark

Weekly Downloads

233

Version

1.1.0

License

MIT

Unpacked Size

34.2 kB

Total Files

13

Last publish

Collaborators

  • sbbullet