Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opentok/accelerator-screen-sharing-js
Accelerator Screen Sharing JS provides an easy way to get started in implementing interoperable screen sharing using the OpenTok platform.
https://github.com/opentok/accelerator-screen-sharing-js
javascript opentok screensharing tokbox webrtc
Last synced: 3 months ago
JSON representation
Accelerator Screen Sharing JS provides an easy way to get started in implementing interoperable screen sharing using the OpenTok platform.
- Host: GitHub
- URL: https://github.com/opentok/accelerator-screen-sharing-js
- Owner: opentok
- License: mit
- Archived: true
- Created: 2017-02-13T12:45:47.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2021-09-01T15:36:30.000Z (about 3 years ago)
- Last Synced: 2024-07-09T15:25:43.194Z (4 months ago)
- Topics: javascript, opentok, screensharing, tokbox, webrtc
- Language: JavaScript
- Homepage: https://tokbox.com/
- Size: 198 KB
- Stars: 16
- Watchers: 27
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Accelerator Screensharing for Javascript
[](https://app.travis-ci.com/github/opentok/accelerator-screen-sharing-js)
[](./README.md)
[](./.github/LICENSE)
[](https://www.npmjs.com/package/opentok-screen-sharing)
## 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
```bash
$ npm install --save opentok-screen-sharing
```
If using browserify or webpack:
```javascript
const screenSharing = require('opentok-screen-sharing');
```
Otherwise, include the accelerator pack in your html:
```html
```
. . . and it will be available in global scope as `ScreenSharingAccPack`
-----------------
Click [here](https://www.npmjs.com/search?q=opentok-acc-pack) 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`:
```javascript
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](https://github.com/opentok/accelerator-core-js), you can subscribe to these events by calling `on` on `otCore` and providing a callback function:
```javascript
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](CONTRIBUTING.md) 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:
- Open an issue on this repository
- See for support options
- Tweet at us! We're [@VonageDev](https://twitter.com/VonageDev) on Twitter
- Or [join the Vonage Developer Community Slack](https://developer.nexmo.com/community/slack)
## Further Reading
- Check out the Developer Documentation at