Coder Social home page Coder Social logo

naf-janus-adapter's Introduction

Networked-AFrame Janus Adapter

npm

Network adapter for networked-aframe that uses the Janus WebRTC server as a backend.

Usage

naf-janus-adapter needs access to networked-aframe's NAF global variable. Include it after including networked-aframe but before the networked-scene is loaded.

Compatibility

naf-janus-adapter should support anything that supports recent WebRTC standards (right now, the RTPSender-based APIs for manipulating streams and tracks). At the time of this writing, that means that many browsers (e.g. Chrome) will require the use of the WebRTC adapter shim. If you're using NPM to build your A-Frame application, you should include webrtc-adapter as a dependency of your application; if you're using the browser distribution, you should include the WebRTC adapter prior to including naf-janus-adapter, as shown in the example code below.

Example

<html>
<head>
  <script src="https://webrtc.github.io/adapter/adapter-latest.js"></script>
  <script src="https://aframe.io/releases/0.7.0/aframe.min.js"></script>
  <script src="https://rawgit.com/netpro2k/networked-aframe/feature/register-adapter/dist/networked-aframe.js"></script>
  <script src="https://unpkg.com/naf-janus-adapter/dist/naf-janus-adapter.min.js"></script>
</head>
<body>
   <a-scene networked-scene="
        room: 1;
        audio: true;
        adapter: janus;
        serverURL: ws://localhost:8080;
      ">
  </a-scene>
</body>
</html>

Migrating to 4.0.0

4.0.0 allows the application to control when occupants are subscribed to. Occupants are no longer automatically subscribed to when they join. The application is now required to call syncOccupants and pass an array of occupantIds that it wants to subscribe to. This list should contain all occupantsIds that are currently desired to be subscribed to- including any that have already been subscribed to and want to continue to be so. Any occupants not on the list that are already subscribed to will be unsubscribed from.

NAF.connection.adapter.syncOccupants(arrayOfOccupantIds);

If you want to automatically subscribe to occupants on join, you may call syncOccupants with the availableOccupants array as the first arugument once.

NAF.connection.adapter.syncOccupants(NAF.connection.adapter.availableOccupants);

Development

  • Dev: npm run start
  • Build: npm run build
  • Release: npm run release

naf-janus-adapter's People

Contributors

gfodor avatar brianpeiris avatar robertlong avatar mqp avatar johnshaughnessy avatar infinitelee avatar netpro2k avatar mozilla-github-standards avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.