npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

opentok-screen-sharing

v1.0.35

Published

OpenTok screen sharing accelerator pack

Downloads

3,141

Readme

Accelerator Screensharing for Javascript

Build Status GitHub release license MIT npm

Quick start

The OpenTok Screensharing Accelerator Pack provides functionality you can add to your OpenTok applications that enables users to share the screen. This section shows you how to use the accelerator pack.

Install

$ npm install --save opentok-screen-sharing

If using browserify or webpack:

const screenSharing = require('opentok-screen-sharing');

Otherwise, include the accelerator pack in your html:

<script src="../your/path/to/opentok-screen-sharing.js"></script>

. . . and it will be available in global scope as ScreenSharingAccPack


Click here for a list of all OpenTok accelerator packs.

Exploring the code

The ScreenShareAccPack class in opentok-screen-sharing.js is the backbone of the screen share feature for the app. This class sets up the screen share UI views and events, and provides functions for sending, receiving, and rendering shared screens.

Initialization

The following options fields are used in the ScreenShareAccPack constructor:

| Feature | Field | Required | | ------------------------------------------------------------------------------------- | ------------------------ | -------- | | Set the OpenTok session (object). | session | true | | Set the screen container (string). | screenSharingContainer | false | | Set the Common layer API (object). | accPack | false | | Set the ID of the Chrome extension (string). | extensionID | false | | Append a link tag for Chrome Web Store inline install (boolean) (defaults to true). | appendWebStoreLink | false | | Set the download path for the FireFox extension (string). | extentionPathFF | false | | Using screen sharing with the annotation accelerator pack. | annotation | false | | If using annotation, should we use an external window. | externalWindow | false | | Set the container to append the start/stop button (string). | controlsContainer | false | | Append the start/stop button to the DOM | appendControl | false | | Set custom properties for the publisher (object) | localScreenProperties | false | | Allow screen sharing over http in development (boolean) | dev | false |

Once you define the options, you simply create a new instance of the ScreenShareAccPack:

      const screenShareOptions = {
       session: session,
       extensionID: myChromeExtensionID,
       extentionPathFF: myFirefoxExentionPath,
       screensharingParent: myParentContainer,
     };
     const screenSharing = new ScreenShareAccPack(screenShareOptions);

ScreenShareAccPack Methods

The ScreenShareAccPack component has the following methods:

| Method | Description | | ---------------------- | --------------------------------------- | | extensionAvailable() | Test whether an extension is available. | | start() | Start sharing screen. | | end() | Stop sharing screen. |

Events

The ScreenSharingAccPack component emits the following events:

| Event | Description | | --------------------- | -------------------------------------------- | | startScreenSharing | We've started publishing/sharing the screen. | | endScreenSharing | We've stopped publishing/sharing the screen. | | screenSharingError | A screen sharing error occurred. |

If using the screen sharing accelerator pack with Accelerator Core, you can subscribe to these events by calling on on otCore and providing a callback function:

otCore.on('eventName', callback)

Multiparty video communication sample app using the Accelerator Screensharing with best-practices for Javascript (https://github.com/opentok/accelerator-sample-apps-js)

Development and Contributing

Interested in contributing? We :heart: pull requests! See the Contribution guidelines.

Getting Help

We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:

Further Reading