PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

1.0.22

npm

6buns-client

Client Library for 6buns

Published18 Apr 2022
Direct dependencies21
Transitive dependenciesNot calculated

README

Current package documentation

web-client

Installation

  • Using npm,
npm i 6buns-client
  • Using CDN,
<script src="https://unpkg.com/6buns@1.0.0"></script>

Usage

You create bun object, which handles all the webrtc things for you,

const options = {
  accountSid: "",
  apiKey: "",
  maxParticipants: "",
};

const bun = new Bun(options);

Join a room, by providing an id, and password key if required.

bun.join({
  roomId: "abcdef",
  roomPass: 45678,
});

Add Media, like microphone, or webcam, or screen

bun.setMedia({
	video: false, // camera or screen share
	audio: true,
	screen: true,
})

Stop live stream of your webcam, or other user's webcam.

bun.stop({
	mediaType: '',
	peerId: ''
})

Whenever a new user joins, new-peer event is fired, which can be handled on frontend.

bun.on("new-peer", (event) => {
  // Do something whenever a new user joins.
});

Whenever a new media track is available, new-remote-track event is fired. This event is usually fired when a user in room switched on/off their webcam/mic/screenshare

bun.on("new-remote-track", (event) => {
  // Add remote user's track
});

Whenever a user leaves, peer-left event is fired.

bun.on("peer-left", (id) => {
	// Do something when user leaves
});

Process for WEBRTC Peer to Peer

INITIATOR

  • Get User Media
  • Add Stream
  • Create Offer
  • Set Local SDP, Send Offer
  • On Answer
  • Set Remote Description
  • Send Candidates
  • Add Candidates

PARTICIPANT

  • Get User Media
  • Add Stream
  • On Offer
  • Set Remote Description
  • Create Answer
  • Set Local Description, Send Answer
  • Add Ice Candidates
  • Send Ice Candidates

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 21

