Natural Polyglot Machine

    videojs-awesome-watermark

    0.0.12 • Public • Published

    videojs-awesome-watermark

    A simple plugin to display a text/image watermark

    Installation

    npm install --save videojs-awesome-watermark

    Usage

    To include videojs-awesome-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.

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

    Browserify/CommonJS

    When using with Browserify, install videojs-awesome-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-awesome-watermark');
    
    var player = videojs('my-video');
    
    player.awesomeWatermark();

    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-awesome-watermark'], function(videojs) {
      var player = videojs('my-video');
    
      player.awesomeWatermark();
    });

    Options and defaults

    const defaults = {
      // Watermark types are 'text' and 'img'
      type: 'text',
    
      // General options
      intermittent: false,
      hiddenTime: 5,
      visibleTime: 5,
      opacity: 0.4,
    
      // Positioning
      // when 'position' is set, the other positioning options (left, right, top and bottom) will be ignored
      // 'random', 'top-left', 'top-right', 'bottom-left', 'bottom-right', 'center', 'top-center'
      // 'bottom-center', 'offcenter-center', 'offcenter-left', 'offcenter-right', 
      position: null,
      positionUnit: 'px',  // the CSS unit for positioning
      randomPositionSwitchingTime: 3, // random position switching time
      // make sure you set a pair [left,right] / [top,bottom], (like the 'position' option), 
      // otherwise you may get undesired results
      top: '20',
      bottom: null,
      left: null,
      right: '20',
    
      // Text watermark properties
      fontColor: 'white',
      fontFamily: 'Arial',
      fontSize: '30',
      fontSizeUnit: 'pixels',
      text: "Watermark",
    
      // Image watermark properties
      image: 'https://picsum.photos/200',
      imageWith: '100px',
      
      // Link watermark to external page
      url: 'https://google.com',
    };

    License

    MIT. Copyright (c) Jommy Barban <fanguitocoder@gmail.com>

    Install

    npm i videojs-awesome-watermark

    DownloadsWeekly Downloads

    27

    Version

    0.0.12

    License

    MIT

    Unpacked Size

    42 kB

    Total Files

    17

    Last publish

    Collaborators

    • fanguitocoder