rtc-sharedcursor

    1.0.2 • Public • Published

    rtc-sharedcursor

    The rtc-sharedcursor module makes it simple to share and touch mouse events for a target element across the wire one or more peers across a data channel connection.

    NPM

    unstable bitHound Score

    Example Usage

    var quickconnect = require('rtc-quickconnect');
    var crel = require('crel');
     
    // initialise quickconnect
    var qc = quickconnect('https://switchboard.rtc.io/', {
      room: 'test:sharedcursor'
    });
     
    // create the shared cursor
    var cursor = require('rtc-sharedcursor')(qc);
     
    // create some test elements
    var elements = [
      crel('canvas', { width: 200, height: 200 }),
      crel('canvas', { width: 500, height: 500 }),
      crel('canvas', { width: 20, height: 100 }),
    ];
     
    // randomly select one of the canvases
    var target = elements[(Math.random() * elements.length) | 0];
    var context = target.getContext('2d');
     
    // add our test elements to the dom
    elements.forEach(function(el) {
      document.body.appendChild(el);
    });
     
    // color our target so we know the capture source
    context.fillStyle = 'rgb(200, 200, 200)';
    context.fillRect(0, 0, target.width, target.height);
     
    // attach the cursor the element now it is in the dom and has
    // valid DOM bounds
    cursor.attach(target);
     
    // draw on the target
    cursor.on('data', function(id, type, x, y) {
      context.fillStyle = 'rgb(200, 200, 200)';
      context.fillRect(0, 0, target.width, target.height);
      context.fillStyle = type === 'move' ? 'green' : 'red';
      context.fillRect(- 5, y - 5, 10, 10);
    });
     

    Running the example in a few different windows, should display something similar to what is shown below:

    Screenshot

    License(s)

    Apache 2.0

    Copyright 2015 National ICT Australia Limited (NICTA)

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0
    

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    Install

    npm i rtc-sharedcursor

    DownloadsWeekly Downloads

    1

    Version

    1.0.2

    License

    Apache 2.0

    Last publish

    Collaborators

    • damonoehlman