Native requirements
21 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
events
Environment
{
  "local_name": "events",
  "alias": false,
  "peer_metadata": null
}
^3.3.0runtime
socket.io-client
Environment
{
  "local_name": "socket.io-client",
  "alias": false,
  "peer_metadata": null
}
^4.4.1runtime
@babel/core
Environment
{
  "local_name": "@babel/core",
  "alias": false,
  "peer_metadata": null
}
^7.17.5development
@babel/preset-env
Environment
{
  "local_name": "@babel/preset-env",
  "alias": false,
  "peer_metadata": null
}
^7.16.11development
@babel/preset-typescript
Environment
{
  "local_name": "@babel/preset-typescript",
  "alias": false,
  "peer_metadata": null
}
^7.16.7development
@rollup/plugin-babel
Environment
{
  "local_name": "@rollup/plugin-babel",
  "alias": false,
  "peer_metadata": null
}
^5.3.1development
@rollup/plugin-commonjs
Environment
{
  "local_name": "@rollup/plugin-commonjs",
  "alias": false,
  "peer_metadata": null
}
^21.0.2development
@rollup/plugin-node-resolve
Environment
{
  "local_name": "@rollup/plugin-node-resolve",
  "alias": false,
  "peer_metadata": null
}
^13.1.3development
@rollup/plugin-typescript
Environment
{
  "local_name": "@rollup/plugin-typescript",
  "alias": false,
  "peer_metadata": null
}
^8.3.1development
@types/debug
Environment
{
  "local_name": "@types/debug",
  "alias": false,
  "peer_metadata": null
}
^4.1.7development
@types/jsonwebtoken
Environment
{
  "local_name": "@types/jsonwebtoken",
  "alias": false,
  "peer_metadata": null
}
^8.5.8development
babel
Environment
{
  "local_name": "babel",
  "alias": false,
  "peer_metadata": null
}
^6.23.0development
core-js
Environment
{
  "local_name": "core-js",
  "alias": false,
  "peer_metadata": null
}
^3.21.1development
debug
Environment
{
  "local_name": "debug",
  "alias": false,
  "peer_metadata": null
}
^4.3.3development
jsdoc
Environment
{
  "local_name": "jsdoc",
  "alias": false,
  "peer_metadata": null
}
^3.6.10development
regenerator-runtime
Environment
{
  "local_name": "regenerator-runtime",
  "alias": false,
  "peer_metadata": null
}
^0.13.9development
rollup
Environment
{
  "local_name": "rollup",
  "alias": false,
  "peer_metadata": null
}
^2.68.0development
rollup-plugin-node-builtins
Environment
{
  "local_name": "rollup-plugin-node-builtins",
  "alias": false,
  "peer_metadata": null
}
^2.1.2development
rollup-plugin-node-globals
Environment
{
  "local_name": "rollup-plugin-node-globals",
  "alias": false,
  "peer_metadata": null
}
^1.4.0development
rollup-plugin-terser
Environment
{
  "local_name": "rollup-plugin-terser",
  "alias": false,
  "peer_metadata": null
}
^7.0.2development
tslib
Environment
{
  "local_name": "tslib",
  "alias": false,
  "peer_metadata": null
}
^2.3.1development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "integrity": "sha512-3RPXODHJMvuxdRz3DRrxakexrRIb1r1z57JVAcdE9TrdEzCLlFmui9JQaJpGSoRB56j/3pGjGxnKidjJLFvuUg==",
  "shasum": "99a91e55ec750aad64dbd191d1dab0400172eb94",
  "tarball": "https://registry.npmjs.org/6buns-client/-/6buns-client-1.0.22.tgz",
  "fileCount": 3,
  "unpackedSize": 73503,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEQCIGFmWk3HQY4Pi4Zur0EQZg/dL7v+Kb7kFJVJb17E9hC3AiBVVc/Y/ouuQ1OEtCWgr+KE3lukz4O5auJw3r6HUhX+AA=="
    }
  ],
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiXXFdACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrekw//TqcDqwhHI7sk1QaEXU1hlmHXxj+GfZ3sApP2ONz3wzP82V2G\r\n4cTePb4HW0VmvO5ixXmcEKf+5zQG4Ct6M4gvMkaKwaBQ2KVA2kKk6LwmkKyD\r\nQsKoz/quJE/siD5WUOBQXcIohQs6FIv5AajjWH8RNnLDUnZlqrDG+QB3uty8\r\nmfNe+6JHj4b8poI1XbtYMFMhaKh46sZzYxXlM/UdjLGfA/aATA36Xqtr1p45\r\nxuCq4XAlwPIiEwlC7FOiSDBNWfYKJVtRcrKpVKR3PdXdJ9s3rr5qesZ3Qsyr\r\nvLk2U2h/+jmzRlA/YwmeEoNpX0SiosSf9/m9OVIl8/wC5Sv0E7yNDSowNSFb\r\n1rvO6RUxry9jNA72flqTlwexHVyMjpyc+zPHXjlNgAkAid6wF5+/REo3JV0X\r\nDdBLl8OI+tYJBLUOi1Psc77FY+M5HS6VYLmzlrfXXzSTBIGQ9C2F3jmiTerR\r\nzNODbEjA2fBTCOV/Jwtr8CnKTtTvDiPiyFfFFejRZ97YnV53ODX/HKzwopmm\r\nl0dwwVN7RYRBOCiEmOfjTGeZkVBH5AVy5JgXmI13lekabupji0UTusqwFwPy\r\nwYSkW51yItwgvdI6ibW6qDjFkhlyvDLnk+sCFEV5nxsPMYkDsu83xNXiirBQ\r\n2dl6+UwcNMWIlN7BCbrlw37+yQ32JefUwJ8=\r\n=1VIk\r\n-----END PGP SIGNATURE-----\r\n"
}

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 20:50 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:eecc1a7eadfc30209c13c1765d1b358dcac1be8b02cc5aad5c233d08bca17b69

Other collected versions

1.0.2419 Apr1.0.2318 Apr1.0.2116 Apr1.0.2016 Apr1.0.1916 Apr1.0.1816 AprView all collected versions →